@xo-cash/types
    Preparing search index...

    Type Alias XOTemplateAssetAmounts

    Asset amounts configuration. Used for balance tracking on locking scripts and their roles, and for omitting change amounts. All fields are optional. Values may be literal amounts or CashASM expressions resolving to amounts.

    type XOTemplateAssetAmounts = {
        fungibleTokens?: FungibleTokenAmount | string | true;
        nonfungibleTokens?: true | 0 | 1 | string;
        satoshis?: Satoshis | string | true;
    }
    Index

    Properties

    fungibleTokens?: FungibleTokenAmount | string | true

    The fungible token amount.

    • FungibleTokenAmount: A specific bigint amount.
    • string: A CashASM expression that resolves to the amount.
    • true: all, i.e. the entire amount
    nonfungibleTokens?: true | 0 | 1 | string

    Whether a non-fungible token is present (0 for absent, 1 for present), or a CashASM expression that evaluates to 0 or 1.

    • true: resolves to 1 if an NFT is present, or 0 if none is present. Use this when the NFT is optional, to express that the NFT is estimated to be part of the balance if present, or absent from it if not.
    • 0: None, i.e. nothing is expected to be included
    • 1: present and complete, as value > 1 does not make sense for non-fungible tokens
    • string: A CashASM expression that evaluates to 0 or 1.
    satoshis?: Satoshis | string | true

    The satoshi amount.

    • Satoshis: A specific bigint amount.
    • string: A CashASM expression that resolves to the amount.
    • true: all, i.e. the entire amount