token: SVM (SPL Token) target

The token namespace emits SauceScript for token operations: ERC-20 on an EVM compile target, SPL Token on svm. It is TypeScript that writes SauceScript for a host program; a SauceScript program imports the @sauce/token library instead. token.Token.transfer({ token, to, amount }).toSauceScript("evm") returns an object whose source is a program routes.compileSauceProgram compiles. token.Token is also the root export Token.

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

Generated from the type declarations of @eco-incorp/sauce.

`token.tokenProgramValueExpr`

Function · @eco-incorp/sauce The SauceScript expression for a SvmTokenProgramInput CPI-target VALUE. Defaults to "spl".

export declare function tokenProgramValueExpr(input: SvmTokenProgramInput | undefined): string;

`token.assertRefIsIdentifier`

Function · @eco-incorp/sauce

export declare function assertRefIsIdentifier(ref: string, label: string): void;

`token.newSvmEmitState`

Function · @eco-incorp/sauce

export declare function newSvmEmitState(): SvmEmitState;

`token.accountParamType`

Function · @eco-incorp/sauce Account, Account<Writable>, Account<Signer> or Account<Writable, Signer>.

export declare function accountParamType({ writable, signer }: Role): string;

`token.svmAccountParams`

Function · @eco-incorp/sauce Every account the program’s specs touch, in FIRST-USE order - the order a caller attaches them and the order the manifest reports. A ref shared across ops (owner/tokenProgram by design) appears once, holding the strongest role any op demanded of it.

export declare function svmAccountParams(specs: readonly TokenSpec[]): readonly SvmAccountParam[];

`token.svmAccountParamList`

Function · @eco-incorp/sauce The main(...) parameter list for specs, annotated with each slot’s required role.

export declare function svmAccountParamList(specs: readonly TokenSpec[]): string;

`token.svmTransferLines`

Function · @eco-incorp/sauce

export declare function svmTransferLines(spec: TokenTransferSpec, index: number, state: SvmEmitState): readonly string[];

`token.svmApproveLines`

Function · @eco-incorp/sauce

export declare function svmApproveLines(spec: TokenApproveSpec, index: number, state: SvmEmitState): readonly string[];

`token.svmBalanceExpression`

Function · @eco-incorp/sauce

export declare function svmBalanceExpression(spec: TokenBalanceSpec): string;

`token.accountRefsForTransfer`

Function · @eco-incorp/sauce The account manifest refs, in attach order, for transfer/approve with the given refs.

export declare function accountRefsForTransfer(refs: SvmTokenRefs): readonly string[];

`token.accountRefsForApprove`

Function · @eco-incorp/sauce

export declare function accountRefsForApprove(refs: SvmTokenRefs): readonly string[];

`token.TOKEN_PROGRAM_BIGINT`

Variable · @eco-incorp/sauce Well-known SPL program ids, converted once to the bigint literal the identity check wants.

TOKEN_PROGRAM_BIGINT: bigint

`token.TOKEN_2022_PROGRAM_BIGINT`

Variable · @eco-incorp/sauce

TOKEN_2022_PROGRAM_BIGINT: bigint

`token.SvmEmitState`

Interface · @eco-incorp/sauce Per-program emission state: a token program is pinned at most once per ref per program.

export interface SvmEmitState {
    pinnedTokenPrograms: Map<string, string>;
}

`token.SvmAccountParam`

Interface · @eco-incorp/sauce One main account parameter: the ref name and the role its annotation asserts.

export interface SvmAccountParam {
    ref: string;
    writable: boolean;
    signer: boolean;
}

Start here

Integration guides

Language reference

SauceScript libraries

Runtime and security

Troubleshooting and production

Chains and protocols

@eco-incorp/sauce

@eco-incorp/sauce-compiler

token: SVM (SPL Token) target

`token.tokenProgramValueExpr`

`token.assertRefIsIdentifier`

`token.newSvmEmitState`

`token.accountParamType`

`token.svmAccountParams`

`token.svmAccountParamList`

`token.svmTransferLines`

`token.svmApproveLines`

`token.svmBalanceExpression`

`token.accountRefsForTransfer`

`token.accountRefsForApprove`

`token.TOKEN_PROGRAM_BIGINT`

`token.TOKEN_2022_PROGRAM_BIGINT`

`token.SvmEmitState`

`token.SvmAccountParam`

​token.tokenProgramValueExpr

​token.assertRefIsIdentifier

​token.newSvmEmitState

​token.accountParamType

​token.svmAccountParams

​token.svmAccountParamList

​token.svmTransferLines

​token.svmApproveLines

​token.svmBalanceExpression

​token.accountRefsForTransfer

​token.accountRefsForApprove

​token.TOKEN_PROGRAM_BIGINT

​token.TOKEN_2022_PROGRAM_BIGINT

​token.SvmEmitState

​token.SvmAccountParam

`token.tokenProgramValueExpr`

`token.assertRefIsIdentifier`

`token.newSvmEmitState`

`token.accountParamType`

`token.svmAccountParams`

`token.svmAccountParamList`

`token.svmTransferLines`

`token.svmApproveLines`

`token.svmBalanceExpression`

`token.accountRefsForTransfer`

`token.accountRefsForApprove`

`token.TOKEN_PROGRAM_BIGINT`

`token.TOKEN_2022_PROGRAM_BIGINT`

`token.SvmEmitState`

`token.SvmAccountParam`