@dfinity/ledger-icp NPM

ledger-icp-js

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

ℹ️ This library is meant to interface with the ICP ledger only. If you are looking to interact with Snses, ckBTC, or other ICRC tokens, use the ledger-icrc-js library.

Installation

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

npm i @dfinity/ledger-icp

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 @dfinity/nns-proto

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 { 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-icp-js implements following features:

:factory: AccountIdentifier

:link: Source

Methods

:gear: fromHex

Method	Type
`fromHex`	`(hex: string) => AccountIdentifier`

:link: Source

:gear: fromPrincipal

Method	Type
`fromPrincipal`	`({ principal, subAccount, }: { principal: Principal; subAccount?: SubAccount; }) => AccountIdentifier`

:link: Source

:gear: toProto

Method	Type
`toProto`	`() => Promise<AccountIdentifier>`

:link: Source

:gear: toHex

Method	Type
`toHex`	`() => string`

:link: Source

:gear: toUint8Array

Method	Type
`toUint8Array`	`() => Uint8Array`

:link: Source

:gear: toNumbers

Method	Type
`toNumbers`	`() => number[]`

:link: Source

:gear: toAccountIdentifierHash

Method	Type
`toAccountIdentifierHash`	`() => { hash: Uint8Array; }`

:link: Source

:factory: SubAccount

:link: Source

Methods

:gear: fromBytes

Method	Type
`fromBytes`	`(bytes: Uint8Array) => SubAccount or Error`

:link: Source

:gear: fromPrincipal

Method	Type
`fromPrincipal`	`(principal: Principal) => SubAccount`

:link: Source

:gear: fromID

Method	Type
`fromID`	`(id: number) => SubAccount`

:link: Source

:gear: toUint8Array

Method	Type
`toUint8Array`	`() => Uint8Array`

:link: Source

:factory: LedgerCanister

:link: Source

Methods

:gear: create

Method	Type
`create`	`(options?: LedgerCanisterOptions) => LedgerCanister`

:link: Source

:gear: accountBalance

Returns the balance of the specified account identifier.

If certified is true, the request is fetched as an update call, otherwise it is fetched using a query call.

Method	Type
`accountBalance`	`({ accountIdentifier, certified, }: { accountIdentifier: AccountIdentifier; certified?: boolean; }) => Promise<bigint>`

:link: Source

:gear: transactionFee

Returns the transaction fee of the ledger canister

Method	Type
`transactionFee`	`() => Promise<bigint>`

:link: Source

:gear: transfer

Transfer ICP from the caller to the destination accountIdentifier. Returns the index of the block containing the tx if it was successful.

Method	Type
`transfer`	`(request: TransferRequest) => Promise<bigint>`

:link: Source

:gear: icrc1Transfer

Transfer ICP from the caller to the destination Account. Returns the index of the block containing the tx if it was successful.

Method	Type
`icrc1Transfer`	`(request: Icrc1TransferRequest) => Promise<bigint>`

:link: Source

Resources

internet computer internet-computer ic dfinity Ledger ICP ledger token icp

@everything-registry/sub-chunk-240 @ic0-computer/tools fpdao-ui @omnity/widget

2.2.3-next-2024-04-29

13 days ago

2.2.3

13 days ago

2.2.2-next-2024-04-26

16 days ago

2.2.2-next-2024-04-25

17 days ago

2.2.2-next-2024-04-23

19 days ago

2.2.2-next-2024-04-22

20 days ago

2.2.2-next-2024-04-19

23 days ago

2.2.2-next-2024-04-03.1

1 month ago

2.2.2-next-2024-04-03.2

1 month ago

2.2.2-next-2024-04-02

1 month ago

2.2.2-next-2024-04-03

1 month ago

2.2.2-next-2024-04-01

1 month ago

2.2.2-next-2024-03-31

1 month ago

2.2.2-next-2024-03-30

1 month ago

2.2.2-next-2024-03-28.1

2 months ago

2.2.2-next-2024-03-29

1 month ago

2.2.2-next-2024-03-28

2 months ago

2.2.2-next-2024-03-27

2 months ago

2.2.2-next-2024-03-26

2 months ago

2.2.2-next-2024-03-26.1

2 months ago

2.2.2

2 months ago

2.2.2-next-2024-03-25.1

2 months ago

2.2.2-next-2024-03-25

2 months ago

2.2.1-next-2024-03-25

2 months ago

2.2.1-next-2024-03-24

2 months ago

2.2.1-next-2024-03-23

2 months ago

2.2.1-next-2024-03-22

2 months ago

2.2.1-next-2024-03-21

2 months ago

2.2.1-next-2024-03-20

2 months ago

2.2.1-next-2024-03-19

2 months ago

2.2.1-next-2024-03-18.1

2 months ago

2.2.1-next-2024-03-18

2 months ago

2.2.1-next-2024-03-16

2 months ago

2.2.1-next-2024-03-17

2 months ago

2.2.1-next-2024-03-15

2 months ago

2.2.1-next-2024-03-14

2 months ago

2.2.1-next-2024-03-12

2 months ago

2.2.1-next-2024-03-13

2 months ago

2.2.1-next-2024-03-11

2 months ago

2.2.1-next-2024-03-10

2 months ago

2.2.1-next-2024-03-09

2 months ago

2.2.1-next-2024-03-08

2 months ago

2.2.1-next-2024-03-07

2 months ago

2.2.1-next-2024-03-06

2 months ago

2.2.1-next-2024-03-05

2 months ago

2.2.1-next-2024-03-04.3

2 months ago

2.2.1-next-2024-03-04.2

2 months ago

2.2.1-next-2024-03-05.3

2 months ago

2.2.1-next-2024-03-05.2

2 months ago

2.2.1-next-2024-03-05.1

2 months ago

2.2.1-next-2024-03-04.1

2 months ago

2.2.1-next-2024-03-04

2 months ago

2.2.1-next-2024-03-03

2 months ago

2.2.1-next-2024-03-02

2 months ago

2.2.1-next-2024-03-01

2 months ago

2.2.1-next-2024-02-28.1

2 months ago

2.2.1-next-2024-02-28.2

2 months ago

2.2.1-next-2024-02-29

2 months ago

2.2.1-next-2024-02-28

2 months ago

2.2.1-next-2024-02-26.1

3 months ago

2.2.1-next-2024-02-27

3 months ago

2.2.1-next-2024-02-26

3 months ago

2.2.1-next-2024-02-25

3 months ago

2.2.1-next-2024-02-24

3 months ago

2.2.1-next-2024-02-23

3 months ago

2.2.1-next-2024-02-22

3 months ago

2.2.1-next-2024-02-21.1

3 months ago

2.2.1

3 months ago

2.2.0-next-2024-02-21

3 months ago

2.2.1-next-2024-02-21

3 months ago

2.2.0-next-2024-02-19.4

3 months ago

2.2.0-next-2024-02-19.3

3 months ago

2.2.0-next-2024-02-19.2

3 months ago

2.2.0-next-2024-02-19.1

3 months ago

2.2.0-next-2024-02-20

3 months ago

2.2.0-next-2024-02-18

3 months ago

2.2.0-next-2024-02-19

3 months ago

2.2.0-next-2024-02-17

3 months ago

2.2.0-next-2024-02-16

3 months ago

2.1.2-next-2024-02-14

3 months ago

2.2.0-next-2024-02-14

3 months ago

2.2.0-next-2024-02-15

3 months ago

2.2.0

3 months ago

2.1.2-next-2024-02-13

3 months ago

2.1.2-next-2024-02-12

3 months ago

2.1.2-next-2024-02-12.1

3 months ago

2.1.2-next-2024-02-11

3 months ago

2.1.2-next-2024-02-10

3 months ago

2.1.2-next-2024-02-09

3 months ago

2.1.2-next-2024-02-08

3 months ago

2.1.2-next-2024-02-07

3 months ago

2.1.2-next-2024-02-06

3 months ago

2.1.2-next-2024-02-05

3 months ago

2.1.2-next-2024-02-04

3 months ago

2.1.2-next-2024-02-02.1

3 months ago

2.1.2-next-2024-02-03

3 months ago

2.1.2-next-2024-02-02

3 months ago

2.1.2-next-2024-02-01

3 months ago

2.1.1-next-2024-01-30

3 months ago

2.1.1-next-2024-01-29

3 months ago

2.1.2-next-2024-01-30.1

3 months ago

2.1.2

3 months ago

2.1.2-next-2024-01-30

3 months ago

2.1.2-next-2024-01-31

3 months ago

2.1.1-next-2024-01-28

4 months ago

2.1.1-next-2024-01-27

4 months ago

2.1.1-next-2024-01-26

4 months ago

2.1.1-next-2024-01-25

4 months ago

2.1.1-next-2024-01-24

4 months ago

2.1.1-next-2024-01-23

4 months ago

2.1.1-next-2024-01-21

4 months ago

2.1.1-next-2024-01-22

4 months ago

2.1.1-next-2024-01-20

4 months ago

2.1.1-next-2024-01-19

4 months ago

2.1.1-next-2024-01-18.2

4 months ago

2.1.1-next-2024-01-18.1

4 months ago

2.1.1-next-2024-01-18

4 months ago

2.1.1-next-2024-01-17.2

4 months ago

2.1.1-next-2024-01-17.1

4 months ago

2.1.1-next-2024-01-17

4 months ago

2.1.1-next-2024-01-16

4 months ago

2.1.1-next-2024-01-15

4 months ago

2.1.1-next-2024-01-14

4 months ago

2.1.1-next-2024-01-15.1

4 months ago

2.1.1-next-2024-01-13

4 months ago

2.1.1-next-2024-01-12

4 months ago

2.1.1-next-2024-01-10

4 months ago

2.1.1-next-2024-01-11

4 months ago

2.1.1-next-2024-01-10.2

4 months ago

2.1.1-next-2024-01-10.1

4 months ago

2.1.1-next-2024-01-09

4 months ago

2.1.1

4 months ago

2.1.0-next-2024-01-09

4 months ago

2.1.0-next-2024-01-08.1

4 months ago

2.1.0-next-2024-01-08

4 months ago

2.1.0-next-2024-01-07

4 months ago

2.1.0-next-2024-01-06

4 months ago

2.1.0-next-2024-01-05

4 months ago

2.1.0-next-2024-01-04

4 months ago

2.1.0-next-2024-01-03

4 months ago

2.1.0-next-2024-01-02

4 months ago

2.1.0-next-2023-12-31

4 months ago

2.1.0-next-2024-01-01

4 months ago

2.1.0-next-2023-12-30

4 months ago

2.1.0-next-2023-12-29

5 months ago

2.1.0-next-2023-12-28.1

5 months ago

2.1.0-next-2023-12-28.2

5 months ago

2.1.0-next-2023-12-28

5 months ago

2.1.0-next-2023-12-27

5 months ago

2.1.0-next-2023-12-26

5 months ago

2.1.0-next-2023-12-23

5 months ago

2.1.0-next-2023-12-25

5 months ago

2.1.0-next-2023-12-24

5 months ago

2.1.0-next-2023-12-22

5 months ago

2.1.0-next-2023-12-21

5 months ago

2.1.0-next-2023-12-20

5 months ago

2.0.0-next-2023-12-20

5 months ago

2.1.0

5 months ago

2.0.0-next-2023-12-19.4

5 months ago

2.0.0-next-2023-12-19.3

5 months ago

2.0.0-next-2023-12-19

5 months ago

2.0.0-next-2023-12-19.2

5 months ago

2.0.0-next-2023-12-19.1

5 months ago

2.0.0-next-2023-12-17

5 months ago

2.0.0-next-2023-12-18

5 months ago

2.0.0-next-2023-12-16

5 months ago

2.0.0-next-2023-12-15

5 months ago

2.0.0-next-2023-12-14

5 months ago

2.0.0-next-2023-12-14.1

5 months ago

2.0.0-next-2023-12-13.1

5 months ago

2.0.0-next-2023-12-13

5 months ago

2.0.0-next-2023-12-12.1

5 months ago

2.0.0-next-2023-12-11

5 months ago

2.0.0-next-2023-12-12

5 months ago

2.0.0-next-2023-12-11.1

5 months ago

2.0.0-next-2023-12-10

5 months ago

2.0.0-next-2023-12-08

5 months ago

2.0.0-next-2023-12-09

5 months ago

2.0.0-next-2023-12-07.1

5 months ago

2.0.0-next-2023-12-07

5 months ago

2.0.0-next-2023-12-06

5 months ago

2.0.0-next-2023-12-05

5 months ago

2.0.0-next-2023-12-04

5 months ago

2.0.0-next-2023-12-03

5 months ago

2.0.0-next-2023-12-02

5 months ago

2.0.0-next-2023-12-01

5 months ago

2.0.0-next-2023-11-30

5 months ago

2.0.0-next-2023-12-01.1

5 months ago

2.0.0-next-2023-12-01.2

5 months ago

2.0.0-next-2023-11-29.1

5 months ago

2.0.0-next-2023-11-29

6 months ago

2.0.0-next-2023-11-28

6 months ago

2.0.0-next-2023-11-27

6 months ago

2.0.0-next-2023-11-26

6 months ago

2.0.0-next-2023-11-25

6 months ago

2.0.0-next-2023-11-24

6 months ago

2.0.0-next-2023-11-23.1

6 months ago

2.0.0-next-2023-11-23

6 months ago

2.0.0-next-2023-11-22

6 months ago

2.0.0

6 months ago

1.1.0-next-2023-11-21.1

6 months ago

1.1.0-next-2023-11-21

6 months ago

1.1.0-next-2023-11-20.1

6 months ago

1.1.0-next-2023-11-20

6 months ago

1.1.0-next-2023-11-19

6 months ago

1.1.0-next-2023-11-18

6 months ago

1.1.0-next-2023-11-17

6 months ago

1.1.0-next-2023-11-16

6 months ago

1.1.0-next-2023-11-15

6 months ago

1.1.0

6 months ago

1.0.0-next-2023-11-15

6 months ago

1.0.0-next-2023-11-14

6 months ago

1.0.0-next-2023-11-13.2

6 months ago

1.0.0-next-2023-11-13.1

6 months ago

1.0.0-next-2023-11-13

6 months ago

1.0.0-next-2023-11-12

6 months ago

1.0.0-next-2023-11-11

6 months ago

1.0.0-next-2023-11-10

6 months ago

1.0.0-next-2023-11-09.1

6 months ago

1.0.0-next-2023-11-09

6 months ago

1.0.0-next-2023-11-08

6 months ago

1.0.0-next-2023-11-07

6 months ago

1.0.0-next-2023-11-06

6 months ago

1.0.0-next-2023-11-05

6 months ago

1.0.0-next-2023-11-04

6 months ago

1.0.0-next-2023-11-03

6 months ago

1.0.0-next-2023-11-02

6 months ago

1.0.0-next-2023-11-01

6 months ago

1.0.0-next-2023-10-31

6 months ago

1.0.0-next-2023-10-30

7 months ago

1.0.0-next-2023-10-29

7 months ago

1.0.0-next-2023-10-28

7 months ago

1.0.0-next-2023-10-27

7 months ago

1.0.0-next-2023-10-26

7 months ago

1.0.0-next-2023-10-25

7 months ago

1.0.0-next-2023-10-24

7 months ago

1.0.0-next-2023-10-23.1

7 months ago

1.0.0-next-2023-10-23

7 months ago

1.0.0-next-2023-10-22

7 months ago

1.0.0-next-2023-10-21

7 months ago

1.0.0-next-2023-10-20

7 months ago

1.0.0-next-2023-10-19.1

7 months ago

1.0.0-next-2023-10-19

7 months ago

1.0.0-next-2023-10-18.1

7 months ago

1.0.0-next-2023-10-18

7 months ago

1.0.0-next-2023-10-17.1

7 months ago

1.0.0-next-2023-10-17

7 months ago

1.0.0-next-2023-10-16

7 months ago

1.0.0-next-2023-10-15

7 months ago

1.0.0-next-2023-10-14

7 months ago

1.0.0-next-2023-10-13

7 months ago

1.0.0-next-2023-10-12

7 months ago

1.0.0-next-2023-10-11.2

7 months ago

1.0.0-next-2023-10-11.1

7 months ago

1.0.0-next-2023-10-11

7 months ago

1.0.0-next-2023-10-10

7 months ago

1.0.0-next-2023-10-09

7 months ago

1.0.0-next-2023-10-08

7 months ago

1.0.0-next-2023-10-07

7 months ago

1.0.0-next-2023-10-06

7 months ago

1.0.0-next-2023-10-05.1

7 months ago

1.0.0-next-2023-10-05

7 months ago

1.0.0-next-2023-10-04

7 months ago

1.0.0-next-2023-10-03.1

7 months ago

1.0.0-next-2023-10-03

7 months ago

1.0.0

7 months ago

@dfinity/ledger-icp v2.2.3

ledger-icp-js

Table of contents

Installation

Usage

Features

:factory: AccountIdentifier

Methods

:gear: fromHex

:gear: fromPrincipal

:gear: toProto

:gear: toHex

:gear: toUint8Array

:gear: toNumbers

:gear: toAccountIdentifierHash

:factory: SubAccount

Methods

:gear: fromBytes

:gear: fromPrincipal

:gear: fromID

:gear: toUint8Array

:factory: LedgerCanister

Methods

:gear: create

:gear: accountBalance

:gear: transactionFee

:gear: transfer

:gear: icrc1Transfer

Resources