Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.14 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.14 KB

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.