{"_id":"@aws/web3-ws-provider","_rev":"24-1b6d8a75a695201dfbbed4d06ab84b32","name":"@aws/web3-ws-provider","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.2":{"name":"@aws/web3-ws-provider","version":"1.0.2","license":"LGPL-3.0-or-later","_id":"@aws/web3-ws-provider@1.0.2","maintainers":[{"name":"cayblood","email":"carl@youngbloods.org"},{"name":"forrest-not-gump","email":"colyerf@amazon.com"},{"name":"mattsb42-aws","email":"bullocm@amazon.com"},{"name":"aws-sdk-team","email":"aws-sdk-js@amazon.com"},{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"awsxray","email":"aws-xray-sdk-node@amazon.com"},{"name":"aws-iot-sdk","email":"fengsong@amazon.com"},{"name":"aws-amplify-ops","email":"aws-amplify@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"},{"name":"mohit0193","email":"mohit.ag0193@gmail.com"},{"name":"rishabh6788","email":"rishabhksingh@gmail.com"},{"name":"weicongs","email":"weicongs@amazon.com"},{"name":"sayaligaikawad","email":"gaiksaya@amazon.com"},{"name":"peterzhuamazon","email":"zhujiaxi@amazon.com"}],"dist":{"shasum":"a047a7e9559abc551b27842f4c3f79781954e903","tarball":"https://registry.npmjs.org/@aws/web3-ws-provider/-/web3-ws-provider-1.0.2.tgz","fileCount":6,"integrity":"sha512-VKya0A3XYSz51VJ7eI+7lCwIFeCI5W+WwSUjM8qeZMuEBnmtBLpsaD6nm5+0nLbJgkIVErVezkV2tkE7qurhKg==","signatures":[{"sig":"MEUCIFDerwNpCIfANbmIDc40xFXMEMsEyG682CmnlWRC6PpwAiEAyW3b1TDnjNBQxUcTDs6pao1NsLIdG+o5SKrLa3tEO00=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16490,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgk3hsCRA9TVsSAnZWagAA2Q8QAJpCMI2+j3qCMJV2OlcB\ngcGLkz5voz/lTF+vFmtoeFyJ1P0Ynf6j7ed/03P4uN4qTI+hGLUQrpc4liYP\nOazny7bmUYG5zTJDj3bn/eMgs8ecsikUhJVhPuXgkZSRmC2hBOBy8YB2xQMI\nFPn3UOMsJGXAmbwLpVu3eu7a8QndjMOBWcAJ8OZtIUqOaJlUk1VRZn2tzrwP\nUrAFFBE9pC8lGKjKQS+c7s4WFni6ZaGaKG780VeS6oDNIyWkqJYMSQMTQ7m8\nuVZaT/FIA4ElcTCUe+jsB8utjkTr6I4/By6AcbhxEMzno4su0TlKcatRboWa\nXZBsvt5w2qNA7JwoPfKh3wil4Upfm5POy9zowC4NMOmZs8B9Wmo3j+9lU3Am\n72OIdOg99bTCF3cT8/1Z205RVoxxnImF8v/Wj7iu7hrvv4CQDq42jCMJ5gDo\n7uQMGDUNj0C7DCdE8hr769kjXGlrIzOhvVHWqzNGAYq5UdqCfPE+U/S+ByoN\nbcdO6F+mgGFIwcJ1IaOP5H3/1673/FUl+x8ZAmDe0xSw4w6tQLYenQPHeygA\npbGF8/y7+kzQ+leHArknz5ftqhaqd/cQgiq/dVzihlr/142tbnFxuwgPpyB+\n2yXnW1tdPErFnpJBBUmKo6LoQweV1muW4TTLk3pb3CfyH+lbCnAbvnCBB2m6\n9gsD\r\n=v2Ty\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","authors":[{"url":"https://github.com/cayblood","name":"Carl Youngblood","email":"cayblood@amazon.com"},{"url":"https://github.com/forrest-not-gump","name":"Forrest Colyer","email":"colyerf@amazon.com"},{"url":"https://github.com/evertonfraga","name":"Everton Fraga","email":"effraga@amazon.com"}],"gitHead":"d89a25054f1da0932ee5e83e6a7de6164bad7978","scripts":{"test":"echo \"Follow instructions in test dir\" && exit 1"},"_npmUser":{"name":"cayblood","email":"carl@youngbloods.org"},"repository":{"url":"git@ssh.gitlab.aws.dev:cayblood/aws-web3-ws-provider.git","type":"git"},"_npmVersion":"6.14.11","description":"Web3 WebSockets provider for Amazon Managed Blockchain that handles AWS Signature Version 4 authentication","directories":{},"_nodeVersion":"14.16.0","dependencies":{"aws-sdk":"^2.809.0","web3-providers-ws":"^1.3.5"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/web3-ws-provider_1.0.2_1620277355843_0.14489667775787307","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@aws/web3-ws-provider","version":"1.0.3","license":"LGPL-3.0-or-later","_id":"@aws/web3-ws-provider@1.0.3","maintainers":[{"name":"cayblood","email":"carl@youngbloods.org"},{"name":"forrest-not-gump","email":"colyerf@amazon.com"},{"name":"mattsb42-aws","email":"bullocm@amazon.com"},{"name":"aws-sdk-team","email":"aws-sdk-js@amazon.com"},{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"awsxray","email":"aws-xray-sdk-node@amazon.com"},{"name":"aws-iot-sdk","email":"fengsong@amazon.com"},{"name":"aws-amplify-ops","email":"aws-amplify@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"},{"name":"mohit0193","email":"mohit.ag0193@gmail.com"},{"name":"rishabh6788","email":"rishabhksingh@gmail.com"},{"name":"weicongs","email":"weicongs@amazon.com"},{"name":"sayaligaikawad","email":"gaiksaya@amazon.com"},{"name":"peterzhuamazon","email":"zhujiaxi@amazon.com"}],"dist":{"shasum":"87cc324b752f00edc4ba8b35f991ea6a59a30ed8","tarball":"https://registry.npmjs.org/@aws/web3-ws-provider/-/web3-ws-provider-1.0.3.tgz","fileCount":6,"integrity":"sha512-dX20WQsWmH2FW7uP9dnqySNCg9Uek6w68vvA1Z8FbylY4xETJx5MuyLCeytgeqaBYzxd8LCeNuka8Y5LxRyu0Q==","signatures":[{"sig":"MEUCIQDyaOnAXn01GeeZgVNXgJOWRuRFqfyZYsp6vS20sQaRCAIgCsDdp460zG5/IezljF42jCQc76jj1srSAb+lRyW9a2I=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16495,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgk3sqCRA9TVsSAnZWagAACi0QAJtLTucCSs4eJV5J9gEf\nS2zrlwPM67utK9HO4BGvMOhFDRNHbupk5NH8csPyZvbVmNIio+KYUDGDRpzl\na2QqHui00VVpcd1GmjJhKNbDy1C2kRS3n1jHUEOVjpm7fXnaZntbRScpOTll\nz5/hsOeXljsFyV14re0N8HBv4LqD9pFo6+t6xS2INZjyP7Nl1RBZ+dLNlJdm\nZ0/vhdGrweFulQyatUmVptfJBrRiUWvgY5UMKu0e2ay3Y43PlV3Hoq2u9UgW\nZjBaN8g7XR+5yVLlCPcGtCug9SVRyyEYt3OVLWaYtkKxJhsjI743EmHAAILN\nqjNyoc96f/K38XoggoweWTwjH2Ur026TWdXwcz3Z7O5tFaxI64AajQIBv3FK\nbdL7D1oZAPU6ogkD5TZX0d7f9M8drpZeNZPh57BXSA/juJ/aCcuFt2Gd38kR\nMr3xwwac050wij3H6Jp/arfPjw/jyqW5dEGrFbaDNarpHUe4JWQ8Ct09YcjO\nYTp0sIeuKwp0fETES6Ac19JugYAunE0GC2FcnFgUAh88VPoggHzWiOdTy4td\nuY5UVEMNHxbkx/6tZnSwYo2UZlNnI9qyreMWAt0NtVMh8qIYNJBsVCno3Ikk\ngDaIDr1LCLXEFVscmcRqYC/kAXs/KzVqRjwcTMVSUethyPPRjefPEp5OvV/t\np5gE\r\n=UQ99\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","authors":[{"url":"https://github.com/cayblood","name":"Carl Youngblood","email":"cayblood@amazon.com"},{"url":"https://github.com/forrest-not-gump","name":"Forrest Colyer","email":"colyerf@amazon.com"},{"url":"https://github.com/evertonfraga","name":"Everton Fraga","email":"effraga@amazon.com"}],"gitHead":"37f7401afbdd32a52022ed79f07cc50dfa1c3638","scripts":{"test":"echo \"Follow instructions in test dir\" && exit 1"},"_npmUser":{"name":"cayblood","email":"carl@youngbloods.org"},"repository":{"url":"git@ssh.gitlab.aws.dev:cayblood/aws-web3-ws-provider.git","type":"git"},"_npmVersion":"6.14.11","description":"Web3 WebSockets provider for Amazon Managed Blockchain that handles AWS Signature Version 4 authentication","directories":{},"_nodeVersion":"14.16.0","dependencies":{"aws-sdk":"^2.809.0","web3-providers-ws":"^1.3.5"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/web3-ws-provider_1.0.3_1620278058042_0.735884166891406","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-05-06T05:02:35.488Z","modified":"2026-06-22T20:42:54.050Z","1.0.2":"2021-05-06T05:02:35.984Z","1.0.3":"2021-05-06T05:14:18.185Z"},"license":"LGPL-3.0-or-later","repository":{"url":"git@ssh.gitlab.aws.dev:cayblood/aws-web3-ws-provider.git","type":"git"},"description":"Web3 WebSockets provider for Amazon Managed Blockchain that handles AWS Signature Version 4 authentication","maintainers":[{"email":"aws-sdk-js@amazon.com","name":"aws-sdk-team"},{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"},{"email":"aws-xray-sdk-node@amazon.com","name":"awsxray"},{"email":"aws-sdk-common-runtime@amazon.com","name":"aws-iot-sdk"},{"email":"aws-amplify@amazon.com","name":"aws-amplify-ops"},{"email":"bedrock-agentcore-npm@amazon.com","name":"bedrock-agentcore-npm"},{"email":"amazon-q-developer-cli@amazon.com","name":"amazon-q-cli-bot"},{"email":"aws-apm-synthetics-npm@amazon.com","name":"aws-apm-synthetics-npm"}],"readme":"# @aws/web3-ws-provider\n\nThis is an NPM package that takes care of Signature Version 4 authentication\nfor websocket connections to Ethereum nodes on\n[Amazon Managed Blockchain](https://aws.amazon.com/managed-blockchain/).\n\n## Installing\n\nInstall and save as a dependency using NPM:\n`npm install @aws/web3-ws-provider --save`\n\n## Example\n\nThis example assumes that your AWS IAM-related environment variables have been set\npreviously. For example:\n```\nexport AWS_ACCESS_KEY_ID=...\nexport AWS_SECRET_ACCESS_KEY=...\n\n# if your IAM credentials are temporary:\nexport AWS_SESSION_TOKEN=...\n```\n\n```\nconst Web3 = require('web3');\nconst AWSWebsocketProvider = require('@aws/web3-ws-provider');\nconst endpoint = 'wss://nd-NODEID.wss.ethereum.managedblockchain.REGION.amazonaws.com';\nconst web3 = new Web3(new AWSWebsocketProvider(endpoint));\nweb3.eth.getNodeInfo().then(console.log).then(() => {\n  web3.currentProvider.connection.close();\n});\n```\n\nYou may also provide your credentials directly to the constructor arguments of a new instance of AWSWebsocketProvider()\nusing the clientConfig options object:\n```\nconst Web3 = require('web3');\nconst AWSWebsocketProvider = require('@aws/web3-ws-provider');\n\nconst credentials = {\n  accessKeyId: process.env.AWS_ACCESS_KEY_ID, \n  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY\n};\nconst endpoint = 'wss://nd-NODEID.wss.ethereum.managedblockchain.REGION.amazonaws.com';\nconst web3 = new Web3(new AWSWebsocketProvider(endpoint, { clientConfig: { credentials: credentials }}));\nweb3.eth.getNodeInfo().then(console.log).then(() => {\n  web3.currentProvider.connection.close();\n});\n```\n\nThis reusable WS provider can be used to create a valid WS provider in the popular Ethers.js library:\n\nIn your project's root directory, install ethers:\n`npm install ethers --save`\n\n```\nconst ethers = require('ethers');\nconst AWSWebsocketProvider = require('@aws/web3-ws-provider');\n\nconst credentials = {\n  accessKeyId: process.env.AWS_ACCESS_KEY_ID, \n  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY\n};\nconst endpoint = 'wss://nd-NODEID.wss.ethereum.managedblockchain.REGION.amazonaws.com';\nconst baseProvider = new AWSWebsocketProvider(endpoint, { clientConfig: { credentials: credentials }}));\nlet provider = new ethers.providers.WebSocketProvider(baseProvider);\n```\n\n\n## Testing\n\nTo test this package, follow the instructions in `test/README`.\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more\ninformation.\n\n## License\n\nThis library is licensed under the [LGPL-3.0 License](LICENSE).\n","readmeFilename":"README.md"}