{"bugs":{"url":"https://github.com/dfinity/ic-js"},"dist":{"shasum":"f2df4f1a63352dfee56a9954e663dc73a8b89c42","tarball":"https://registry.npmjs.org/@dfinity/ledger/-/ledger-0.0.2.tgz","fileCount":27,"integrity":"sha512-Ob6krYzjjSbREMpxGaBKqEG7nSJZO55/qHA8Gg6JmdJaWcA9sV+jUntEhI2tMQ6xztHtLnfYzWxgMbUD57UfDQ==","signatures":[{"sig":"MEYCIQCFHJ4Fe7NRLcA1L1OhA/elHFLDm5yqRx5Uf+51RkquUwIhAONb5KZs5AM9pp6nIwXsOlMPZ5G4QmbLF8n9BOO65WEi","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":90770,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjz+WKACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpyUw/+MjVWURa7lLq5uVCnmgm5aew5ogLvyIKOre29mzeLnEXk21Ez\r\nDHAKBiQvZaSreEdO0pJ6HKoU3KV5qv9FU/+yNM+HGK0ayKYL72rz1B3gzf+Q\r\nEEat9drEik+7L3Oo4KNDZ05/jitn4/YB5E+eKrIqQRJhzFRd2WaWHIBbux3S\r\nFsmzrVDQvg4H2bPW7y4JQD3gHaH3Pic7TGcScLHDZ27jJvgXVQaFk6zoZTNA\r\n/jCYrXbbGcd//ui3JUbT1aV5zceGWPpjDPtpWiyGbCYxBD8f8XnIi2OycnDE\r\n+BFB3MwG/lkecvLW2GZbd5q7j/BKUl+jBcu3a1Uwqa8fTD71obtfOWdCD9eV\r\nD6dHWj/QdcXzURj4kvEnyEeMGnXiLQA1E10eGZIOhpUi8N3Tka820SqmxE4O\r\nxbYuztyXRoICVkwk17Nd20yRffzu6Rm9igatXpNnY456VMAsX6MKkHzzRp+g\r\nJLQB1ScPg2hm7l5Hb32ipkJhw7uXSsY22jmzVVihLVKqWLRwsFbCmRgWPtUH\r\nCHfUdVIaoYsz1AcdjAyTLqcrCK+7rjYYC/wAXF+RI4957UOh/lOZFTWN2zez\r\n3mmfGKq23xy6d7GX3Pj5MNO07U2iYLmLXgbPbh7nS8zyxCL1H8CzSa0b+ZKM\r\nT7HzMh7Y5DICLuVmPekzYdNDQdCA/RHH4ec=\r\n=K0Ne\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/cjs/index.cjs.js","name":"@dfinity/ledger","types":"dist/types/index.d.ts","module":"dist/esm/index.js","readme":"# ledger-js\n\nA library for interfacing with [ICRC ledgers](https://github.com/dfinity/ic/tree/master/rs/rosetta-api/icrc1) on the Internet Computer.\n\n[![npm version](https://img.shields.io/npm/v/@dfinity/ledger.svg?logo=npm)](https://www.npmjs.com/package/@dfinity/ledger) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n## Table of contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Features](#features)\n- [Resources](#resources)\n\n## Installation\n\nYou can use `ledger-js` by installing it in your project.\n\n```bash\nnpm i @dfinity/ledger\n```\n\nThe bundle needs peer dependencies, be sure that following resources are available in your project as well.\n\n```bash\nnpm i @dfinity/agent @dfinity/candid @dfinity/principal @dfinity/utils\n```\n\n## Usage\n\nThe features are available through the class `LedgerCanister`. It has to be instantiated with a canister ID.\n\ne.g. fetching a token metadata.\n\n```ts\nimport { IcrcLedgerCanister } from \"@dfinity/ledger\";\nimport { createAgent } from \"@dfinity/utils\";\n\nconst agent = await createAgent({\n  identity,\n  host: HOST,\n});\n\nconst { metadata } = LedgerCanister.create({\n  agent,\n  canisterId: MY_LEDGER_CANISTER_ID,\n});\n\nconst data = await metadata();\n```\n\n## Features\n\n`ledger-js` implements following features:\n\n<!-- TSDOC_START -->\n\n### :toolbox: Functions\n\n- [encodeIcrcAccount](#gear-encodeicrcaccount)\n- [decodeIcrcAccount](#gear-decodeicrcaccount)\n\n#### :gear: encodeIcrcAccount\n\nEncodes an Icrc-1 account compatible into a string.\nFormatting Reference: https://github.com/dfinity/ICRC-1/pull/55/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R238\n\n| Function            | Type                                              |\n| ------------------- | ------------------------------------------------- |\n| `encodeIcrcAccount` | `({ owner, subaccount, }: IcrcAccount) => string` |\n\nParameters:\n\n- `account`: : Principal, subaccount?: Uint8Array }\n\n#### :gear: decodeIcrcAccount\n\nDecodes a string into an Icrc-1 compatible account.\nFormatting Reference: https://github.com/dfinity/ICRC-1/pull/55/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R268\n\n| Function            | Type                                     |\n| ------------------- | ---------------------------------------- |\n| `decodeIcrcAccount` | `(accountString: string) => IcrcAccount` |\n\nParameters:\n\n- `accountString`: string\n\n### :factory: IcrcLedgerCanister\n\n#### Constructors\n\n`public`\n\n#### Methods\n\n- [create](#gear-create)\n- [metadata](#gear-metadata)\n- [transactionFee](#gear-transactionfee)\n- [balance](#gear-balance)\n- [transfer](#gear-transfer)\n\n##### :gear: create\n\n| Method   | Type                                                                   |\n| -------- | ---------------------------------------------------------------------- |\n| `create` | `(options: IcrcLedgerCanisterOptions<_SERVICE>) => IcrcLedgerCanister` |\n\n##### :gear: metadata\n\nThe token metadata (name, symbol, etc.).\n\n| Method     | Type                                                          |\n| ---------- | ------------------------------------------------------------- |\n| `metadata` | `(params: QueryParams) => Promise<IcrcTokenMetadataResponse>` |\n\n##### :gear: transactionFee\n\nThe ledger transaction fees.\n\n| Method           | Type                                       |\n| ---------------- | ------------------------------------------ |\n| `transactionFee` | `(params: QueryParams) => Promise<bigint>` |\n\n##### :gear: balance\n\nReturns the balance of the given account.\n\n| Method    | Type                                         |\n| --------- | -------------------------------------------- |\n| `balance` | `(params: BalanceParams) => Promise<bigint>` |\n\nParameters:\n\n- `params`: The parameters to get the balance of an account.\n\n##### :gear: transfer\n\nTransfers tokens from the sender to the given account.\n\n| Method     | Type                                          |\n| ---------- | --------------------------------------------- |\n| `transfer` | `(params: TransferParams) => Promise<bigint>` |\n\nParameters:\n\n- `params`: The parameters to transfer tokens.\n\n<!-- TSDOC_END -->\n\n## Resources\n\n- [Ledger & Tokenization Working Group Standards](https://github.com/dfinity/ICRC-1/)\n","gitHead":"aed56262c499ef6163858e019528a9f2fcaa7959","license":"Apache-2.0","scripts":{"test":"jest","build":"npm run rmdir && mkdir -p dist && cp -R candid dist && node esbuild.mjs && npm run ts-declaration","rmdir":"node ../../scripts/rmdir.mjs","prepack":"npm run build","ts-declaration":"tsc --emitDeclarationOnly --outDir dist/types"},"_npmUser":{"name":"bitdivine","email":"bitdivine69@gmail.com"},"homepage":"https://github.com/dfinity/ic-js#readme","keywords":["internet computer","internet-computer","ic","dfinity","Ledger","ICRC-1 ledger","token"],"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/dfinity/ic-js.git","type":"git","directory":"packages/cmc"},"_npmVersion":"8.19.3","description":"A library for interfacing with ICRC ledgers on the Internet Computer.","directories":{},"maintainers":[{"name":"frederikrothenberger","email":"frederik.rothenberger@dfinity.org"},{"name":"bitdivine","email":"bitdivine69@gmail.com"},{"name":"ielashi","email":"diner-rodding@ic8.org"},{"name":"liadrit","email":"lia.bajraliu@dfinity.org"},{"name":"dayyildiz","email":"dominik.ayyildiz@dfinity.org"},{"name":"anthony_dfinity","email":"anthony@dfinity.org"},{"name":"eric-swanson-dfinity","email":"eric.swanson@dfinity.org"},{"name":"krpeacock","email":"kylpeacock@gmail.com"},{"name":"terrorjack","email":"astrohavoc@gmail.com"},{"name":"npm-dfinity-org","email":"npm@dfinity.org"}],"_nodeVersion":"16.19.0","_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"@dfinity/utils":"^0.0.9"},"_npmOperationalInternal":{"tmp":"tmp/ledger_0.0.2_1674569098318_0.15165563959076134","host":"s3://npm-registry-packages"},"_id":"@dfinity/ledger@0.0.2","version":"0.0.2"}