@dfinity/ledger NPM

ledger-js

A library for interfacing with ICRC ledgers 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/pull/55/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R238

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

Parameters:

account: : Principal, subaccount?: Uint8Array }

:gear: decodeIcrcAccount

Decodes a string into an Icrc-1 compatible account. Formatting Reference: https://github.com/dfinity/ICRC-1/pull/55/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R268

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

Parameters:

accountString: string

:factory: IcrcLedgerCanister

Constructors

public

Methods

:gear: create

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

:gear: metadata

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

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

:gear: transactionFee

The ledger transaction fees.

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

:gear: balance

Returns the balance of the given account.

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

Parameters:

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

: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.

Resources

Ledger & Tokenization Working Group Standards

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

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

0.0.13-next-2023-08-09

9 months ago

0.0.13-next-2023-08-08

9 months ago

0.0.16-next-2023-09-12.1

8 months ago

0.0.13-next-2023-08-07

9 months ago

0.0.13-next-2023-08-19

9 months ago

0.0.13-next-2023-08-18

9 months ago

0.0.13-next-2023-08-17

9 months ago

0.0.13-next-2023-08-16

9 months ago

0.0.13-next-2023-08-15

9 months ago

0.0.11-next-2023-07-01.1

11 months ago

0.0.13-next-2023-08-14

9 months ago

0.0.13-next-2023-08-13

9 months ago

0.0.13-next-2023-08-12

9 months ago

0.0.13-next-2023-08-11

9 months ago

0.0.13-next-2023-08-10

9 months ago

0.0.16-next-2023-09-05

8 months ago

0.0.16-next-2023-09-07

8 months ago

0.0.16-next-2023-09-06

8 months ago

0.0.16-next-2023-09-09

8 months ago

0.0.16-next-2023-09-08

8 months ago

0.0.13-next-2023-08-24

9 months ago

0.0.13-next-2023-08-23

9 months ago

0.0.13-next-2023-08-22

9 months ago

0.0.13-next-2023-08-21

9 months ago

0.0.13-next-2023-08-20

9 months ago

1.0.0-next-2023-10-02.1

7 months ago

0.0.16-next-2023-09-22.1

8 months ago

0.0.12-next-2023-08-02.1

9 months ago

0.0.12-next-2023-07-24.1

10 months ago

0.0.11-next-2023-06-29.1

11 months ago

8 months ago

10 months ago

9 months ago

9 months ago

8 months ago

0.0.14-next-2023-08-28.1

9 months ago

0.0.12-next-2023-08-04.1

9 months ago

0.0.12-next-2023-07-19

10 months ago

0.0.12-next-2023-07-17

10 months ago

0.0.12-next-2023-07-18

10 months ago

0.0.12-next-2023-07-11

10 months ago

0.0.12-next-2023-07-12

10 months ago

0.0.12-next-2023-07-10

10 months ago

0.0.12-next-2023-07-15

10 months ago

0.0.12-next-2023-07-16

10 months ago

0.0.12-next-2023-07-13

10 months ago

0.0.12-next-2023-07-14

10 months ago

0.0.14-next-2023-09-03

8 months ago

0.0.14-next-2023-09-02

8 months ago

0.0.14-next-2023-09-04

8 months ago

0.0.14-next-2023-09-01

8 months ago

0.0.14-next-2023-08-30

9 months ago

0.0.14-next-2023-08-31

9 months ago

0.0.12-next-2023-07-03.1

10 months ago

0.0.12-next-2023-07-28

10 months ago

0.0.12-next-2023-07-29

10 months ago

0.0.12-next-2023-07-22

10 months ago

0.0.12-next-2023-07-23

10 months ago

0.0.12-next-2023-07-20

10 months ago

0.0.12-next-2023-07-21

10 months ago

0.0.12-next-2023-07-26

10 months ago

0.0.12-next-2023-07-27

10 months ago

0.0.12-next-2023-07-24

10 months ago

0.0.12-next-2023-07-25

10 months ago

0.0.14-next-2023-08-25

9 months ago

0.0.14-next-2023-08-26

9 months ago

0.0.11-next-2023-06-30.1

11 months ago

0.0.14-next-2023-08-24

9 months ago

0.0.11-next-2023-06-30.2

11 months ago

0.0.12-next-2023-07-30

10 months ago

0.0.14-next-2023-08-29

9 months ago

0.0.14-next-2023-08-27

9 months ago

0.0.14-next-2023-08-28

9 months ago

1.0.0-next-2023-10-02

7 months ago

0.0.12-next-2023-07-08

10 months ago

0.0.12-next-2023-07-09

10 months ago

0.0.12-next-2023-07-06

10 months ago

0.0.12-next-2023-07-07

10 months ago

0.0.12-next-2023-07-04

10 months ago

0.0.12-next-2023-07-05

10 months ago

0.0.12-next-2023-07-03

10 months ago

0.0.13-next-2023-08-14.1

9 months ago

1.0.0

7 months ago

0.0.16-next-2023-09-21

8 months ago

0.0.16-next-2023-09-20

8 months ago

0.0.16-next-2023-09-23

8 months ago

0.0.16-next-2023-09-22

8 months ago

0.0.16-next-2023-09-25

8 months ago

0.0.16-next-2023-10-02

7 months ago

0.0.16-next-2023-09-24

8 months ago

0.0.16-next-2023-09-27

8 months ago

0.0.16-next-2023-09-26

8 months ago

0.0.16-next-2023-09-29

8 months ago

0.0.16-next-2023-09-28

8 months ago

0.0.16-next-2023-09-18.1

8 months ago

0.0.16-next-2023-09-18.2

8 months ago

0.0.16-next-2023-10-01

7 months ago

0.0.16-next-2023-09-10

8 months ago

0.0.15-next-2023-09-05

8 months ago

0.0.16-next-2023-09-12

8 months ago

0.0.16-next-2023-09-11

8 months ago

0.0.16-next-2023-09-14

8 months ago

0.0.16-next-2023-09-13

8 months ago

0.0.16-next-2023-09-16

8 months ago

0.0.16-next-2023-09-15

8 months ago

0.0.16-next-2023-09-18

8 months ago

0.0.16-next-2023-09-17

8 months ago

0.0.15-next-2023-09-04

8 months ago

0.0.16-next-2023-09-19

8 months ago

0.0.16-next-2023-09-21.1

8 months ago

0.0.12-next-2023-08-07

9 months ago

0.0.12-next-2023-08-02

9 months ago

0.0.12-next-2023-07-31

10 months ago

0.0.12-next-2023-08-01

10 months ago

0.0.12-next-2023-08-04

9 months ago

0.0.12-next-2023-08-03

9 months ago

0.0.12-next-2023-08-06

9 months ago

0.0.12-next-2023-08-05

9 months ago

0.0.11-next-2023-07-03

10 months ago

0.0.11-next-2023-07-01

11 months ago

0.0.11-next-2023-07-02

11 months ago

0.0.16-next-2023-09-30

8 months ago

0.0.11-next-2023-06-30

11 months ago

0.0.11-next-2023-06-29

11 months ago

0.0.11-next-2023-06-28

11 months ago

0.0.11-next-2023-06-27

11 months ago

0.0.11-next-2023-06-26.1

11 months ago

0.0.11-next-2023-06-26.2

11 months ago

0.0.11-next-2023-06-24

11 months ago

0.0.11-next-2023-06-25

11 months ago

0.0.11-next-2023-06-26

11 months ago

0.0.11-next-2023-06-23

11 months ago

0.0.8-next-2023-04-19

1 year ago

0.0.8-next-2023-04-18

1 year ago

0.0.9-next-2023-06-12.1

11 months ago

0.0.8-next-2023-04-24

1 year ago

0.0.8-next-2023-04-25

1 year ago

0.0.8-next-2023-04-22

1 year ago

0.0.8-next-2023-04-23

1 year ago

0.0.8-next-2023-04-20

1 year ago

0.0.8-next-2023-04-21

1 year ago

0.0.8-next-2023-04-28

1 year ago

0.0.8-next-2023-04-29

1 year ago

0.0.8-next-2023-04-26

1 year ago

0.0.8-next-2023-04-27

1 year ago

0.0.8-next-2023-04-24.1

1 year ago

0.0.8-next-2023-04-24.2

1 year ago

0.0.11-next-2023-06-22.1

11 months ago

0.0.9-next-2023-06-13.1

11 months ago

0.0.9-next-2023-06-13.2

11 months ago

11 months ago

12 months ago

1 year ago

1 year ago

0.0.9-next-2023-06-06.1

11 months ago

0.0.10-next-2023-06-21

11 months ago

0.0.6-next-2023-04-18

1 year ago

0.0.6-next-2023-04-17

1 year ago

0.0.10

11 months ago

0.0.9-next-2023-05-30.1

12 months ago

0.0.8-next-2023-04-27.1

1 year ago

0.0.9-next-2023-06-08

11 months ago

0.0.9-next-2023-06-07

11 months ago

0.0.9-next-2023-06-06

11 months ago

0.0.9-next-2023-06-05

11 months ago

0.0.9-next-2023-06-09

11 months ago

0.0.9-next-2023-05-31

12 months ago

0.0.9-next-2023-05-30

12 months ago

0.0.9-next-2023-06-04

11 months ago

0.0.9-next-2023-06-03

11 months ago

0.0.9-next-2023-06-02

12 months ago

0.0.9-next-2023-06-01

12 months ago

0.0.8-next-2023-04-20.1

1 year ago

0.0.9-next-2023-05-29

12 months ago

0.0.9-next-2023-05-28

12 months ago

0.0.9-next-2023-05-27

12 months ago

0.0.9-next-2023-05-26

12 months ago

0.0.9-next-2023-05-25

12 months ago

0.0.9-next-2023-05-24

12 months ago

0.0.10-next-2023-06-21.1

11 months ago

0.0.10-next-2023-06-21.2

11 months ago

0.0.9-next-2023-06-20

11 months ago

0.0.8-next-2023-05-24

12 months ago

0.0.8-next-2023-05-23

12 months ago

0.0.8-next-2023-05-20

12 months ago

0.0.8-next-2023-05-22

12 months ago

0.0.8-next-2023-05-21

12 months ago

0.0.9-next-2023-06-19

11 months ago

0.0.9-next-2023-06-18

11 months ago

0.0.9-next-2023-06-17

11 months ago

0.0.9-next-2023-06-16

11 months ago

0.0.9-next-2023-06-11

11 months ago

0.0.9-next-2023-06-10

11 months ago

0.0.9-next-2023-06-15

11 months ago

0.0.9-next-2023-06-14

11 months ago

0.0.9-next-2023-06-13

11 months ago

0.0.9-next-2023-06-12

11 months ago

0.0.7-next-2023-04-18

1 year ago

0.0.8-next-2023-05-02

1 year ago

0.0.8-next-2023-05-01

1 year ago

0.0.8-next-2023-05-04

1 year ago

0.0.8-next-2023-05-03

1 year ago

0.0.8-next-2023-04-30

1 year ago

0.0.8-next-2023-05-09

1 year ago

0.0.8-next-2023-05-06

1 year ago

0.0.8-next-2023-05-05

1 year ago

0.0.8-next-2023-05-08

1 year ago

0.0.8-next-2023-05-07

1 year ago

0.0.9-next-2023-06-15.1

11 months ago

0.0.8-next-2023-05-13

1 year ago

0.0.8-next-2023-05-12

1 year ago

0.0.8-next-2023-05-15

12 months ago

0.0.8-next-2023-05-14

12 months ago

0.0.11-next-2023-06-21

11 months ago

0.0.11-next-2023-06-22

11 months ago

0.0.8-next-2023-05-11

1 year ago

0.0.8-next-2023-05-10

1 year ago

0.0.8-next-2023-05-17

12 months ago

0.0.8-next-2023-05-16

12 months ago

0.0.8-next-2023-05-19

12 months ago

0.0.8-next-2023-05-18

12 months ago

0.0.6-next-2023-04-04.1

1 year ago

0.0.6-next-2023-04-04.2

1 year ago

0.0.6-next-2023-04-13.2

1 year ago

0.0.6-next-2023-04-13.1

1 year ago

0.0.6-next-2023-04-07

1 year ago

0.0.6-next-2023-04-06

1 year ago

0.0.6-next-2023-04-09

1 year ago

0.0.6-next-2023-04-08

1 year ago

0.0.6-next-2023-04-01

1 year ago

0.0.6-next-2023-03-30

1 year ago

0.0.6-next-2023-03-31

1 year ago

0.0.6-next-2023-04-03

1 year ago

0.0.6-next-2023-04-02

1 year ago

0.0.6-next-2023-04-05

1 year ago

0.0.6-next-2023-04-04

1 year ago

0.0.6-next-2023-04-10

1 year ago

0.0.6-next-2023-04-12

1 year ago

0.0.6-next-2023-04-11

1 year ago

0.0.6-next-2023-04-14

1 year ago

0.0.6-next-2023-04-13

1 year ago

0.0.6-next-2023-04-16

1 year ago

0.0.6-next-2023-04-15

1 year ago

0.0.6-next-2023-02-28

1 year ago

0.0.6-next-2023-02-26

1 year ago

0.0.6-next-2023-02-27

1 year ago

0.0.6-next-2023-02-20

1 year ago

0.0.6-next-2023-02-21

1 year ago

0.0.6-next-2023-02-24

1 year ago

0.0.6-next-2023-02-25

1 year ago

0.0.6-next-2023-02-22

1 year ago

0.0.6-next-2023-03-07.1

1 year ago

0.0.6-next-2023-02-23

1 year ago

0.0.6-next-2023-02-27.1

1 year ago

0.0.6-next-2023-03-29

1 year ago

0.0.6-next-2023-03-27

1 year ago

0.0.6-next-2023-03-28

1 year ago

0.0.6-next-2023-03-21

1 year ago

0.0.6-next-2023-03-22

1 year ago

0.0.6-next-2023-03-20

1 year ago

0.0.6-next-2023-03-25

1 year ago

0.0.6-next-2023-03-26

1 year ago

0.0.6-next-2023-03-23

1 year ago

0.0.6-next-2023-03-24

1 year ago

0.0.6-next-2023-03-18

1 year ago

0.0.6-next-2023-03-19

1 year ago

0.0.6-next-2023-03-16

1 year ago

0.0.6-next-2023-03-17

1 year ago

0.0.6-next-2023-03-21.1

1 year ago

0.0.6-next-2023-03-10

1 year ago

0.0.6-next-2023-03-11

1 year ago

0.0.6-next-2023-03-14

1 year ago

0.0.6-next-2023-03-15

1 year ago

0.0.6-next-2023-03-12

1 year ago

0.0.6-next-2023-03-06.1

1 year ago

0.0.6-next-2023-03-13

1 year ago

0.0.6-next-2023-02-22.1

1 year ago

0.0.6-next-2023-03-07

1 year ago

0.0.6-next-2023-03-08

1 year ago

0.0.6-next-2023-03-05

1 year ago

0.0.6-next-2023-03-06

1 year ago

0.0.6-next-2023-03-09

1 year ago

0.0.6-next-2023-03-13.1

1 year ago

0.0.6-next-2023-03-03

1 year ago

0.0.6-next-2023-03-04

1 year ago

0.0.6-next-2023-03-01

1 year ago

0.0.6-next-2023-03-02

1 year ago

0.0.6-next-2023-02-19

1 year ago

0.0.6-next-2023-02-18

1 year ago

0.0.6-next-2023-02-17

1 year ago

0.0.6-next-2023-02-16

1 year ago

0.0.6-next-2023-02-15.1

1 year ago

0.0.6-next-2023-02-15

1 year ago

0.0.6-next-2023-02-14.2

1 year ago

0.0.6-next-2023-02-14.1

1 year ago

0.0.6-next-2023-02-14

1 year ago

0.0.6-next-2023-02-13.3

1 year ago

0.0.6-next-2023-02-13.2

1 year ago

0.0.6-next-2023-02-13.1

1 year ago

0.0.6-next-2023-02-13

1 year ago

0.0.6-next-2023-02-12

1 year ago

0.0.6-next-2023-02-11

1 year ago

0.0.6-next-2023-02-10

1 year ago

0.0.6-next-2023-02-09

1 year ago

0.0.6-next-2023-02-08.1

1 year ago

0.0.6-next-2023-02-08

1 year ago

0.0.6-next-2023-02-07.1

1 year ago

0.0.6-next-2023-02-07

1 year ago

0.0.5

1 year ago

0.0.5-next-2023-02-07

1 year ago

0.0.5-next-2023-02-06

1 year ago

0.0.5-next-2023-02-05

1 year ago

0.0.5-next-2023-02-04

1 year ago

0.0.5-next-2023-02-03

1 year ago

0.0.5-next-2023-02-02

1 year ago

0.0.5-next-2023-02-01

1 year ago

0.0.5-next-2023-01-31.1

1 year ago

0.0.5-next-2023-01-31

1 year ago

0.0.5-next-2023-01-30.2

1 year ago

0.0.5-next-2023-01-30.1

1 year ago

0.0.5-next-2023-01-30

1 year ago

0.0.5-next-2023-01-29

1 year ago

0.0.5-next-2023-01-28.1

1 year ago

0.0.5-next-2023-01-28

1 year ago

0.0.4

1 year ago

0.0.4-next-2023-01-28.1

1 year ago

0.0.4-next-2023-01-28

1 year ago

0.0.4-next-2023-01-27

1 year ago

0.0.4-next-2023-01-26.1

1 year ago

0.0.4-next-2023-01-26

1 year ago

0.0.4-next-2023-01-25.1

1 year ago

0.0.4-next-2023-01-25

1 year ago

0.0.4-next-2023-01-24

1 year ago

0.0.3

1 year ago

0.0.2-next-2023-01-24

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago

@dfinity/ledger v1.0.0

ledger-js

Table of contents

Installation

Usage

Features

:toolbox: Functions

:gear: encodeIcrcAccount

:gear: decodeIcrcAccount

:factory: IcrcLedgerCanister

Constructors

Methods

:gear: create

:gear: metadata

:gear: transactionFee

:gear: balance

:gear: transfer

Resources