token: Specs, parameters and source emission

import { token } from "@eco-incorp/sauce";

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

export type AddressInput = Address | bigint;

export type TokenTarget = "evm" | "v1" | "v12" | "svm";

export type TokenOp = "transfer" | "approve" | "balanceOf";

SPL_TRANSFER_CHECKED = 12

SPL_APPROVE_CHECKED = 13

SPL_AMOUNT_OFFSET = 64

MINT_DECIMALS_OFFSET = 44

export interface SvmTokenRefs {
    source: string;
    mint?: string;
    dest?: string;
    delegate?: string;
    owner?: string;
    tokenProgram?: string;
}

export type SvmTokenProgramInput = "spl" | "token-2022" | bigint;

export interface TokenTransferSpec {
    token?: AddressInput;
    to?: AddressInput;
    amount: bigint | number | "balance";
    svm?: SvmTokenRefs;
    tokenProgram?: SvmTokenProgramInput;
}

export interface TokenApproveSpec {
    token?: AddressInput;
    spender?: AddressInput;
    amount: bigint | number | "balance";
    svm?: SvmTokenRefs;
    tokenProgram?: SvmTokenProgramInput;
}

export interface TokenBalanceSpec {
    token?: AddressInput;
    owner?: AddressInput | "self";
    svm?: Pick<SvmTokenRefs, "source">;
}

export type TokenSpec = ({
    op: "transfer";
} & TokenTransferSpec) | ({
    op: "approve";
} & TokenApproveSpec) | ({
    op: "balanceOf";
} & TokenBalanceSpec);

export declare function isEvmTarget(target: TokenTarget): boolean;

export declare function toAddressBigint(value: AddressInput, _label: string): bigint;

export declare function assertU64Range(amount: bigint, label: string): void;

export declare function toAmountBigint(amount: bigint | number, label: string): bigint;

export declare function ownerRef(refs: SvmTokenRefs): string;

export declare function tokenProgramRef(refs: SvmTokenRefs): string;

export declare function validateTransferSpec(spec: TokenTransferSpec, target: TokenTarget): void;

export declare function validateApproveSpec(spec: TokenApproveSpec, target: TokenTarget): void;

export declare function validateBalanceSpec(spec: TokenBalanceSpec, target: TokenTarget): void;

export declare function assertNoDuplicateSvmRefs(specs: readonly TokenSpec[]): void;

export declare function tokenImportLines(specs: readonly TokenSpec[], target: TokenTarget): readonly string[];

export declare function tokenCallStatement(spec: TokenSpec, target: TokenTarget, index?: number, svmState?: SvmEmitState): string;

export declare function tokenExpression(spec: TokenSpec, target: TokenTarget): string;

export declare function tokenAccountRefs(spec: TokenSpec, target: TokenTarget): readonly string[];

export declare function tokenSource(spec: TokenSpec | readonly TokenSpec[], target: TokenTarget, opts?: TokenSourceOptions): string;

TOKEN_BASE_DIRS: readonly string[]

export interface TokenSourceOptions {
    functionName?: string;
    imports?: readonly string[];
}