Capxul Docs
API referenceClient setup

Read current holdings

Read the current native-token and USDX holdings.

client.holdings.current

Read the current native-token and USDX holdings.

Available in the Core SDK

The typed Core SDK operation is implemented. Live service behavior still depends on the configured environment.

Import and client prerequisite

import { createCapxulClient } from "@capxul/sdk";

const created = await createCapxulClient({
  publishableKey: "cap_pk_…",
});

if (!created.ok) throw created.error;
const client = created.value;

Usage

const result = await client.holdings.current();

if (!result.ok) {
  console.error(result.error.code);
  return;
}

console.log(result.value);

Signature

client.holdings.current(input?: { readonly actor?: ActorReference; }, options?: { readonly signal?: AbortSignal; }): Promise<CapxulResult<CurrentHoldings>>;

Source: packages/sdk/src/surface/holdings.ts:15.

Parameters

input

Optional.

{ readonly actor?: ActorReference; } | undefined

options

Optional.

{ readonly signal?: AbortSignal; } | undefined

Returns

Promise<
  CapxulResult<{
    readonly actor:
      | { readonly kind: "account"; readonly accountId: string }
      | { readonly kind: "organization"; readonly orgId: string };
    readonly chainId: ChainId;
    readonly observedAt: number;
    readonly stale: boolean;
    readonly rows: readonly (
      | {
          readonly assetKind: "native";
          readonly rawBalance: WeiAmount;
          readonly symbol?: string | undefined;
          readonly decimals?: number | undefined;
        }
      | {
          readonly assetKind: "erc20";
          readonly rawBalance: WeiAmount;
          readonly tokenAddress: Address;
          readonly symbol?: string | undefined;
          readonly decimals?: number | undefined;
        }
    )[];
  }>
>;

Read the ok discriminant before accessing value or error.

Errors

Expected failures resolve as { ok: false, error: CapxulError }; they are not thrown as the normal domain contract. Branch on result.ok and use the stable error.code. A pre-aborted AbortSignal returns a CANCELLED failure. Provider messages and internal causes are not public contracts.

Availability and evidence

Available in the Core SDK. Evidence classification: shipped-proven.

shipped-proven at the typed or hermetic Core SDK contract boundary. The callable surface and result mapping are covered by release-trunk type or hermetic tests. That does not by itself prove a live backend, provider, email, browser, or chain journey. Check the capability-status reference before presenting this operation as live.

On this page