@cashlab/common
    Preparing search index...

    Type Alias PayoutChangeRule

    PayoutChangeRule: PayoutRuleCommon & {
        add_change_to_txfee_when_bch_change_is_dust?: boolean;
        allow_mixing_native_and_token?: boolean;
        allow_mixing_native_and_token_when_bch_change_is_dust?: boolean;
        generateChangeLockingBytecodeForOutput?: (output: Output) => Uint8Array;
        locking_bytecode?: Uint8Array;
        shouldBurn?: (token_id: TokenId, amount: bigint) => void;
        type: CHANGE;
    }

    Type declaration

    • Optionaladd_change_to_txfee_when_bch_change_is_dust?: boolean

      When true if the bch change is considered as dust it will be added to the transaction fee.

    • Optionalallow_mixing_native_and_token?: boolean

      When true the change output may contain the remaining bch & tokens in a single output. Warning: Not all wallets know how to get access to mixed outputs, Set this to true only if you know what you're doing.

    • Optionalallow_mixing_native_and_token_when_bch_change_is_dust?: boolean

      When true the bch change output will be mixed by a token output if bch change is considered as dust output.

    • OptionalgenerateChangeLockingBytecodeForOutput?: (output: Output) => Uint8Array

      Generate a locking_bytecode for a change output.

    • Optionallocking_bytecode?: Uint8Array

      The value defines the locking_bytecode of the generated outputs. (optional)

    • OptionalshouldBurn?: (token_id: TokenId, amount: bigint) => void

      The command method to burn the change for a token when it throws BurnTokenException

      BurnTokenException if the rule is to burn the change for the given token_id (excluding native BCH).

    • type: CHANGE

    Settings

    Member Visibility