@dfinity/ledger NPM

ledger-js

A library for interfacing with ICRC ledger on the Internet Computer.

Installation

You can use ledger-js by installing it in your project.

npm i @dfinity/ledger

The bundle needs peer dependencies, be sure that following resources are available in your project as well.

npm i @dfinity/agent @dfinity/candid @dfinity/principal @dfinity/utils

Usage

The features are available through the class LedgerCanister. It has to be instantiated with a canister ID.

e.g. fetching a token metadata.

import { IcrcLedgerCanister } from "@dfinity/ledger";
import { createAgent } from "@dfinity/utils";

const agent = await createAgent({
  identity,
  host: HOST,
});

const { metadata } = LedgerCanister.create({
  agent,
  canisterId: MY_LEDGER_CANISTER_ID,
});

const data = await metadata();

Features

ledger-js implements following features:

:toolbox: Functions

:gear: encodeIcrcAccount

Encodes an Icrc-1 account compatible into a string. Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md

Function	Type
`encodeIcrcAccount`	`({ owner, subaccount, }: IcrcAccount) => string`

Parameters:

account: : Principal, subaccount?: Uint8Array }

:link: Source

:gear: decodeIcrcAccount

Decodes a string into an Icrc-1 compatible account. Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md

Function	Type
`decodeIcrcAccount`	`(accountString: string) => IcrcAccount`

Parameters:

accountString: string

:link: Source

:gear: decodePayment

👀 This feature is currently in draft. You can find more information about it at https://github.com/dfinity/ICRC/issues/22.

A naive implementation of a payment parser. Given a code, the function attempts to extract a token name, account identifier (textual representation), and an optional amount.

If the code doesn't match the expected pattern, undefined is returned for simplicity. Similarly, if an optional amount is provided but it's not a valid number, the parser will not throw an exception and returns undefined.

Please note that this function doesn't perform any validity checks on the extracted information. It does not verify if the token is known or if the identifier is a valid address.

urn            = token ":" address [ "?" params]
token         = [ ckbtc / icp / chat / bitcoin / ethereum ... ]
address       = STRING
params        = param [ "&" params ]
param         = [ amountparam ]
amountparam   = "amount=" *digit [ "." *digit ]

Function	Type
`decodePayment`	`(code: string) => { token: string; identifier: string; amount?: number; }`

Parameters:

code: string

:link: Source

:factory: IcrcLedgerCanister

:link: Source

Methods

:gear: create

Method	Type
`create`	`(options: IcrcLedgerCanisterOptions<_SERVICE>) => IcrcLedgerCanister`

:link: Source

:gear: metadata

The token metadata (name, symbol, etc.).

Method	Type
`metadata`	`(params: QueryParams) => Promise<IcrcTokenMetadataResponse>`

:link: Source

:gear: transactionFee

The ledger transaction fees.

Method	Type
`transactionFee`	`(params: QueryParams) => Promise<bigint>`

:link: Source

:gear: balance

Returns the balance for a given account provided as owner and with optional subaccount.

Method	Type
`balance`	`(params: BalanceParams) => Promise<bigint>`

Parameters:

params: The parameters to get the balance of an account.

:link: Source

:gear: transfer

Transfers tokens from the sender to the given account.

Method	Type
`transfer`	`(params: TransferParams) => Promise<bigint>`

Parameters:

params: The parameters to transfer tokens.

:link: Source

:gear: totalTokensSupply

Returns the total supply of tokens.

Method	Type
`totalTokensSupply`	`(params: QueryParams) => Promise<bigint>`

:link: Source

:factory: IcrcIndexCanister

:link: Source

Methods

:gear: create

Method	Type
`create`	`(options: IcrcLedgerCanisterOptions<_SERVICE>) => IcrcIndexCanister`

:link: Source

:gear: getTransactions

Get the transactions of an account

Always certified. get_account_transactions needs to be called with an update because the index canisters makes a call to the ledger canister to get the transaction data. Index Canister only holds the transactions ids in state, not the whole transaction data.

Method	Type
`getTransactions`	`(params: GetAccountTransactionsParams) => Promise<GetTransactions>`

:link: Source

Resources

internet computer internet-computer ic dfinity Ledger ICRC-1 ledger token

@infinitebrahmanuniverse/nolb-_df @everything-registry/sub-chunk-240 yolosns-2 quickfixicrc1 @infinityswapofficial/token-lists

0.0.13-next-2023-08-09

2 years ago

0.0.13-next-2023-08-08

2 years ago

0.0.16-next-2023-09-12.1

2 years ago

0.0.13-next-2023-08-07

2 years ago

0.0.13-next-2023-08-19

2 years ago

0.0.13-next-2023-08-18

2 years ago

0.0.13-next-2023-08-17

2 years ago

0.0.13-next-2023-08-16

2 years ago

0.0.13-next-2023-08-15

2 years ago

0.0.11-next-2023-07-01.1

2 years ago

0.0.13-next-2023-08-14

2 years ago

0.0.13-next-2023-08-13

2 years ago

0.0.13-next-2023-08-12

2 years ago

0.0.13-next-2023-08-11

2 years ago

0.0.13-next-2023-08-10

2 years ago

0.0.16-next-2023-09-05

2 years ago

0.0.16-next-2023-09-07

2 years ago

0.0.16-next-2023-09-06

2 years ago

0.0.16-next-2023-09-09

2 years ago

0.0.16-next-2023-09-08

2 years ago

0.0.13-next-2023-08-24

2 years ago

0.0.13-next-2023-08-23

2 years ago

0.0.13-next-2023-08-22

2 years ago

0.0.13-next-2023-08-21

2 years ago

0.0.13-next-2023-08-20

2 years ago

1.0.0-next-2023-10-02.1

2 years ago

0.0.16-next-2023-09-22.1

2 years ago

0.0.12-next-2023-08-02.1

2 years ago

0.0.12-next-2023-07-24.1

2 years ago

0.0.11-next-2023-06-29.1

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.14-next-2023-08-28.1

2 years ago

0.0.12-next-2023-08-04.1

2 years ago

0.0.12-next-2023-07-19

2 years ago

0.0.12-next-2023-07-17

2 years ago

0.0.12-next-2023-07-18

2 years ago

0.0.12-next-2023-07-11

2 years ago

0.0.12-next-2023-07-12

2 years ago

0.0.12-next-2023-07-10

2 years ago

0.0.12-next-2023-07-15

2 years ago

0.0.12-next-2023-07-16

2 years ago

0.0.12-next-2023-07-13

2 years ago

0.0.12-next-2023-07-14

2 years ago

0.0.14-next-2023-09-03

2 years ago

0.0.14-next-2023-09-02

2 years ago

0.0.14-next-2023-09-04

2 years ago

0.0.14-next-2023-09-01

2 years ago

0.0.14-next-2023-08-30

2 years ago

0.0.14-next-2023-08-31

2 years ago

0.0.12-next-2023-07-03.1

2 years ago

0.0.12-next-2023-07-28

2 years ago

0.0.12-next-2023-07-29

2 years ago

0.0.12-next-2023-07-22

2 years ago

0.0.12-next-2023-07-23

2 years ago

0.0.12-next-2023-07-20

2 years ago

0.0.12-next-2023-07-21

2 years ago

0.0.12-next-2023-07-26

2 years ago

0.0.12-next-2023-07-27

2 years ago

0.0.12-next-2023-07-24

2 years ago

0.0.12-next-2023-07-25

2 years ago

0.0.14-next-2023-08-25

2 years ago

0.0.14-next-2023-08-26

2 years ago

0.0.11-next-2023-06-30.1

2 years ago

0.0.14-next-2023-08-24

2 years ago

0.0.11-next-2023-06-30.2

2 years ago

0.0.12-next-2023-07-30

2 years ago

0.0.14-next-2023-08-29

2 years ago

0.0.14-next-2023-08-27

2 years ago

0.0.14-next-2023-08-28

2 years ago

1.0.0-next-2023-10-02

2 years ago

0.0.12-next-2023-07-08

2 years ago

0.0.12-next-2023-07-09

2 years ago

0.0.12-next-2023-07-06

2 years ago

0.0.12-next-2023-07-07

2 years ago

0.0.12-next-2023-07-04

2 years ago

0.0.12-next-2023-07-05

2 years ago

0.0.12-next-2023-07-03

2 years ago

0.0.13-next-2023-08-14.1

2 years ago

1.0.0

2 years ago

0.0.16-next-2023-09-21

2 years ago

0.0.16-next-2023-09-20

2 years ago

0.0.16-next-2023-09-23

2 years ago

0.0.16-next-2023-09-22

2 years ago

0.0.16-next-2023-09-25

2 years ago

0.0.16-next-2023-10-02

2 years ago

0.0.16-next-2023-09-24

2 years ago

0.0.16-next-2023-09-27

2 years ago

0.0.16-next-2023-09-26

2 years ago

0.0.16-next-2023-09-29

2 years ago

0.0.16-next-2023-09-28

2 years ago

0.0.16-next-2023-09-18.1

2 years ago

0.0.16-next-2023-09-18.2

2 years ago

0.0.16-next-2023-10-01

2 years ago

0.0.16-next-2023-09-10

2 years ago

0.0.15-next-2023-09-05

2 years ago

0.0.16-next-2023-09-12

2 years ago

0.0.16-next-2023-09-11

2 years ago

0.0.16-next-2023-09-14

2 years ago

0.0.16-next-2023-09-13

2 years ago

0.0.16-next-2023-09-16

2 years ago

0.0.16-next-2023-09-15

2 years ago

0.0.16-next-2023-09-18

2 years ago

0.0.16-next-2023-09-17

2 years ago

0.0.15-next-2023-09-04

2 years ago

0.0.16-next-2023-09-19

2 years ago

0.0.16-next-2023-09-21.1

2 years ago

0.0.12-next-2023-08-07

2 years ago

0.0.12-next-2023-08-02

2 years ago

0.0.12-next-2023-07-31

2 years ago

0.0.12-next-2023-08-01

2 years ago

0.0.12-next-2023-08-04

2 years ago

0.0.12-next-2023-08-03

2 years ago

0.0.12-next-2023-08-06

2 years ago

0.0.12-next-2023-08-05

2 years ago

0.0.11-next-2023-07-03

2 years ago

0.0.11-next-2023-07-01

2 years ago

0.0.11-next-2023-07-02

2 years ago

0.0.16-next-2023-09-30

2 years ago

0.0.11-next-2023-06-30

2 years ago

0.0.11-next-2023-06-29

2 years ago

0.0.11-next-2023-06-28

2 years ago

0.0.11-next-2023-06-27

2 years ago

0.0.11-next-2023-06-26.1

2 years ago

0.0.11-next-2023-06-26.2

2 years ago

0.0.11-next-2023-06-24

2 years ago

0.0.11-next-2023-06-25

2 years ago

0.0.11-next-2023-06-26

2 years ago

0.0.11-next-2023-06-23

2 years ago

0.0.8-next-2023-04-19

3 years ago

0.0.8-next-2023-04-18

3 years ago

0.0.9-next-2023-06-12.1

2 years ago

0.0.8-next-2023-04-24

3 years ago

0.0.8-next-2023-04-25

3 years ago

0.0.8-next-2023-04-22

3 years ago

0.0.8-next-2023-04-23

3 years ago

0.0.8-next-2023-04-20

3 years ago

0.0.8-next-2023-04-21

3 years ago

0.0.8-next-2023-04-28

3 years ago

0.0.8-next-2023-04-29

3 years ago

0.0.8-next-2023-04-26

3 years ago

0.0.8-next-2023-04-27

3 years ago

0.0.8-next-2023-04-24.1

3 years ago

0.0.8-next-2023-04-24.2

3 years ago

0.0.11-next-2023-06-22.1

2 years ago

0.0.9-next-2023-06-13.1

2 years ago

0.0.9-next-2023-06-13.2

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

0.0.9-next-2023-06-06.1

2 years ago

0.0.10-next-2023-06-21

2 years ago

0.0.6-next-2023-04-18

3 years ago

0.0.6-next-2023-04-17

3 years ago

0.0.10

2 years ago

0.0.9-next-2023-05-30.1

2 years ago

0.0.8-next-2023-04-27.1

3 years ago

0.0.9-next-2023-06-08

2 years ago

0.0.9-next-2023-06-07

2 years ago

0.0.9-next-2023-06-06

2 years ago

0.0.9-next-2023-06-05

2 years ago

0.0.9-next-2023-06-09

2 years ago

0.0.9-next-2023-05-31

2 years ago

0.0.9-next-2023-05-30

2 years ago

0.0.9-next-2023-06-04

2 years ago

0.0.9-next-2023-06-03

2 years ago

0.0.9-next-2023-06-02

2 years ago

0.0.9-next-2023-06-01

2 years ago

0.0.8-next-2023-04-20.1

3 years ago

0.0.9-next-2023-05-29

2 years ago

0.0.9-next-2023-05-28

2 years ago

0.0.9-next-2023-05-27

2 years ago

0.0.9-next-2023-05-26

2 years ago

0.0.9-next-2023-05-25

2 years ago

0.0.9-next-2023-05-24

2 years ago

0.0.10-next-2023-06-21.1

2 years ago

0.0.10-next-2023-06-21.2

2 years ago

0.0.9-next-2023-06-20

2 years ago

0.0.8-next-2023-05-24

2 years ago

0.0.8-next-2023-05-23

2 years ago

0.0.8-next-2023-05-20

2 years ago

0.0.8-next-2023-05-22

2 years ago

0.0.8-next-2023-05-21

2 years ago

0.0.9-next-2023-06-19

2 years ago

0.0.9-next-2023-06-18

2 years ago

0.0.9-next-2023-06-17

2 years ago

0.0.9-next-2023-06-16

2 years ago

0.0.9-next-2023-06-11

2 years ago

0.0.9-next-2023-06-10

2 years ago

0.0.9-next-2023-06-15

2 years ago

0.0.9-next-2023-06-14

2 years ago

0.0.9-next-2023-06-13

2 years ago

0.0.9-next-2023-06-12

2 years ago

0.0.7-next-2023-04-18

3 years ago

0.0.8-next-2023-05-02

3 years ago

0.0.8-next-2023-05-01

3 years ago

0.0.8-next-2023-05-04

2 years ago

0.0.8-next-2023-05-03

2 years ago

0.0.8-next-2023-04-30

3 years ago

0.0.8-next-2023-05-09

2 years ago

0.0.8-next-2023-05-06

2 years ago

0.0.8-next-2023-05-05

2 years ago

0.0.8-next-2023-05-08

2 years ago

0.0.8-next-2023-05-07

2 years ago

0.0.9-next-2023-06-15.1

2 years ago

0.0.8-next-2023-05-13

2 years ago

0.0.8-next-2023-05-12

2 years ago

0.0.8-next-2023-05-15

2 years ago

0.0.8-next-2023-05-14

2 years ago

0.0.11-next-2023-06-21

2 years ago

0.0.11-next-2023-06-22

2 years ago

0.0.8-next-2023-05-11

2 years ago

0.0.8-next-2023-05-10

2 years ago

0.0.8-next-2023-05-17

2 years ago

0.0.8-next-2023-05-16

2 years ago

0.0.8-next-2023-05-19

2 years ago

0.0.8-next-2023-05-18

2 years ago

0.0.6-next-2023-04-04.1

3 years ago

0.0.6-next-2023-04-04.2

3 years ago

0.0.6-next-2023-04-13.2

3 years ago

0.0.6-next-2023-04-13.1

3 years ago

0.0.6-next-2023-04-07

3 years ago

0.0.6-next-2023-04-06

3 years ago

0.0.6-next-2023-04-09

3 years ago

0.0.6-next-2023-04-08

3 years ago

0.0.6-next-2023-04-01

3 years ago

0.0.6-next-2023-03-30

3 years ago

0.0.6-next-2023-03-31

3 years ago

0.0.6-next-2023-04-03

3 years ago

0.0.6-next-2023-04-02

3 years ago

0.0.6-next-2023-04-05

3 years ago

0.0.6-next-2023-04-04

3 years ago

0.0.6-next-2023-04-10

3 years ago

0.0.6-next-2023-04-12

3 years ago

0.0.6-next-2023-04-11

3 years ago

0.0.6-next-2023-04-14

3 years ago

0.0.6-next-2023-04-13

3 years ago

0.0.6-next-2023-04-16

3 years ago

0.0.6-next-2023-04-15

3 years ago

0.0.6-next-2023-02-28

3 years ago

0.0.6-next-2023-02-26

3 years ago

0.0.6-next-2023-02-27

3 years ago

0.0.6-next-2023-02-20

3 years ago

0.0.6-next-2023-02-21

3 years ago

0.0.6-next-2023-02-24

3 years ago

0.0.6-next-2023-02-25

3 years ago

0.0.6-next-2023-02-22

3 years ago

0.0.6-next-2023-03-07.1

3 years ago

0.0.6-next-2023-02-23

3 years ago

0.0.6-next-2023-02-27.1

3 years ago

0.0.6-next-2023-03-29

3 years ago

0.0.6-next-2023-03-27

3 years ago

0.0.6-next-2023-03-28

3 years ago

0.0.6-next-2023-03-21

3 years ago

0.0.6-next-2023-03-22

3 years ago

0.0.6-next-2023-03-20

3 years ago

0.0.6-next-2023-03-25

3 years ago

0.0.6-next-2023-03-26

3 years ago

0.0.6-next-2023-03-23

3 years ago

0.0.6-next-2023-03-24

3 years ago

0.0.6-next-2023-03-18

3 years ago

0.0.6-next-2023-03-19

3 years ago

0.0.6-next-2023-03-16

3 years ago

0.0.6-next-2023-03-17

3 years ago

0.0.6-next-2023-03-21.1

3 years ago

0.0.6-next-2023-03-10

3 years ago

0.0.6-next-2023-03-11

3 years ago

0.0.6-next-2023-03-14

3 years ago

0.0.6-next-2023-03-15

3 years ago

0.0.6-next-2023-03-12

3 years ago

0.0.6-next-2023-03-06.1

3 years ago

0.0.6-next-2023-03-13

3 years ago

0.0.6-next-2023-02-22.1

3 years ago

0.0.6-next-2023-03-07

3 years ago

0.0.6-next-2023-03-08

3 years ago

0.0.6-next-2023-03-05

3 years ago

0.0.6-next-2023-03-06

3 years ago

0.0.6-next-2023-03-09

3 years ago

0.0.6-next-2023-03-13.1

3 years ago

0.0.6-next-2023-03-03

3 years ago

0.0.6-next-2023-03-04

3 years ago

0.0.6-next-2023-03-01

3 years ago

0.0.6-next-2023-03-02

3 years ago

0.0.6-next-2023-02-19

3 years ago

0.0.6-next-2023-02-18

3 years ago

0.0.6-next-2023-02-17

3 years ago

0.0.6-next-2023-02-16

3 years ago

0.0.6-next-2023-02-15.1

3 years ago

0.0.6-next-2023-02-15

3 years ago

0.0.6-next-2023-02-14.2

3 years ago

0.0.6-next-2023-02-14.1

3 years ago

0.0.6-next-2023-02-14

3 years ago

0.0.6-next-2023-02-13.3

3 years ago

0.0.6-next-2023-02-13.2

3 years ago

0.0.6-next-2023-02-13.1

3 years ago

0.0.6-next-2023-02-13

3 years ago

0.0.6-next-2023-02-12

3 years ago

0.0.6-next-2023-02-11

3 years ago

0.0.6-next-2023-02-10

3 years ago

0.0.6-next-2023-02-09

3 years ago

0.0.6-next-2023-02-08.1

3 years ago

0.0.6-next-2023-02-08

3 years ago

0.0.6-next-2023-02-07.1

3 years ago

0.0.6-next-2023-02-07

3 years ago

0.0.5

3 years ago

0.0.5-next-2023-02-07

3 years ago

0.0.5-next-2023-02-06

3 years ago

0.0.5-next-2023-02-05

3 years ago

0.0.5-next-2023-02-04

3 years ago

0.0.5-next-2023-02-03

3 years ago

0.0.5-next-2023-02-02

3 years ago

0.0.5-next-2023-02-01

3 years ago

0.0.5-next-2023-01-31.1

3 years ago

0.0.5-next-2023-01-31

3 years ago

0.0.5-next-2023-01-30.2

3 years ago

0.0.5-next-2023-01-30.1

3 years ago

0.0.5-next-2023-01-30

3 years ago

0.0.5-next-2023-01-29

3 years ago

0.0.5-next-2023-01-28.1

3 years ago

0.0.5-next-2023-01-28

3 years ago

0.0.4

3 years ago

0.0.4-next-2023-01-28.1

3 years ago

0.0.4-next-2023-01-28

3 years ago

0.0.4-next-2023-01-27

3 years ago

0.0.4-next-2023-01-26.1

3 years ago

0.0.4-next-2023-01-26

3 years ago

0.0.4-next-2023-01-25.1

3 years ago

0.0.4-next-2023-01-25

3 years ago

0.0.4-next-2023-01-24

3 years ago

0.0.3

3 years ago

0.0.2-next-2023-01-24

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago

@dfinity/ledger v0.0.12-next-2023-07-30

ledger-js

Table of contents

Installation

Usage

Features

:toolbox: Functions

:gear: encodeIcrcAccount

:gear: decodeIcrcAccount

:gear: decodePayment

:factory: IcrcLedgerCanister

Methods

:gear: create

:gear: metadata

:gear: transactionFee

:gear: balance

:gear: transfer

:gear: totalTokensSupply

:factory: IcrcIndexCanister

Methods

:gear: create

:gear: getTransactions

Resources