verify: Decoding settle programs

import { validateSettleProgram, encodeSettleProgram } from "@eco-incorp/sauce/verify";

export declare function decodeSettleProgram(payload: Hex, programBytes?: number): DecodedSettleProgram;

export declare function validateSettleProgram(payload: Hex, accepted?: readonly (Hex | ProgramPin)[]): DecodedSettleProgram;

export declare function encodeSettleProgram(tokens: readonly (bigint | `0x${string}`)[], minOut: bigint, recipient: bigint | `0x${string}`, programHex: Hex): Hex;

export declare function parseSettleProgram(payload: Hex, programBytes?: number): SettleParse;

export declare function bestEffortDecode(parse: SettleParse): DecodedSettleProgram | null;

export declare class SettleDecodeError extends Error {
    readonly code: SettleFailureCode;
    constructor(code: SettleFailureCode, message: string);
}

export interface DecodedSettleProgram {
    tokens: Address20[];
    minOut: bigint;
    recipient: Address20;
    floorToken: Address20;
    program: Hex;
    programHash: Hex;
    args: Hex;
    argsSize: number;
    payloadSize: number;
}

export interface ProgramPin {
    hash: Hex;
    bytes: number;
}

export type SettleFailureCode = "EMPTY" | "PROGRAM_TRUNCATED" | "ARGS_TRUNCATED" | "ARGS_OVERLONG" | "TOKENS_OFFSET" | "TOKENS_EMPTY" | "DIRTY_ADDRESS_WORD" | "ZERO_RECIPIENT" | "PROGRAM_HASH";

export interface SettleParse {
    bytes: Uint8Array;
    program: Uint8Array | null;
    programHash: Hex | null;
    args: Uint8Array | null;
    tokensOffset: bigint | null;
    minOut: bigint | null;
    recipient: bigint | null;
    recipientWord: bigint | null;
    recipientNonZero: boolean;
    tokenCount: bigint | null;
    tokenWords: bigint[];
    fatal: {
        code: SettleFailureCode;
        message: string;
    } | null;
}

export type Address20 = `0x${string}`;