@rumblefishdev/eth-signer-kms

@rumblefishdev/eth-signer-kms

Web3 provider that derives address and signs transactions using AWS KMS.

Install

$ npm i @rumblefishdev/eth-signer-kms

Requirements

aws-sdk

In order to work properly AWS KMS managed key must be:

• asymmetric
• able to sign and verify
• ECC_SECG_P256K1 specified

Usage

* Before use, make sure that AWS SDK is properly configured! Find out how to do it here.

KMSProvider can be used as a standalone Web3 provider and within Truffle config. It's based on @truffle/hdwallet-provider so wallet non-related params (providerOrUrl, shareNonce, poolingInterval and chainId) remain the same.

keyId can be obtained via KMS package of aws-sdk or directly via AWS console.

Parameters:

Parameter	Type	Default	Required	Description
keyId	string	null	[x]	Key ID of AWS KMS managed private key.
providerOrUrl	string/object	null	[x]	Official doc
shareNonce	boolean	true	[ ]	Official doc
pollingInterval	number	4000	[ ]	Official doc
chainId	number/string	undefined	[ ]	Official doc

Examples

Truffle usage example - TODO Web3 provider usage - TODO

Credits:

@lucashenning @truffle team