@dfinity/ledger-icp
Advanced tools
Readme
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.
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
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";
import { LedgerCanister } from "@dfinity/ledger-icp";
const agent = await createAgent({
identity,
host: HOST,
});
const { metadata } = LedgerCanister.create({
agent,
canisterId: MY_LEDGER_CANISTER_ID,
});
const data = await metadata();
ledger-icp-js implements following features:
| Method | Type |
|---|---|
fromHex | (hex: string) => AccountIdentifier |
| Method | Type |
|---|---|
fromPrincipal | ({ principal, subAccount, }: { principal: Principal; subAccount?: SubAccount or undefined; }) => AccountIdentifier |
| Method | Type |
|---|---|
toHex | () => string |
| Method | Type |
|---|---|
toUint8Array | () => Uint8Array |
| Method | Type |
|---|---|
toNumbers | () => number[] |
| Method | Type |
|---|---|
toAccountIdentifierHash | () => { hash: Uint8Array; } |
| Method | Type |
|---|---|
fromBytes | (bytes: Uint8Array) => SubAccount or Error |
| Method | Type |
|---|---|
fromPrincipal | (principal: Principal) => SubAccount |
| Method | Type |
|---|---|
fromID | (id: number) => SubAccount |
| Method | Type |
|---|---|
toUint8Array | () => Uint8Array |
| Method | Type |
|---|---|
create | (options?: LedgerCanisterOptions) => LedgerCanister |
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: accountIdentifierParam, certified, }: AccountBalanceParams) => Promise<bigint> |
Parameters:
params: The parameters to get the balance of an account.params.accountIdentifier: The account identifier provided either as hex string or as an AccountIdentifier.params.certified: query or update call.Returns the transaction fee of the ledger canister
| Method | Type |
|---|---|
transactionFee | () => Promise<bigint> |
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> |
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> |
| Method | Type |
|---|---|
create | ({ canisterId: optionsCanisterId, ...options }: CanisterOptions<_SERVICE>) => IndexCanister |
Returns the balance of the specified account identifier.
| Method | Type |
|---|---|
accountBalance | ({ certified, accountIdentifier, }: AccountBalanceParams) => Promise<bigint> |
Parameters:
params: The parameters to get the balance of an account.params.accountIdentifier: The account identifier provided either as hex string or as an AccountIdentifier.params.certified: query or update call.Returns the transactions and balance of an ICP account.
| Method | Type |
|---|---|
getTransactions | ({ certified, accountIdentifier, start, maxResults: max_results, }: GetTransactionsParams) => Promise<GetAccountIdentifierTransactionsResponse> |
Parameters:
params: The parameters to get the transactions.params.certified: query or update call.params.accountIdentifier: The account identifier provided either as hex string or as an AccountIdentifier.params.start: If set then the results will start from the next most recent transaction id after start (start won't be included). If not provided, then the results will start from the most recent transaction id.params.maxResults: Maximum number of transactions to fetch.FAQs
A library for interfacing with the ICP ledger on the Internet Computer.
The npm package @dfinity/ledger-icp receives a total of 2,440 weekly downloads. As such, @dfinity/ledger-icp popularity was classified as popular.
We found that @dfinity/ledger-icp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.