{"_id":"@circlecurve/eth-signer-kms","_rev":"2-08a39e2e4a4130cd843e473b7ae344c5","name":"@circlecurve/eth-signer-kms","dist-tags":{"latest":"1.2.2"},"versions":{"1.2.1":{"name":"@circlecurve/eth-signer-kms","version":"1.2.1","description":"Web3 provider that derives address and signs transactions using [AWS KMS](https://aws.amazon.com/kms/).","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && tsc","prepublish":"tsc"},"repository":{"type":"git","url":"git+https://github.com/circlecurve/eth-signer-kms.git"},"author":{},"license":"ISC","bugs":{"url":"https://github.com/circlecurve/eth-signer-kms/issues"},"homepage":"https://github.com/circlecurve/eth-signer-kms#readme","peerDependencies":{"aws-sdk":"*"},"dependencies":{"@ethereumjs/common":"^2.5.0","@ethereumjs/tx":"^3.3.2","@ethersproject/bytes":"^5.5.0","@ethersproject/hash":"^5.5.0","@types/ethereum-protocol":"^1.0.1","asn1.js":"^5.4.1","bn.js":"^4.12.0","ethereum-protocol":"^1.0.1","ethereumjs-util":"^6.2.1","ethereumjs-wallet":"^1.0.1","js-sha3":"^0.8.0","url":"^0.10.3","web3-provider-engine":"^16.0.1"},"devDependencies":{"@typescript-eslint/eslint-plugin":"^4.27.0","@typescript-eslint/parser":"^4.27.0","aws-sdk":"*","eslint":"^7.29.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.4.0","prettier":"^2.3.1","typescript":"^4.3.4"},"publishConfig":{"access":"public"},"_id":"@circlecurve/eth-signer-kms@1.2.1","dist":{"shasum":"2ce3cbfd24298fb44fbad53a8bf3a149c4566639","integrity":"sha512-K4Jyng/A/7+QBgQORwWNgvkEqLLgMETh0VSPKIg3uVtmmGoPiC0eJ8tWEbxq0uAkiUe+6b8nxBTL13gpmHeSKQ==","tarball":"https://registry.npmjs.org/@circlecurve/eth-signer-kms/-/eth-signer-kms-1.2.1.tgz","fileCount":28,"unpackedSize":188998,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiFfXvACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoLCA//QWa5JMTw/CYVWFEw7OcPiSUlDYvPu3j7tBfrPi9+65Cz1u4w\r\nUoGI0csXoc6fAT9+FyNkX/C4BlUQvTZbL+NZKpHPh10LU2Ovm2H6QXyWEoU5\r\nDknYaOP43LiblYZfBSBJEkEwrzv1YzhlIyot64E8O5B7EzoMYYn8hXU9dwiN\r\nW4FA618TuMdnp0GIR95RgKMzytI5JpVcBacZtgOSDRHyOkDtjZM2hSGEh76V\r\nwyHjc59lqJoeaqTqTHAL256AnI4sdbV3Y7p/VicgSTuJf8jvVdQy9Xv5v5es\r\natEV+po0xFpVtNUtd5dy654xTfvLpIUCLXJMVlDgQ4SQ9NYkIQdU2hzYkcir\r\n90YZ2RLOACxaSKXjQCWTyg/S6uyYr/l82/IP8iGr13dAwEIWl3bhqwigRn5a\r\nTvykZKrSGu0oe/rlgSF+63CRg6lIKHOVjYgkoyjALbc5aGNs0zkGQDuZtyzq\r\nMqyQGLdvliA90l0lpfY9Q9nPSdbB+TuXr0DVa5mCAgdzpomKgh7VKJx6eG1j\r\n/Pps3Lj87ht9HxUZH3p45HXd3BVloLcrFuDLroTx9tR/P0Mprsu5RwRM9nMk\r\nXjFpcyFRTdFaheOIU1g2MQpTECKIT2shja5NBuS/yA0xSfTPUZE4ZHa6vT0M\r\nfyCb+F7/ydcBpbKSuXonUq1oiIuwXefof9s=\r\n=Ywu9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICvEgbSFB9qkTJ+5sFKW9hFy8rvqbCHMSyUuh3eQmR7vAiAKy7mw/9JgeWzuwJuTlnwMno1z2D273iR7GNU5VCQZdA=="}]},"_npmUser":{"name":"circlecurve","email":"patrickngnet@gmail.com"},"directories":{},"maintainers":[{"name":"circlecurve","email":"patrickngnet@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eth-signer-kms_1.2.1_1645606383553_0.7049082996692166"},"_hasShrinkwrap":false},"1.2.2":{"name":"@circlecurve/eth-signer-kms","version":"1.2.2","description":"Web3 provider that derives address and signs transactions using [AWS KMS](https://aws.amazon.com/kms/).","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && tsc","prepublish":"tsc"},"repository":{"type":"git","url":"git+https://github.com/circlecurve/eth-signer-kms.git"},"author":{},"license":"ISC","bugs":{"url":"https://github.com/circlecurve/eth-signer-kms/issues"},"homepage":"https://github.com/circlecurve/eth-signer-kms#readme","peerDependencies":{"aws-sdk":"*"},"dependencies":{"@ethereumjs/common":"^2.5.0","@ethereumjs/tx":"^3.3.2","@ethersproject/bytes":"^5.5.0","@ethersproject/hash":"^5.5.0","@types/ethereum-protocol":"^1.0.1","asn1.js":"^5.4.1","bn.js":"^4.12.0","ethereum-protocol":"^1.0.1","ethereumjs-util":"^6.2.1","ethereumjs-wallet":"^1.0.1","js-sha3":"^0.8.0","url":"^0.10.3","web3-provider-engine":"^16.0.1"},"devDependencies":{"@typescript-eslint/eslint-plugin":"^4.27.0","@typescript-eslint/parser":"^4.27.0","aws-sdk":"*","eslint":"^7.29.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.4.0","prettier":"^2.3.1","typescript":"^4.3.4"},"publishConfig":{"access":"public"},"_id":"@circlecurve/eth-signer-kms@1.2.2","dist":{"shasum":"c80bbe19495324098b69726b65effde545a6e55f","integrity":"sha512-Gok1e/i2wv/EzJ5mVFfGHxxNCAHPdqgvPoGdHPJs7mY/WOAtoSa1sa/Xi2j43hrj7Pol+FGxKbU/5oEw4kKg8w==","tarball":"https://registry.npmjs.org/@circlecurve/eth-signer-kms/-/eth-signer-kms-1.2.2.tgz","fileCount":28,"unpackedSize":190356,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiFfxWACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmohpA//UdV0xxp2tB5XFH9h+0bgibzop2gERCa3M6A6RBv2ftbVH1zl\r\nfiJrDSVzAKo9jsJoBaXGFXYccHFz0ot1SYpFjxE2VmxB4DQIxmbx7qYAxqbO\r\nr1xUNmA2gWRvacL63+cQKln1DRTx0aTHk6MNLGzlfPXEeJYcVN850O1+YPGk\r\nu4DFU5x+DxHU2xdL/N1LQw0opY4mFWe7rGLVpWJW0Xn5ir3IzxbuSHa5RUh+\r\nGRVa24vOgdRoe+S3FkIe8J0QzC/FXINV+Q/g3wrObhcVU+a4Bw6P2HdzrROG\r\nxO4G2bvZzaul5Kcvauwe7DccuSl3epYfrUaC0x5OG6Zcwna9cZ2yRyCwNqFK\r\nus1OFE34oAgVBWz/qCrgp4YH5rvStS/T6oyk4Eh63ucE/91TzXkYnYPLN+Ml\r\n3QYai7cIT/yuPhYHkK8w8iB5ILwYNFMVBlFSxqJkRJ6DGrdNlHAyCxbSFnsA\r\nCVopvql7wQEjWPFuWSYtYBl9ltkvs3qfB/NOrxExpOm0BN8VsNZBRBJXb+6q\r\nK/n9IjucRGLy7hIr7ITeIoGPbNrSf0XRnwWxH8Dj2UYaVz8tUIjCsE37+rqc\r\n865hq92GO8fLR0dSYXHD431Xd+Il6wup8uIemsBuwV7j9Z9IeaPcXYHdgJvt\r\n8dJoTE2eukESmxQ+C6GQl/0OJTTkXsL4hHc=\r\n=q0E1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCnqtGD2XXxhVR+HLgAOgFznBebKfa/K+19uG5bvgbZhAIgdum1KG/r76VQkt+0M67fGID4AjEgQ+2XVxMJAiSwQ98="}]},"_npmUser":{"name":"circlecurve","email":"patrickngnet@gmail.com"},"directories":{},"maintainers":[{"name":"circlecurve","email":"patrickngnet@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eth-signer-kms_1.2.2_1645608022204_0.20289770460007506"},"_hasShrinkwrap":false}},"time":{"created":"2022-02-23T08:53:03.492Z","1.2.1":"2022-02-23T08:53:03.873Z","modified":"2022-04-04T23:01:44.057Z","1.2.2":"2022-02-23T09:20:22.387Z"},"maintainers":[{"name":"circlecurve","email":"patrickngnet@gmail.com"}],"description":"Web3 provider that derives address and signs transactions using [AWS KMS](https://aws.amazon.com/kms/).","homepage":"https://github.com/circlecurve/eth-signer-kms#readme","repository":{"type":"git","url":"git+https://github.com/circlecurve/eth-signer-kms.git"},"author":{},"bugs":{"url":"https://github.com/circlecurve/eth-signer-kms/issues"},"license":"ISC","readme":"# @circlecurve/eth-signer-kms\n\nWeb3 provider that derives address and signs transactions using [AWS KMS](https://aws.amazon.com/kms/).\n\n## Install\n\n```\n$ npm i @circlecurve/eth-signer-kms\n```\n\n## Requirements\n\n```\naws-sdk\n```\n\nIn order to work properly AWS KMS managed key must be:\n\n- asymmetric\n- able to sign and verify\n- ECC_SECG_P256K1 specified\n\n## Usage\n\n#### \\* Before use, make sure that AWS SDK is properly configured! Find out how to do it [here](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/configuring-the-jssdk.html).\n\nKMSProvider can be used as a standalone Web3 provider and within Truffle config. It's based on [@truffle/hdwallet-provider](https://www.npmjs.com/package/@truffle/hdwallet-provider) so wallet non-related params (`providerOrUrl`, `shareNonce` and `poolingInterval` and `chainId`) remain the same. In addition, it uses [@ethereumjs/tx](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/tx) under the hood which offers [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) support.\n\n`keyId` can be obtained via `KMS` package of `aws-sdk` or directly via AWS console.\nhttps://github.com/ethereumjs/ethereumjs-monorepo\n\n### Parameters:\n\n| Parameter         | Type            | Default | Required | Description                                                                                                                                                                                                                                                                          |\n| ----------------- | --------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `keyId`           | `string`        | `null`  | [x]      | Key ID of AWS KMS managed private key                                                                                                                                                                                                                                                |\n| `providerOrUrl`   | `string/object` | `null`  | [x]      | [Official doc](https://github.com/trufflesuite/truffle/blob/develop/packages/hdwallet-provider/README.md#instantiation)                                                                                                                                                              |\n| `chainSettings`   | `Common`        | `{}`    | [ ]      | Common object used to configure tx options. If chainId is not passed, it will be obtained automatically via `eth_chainId`. For details instructions please refer to [Common](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/common) and [Tx]() official docs |\n| `shareNonce`      | `boolean`       | `true`  | [ ]      | [Official doc](https://github.com/trufflesuite/truffle/blob/develop/packages/hdwallet-provider/README.md#instantiation)                                                                                                                                                              |\n| `pollingInterval` | `number`        | `4000`  | [ ]      | [Official doc](https://github.com/trufflesuite/truffle/blob/develop/packages/hdwallet-provider/README.md#instantiation)                                                                                                                                                              |\n\n## Examples\n\n[Truffle usage example](https://github.com/circlecurve/eth-signer-kms/tree/master/examples/truffle)\n\n[Nodejs + ethersjs usage example ](https://github.com/circlecurve/eth-signer-kms/tree/master/examples/ethers)\n\n## Credits:\n\n[@lucashenning](https://github.com/lucashenning/aws-kms-ethereum-signing)\n[@truffle team](https://github.com/trufflesuite/truffle/tree/develop/packages/hdwallet-provider)\n","readmeFilename":"README.md"}