index-ng.did

type Tokens = nat;

type InitArg = record {
    ledger_id: principal;
    // The interval in seconds in which to retrieve blocks from the ledger. A lower value makes the index more
    // responsive in showing new blocks, but increases the consumption of cycles of both the index and ledger canisters.
    // A higher values means that it takes longer for new blocks to show up in the index.
    retrieve_blocks_from_ledger_interval_seconds : opt nat64;
};

type UpgradeArg = record {
    ledger_id: opt principal;
    // The interval in seconds in which to retrieve blocks from the ledger. A lower value makes the index more
    // responsive in showing new blocks, but increases the consumption of cycles of both the index and ledger canisters.
    // A higher values means that it takes longer for new blocks to show up in the index.
    retrieve_blocks_from_ledger_interval_seconds : opt nat64;
};

type IndexArg = variant {
    Init: InitArg;
    Upgrade: UpgradeArg;
};

type GetBlocksRequest = record {
    start : nat;
    length : nat;
};

type Value = variant {
    Blob : blob;
    Text : text;
    Nat : nat;
    Nat64: nat64;
    Int : int;
    Array : vec Value;
    Map : Map;
};

type Map = vec record { text; Value };

type Block = Value;

type GetBlocksResponse = record {
    chain_length: nat64;
    blocks: vec Block;
};

type BlockIndex = nat;

type SubAccount = blob;

type Account = record { owner : principal; subaccount : opt SubAccount };

type Transaction = record {
  burn : opt Burn;
  kind : text;
  mint : opt Mint;
  approve : opt Approve;
  timestamp : nat64;
  transfer : opt Transfer;
};

type Approve = record {
  fee : opt nat;
  from : Account;
  memo : opt vec nat8;
  created_at_time : opt nat64;
  amount : nat;
  expected_allowance : opt nat;
  expires_at : opt nat64;
  spender : Account;
};

type Burn = record {
  from : Account;
  memo : opt vec nat8;
  created_at_time : opt nat64;
  amount : nat;
  spender : opt Account;
};

type Mint = record {
  to : Account;
  memo : opt vec nat8;
  created_at_time : opt nat64;
  amount : nat;
};

type Transfer = record {
  to : Account;
  fee : opt nat;
  from : Account;
  memo : opt vec nat8;
  created_at_time : opt nat64;
  amount : nat;
  spender : opt Account;
};

type GetAccountTransactionsArgs = record {
    account : Account;
    // The txid of the last transaction seen by the client.
    // If None then the results will start from the most recent
    // txid.
    start : opt BlockIndex;
    // Maximum number of transactions to fetch.
    max_results : nat;
};

type TransactionWithId = record {
  id : BlockIndex;
  transaction : Transaction;
};

type GetTransactions = record {
  balance : Tokens;
  transactions : vec TransactionWithId;
  // The txid of the oldest transaction the account has
  oldest_tx_id : opt BlockIndex;
};

type GetTransactionsErr = record {
  message : text;
};

type GetTransactionsResult = variant {
  Ok : GetTransactions;
  Err : GetTransactionsErr;
};

type ListSubaccountsArgs = record {
    owner: principal;
    start: opt SubAccount;
};

type Status = record {
    num_blocks_synced : BlockIndex;
};

type FeeCollectorRanges = record {
    ranges : vec  record { Account; vec record { BlockIndex; BlockIndex } };
}

service : (index_arg: opt IndexArg) -> {
    get_account_transactions : (GetAccountTransactionsArgs) -> (GetTransactionsResult) query;
    get_blocks : (GetBlocksRequest) -> (GetBlocksResponse) query;
    get_fee_collectors_ranges : () -> (FeeCollectorRanges) query;
    icrc1_balance_of : (Account) -> (Tokens) query;
    ledger_id : () -> (principal) query;
    list_subaccounts : (ListSubaccountsArgs) -> (vec SubAccount) query;
    status : () -> (Status) query;
}