{"_id":"@aviannetwork/avian-rpc","_rev":"6-63ab7eca75c56cb9469d09a6692a0103","name":"@aviannetwork/avian-rpc","dist-tags":{"latest":"2.1.3"},"versions":{"2.1.0":{"name":"@aviannetwork/avian-rpc","version":"2.1.0","author":{"name":"Michael McShinsky"},"license":"MIT","_id":"@aviannetwork/avian-rpc@2.1.0","maintainers":[{"name":"aviannetwork","email":"contact@avn.network"}],"homepage":"https://github.com/AvianNetwork/avian-rpc#readme","bugs":{"url":"https://github.com/AvianNetwork/avian-rpc/issues"},"dist":{"shasum":"4fb6318c61da0151e70b479072729eb9f4fc3846","tarball":"https://registry.npmjs.org/@aviannetwork/avian-rpc/-/avian-rpc-2.1.0.tgz","fileCount":72,"integrity":"sha512-cVMJdF77Q71rvS74tLK9jlxYCd3wIn06WNIjW0ffDl5AMQqAMdQCDeaC9mwW1GJsPh52RYjxE+1jnzUBvAuK0w==","signatures":[{"sig":"MEQCICtFwA2KSAjCbBQPLGTEvGbcJuyFs+GLbnSJVgQORt9MAiBhMde7yyWdjl280ysX5IuHxqxG7wmOfVwPJ0ccVrnUQQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1293906},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"tsdx lint"}},"types":"dist/index.d.ts","module":"dist/avian-rpc.esm.js","engines":{"node":">=14"},"gitHead":"4ed0cf05d72d4ff834e8fe5e075900e225e3e25f","scripts":{"docs":"jsdoc -c jsdoc.json","lint":"tsdx lint","size":"size-limit","test":"tsdx test","build":"tsdx build","start":"tsdx watch","analyze":"size-limit --why","prepare":"tsdx build","lint:fix":"tsdx lint --fix"},"typings":"dist/index.d.ts","_npmUser":{"name":"aviannetwork","email":"contact@avn.network"},"prettier":{"semi":true,"printWidth":80,"singleQuote":true,"trailingComma":"es5"},"repository":{"url":"git+https://github.com/AvianNetwork/avian-rpc.git","type":"git","directory":"packages/rpc"},"_npmVersion":"10.2.4","description":"![Avian RPC Banner](https://github.com/AvianNetwork/avian-rpc/raw/main/media/repo-banner.png)","directories":{},"_nodeVersion":"20.11.1","dependencies":{"axios":"^0.27.2","@hyperbitjs/rpc":"^0.1.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsdx":"^0.14.1","husky":"^7.0.4","jsdoc":"^3.6.11","tslib":"^2.3.1","size-limit":"^7.0.8","typescript":"^4.6.3","@types/node":"^17.0.23","better-docs":"^2.7.2","@size-limit/preset-small-lib":"^7.0.8"},"_npmOperationalInternal":{"tmp":"tmp/avian-rpc_2.1.0_1720274872314_0.5997646990468883","host":"s3://npm-registry-packages"}},"2.1.2":{"name":"@aviannetwork/avian-rpc","version":"2.1.2","author":{"name":"Michael McShinsky"},"license":"MIT","_id":"@aviannetwork/avian-rpc@2.1.2","maintainers":[{"name":"cdonnachie","email":"contact@avn.network"}],"homepage":"https://github.com/AvianNetwork/avian-rpc#readme","bugs":{"url":"https://github.com/AvianNetwork/avian-rpc/issues"},"dist":{"shasum":"067c0786a90da260179cc82532a1b6ea1e956ef7","tarball":"https://registry.npmjs.org/@aviannetwork/avian-rpc/-/avian-rpc-2.1.2.tgz","fileCount":72,"integrity":"sha512-NjbkQ0ReJoDqPGz0Ptav/EBN2bo62lhW/VKDVhIYxd6whmMbdmqTTBmLby9w8pTQBmcMshdb4lIpqJrloqSamw==","signatures":[{"sig":"MEUCIQD9oRE3dIyTQS6Wds/W0EekdvToKtSukqWe2T6rF9gudgIgVaBmlIYU9iotsvXz0JtK4D6mg+OTQ6Vya7giDOByBW8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1293906},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"tsdx lint"}},"types":"dist/index.d.ts","module":"dist/avian-rpc.esm.js","engines":{"node":">=14"},"gitHead":"65b38378be36efced2cf013778edb3da4b094d43","scripts":{"docs":"jsdoc -c jsdoc.json","lint":"tsdx lint","size":"size-limit","test":"tsdx test","build":"tsdx build","start":"tsdx watch","analyze":"size-limit --why","prepare":"tsdx build","lint:fix":"tsdx lint --fix"},"typings":"dist/index.d.ts","_npmUser":{"name":"cdonnachie","email":"contact@avn.network"},"prettier":{"semi":true,"printWidth":80,"singleQuote":true,"trailingComma":"es5"},"repository":{"url":"git+https://github.com/AvianNetwork/avian-rpc.git","type":"git","directory":"packages/rpc"},"_npmVersion":"10.2.4","description":"![Avian RPC Banner](https://github.com/AvianNetwork/avian-rpc/raw/main/media/repo-banner.png)","directories":{},"_nodeVersion":"20.11.1","dependencies":{"axios":"^0.27.2","@hyperbitjs/rpc":"^0.1.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsdx":"^0.14.1","husky":"^7.0.4","jsdoc":"^3.6.11","tslib":"^2.3.1","size-limit":"^7.0.8","typescript":"^4.6.3","@types/node":"^17.0.23","better-docs":"^2.7.2","@size-limit/preset-small-lib":"^7.0.8"},"_npmOperationalInternal":{"tmp":"tmp/avian-rpc_2.1.2_1720279437946_0.14694051334931113","host":"s3://npm-registry-packages"}},"2.1.3":{"version":"2.1.3","license":"MIT","main":"dist/index.js","types":"dist/index.d.ts","typings":"dist/index.d.ts","engines":{"node":">=14"},"scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test","lint":"tsdx lint","lint:fix":"tsdx lint --fix","prepare":"tsdx build","size":"size-limit","analyze":"size-limit --why","docs":"jsdoc -c jsdoc.json"},"husky":{"hooks":{"pre-commit":"tsdx lint"}},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"name":"@aviannetwork/avian-rpc","author":{"name":"Michael McShinsky"},"repository":{"type":"git","url":"git+https://github.com/AvianNetwork/avian-rpc.git","directory":"packages/rpc"},"module":"dist/avian-rpc.esm.js","devDependencies":{"@size-limit/preset-small-lib":"^7.0.8","@types/node":"^17.0.23","better-docs":"^2.7.3","husky":"^7.0.4","jsdoc":"^4.0.4","size-limit":"^7.0.8","tsdx":"^0.14.1","tslib":"^2.3.1","typescript":"^4.6.3"},"dependencies":{"@hyperbitjs/rpc":"^0.1.1","axios":"^1.8.4"},"publishConfig":{"access":"public"},"gitHead":"1fb895bca63ef3f4f064dfd241e45779cd418e70","description":"![Avian RPC Banner](https://github.com/AvianNetwork/avian-rpc/raw/main/media/repo-banner.png)","bugs":{"url":"https://github.com/AvianNetwork/avian-rpc/issues"},"homepage":"https://github.com/AvianNetwork/avian-rpc#readme","_id":"@aviannetwork/avian-rpc@2.1.3","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-znCl88NWOJXqXDaAHVOMPW8cTjWCAPM6nRuyI1TekIE6nnjeNOikptcl4VqB4DTgFL/cDwjZTtoj2502/sRBbQ==","shasum":"a9723f747d981e091897864ba289e5f670400a76","tarball":"https://registry.npmjs.org/@aviannetwork/avian-rpc/-/avian-rpc-2.1.3.tgz","fileCount":72,"unpackedSize":1345778,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDeqJ62zVebOQ3KjQSkXrRIB3YvXJnQ2y8rM+iTJeI0MQIhAOpLnl3VYJFl2QwKrKX2h3nKStixRjxb6e/jaZ2Jdk0M"}]},"_npmUser":{"name":"cdonnachie","email":"craig.donnachie@gmail.com"},"directories":{},"maintainers":[{"name":"cdonnachie","email":"craig.donnachie@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/avian-rpc_2.1.3_1742820463278_0.7135225613124387"},"_hasShrinkwrap":false}},"time":{"created":"2024-07-06T14:07:52.219Z","modified":"2025-03-24T12:47:43.711Z","1.0.0":"2024-07-06T12:27:48.152Z","2.1.0":"2024-07-06T14:07:52.488Z","2.1.2":"2024-07-06T15:23:58.118Z","2.1.3":"2025-03-24T12:47:43.522Z"},"bugs":{"url":"https://github.com/AvianNetwork/avian-rpc/issues"},"author":{"name":"Michael McShinsky"},"license":"MIT","homepage":"https://github.com/AvianNetwork/avian-rpc#readme","repository":{"type":"git","url":"git+https://github.com/AvianNetwork/avian-rpc.git","directory":"packages/rpc"},"description":"![Avian RPC Banner](https://github.com/AvianNetwork/avian-rpc/raw/main/media/repo-banner.png)","maintainers":[{"name":"cdonnachie","email":"craig.donnachie@gmail.com"}],"readme":"![Avian RPC Banner](https://github.com/AvianNetwork/avian-rpc/raw/main/media/repo-banner.png)\r\n\r\n# Avian Network - Avian RPC\r\n\r\n<a href=\"https://aviannetwork.github.io/avian-rpc/Client.html\" target=\"_blank\">Documentation Website</a>\r\n\r\nA client library to connect to Avian Core RPC in JavaScript.\r\n\r\n[![NPM Package](https://img.shields.io/npm/v/@aviannetwork/avian-rpc.svg?style=flat-square)](https://www.npmjs.org/package/@aviannetwork/avian-rpc)\r\n\r\n**An Avian module for [avian](https://github.com/AvianNetwork/Avian).**\r\n\r\n## Getting Started\r\n\r\n```sh\r\n# Using npm\r\nnpm install @aviannetwork/avian-rpc\r\n\r\n# Using yarn\r\nyarn add @aviannetwork/avian-rpc\r\n```\r\n\r\n### Usage\r\n\r\nYou can either write manually requests to your RPC connection via the `request` method, or you can use the built-in methods provided by the client class.\r\n\r\n#### Manually\r\n\r\n```javascript\r\nimport { Client } from '@aviannetwork/avian-rpc';\r\n\r\nconst client = new Client({\r\n  url: 'http://127.0.0.1:7896',\r\n  username: 'username',\r\n  password: 'password',\r\n});\r\n\r\nclient.request('getchaintips').then(response => {\r\n  console.log('response', response);\r\n});\r\n```\r\n\r\n#### Built-in Methods\r\n\r\n```javascript\r\nimport { Client } from '@aviannetwork/avian-rpc';\r\n\r\nconst client = new Client({\r\n  url: 'http://127.0.0.1:7896',\r\n  username: 'username',\r\n  password: 'password',\r\n});\r\n\r\nclient.methods.listAssets().then(assets => {\r\n  console.log('assets', assets);\r\n});\r\n```\r\n\r\n## Examples and Documentation\r\n\r\nSee [documentation](https://aviannetwork.github.io/avian-rpc/Client.html) for developer guides.\r\n\r\n## License\r\n\r\nCode released under [the MIT license](./LICENSE.md).\r\n\r\n### Development\r\n\r\nSome RPC commands within Avian have known bugs. You may experience them as a result. If you find that the issue comes from this library, please create an Issue so that it can be resolved quickly.","readmeFilename":"README.md"}