getPortfolio

Storage-independent, note-free portfolio including pending-only assets and recovery ownership.

Import

import { getPortfolio } from "@0xcurvy/curvy-sdk/actions";

Usage

const result = await getPortfolio({ config });

Signature

function getPortfolio(parameters?: GetPortfolioParameters): Promise<PortfolioSnapshot>

Returns

Promise<PortfolioSnapshot>

The action resolves or returns the value shown in the signature.

Parameters

accountId

• Type: string
• Required: no

The account whose portfolio is built. Defaults to the active account.

const result = await getPortfolio({
  accountId, 
});

inputFinalityPolicy

• Type: InputFinalityPolicy
• Required: no

Which balance buckets count as spendable.

const result = await getPortfolio({
  inputFinalityPolicy: "finalized", 
});

signal

• Type: AbortSignal
• Required: no

Aborts the read.

const result = await getPortfolio({
  signal, 
});

priceMaxAgeMs

• Type: number
• Required: no

Host freshness policy; defaults to five minutes.

const result = await getPortfolio({
  priceMaxAgeMs, 
});

balanceMaxAgeMs

• Type: number
• Required: no

How old balance data may be before it is refreshed.

const result = await getPortfolio({
  balanceMaxAgeMs, 
});

metadataMaxAgeMs

• Type: number
• Required: no

Registry metadata freshness policy; defaults to thirty minutes.

const result = await getPortfolio({
  metadataMaxAgeMs, 
});

config

• Type: CurvyConfig
• Required: no

Curvy config to use. Defaults to the ambient config.

const result = await getPortfolio({
  config, 
});

Errors

Errors from config resolution and the underlying SDK operation are propagated to the caller.

Related

• Interacting with assets guide

Source

packages/@0xcurvy/sdk/src/actions/views/getPortfolio.ts