{"_rev":"7-481c4b269a3c3ed9d80b93fa3a3cf3d1","time":{"created":"2023-07-28T22:43:23.909Z","1.0.0":"2023-07-27T15:29:39.787Z","modified":"2023-07-28T22:43:24.287Z","1.0.1":"2023-07-27T15:50:55.682Z","1.0.2":"2023-07-27T16:50:12.794Z","1.0.3":"2023-07-28T22:43:24.120Z"},"_id":"@dennisdang/ethers-aws-kms-signer","name":"@dennisdang/ethers-aws-kms-signer","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.3":{"name":"@dennisdang/ethers-aws-kms-signer","version":"1.0.3","description":"An Ethers.js compatible signer that connects to AWS KMS","license":"MIT","repository":{"type":"git","url":"git+https://github.com/dangdennis/ethers-aws-kms-signer.git"},"main":"dist/index.js","types":"dist/index.d.ts","author":{"name":"Dennis Dang","email":"dennis.dang@hey.com","url":"https://github.com/dangdennis"},"keywords":[],"scripts":{"build":"tsc","check":"npx rome check src/","format":"npx rome format src/ --write","test":"npx tsc --project tsconfig.tests.json && npx vitest run"},"dependencies":{"@aws-sdk/client-kms":"^3.378.0","@types/node":"^20.4.5","asn1.js":"^5.4.1","dotenv":"^16.3.1","ethers":"^6.6.5"},"devDependencies":{"@types/asn1":"^0.2.0","rome":"^12.1.3","typescript":"^5.1.6","vitest":"^0.33.0"},"engines":{"node":">= 10.18"},"gitHead":"3ae980dd2f0ed50a6da6bea65b32b9893a09bb1f","bugs":{"url":"https://github.com/dangdennis/ethers-aws-kms-signer/issues"},"homepage":"https://github.com/dangdennis/ethers-aws-kms-signer#readme","_id":"@dennisdang/ethers-aws-kms-signer@1.0.3","_nodeVersion":"18.16.0","_npmVersion":"9.5.1","dist":{"integrity":"sha512-t7QUjTltWt/4Dnl0p7Vpiq56d7i8R/8tsrfUI4YrsZkbr8Dq8sBYGXALijlbDc41Hcb6AzBQoCYZIqYBQw+/vA==","shasum":"ea68ea5eb94ded6eeaaa4c0101e1f2a8945a2e8f","tarball":"https://registry.npmjs.org/@dennisdang/ethers-aws-kms-signer/-/ethers-aws-kms-signer-1.0.3.tgz","fileCount":9,"unpackedSize":18553,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDpQfVBrg3JG8N4eECVgUxkxX5HSACQlM/uCox0lx4eZwIgUNSDfpvCTwa2GnnAKz1nAMsDS4oRiptNH1dEDSSZwZM="}]},"_npmUser":{"name":"dennisdang-dev","email":"dangggdennis@gmail.com"},"directories":{},"maintainers":[{"name":"dennisdang-dev","email":"dangggdennis@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ethers-aws-kms-signer_1.0.3_1690584203984_0.3545052195560614"},"_hasShrinkwrap":false}},"maintainers":[{"name":"dennisdang-dev","email":"dangggdennis@gmail.com"}],"description":"An Ethers.js compatible signer that connects to AWS KMS","homepage":"https://github.com/dangdennis/ethers-aws-kms-signer#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/dangdennis/ethers-aws-kms-signer.git"},"author":{"name":"Dennis Dang","email":"dennis.dang@hey.com","url":"https://github.com/dangdennis"},"bugs":{"url":"https://github.com/dangdennis/ethers-aws-kms-signer/issues"},"license":"MIT","readme":"# ethers-aws-kms-signer\n\nThis is an Ethers@v6 Signer that can be used together with [Ethers.js](https://github.com/ethers-io/ethers.js/) applications, using AWS KMS as the key storage.\nFor GCP KMS look [here](https://github.com/openlawteam/ethers-gcp-kms-signer)\n\n## Getting Started\n\n```sh\nnpm i @dennisdang/ethers-aws-kms-signer\n```\n\n```js\nimport { AwsKmsSigner } from \"ethers-aws-kms-signer\";\n\nconst kms = new KMSClient({\n  region: \"us-east-1\",\n  credentials: {\n    accessKeyId: \"x\",\n    secretAccessKey: \"y\",\n    sessionToken: \"z\", // required if using temporary credentials\n  },\n});\n\nconst provider = new JsonRpcProvider(\"rpc endpoint\");\nconst signer = new AwsKmsSigner(\n  \"db3e7082-2b67-49a8-a7e1-092d52a1b2b8\",\n  kms,\n  provider\n);\nconst SomeContract = new Contract(\n  \"0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0\",\n  yourJsonAbi,\n  signer\n);\n\nconst tx = await SomeContract.mint(\"to-address\", tokenId);\n\nawait tx.wait();\n\nconsole.log(tx);\n```\n\n# Development\n\n## Install\n\n1. clone repo\n2. `npm i`\n\n## Commands\n\n```sh\n$ npm test # run tests\n$ npm run check # lint and format code\n$ npm run build # generate docs and transpile code\n$ npx tsc --watch # typecheck in watch mode\n```\n\n## License\n\nMIT © [Dennis Dang](https://github.com/dangdennis)\n\n# Credits\n\nCredit goes to RJ Chow's original library [ethers-aws-kms-signer](https://github.com/rjchow/ethers-aws-kms-signer). I've updated the library to use the latest version of ethers and simplified the tooling for my personal tastes (Rome, Vitest).\n","readmeFilename":"README.md"}