{"_id":"@brynjarrr/xchain-litecoin","_rev":"1-0c8041ead44e3aa7bd6024fa55ad72c2","name":"@brynjarrr/xchain-litecoin","dist-tags":{"latest":"0.8.0"},"versions":{"0.8.0":{"name":"@brynjarrr/xchain-litecoin","version":"0.8.0","description":"Custom Litecoin client and utilities used by XChainJS clients","keywords":["XChain","Litecoin"],"author":{"name":"XChainJS"},"homepage":"https://github.com/xchainjs/xchainjs-lib","license":"MIT","main":"lib/index.js","module":"lib/index.esm.js","typings":"lib/index.d.ts","directories":{"lib":"lib","test":"__tests__"},"repository":{"type":"git","url":"git+ssh://git@github.com/xchainjs/xchainjs-lib.git"},"scripts":{"clean":"rimraf lib/**","build":"yarn clean && rollup -c","test":"jest","lint":"eslint \"{src,__tests__}/**/*.ts\" --fix --max-warnings 0","prepublishOnly":"yarn build","postversion":"git push --follow-tags"},"devDependencies":{"@types/bitcoinjs-lib":"^5.0.0","@types/wif":"^2.0.2","@xchainjs/xchain-client":"^0.11.1","@xchainjs/xchain-crypto":"^0.2.6","@xchainjs/xchain-util":"^0.5.1","axios":"^0.25.0","axios-mock-adapter":"^1.20.0","bitcoinjs-lib":"^5.2.0","coininfo":"^5.1.0","coinselect":"3.1.12","wif":"^2.0.6"},"peerDependencies":{"@xchainjs/xchain-client":"^0.11.1","@xchainjs/xchain-crypto":"^0.2.6","@xchainjs/xchain-util":"^0.5.1","axios":"^0.25.0","bitcoinjs-lib":"^5.2.0","coininfo":"^5.1.0","coinselect":"3.1.12","wif":"^2.0.6"},"publishConfig":{"access":"public"},"gitHead":"515ef43a4f0e3aa11644c69f7025caf0f0a0c1db","bugs":{"url":"https://github.com/xchainjs/xchainjs-lib/issues"},"_id":"@brynjarrr/xchain-litecoin@0.8.0","_nodeVersion":"16.5.0","_npmVersion":"lerna/3.22.1/node@v16.5.0+arm64 (darwin)","dist":{"integrity":"sha512-Mu4S51Sn4LU91FsUwi1Lw2jm0xACnPc0+3EIBmzf0kvAUs9P97X7PFzmff2uYQNb7AUY8Koi97QiVv3OAiALBg==","shasum":"5ed754369b7f1fa59d774d3dc608bb98df62f6db","tarball":"https://registry.npmjs.org/@brynjarrr/xchain-litecoin/-/xchain-litecoin-0.8.0.tgz","fileCount":20,"unpackedSize":13823072,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiPbUIACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqKcQ/+K0d9ixqYLwu21WTb8k8Rf/aUarqtuXttMj1vRvLUT2peNByq\r\nRFbTYrXlzn+oYOJArOuIOz5HfvpgGQHqvCZJuDvYa7tKi3mmmNPdU5AKBeYI\r\nPqdynhWklaLbCCK7G+jorB1pYNGuy1IrURF8mZzevWdYF1Sy8046m5VM27Kg\r\nAMNoEFK7GVYe44dXjouYaoz3OJJgXsUovx0a2WaHkxe5hQ/Ue/pawAnf3f+K\r\niPrnv5AZNpA70tlvcpPib1KLoZ4qY2AwS2Q5jxMt1L33lJd6OklB4VT4OXC8\r\nAuGgQZ4SXCXBRt3JdxSigziHPDF6fLwOM4BGfZTJXsKB9/o8kmwclKOHKIoo\r\nFn8y8keAqDm1mGfnG23NXJUR7mUoT4xlPWCH55IWPN4tcRNOQ/WDR63GnuDH\r\n97OAVbP8YNdt8Q1X0wnowX9+g8oSCHd6cFuqBllSyXrAOL8P8VK0KB5Sh6Ik\r\ns/MkZ790jB5GCghDnEC3zm+n1GSLhBixitm4a0YaANTeEyc8uCodn5HB5y1B\r\nkT0vbbyX5hcjnlg4QRlerq1YkzQpdjjVbrMr8kqoagME9aEVHz498+lrP7oN\r\nASwx1ZMyN0CCjYIocvy0FMEpkVRoUn9TCLeytgcqoNiMP+gHsV5D+hocX6/g\r\n0KiIZGuACLJha5B0zzf1euDSbIu3E7oYUWk=\r\n=XNfL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDmxl+EWTkrv6W/ahs0SZ4Q3yEED3JMz3PJTmFXM4h1aAIgMYbCKwb8lpkmRd/gEBQpSjCuJN5+IOl11S0Y8Qx1nN8="}]},"_npmUser":{"name":"brynjarrr","email":"coinage_trinity_0a@icloud.com"},"maintainers":[{"name":"brynjarrr","email":"coinage_trinity_0a@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/xchain-litecoin_0.8.0_1648211207976_0.14781432485422386"},"_hasShrinkwrap":false}},"time":{"created":"2022-03-25T12:26:47.922Z","0.8.0":"2022-03-25T12:26:48.247Z","modified":"2022-04-04T20:50:15.127Z"},"maintainers":[{"name":"brynjarrr","email":"coinage_trinity_0a@icloud.com"}],"description":"Custom Litecoin client and utilities used by XChainJS clients","homepage":"https://github.com/xchainjs/xchainjs-lib","keywords":["XChain","Litecoin"],"repository":{"type":"git","url":"git+ssh://git@github.com/xchainjs/xchainjs-lib.git"},"author":{"name":"XChainJS"},"bugs":{"url":"https://github.com/xchainjs/xchainjs-lib/issues"},"license":"MIT","readme":"# `@xchainjs/xchain-client`\n\n## Modules\n\n- `client` - Custom client for communicating with Litecoin using [BIP39](https://github.com/bitcoinjs/bip39) [bitcoinjs-lib](https://github.com/bitcoinjs/bitcoinjs-lib) and [WIF](https://github.com/bitcoinjs/wif)\n\n## Installation\n\n```\nyarn add @xchainjs/xchain-client\n```\n\nFollowing peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-litecoin`.\n\n```\nyarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios bitcoinjs-lib coininfo wif\n```\n\n## Service Providers\n\nThis package uses the following service providers:\n\n| Function                    | Service     | Notes                                                                            |\n| --------------------------- | ----------- | -------------------------------------------------------------------------------- |\n| Balances                    | Sochain     | https://sochain.com/api#get-balance                                              |\n| Transaction history         | Sochain     | https://sochain.com/api#get-display-data-address, https://sochain.com/api#get-tx |\n| Transaction details by hash | Sochain     | https://sochain.com/api#get-tx                                                   |\n| Transaction fees            | Bitgo       | https://app.bitgo.com/docs/#operation/v2.tx.getfeeestimate                       |\n| Transaction broadcast       | Bitaps      | https://ltc.bitaps.com/broadcast                                                 |\n| Explorer                    | Blockstream | https://blockstream.info                                                         |\n\nSochain API rate limits: https://sochain.com/api#rate-limits (300 requests/minute)\n\nBitgo API rate limits: https://app.bitgo.com/docs/#section/Rate-Limiting (10 requests/second)\n\nBitaps API rate limits: Standard limit 15 requests within 5 seconds for a single IP address.\n\n## Usage\n\nInitialize client and use class methods:\n\n```\nimport { Client, Network } from '../src/client'\n\n// Create a new client interface\nconst ltcClient = new Client({ network: Network.Testnet })\n\n// Set phrase\nltcClient.setPhrase('phrase here')\n\n// Get address\nconst address = ltcClient.getAddress()\n\n// Get balance\nconst balance = await ltcClient.getBalance()\n\n// Transfer with feeRate\nconst txid = await ltcClient.transfer({ asset: AssetLTC, recipient: 'recipient address here', amount: baseAmount(100, LTC_DECIMAL), feeRate: 1 })\n\n// Transfer with default feeRate (default is `fast`)\nconst txid = await ltcClient.transfer({ asset: AssetLTC, recipient: 'recipient address here', amount: baseAmount(100, LTC_DECIMAL) })\n\n// Get fee estimations\nconst { fast, fastest, average } = await ltcClient.getFees()\n\n// Get feeRate estimations\nconst { fast, fastest, average } = await ltcClient.getFeeRates()\n\n// Search transactions\nconst transactions = await ltcClient.getTransactions({ address: 'address here', limit: 4 })\n\n// Get a transaction with a given txId/hash\nconst txData = await ltcClient.getTransactionData('b660ee07167cfa32681e2623f3a29dc64a089cabd9a3a07dd17f9028ac956eb8')\n\n```\n","readmeFilename":"README.md"}