API Reference

API Reference

This section provides detailed documentation for all Doxa APIs.

Swap Canister

swap_api

Creates a new swap transaction.

Parameters

record {
    token_in: principal;
    amount_in: nat;
    token_out: principal;
}

Returns

record {
    amount_out: nat;
    cycles_used: nat;
}

Example

dfx canister call swap_canister swap_api '(
  record {
    token_in = principal "xeka7-7iaaa-..."; // USDC
    amount_in = 100_000_000; // 100 USDC
    token_out = principal "ryjl3-tyaaa-..."; // DOXA
  }
)'

get_pool_info

Retrieves information about a specific pool.

Parameters

record {
    pool_id: principal;
}

Returns

record {
    token0: principal;
    token1: principal;
    reserve0: nat;
    reserve1: nat;
    fee: nat;
}

Cycle Management

get_cycle_balance

Gets the current cycle balance of a canister.

Parameters None

Returns

nat

Example

public query func get_cycle_balance() : async Nat {
    Cycles.balance()
};

transfer_cycles

Transfers cycles to another canister.

Parameters

record {
    to: principal;
    amount: nat;
}

Returns

variant {
    Ok: nat;
    Err: text;
}

Authentication

authenticate

Authenticates a user with NFID.

Parameters

record {
    principal: principal;
    signature: vec nat8;
}

Returns

variant {
    Ok: text; // JWT token
    Err: text;
}

Error Codes