Package Exports

@tacoinfra/tezos-kms
@tacoinfra/tezos-kms/build/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@tacoinfra/tezos-kms) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Tezos KMS

About

tezos-kms is a typescript library which provides functionality for using keys stored in AWS KMS for operations in Tezos.

Configuration

In order to use keys you will need to configure a key in AWS KMS. Steps 1-12 of the Harbinger Setup Guide provide a brief overview of how to achieve this.

Usage

import { TezosKmsClient } from '@tacoinfra/tezos-kms'

const awsKeyId = "x" // Place your key here.
const awsRegion = "eu-west-1"

const kmsClient = new TezosKmsClient(awsKeyId, awsRegion)

console.log(await kmsClient.getPublicKey()) // sppk...
console.log(await kmsClient.getPublicKeyHash()) // tz2...

const bytes = Buffer.from('deadbeef', 'hex')
console.log(await kmsClient.signOperation(bytes)) // <bytes>
console.log(await kmsClient.signOperationBase58(bytes)) // spsig...

Building the Library

$ npm i
$ npm run build

Credits

Harbinger is written and maintained by Luke Youngblood and Keefer Taylor.