{"_id":"@avnsystems/web3-providers-ws","_rev":"1-31676871d695c04d34310c791be974a7","name":"@avnsystems/web3-providers-ws","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"version":"1.0.0","name":"@avnsystems/web3-providers-ws","description":"This is a fork of web3-providers-ws that uses @avnsystems/websocket-node","author":{"name":"Allan Avelar"},"main":"index.js","license":"MIT","keywords":["websocket-node","providers-ws","web3"],"repository":{"type":"git","url":"git+https://github.com/avnsystems/web3-providers-ws.git"},"bugs":{"url":"https://github.com/avnsystems/web3-providers-ws/issues"},"homepage":"https://github.com/avnsystems/web3-providers-ws#readme","_id":"@avnsystems/web3-providers-ws@1.0.0","_nodeVersion":"14.17.6","_npmVersion":"6.14.15","dist":{"integrity":"sha512-O06r5PwrHnzE3LRBnt1qZpj6grV5aaJhEVWWgO/sAioFIg29HUtJxrEMQ1eiFAuPAllhd9gpzraJlQsN7F1jxw==","shasum":"c99205f5ca95acec62e9d25dba018e665393fdf0","tarball":"https://registry.npmjs.org/@avnsystems/web3-providers-ws/-/web3-providers-ws-1.0.0.tgz","fileCount":4,"unpackedSize":16031,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhmE7KCRA9TVsSAnZWagAAa7AP/0rnjKow14WtugDeqmcr\nwrKDJkPmaLl3ca8kZ1nVCsWS/A9esepKUKIsKwdg6CU3GAfg1F6CrJPR2XiJ\n7gPEU7W/KyPaC3eXPavudM9IU72Ucp6VN9N6OGdL97bFS/3kPCNiCx9fDOv/\n++6ctaXC153/xBLYnf8RK6V9qLU+YLLs0JiR/CPG0YIJa9oyVo4YKN5Rxl2f\nGef/MEDcGOVqaAHdwTWP3Du+yj5vtfdpymzkqryVCNZTfFMvR0XIXgDFAIB7\n8KCteh/ccSi5sq1hfMAfSNySV+yDlsOEQ1Y7x1+4ui42KjwxfQW84dzOaoE8\nAwytr2qm4DgQkmWPVZMsN7QeYZ56CzQ/kvbnkspFwxIee+W6VBKtoleysbXU\nwVgZdoiUcBCPbsRxZK81Q+7Wlz+1VVHYqDe6D+DbvB+DkaRZbRSaiAApOvIP\n3BA9RD6CEj4f2KMtffxVkmt5iIoTQ/5OH+gFpbobxG8jYJ9paQXMtpBEnFJf\nbrnF/7IkrSMNSbF80yDIkeaLxYZeiKIe+FKZzUwIfiudeZ4ecrLgwG21A5M/\nu+mnOXevc9b2r0I8A+NYXDoltXPU8//IvMc59R4agXcYoFs9G8WIyDd851vD\nfJ7K6DzOGiEefU0g6nIHE2SJhreqYLslmYBcxU5olPtXZX6gJLCrhQnw/goo\nL7d3\r\n=yW3a\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD7he0TvaBRvsNDMNyG4AwXWuHABLKg9JDmlTjtmfiPWQIhAOpILHPBhwvmCVCHEFWtXwOaB04rUuFauZ/eZqvjd7aQ"}]},"_npmUser":{"name":"allanavelar","email":"allanavelar.dev@gmail.com"},"directories":{},"maintainers":[{"name":"allanavelar","email":"allanavelar.dev@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/web3-providers-ws_1.0.0_1637371594025_0.32186848089120357"},"_hasShrinkwrap":false}},"time":{"created":"2021-11-20T01:26:33.970Z","1.0.0":"2021-11-20T01:26:34.200Z","modified":"2022-04-04T16:48:03.953Z"},"maintainers":[{"name":"allanavelar","email":"allanavelar.dev@gmail.com"}],"description":"This is a fork of web3-providers-ws that uses @avnsystems/websocket-node","homepage":"https://github.com/avnsystems/web3-providers-ws#readme","keywords":["websocket-node","providers-ws","web3"],"repository":{"type":"git","url":"git+https://github.com/avnsystems/web3-providers-ws.git"},"author":{"name":"Allan Avelar"},"bugs":{"url":"https://github.com/avnsystems/web3-providers-ws/issues"},"license":"MIT","readme":"<p align=\"center\">\r\n  <a href=\"#\">\r\n    <h1 align=\"center\">Web3 Providers WebSocket</h1>\r\n  </a>\r\n</p>\r\n\r\n<p align=\"center\">\r\n  <a href=\"#\">\r\n    <img src=\"https://img.shields.io/npm/v/web3-providers-ws.svg?style=for-the-badge\" alt=\"language-used\"/>\r\n  </a>\r\n\r\n  <a href=\"#\">\r\n    <img src=\"https://img.shields.io/github/languages/top/avnsystems/web3-providers-ws.svg?style=for-the-badge\" alt=\"language-used\"/>\r\n  </a>\r\n\r\n  <a href=\"#\">\r\n    <img src=\"https://img.shields.io/github/contributors/avnsystems/web3-providers-ws.svg?style=for-the-badge\">\r\n  </a>\r\n\r\n  <a href=\"#\">\r\n    <img src=\"https://img.shields.io/github/forks/avnsystems/web3-providers-ws.svg?style=for-the-badge\">\r\n  </a>\r\n\r\n  <a href=\"#\">\r\n    <img src=\"https://img.shields.io/github/stars/avnsystems/web3-providers-ws.svg?style=for-the-badge\">\r\n  </a>\r\n\r\n  <a href=\"#\">\r\n    <img src=\"https://img.shields.io/github/issues/avnsystems/web3-providers-ws.svg?style=for-the-badge\">\r\n  </a>\r\n\r\n  <h3 align=\"center\">This is a fork of web3-providers-ws that uses <a href=\"https://github.com/avnsystems/websocket-node\">@avnsystems/websocket-node</a></h3>\r\n</p>\r\n\r\n## Overview\r\n\r\nThis is a websocket provider sub-package for [web3.js][repo].\r\n\r\nPlease read the [documentation][docs] for more.\r\n\r\n## Installation\r\n\r\n### Node.js\r\n\r\n```bash\r\nnpm install @avnsystems/web3-providers-ws\r\n```\r\n\r\n## Usage\r\n\r\n```js\r\nconst AVNWeb3ProvidersWs = require('@avnsystems/web3-providers-ws');\r\n\r\nconst options = {\r\n    // Enable keepalive \r\n    clientConfig: {\r\n        keepalive: true,\r\n        keepaliveInterval: 60000,\r\n        keepaliveForce: true\r\n    },\r\n    // Enable auto reconnection\r\n    reconnect: {\r\n        auto: true,\r\n        delay: 5000, // ms\r\n        maxAttempts: 5,\r\n        onTimeout: false\r\n    }\r\n};\r\n\r\nconst wsProvider = new AVNWeb3ProvidersWs('ws://localhost:8546', options);\r\n```\r\n\r\n## Usage with Web3\r\n\r\n```js\r\nconst Web3 = require('web3');\r\nconst web3 = new Web3(wsProvider);\r\n```\r\n\r\n## Usage with Ethers.js\r\n\r\n```js\r\nconst ethers = require('ethers');\r\nconst provider = new ethers.providers.Web3Provider(wsProvider);\r\n```\r\n\r\nAdditional client config options can be found [here](https://github.com/theturtle32/WebSocket-Node/blob/v1.0.31/docs/WebSocketClient.md#client-config-options).\r\n\r\n## Types\r\n\r\nAll the TypeScript typings are placed in the `types` folder.\r\n\r\n[repo]: https://github.com/ethereum/web3.js\r\n[docs]: http://web3js.readthedocs.io/en/1.0/\r\n","readmeFilename":"README.md"}