parseAmount

function parseAmount(value: 
  | string
  | bigint
  | Amount, asset?: string): {
  atomic: bigint;
  asset?: string;
};

Defined in: guardrails/types.ts:231 Parses an amount into { atomic: bigint; asset?: string }.

Parameters

The amount value to parse (bigint, string, or Amount object). string | bigint | Amount

string Optional asset identifier to scope the amount.

{
  atomic: bigint;
  asset?: string;
}

Parsed amount with atomic bigint value and optional asset.

atomic: bigint;

optional asset: string;

"amount_unparseable" on bad input.