{"_id":"@carnesen/bitcoin-rpc","_rev":"3-f402aa1e00c9303b197954d8a76b5c94","name":"@carnesen/bitcoin-rpc","dist-tags":{"latest":"0.0.0"},"versions":{"0.0.0-0":{"name":"@carnesen/bitcoin-rpc","description":"A Bitcoin remote procedure call (RPC) client","version":"0.0.0-0","main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=8.0.0"},"scripts":{"build":"tsc --project tsconfig.build.json","build:clean":"rimraf lib && npm run build","lint":"tslint --project tsconfig.build.json","lint:fix":"npm run lint -- --fix","test":"npm run lint && npm run test:unit && npm run build","test:unit":"jest src","test:unit:coverage":"npm run test:unit -- --coverage","test:unit:coverage:watch":"npm run test:unit -- --coverage --watch","test:unit:watch":"npm run test:unit -- --watch","preversion":"npm test && npm run build:clean","postversion":"npm publish"},"dependencies":{"@carnesen/bitcoin-config":"0.0.0-3","@carnesen/coded-error":"0.0.0"},"devDependencies":{"@carnesen/tsconfig":"0.0.1","@carnesen/tslint-config":"0.0.3","@types/jest":"23.3.10","@types/node":"8.10.38","@types/temp-write":"3.3.0","@types/tempy":"0.2.0","jest":"23.6.0","rimraf":"2.6.2","temp-write":"3.4.0","tempy":"0.2.1","ts-jest":"23.10.5","ts-node":"7.0.1","tslint":"5.11.0","typescript":"3.2.2"},"keywords":["bitcoin","typescript","rpc","bitcoin-rpc","bitcoind-rpc"],"author":{"name":"Chris Arnesen","email":"chris.arnesen@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/carnesen/bitcoin-rpc.git"},"bugs":{"url":"https://github.com/carnesen/bitcoin-rpc/issues"},"homepage":"https://github.com/carnesen/bitcoin-rpc","license":"MIT","gitHead":"ac201510b7be9715b0909b65c919463624a0cd06","_id":"@carnesen/bitcoin-rpc@0.0.0-0","_npmVersion":"6.4.1","_nodeVersion":"8.14.0","_npmUser":{"name":"carnesen","email":"chris.arnesen@gmail.com"},"dist":{"integrity":"sha512-V0rHiJbyajsj34D+XiGULj3ep/zMKMEnx4PxpKNJaEFDACmkt/ojTWmRVJ2QHzPbQvTWgcbbP+9Mi2mcAaneHw==","shasum":"3b213f6588159ece855db14746f4de1f580f1e30","tarball":"https://registry.npmjs.org/@carnesen/bitcoin-rpc/-/bitcoin-rpc-0.0.0-0.tgz","fileCount":70,"unpackedSize":67099,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcQsA5CRA9TVsSAnZWagAARlMP/iuDRsMOkR4Tji1a1eV6\nEO6Y4xNBOs4ZwMYtDwCiuU40eMltRl6OMf3Qs2AnT9l7XLGNluBudhJgwe3/\np2YYY/T6aGXn/OH8AoaQaZbzUxLCqN8P1RQT+zNUho6tt1ekY/usTc22UX6F\nZp67JL3krYVz1BM9+dxwZ8tedv3E6T+xDIz1u/+zOe2lCY0bBjj9kzS6g1nD\nWo56W5lwEgteP8OkG+I8VJf6bFHfTGpQp9hAdjsmvU3k07okPjUUVrGLTdad\nYsGcm2/24GbWfOKQfUH6kTWOQnVsUCxV8o8s1qG9dP/VS6giqHkvv/TmcxTE\nIPbozKgTX6AenaWpZ8f/DxHJOSfJXLFn09ocE1JdbfACQhMBsx+6RGfrhP5G\nDRuCEdVCl+k1Y9/9MtTmf6BbD6LFD8uaaukcA8e1d3GyAKlP+0xN6rVbqVVa\nMKzek3UwwFl7E4PBMqxViOBvRDQjbeqAZ66FM1AdD7SO3YaGrxQ3FmxiFTB/\ny/RT4zW/sm+zbc2mWwNfzxRiZ12rjW4wrxbUeYjUz4IawQYCoh9aSBoggcY/\nZHmcDogMAbDeKfvKEtszFWpebqdEHDFnEUVZ68OTcxm2K4LW+TDyXE1l4wEq\n90Qkl3yeisJJDah8q6rl/IlJoKLJEoZXfzhZvfNRtzw9qdu6Na4u43G2/ZTd\nN+v1\r\n=41Sq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCnZ9eBDQmxLTDV2WqakF3w+D25vG/JJvKlosiiTLf0qQIgXbPn4tKoq7uSySR+BIpbmXkUlUYIvCU7i3S1bq52kp0="}]},"maintainers":[{"name":"carnesen","email":"chris.arnesen@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bitcoin-rpc_0.0.0-0_1547878457376_0.1210177774822403"},"_hasShrinkwrap":false},"0.0.0":{"name":"@carnesen/bitcoin-rpc","description":"A Bitcoin remote procedure call (RPC) client","version":"0.0.0","main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=8.0.0"},"scripts":{"build":"tsc --project tsconfig.build.json","build:clean":"rimraf lib && npm run build","lint":"tslint --project tsconfig.build.json","lint:fix":"npm run lint -- --fix","test":"npm run lint && npm run test:unit && npm run build","test:unit":"jest --coverage src","test:watch":"npm run test:unit -- --watch","preversion":"npm test && npm run build:clean","postversion":"npm publish"},"dependencies":{"@carnesen/bitcoin-config":"0.0.3","@carnesen/coded-error":"0.1.0"},"devDependencies":{"@carnesen/bitcoin-regtest-service":"0.0.0","@carnesen/tsconfig":"0.1.0","@carnesen/tslint-config":"0.1.2","@types/jest":"24.0.0","@types/node":"10.12.24","@types/temp-write":"3.3.0","@types/tempy":"0.2.0","jest":"24.1.0","rimraf":"2.6.3","temp-write":"3.4.0","tempy":"0.2.1","ts-jest":"23.10.5","ts-node":"8.0.2","tslint":"5.12.1","typescript":"3.3.3"},"keywords":["bitcoin","typescript","rpc","bitcoin-rpc","bitcoind-rpc"],"author":{"name":"Chris Arnesen","email":"chris.arnesen@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/carnesen/bitcoin-rpc.git"},"bugs":{"url":"https://github.com/carnesen/bitcoin-rpc/issues"},"homepage":"https://github.com/carnesen/bitcoin-rpc","license":"MIT","gitHead":"d2d4f4a4a9eff3e800579eb21b040c189cd22838","_id":"@carnesen/bitcoin-rpc@0.0.0","_npmVersion":"6.4.1","_nodeVersion":"10.15.1","_npmUser":{"name":"carnesen","email":"chris.arnesen@gmail.com"},"dist":{"integrity":"sha512-oAQadKK2Cjw4KdmEzg4j5EBNfJgX2ZlGr2AkNp9bq5OmYxm6O2VxNuDKuyqNWj3/WoPCJYrlzsKIjEx+MxfLbA==","shasum":"6b1cc6551083042102eaabbc83a77ef9cff530df","tarball":"https://registry.npmjs.org/@carnesen/bitcoin-rpc/-/bitcoin-rpc-0.0.0.tgz","fileCount":43,"unpackedSize":26743,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcaQpMCRA9TVsSAnZWagAAsGsP/1oa/Aa0Mzgxy35BS5mJ\nqngWnvPADwqJ3L6he/ftU+QyjKABLmq62f7dioCJ90F9+BrFFFV1l65Na3mD\nsSHlzq6CsX75qluPL5CRAQ3FGD30n8iN06uv5s4aFSIst/p8hQ60ckwTRCsC\nIYalKP2uMu3qlV1DtMaiqjCNjVh8TgfsTivxtRDNGlBtPOxTyidgqiyJM5IH\nIp3ncp3g+wTQm4vJR2EaJRMsagsAxuCXvRYPJd1j6KYHo6yZXJgNIdJO/0Pe\noMU6QT4FsXUcg0B9i5oDy4rqGPnCHg0/fbSe2ruwOBKr/1VESaK/yvc8gl9F\n0Qkta7cMZcVGGEBP0X07TmVvLbCxjW7dNdnzz/UCwO48+iNgUjRHmLHrYIM0\nikkvi8o8gpaI0YYDV6oRrb1d1enBv94BSQrhEDannWQWzc1JRiaUYhxQOBbY\nTZy915M2FMV2pS3vGAF9wdje9Takds5dLkpaKMg2kSVs2AAG9WZoLl+7TNkp\nHYbqV1WzpMngUYPjQiLl9YF/rgzkO07fZcRq0BUD6pil9dfAx+iua7CHMW31\ng6zBW1/uujYQIpyD00Ml67prjdZe8JeCg4DqK1VG8EqR3hOuajZTtFwB9+/q\n25AeWZX33UPnZHEnV2TkNV/9cIhRAJlj2DBQonNoXFz6ZrTOGW8DX/+LI+UX\nMQBr\r\n=pFUd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFETBYQMv85uwVpJdq7bhDnCN7EEDedgPIQdgiCV5Zu4AiEAuSIuEY3HBOeZPK+El65DKcQUT6BtYmkvkdugWiAER70="}]},"maintainers":[{"name":"carnesen","email":"chris.arnesen@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bitcoin-rpc_0.0.0_1550387788330_0.9712772086371653"},"_hasShrinkwrap":false,"deprecated":"This project has been abandoned"}},"time":{"created":"2019-01-19T06:14:17.201Z","0.0.0-0":"2019-01-19T06:14:17.530Z","modified":"2022-04-04T21:58:32.193Z","0.0.0":"2019-02-17T07:16:28.460Z"},"maintainers":[{"name":"carnesen","email":"chris.arnesen@gmail.com"}],"description":"A Bitcoin remote procedure call (RPC) client","homepage":"https://github.com/carnesen/bitcoin-rpc","keywords":["bitcoin","typescript","rpc","bitcoin-rpc","bitcoind-rpc"],"repository":{"type":"git","url":"git+https://github.com/carnesen/bitcoin-rpc.git"},"author":{"name":"Chris Arnesen","email":"chris.arnesen@gmail.com"},"bugs":{"url":"https://github.com/carnesen/bitcoin-rpc/issues"},"license":"MIT","readme":"# @carnesen/bitcoin-rpc [![npm version](https://badge.fury.io/js/%40carnesen%2Fbitcoin-rpc.svg)](https://badge.fury.io/js/%40carnesen%2Fbitcoin-rpc) [![Build Status](https://travis-ci.org/carnesen/bitcoin-rpc.svg?branch=master)](https://travis-ci.org/carnesen/bitcoin-rpc)\n\nA Node.js client for bitcoin's remote procedure call (RPC) interface. This package includes runtime JavaScript files suitable for Node.js >=8 as well as the corresponding TypeScript type declarations.\n\n## Usage\n\n```ts\nconst { createBitcoinRpc } = require('@carnesen/bitcoin-rpc');\n\nconst rpcuser = 'carnesen';\nconst rpcpassword = 'password';\nconst rpcHref = `http://${rpcuser}:${rpcpassword}@127.0.0.1:18443/`;\nconst bitcoinRpc = createBitcoinRpc(href);\n\nbitcoinRpc('getblockhash', { height: 0 })\n  .then(result => {\n    // 0f9188f13cb7b2c71f2a335e3a4f\n  })\n```\n\n## API\n\n### `createBitcoinRpc(href): bitcoinRpc`\nA factory function for creating bitcoin RPC clients\n\n#### `href`\nA string of the form `http://<username>:<password>@<hostname>:<port>/` as defined by the [WHATWG URL](https://nodejs.org/api/url.html#url_the_whatwg_url_api) standard. The href can be passed to `createBitcoinRpc` to create an RPC client. \n\n### `bitcoinRpc(method, params): Promise<result>`\nThis section documents the function returned by `createBitcoinRpc`. \n\n#### `method`\n`string`. The name of an RPC method, e.g. `getnetworkinfo`.\n\n#### `params`\nOptional for some methods. An array of positional parameter values or an object of \"named\" parameter values for the specified `method`.\n\n#### `result`\n`any`. The remote procedure call's result.\n\n## Related\n- [@carnesen/bitcoin-rpc-href](https://github.com/carnesen/bitcoin-rpc-href): A Node.js library for reading bitcoin's remote procedure call (RPC) configuration\n- [@carnesen/bitcoin-config](https://github.com/carnesen/bitcoin-config): A Node.js library for bitcoin server software configuration\n- [@carnesen/bitcoin-service](https://github.com/carnesen/bitcoin-service): A Node.js library for managing the bitcoin service `bitcoind`\n- [@carnesen/bitcoin-software](https://github.com/carnesen/bitcoin-software): A Node.js library for installing bitcoin server software\n\n## License\n\nMIT © [Chris Arnesen](https://www.carnesen.com)\n","readmeFilename":"readme.md"}