README

Conseil KMS

About

kms-conseil is a library which provides ConseilJS Signer and KeyStore interfaces for working with keys stored in AWS KMS. This library acts as a binding between ConseilJS and AWS KMS for working with operations in Tezos.

For more information on ConseilJS, see the ConseilJS Documentation.

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 { KmsKeyStore, KmsKeyStore } from '@tacoinfra/conseil-kms'
import { TezosNodeWriter } from 'conseiljs';

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

const signer = new KmsSigner(awsKeyId, awsRegion)
const keystore = KmsKeyStore.from(awsKeyId, awsRegion)

const result = await TezosNodeWriter.sendTransactionOperation(
    "https://rpctest.tzbeta.net", 
    signer, 
    keystore, 
    'tz1RVcUP9nUurgEJMDou8eW3bVDs6qmP5Lnc',     // Recipient
    500_000,                                    // Amount, in mutez
    1500                                        // Fee, in mutez
)

Building the Library

$ npm i
$ npm run build

Credits

This library is written and maintained by Luke Youngblood and Keefer Taylor.

Usage no npm install needed!