@dfinity/ledger-icrc 6.0.1-next-2025-12-08 → 6.0.1-next-2025-12-10

package/dist/types/ledger.params.d.ts

@@ -1,109 +0,0 @@
-import type { QueryParams } from "@dfinity/utils";
-import type { Account, AllowanceArgs, icrc21_consent_message_request as ConsentMessageArgs, GetBlocksArgs, Subaccount, Timestamp, Tokens } from "../candid/icrc_ledger";
-import type { IcrcAccount } from "./ledger.responses";
-/**
- * Params to get the balance of an ICRC-1 account.
- */
-export type BalanceParams = IcrcAccount & QueryParams;
-/**
- * Params to make a transfer in an ICRC-1 ledger
- *
- * @param {Account} to The account to transfer tokens to.
- * @param {Tokens} amount The Amount of tokens to transfer.
- * @param {Subaccount?} from_subaccount The subaccount to transfer tokens to.
- * @param {Uint8Array?} memo Transfer memo.
- * @param {Timestamp?} created_at_time nanoseconds since unix epoc to trigger deduplication and avoid other issues
- * See the link for more details on deduplication
- * https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/README.md#transaction_deduplication
- * @param {Tokens?} fee The fee of the transfer when it's not the default fee.
- */
-export interface TransferParams {
-    to: Account;
-    fee?: Tokens;
-    memo?: Uint8Array;
-    from_subaccount?: Subaccount;
-    created_at_time?: Timestamp;
-    amount: Tokens;
-}
-/**
- * Params for an icrc2_transfer_from.
- *
- * @param {Account} to The account to transfer tokens to.
- * @param {Account} from The account to transfer tokens from.
- * @param {Subaccount?} spender_subaccount A spender subaccount.
- * @param {Tokens} amount The Amount of tokens to transfer.
- * @param {Uint8Array?} memo Transfer memo.
- * @param {Timestamp?} created_at_time nanoseconds since unix epoc to trigger deduplication and avoid other issues
- * @param {Tokens?} fee The fee of the transfer when it's not the default fee.
- */
-export type TransferFromParams = Omit<TransferParams, "from_subaccount"> & {
-    spender_subaccount?: Subaccount;
-    from: Account;
-};
-/**
- * Params for an icrc2_approve.
- *
- * @param {Account} spender The account of the spender.
- * @param {Tokens} amount The Amount of tokens to approve.
- * @param {Subaccount?} from_subaccount The subaccount to transfer tokens from.
- * @param {Uint8Array?} memo Transfer memo.
- * @param {Timestamp?} created_at_time nanoseconds since unix epoc to trigger deduplication and avoid other issues
- * @param {Tokens?} fee The fee of the transfer when it's not the default fee.
- * @param {Tokens?} expected_allowance The optional allowance expected. If the expected_allowance field is set, the ledger MUST ensure that the current allowance for the spender from the caller's account is equal to the given value and return the AllowanceChanged error otherwise.
- * @param {Timestamp?} expires_at When the approval expires. If the field is set, it's greater than the current ledger time.
- */
-export type ApproveParams = Omit<TransferParams, "to"> & {
-    expected_allowance?: Tokens;
-    expires_at?: Timestamp;
-    spender: Account;
-};
-/**
- * Params to get the token allowance that the spender account can transfer from the specified account
- */
-export type AllowanceParams = AllowanceArgs & QueryParams;
-/**
- * Metadata for the consent message in ICRC-21 specification.
- * @param {number} [utcOffsetMinutes] - The user's local timezone offset in minutes from UTC. If absent, the default is UTC.
- * @param {string} language - BCP-47 language tag. See https://www.rfc-editor.org/rfc/bcp/bcp47.txt
- */
-export interface Icrc21ConsentMessageMetadata {
-    utcOffsetMinutes?: number;
-    language: string;
-}
-/**
- * Device specification for displaying the consent message.
- *
- * @param {null} [GenericDisplay] -  A generic display able to handle large documents and do line wrapping and pagination / scrolling.  Text must be Markdown formatted, no external resources (e.g. images) are allowed.
- * @param {Object} [FieldsDisplay] - A simple display able to handle multiple fields with a title and content.
- */
-export type Icrc21ConsentMessageDeviceSpec = {
-    GenericDisplay: null;
-} | {
-    FieldsDisplay: null;
-};
-/**
- * Specification for the consent message, including metadata and device preferences.
- *
- * @param {Icrc21ConsentMessageMetadata} metadata - Metadata of the consent message.
- * @param {Icrc21ConsentMessageDeviceSpec} [deviceSpec] - Information about the device responsible for presenting the consent message to the user.
- */
-export interface Icrc21ConsentMessageSpec {
-    metadata: Icrc21ConsentMessageMetadata;
-    deriveSpec?: Icrc21ConsentMessageDeviceSpec;
-}
-/**
- * Parameters for the consent message request.
- *
- * @param {string} method - Method name of the canister call.
- * @param {Uint8Array} arg - Argument of the canister call.
- * @param {Icrc21ConsentMessageSpec} userPreferences - User preferences with regards to the consent message presented to the end-user.
- */
-export type Icrc21ConsentMessageParams = Omit<ConsentMessageArgs, "user_preferences"> & {
-    userPreferences: Icrc21ConsentMessageSpec;
-};
-/**
- * Parameters to get the canister blocks.
- */
-export type GetBlocksParams = QueryParams & {
-    args: GetBlocksArgs[];
-};

package/dist/types/ledger.responses.d.ts

@@ -1,24 +0,0 @@
-import type { Principal } from "@icp-sdk/core/principal";
-import type { Subaccount, Value } from "../candid/icrc_ledger";
-export declare enum IcrcMetadataResponseEntries {
-    SYMBOL = "icrc1:symbol",
-    NAME = "icrc1:name",
-    DECIMALS = "icrc1:decimals",
-    FEE = "icrc1:fee",
-    LOGO = "icrc1:logo"
-}
-export type IcrcTokenMetadataResponse = [
-    string | IcrcMetadataResponseEntries,
-    Value
-][];
-export interface IcrcAccount {
-    owner: Principal;
-    subaccount?: Subaccount;
-}
-export interface IcrcTokenMetadata {
-    name: string;
-    symbol: string;
-    fee: bigint;
-    decimals: number;
-    icon?: string;
-}

package/dist/utils/ledger.utils.d.ts

@@ -1,31 +0,0 @@
-import { type IcrcAccount, type IcrcTokenMetadata, type IcrcTokenMetadataResponse } from "../types/ledger.responses";
-/**
- * Encodes an Icrc-1 account compatible into a string.
- * Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md
- *
- * @param account { owner: Principal, subaccount?: Uint8Array }
- * @returns string
- */
-export declare const encodeIcrcAccount: ({ owner, subaccount, }: IcrcAccount) => string;
-/**
- * Decodes a string into an Icrc-1 compatible account.
- * Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md
- *
- * @param accountString string
- * @throws Error if the string is not a valid Icrc-1 account
- * @returns IcrcAccount { owner: Principal, subaccount?: Uint8Array }
- */
-export declare const decodeIcrcAccount: (accountString: string) => IcrcAccount;
-/**
- * Maps the token metadata information from a ledger response into a structured record.
- *
- * This utility processes an array of metadata key-value pairs provided by the ledger
- * and extracts specific fields, such as symbol, name, fee, decimals, and logo. It then
- * constructs a `IcrcTokenMetadata` record. If any required fields are missing,
- * the function returns `undefined`.
- *
- * @param {IcrcTokenMetadataResponse} response - An array of key-value pairs representing token metadata.
- *
- * @returns {IcrcTokenMetadata | undefined} - A structured metadata record or `undefined` if required fields are missing.
- */
-export declare const mapTokenMetadata: (response: IcrcTokenMetadataResponse) => IcrcTokenMetadata | undefined;

package/dist/utils/payment.utils.d.ts

@@ -1,28 +0,0 @@
-/**
- * 👀 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 ]
- * ```
- *
- * @param code string
- * @returns { token: string; identifier: string; amount?: number } | undefined
- */
-export declare const decodePayment: (code: string) => {
-    token: string;
-    identifier: string;
-    amount?: number;
-} | undefined;