@dfinity/ledger-icp/dist/candid/index.d.ts

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

import type { ActorMethod } from "@dfinity/agent";
import type { IDL } from "@dfinity/candid";
import type { Principal } from "@dfinity/principal";

export interface Account {
  owner: Principal;
  subaccount: [] | [Uint8Array | number[]];
}
export interface GetAccountIdentifierTransactionsArgs {
  max_results: bigint;
  start: [] | [bigint];
  account_identifier: string;
}
export interface GetAccountIdentifierTransactionsError {
  message: string;
}
export interface GetAccountIdentifierTransactionsResponse {
  balance: bigint;
  transactions: Array<TransactionWithId>;
  oldest_tx_id: [] | [bigint];
}
export type GetAccountIdentifierTransactionsResult =
  | {
      Ok: GetAccountIdentifierTransactionsResponse;
    }
  | { Err: GetAccountIdentifierTransactionsError };
export interface GetAccountTransactionsArgs {
  max_results: bigint;
  start: [] | [bigint];
  account: Account;
}
export interface GetBlocksRequest {
  start: bigint;
  length: bigint;
}
export interface GetBlocksResponse {
  blocks: Array<Uint8Array | number[]>;
  chain_length: bigint;
}
export interface HttpRequest {
  url: string;
  method: string;
  body: Uint8Array | number[];
  headers: Array<[string, string]>;
}
export interface HttpResponse {
  body: Uint8Array | number[];
  headers: Array<[string, string]>;
  status_code: number;
}
export interface InitArg {
  ledger_id: Principal;
}
export type Operation =
  | {
      Approve: {
        fee: Tokens;
        from: string;
        allowance: Tokens;
        expected_allowance: [] | [Tokens];
        expires_at: [] | [TimeStamp];
        spender: string;
      };
    }
  | {
      Burn: { from: string; amount: Tokens; spender: [] | [string] };
    }
  | { Mint: { to: string; amount: Tokens } }
  | {
      Transfer: {
        to: string;
        fee: Tokens;
        from: string;
        amount: Tokens;
        spender: [] | [string];
      };
    };
export interface Status {
  num_blocks_synced: bigint;
}
export interface TimeStamp {
  timestamp_nanos: bigint;
}
export interface Tokens {
  e8s: bigint;
}
export interface Transaction {
  memo: bigint;
  icrc1_memo: [] | [Uint8Array | number[]];
  operation: Operation;
  timestamp: [] | [TimeStamp];
  created_at_time: [] | [TimeStamp];
}
export interface TransactionWithId {
  id: bigint;
  transaction: Transaction;
}
export interface _SERVICE {
  get_account_identifier_balance: ActorMethod<[string], bigint>;
  get_account_identifier_transactions: ActorMethod<
    [GetAccountIdentifierTransactionsArgs],
    GetAccountIdentifierTransactionsResult
  >;
  get_account_transactions: ActorMethod<
    [GetAccountTransactionsArgs],
    GetAccountIdentifierTransactionsResult
  >;
  get_blocks: ActorMethod<[GetBlocksRequest], GetBlocksResponse>;
  http_request: ActorMethod<[HttpRequest], HttpResponse>;
  icrc1_balance_of: ActorMethod<[Account], bigint>;
  ledger_id: ActorMethod<[], Principal>;
  status: ActorMethod<[], Status>;
}
export declare const idlFactory: IDL.InterfaceFactory;
export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];