@eco-incorp/sauce 0.99.6 → 0.99.7

package/sdk/dist/cli/solana.d.ts

@@ -0,0 +1,183 @@
+import { createSolanaRpc, type Address, type KeyPairSigner } from "@solana/kit";
+import type { AccountManifest } from "sauce-compiler";
+import { type CanonicalChain } from "../chains/canonical.js";
+import { type CookVia } from "../svm/index.js";
+import { type SaltChoice } from "./args.js";
+import { type Approver, type ArgsInput, type CliFiles, type CommandOutput, type ProgramInput } from "./commands.js";
+/** A Solana public key from a flag, or a usage error naming the flag. */
+export declare function parsePubkey(flag: string, raw: string): Address;
+/**
+ * `--keypair <path>`: the standard Solana keypair file, a JSON array of the 64 secret-key bytes.
+ * The file's text is registered as a secret before anything can fail and print it.
+ */
+export declare function loadKeypair(path: string, files: CliFiles): Promise<KeyPairSigner>;
+type Rpc = ReturnType<typeof createSolanaRpc>;
+/** How long {@link awaitAccount} waits for an account to show, and how often it asks. */
+export declare const ACCOUNT_WAIT: {
+    tries: number;
+    delayMs: number;
+};
+/**
+ * Waits until the cluster shows `account`, just created in a confirmed transaction. A read with no
+ * commitment is a finalized read, which trails a confirmation by several seconds, and the cook's
+ * simulation reads the same way: cooking straight after creating its Pot would fail on a Pot that
+ * is there.
+ */
+export declare function awaitAccount(rpc: Rpc, url: string, account: Address, what: string, wait?: {
+    readonly tries: number;
+    readonly delayMs: number;
+}): Promise<void>;
+/**
+ * A transaction error, read: the Sauce program's thrown text when the ENGINE failed with its revert
+ * code, the engine's or the Kitchen's error by name when either refused, a token program's refusal
+ * in the words it logged, and otherwise the code and the program it came from. Custom codes collide across programs (every Anchor program numbers from
+ * 6000; System and SPL Token both use 0), so a code is named only for the program the logs show
+ * failing.
+ */
+export declare function failureReason(err: unknown, logs: readonly string[], returnData?: Uint8Array): string;
+export interface SvmSent {
+    readonly signature: string;
+    readonly ok: boolean;
+    readonly reason?: string;
+    readonly computeUnits?: bigint;
+    readonly logs: readonly string[];
+    /** The slot it landed in, where the status said. */
+    readonly slot?: bigint;
+    /** The fee it paid, in lamports, where the node said. */
+    readonly fee?: bigint;
+}
+/**
+ * Signs a plan's Solana transaction (`lifecycle-svm.ts`: base64, its fresh keys' signatures in, the
+ * fee payer's out) with `signer`, the fee payer, rehearses it as signed and refuses it if it would
+ * fail, then sends it and waits until it is confirmed.
+ */
+export declare function sendPlannedSvm(url: string, signer: KeyPairSigner, tx: {
+    readonly feePayer: string;
+    readonly transaction: string;
+    readonly what: string;
+}): Promise<SvmSent>;
+/** `--account name=<pubkey | pot | owner | pot:<token> | owner:<token> | mint:<token> | program:<token>>`, parsed. */
+export declare function parseAccounts(raws: readonly string[]): Record<string, string>;
+/** One `<whose>:<token>` resolved: the account, what it is for a person, and which kind it is. */
+interface TokenAccountNamed {
+    readonly address: Address;
+    readonly label: string;
+    /** A holder's token account, which a transfer can bring into being, or the mint or its program. */
+    readonly kind: "account" | "mint" | "program";
+}
+/** The token program that owns a mint the registry does not record, read from the cluster. */
+export type MintProgramOf = (mint: Address) => Promise<Address>;
+/**
+ * Each `--account` value that names an account by its token as that account: `pot:USDC` and
+ * `owner:<mint>` the associated token account of the Pot (or the owner) for the mint, under the
+ * token program that owns the mint; `mint:USDC` the mint; `program:USDC` that token program — the
+ * accounts `@sauce/token`'s writes take. A symbol is one of the cluster's registered mints, whose
+ * row records its program; any other mint is given by its base58 address, and its program is read
+ * with `programOf`. Every other value is left as it is.
+ */
+export declare function resolveTokenAccounts(given: Readonly<Record<string, string>>, owner: Address, pot: Address, chain: CanonicalChain, via?: "kitchen" | "engine", programOf?: MintProgramOf): Promise<{
+    readonly accounts: Record<string, string>;
+    readonly named: ReadonlyMap<string, TokenAccountNamed>;
+}>;
+export interface SvmTarget extends SaltChoice {
+    readonly owner: Address;
+}
+/** Whether the Kitchen has created `target`'s Pot on the cluster `rpcUrl` serves. */
+export declare function svmPotExists(target: SvmTarget, rpcUrl: string): Promise<boolean>;
+/** The Pot's associated token account for one registered mint, and what it holds. */
+export interface SvmPotTokenAccount {
+    readonly symbol: string;
+    readonly mint: string;
+    readonly decimals: number;
+    /** The token program that owns the mint: legacy SPL Token or Token-2022. */
+    readonly tokenProgram: Address;
+    /** The associated token account of the Pot for the mint, under its token program. */
+    readonly account: Address;
+    readonly exists: boolean;
+    /** Base units, as a decimal string; `null` while the account does not exist. */
+    readonly balance: string | null;
+}
+/**
+ * The Pot's associated token account for every mint the chain's cluster registers — each under the
+ * token program its row records — whether it exists, and its balance.
+ */
+export declare function svmPotTokenAccounts(target: SvmTarget, rpcUrl: string, chain: CanonicalChain): Promise<readonly SvmPotTokenAccount[]>;
+export interface SvmCookInput extends ProgramInput, SvmTarget {
+    readonly accounts: Readonly<Record<string, string>>;
+    readonly args?: ArgsInput;
+    readonly rpcUrl: string;
+    /**
+     * How the cook reaches the engine (`--via`): `kitchen`, the default, is the Kitchen's `cook` on
+     * the owner's Pot; `engine` is the engine's own paid `cookAndPay`, with no Kitchen and no Pot, the
+     * owner signing as the authority the program acts with.
+     */
+    readonly via?: CookVia;
+    /**
+     * The most the cook may pay in execution fee, in lamports (`--max-execution-fee`): with a fee
+     * above it the command refuses before signing or sending anything. Either way the cook signs the
+     * fee it read as its `max_execution_fee`, so it pays that or, if the fee rises first, fails.
+     */
+    readonly maxExecutionFee?: bigint;
+}
+/** Whether a cook fits one transaction, measured without a cluster. */
+export interface SvmCookSize {
+    /** The cook measured: through the Kitchen, or direct to the engine. */
+    readonly via: CookVia;
+    readonly size: number;
+    readonly limit: number;
+    readonly fits: boolean;
+    /** The slots measured with a placeholder: no `--account` named them. */
+    readonly assumed: readonly string[];
+    /** The program reads accounts after its named ones, which add to the size. */
+    readonly remaining: boolean;
+}
+/**
+ * The size of the cook that carries `bytecode` inline, offline: the transaction `run` sends (heap
+ * frame, compute-unit limit, the Kitchen's `cook` — or `via` engine, the engine's `cookAndPay`) for
+ * `manifest`, with each account `--account` gives where it is given — `pot` and `owner` are the
+ * cook's own — and a distinct account for every other slot, so a size is the most those slots can
+ * make it. The blockhash and signature are fixed widths, so a placeholder of each measures the same.
+ */
+export declare function svmCookSize(bytecode: Uint8Array, manifest: AccountManifest, given: Readonly<Record<string, string>>, via?: CookVia): Promise<SvmCookSize>;
+/**
+ * `sauce simulate` on Solana: the cook, simulated from the Pot's owner with no key — and, for a
+ * Pot the Kitchen has not created yet, its `create_pot` first, in the same transaction. Directly to
+ * the engine (`via` engine) there is no Pot to create: the owner is the signer, and pays.
+ */
+export declare function svmSimulateCommand(input: SvmCookInput, files: CliFiles): Promise<CommandOutput>;
+/** `sauce tx` on Solana: the cook as an unsigned, serialized transaction for a wallet. */
+export declare function svmTxCommand(input: SvmCookInput, files: CliFiles): Promise<CommandOutput>;
+export interface SvmRunInput extends SvmCookInput {
+    readonly signer: KeyPairSigner;
+    readonly approver: Approver;
+}
+/** `sauce run` on Solana: compile, create the Pot if agreed, stage if needed, cook, confirm. */
+export declare function svmRunCommand(input: SvmRunInput, files: CliFiles): Promise<CommandOutput>;
+export interface SvmVerifyInput {
+    readonly signature: string;
+    readonly rpcUrl: string;
+    /** What the settle must enforce: both are compiled into an SVM settle, so a recompile pins them. */
+    readonly minOut: bigint;
+    readonly splCount: bigint;
+}
+/**
+ * `sauce verify --chain solana <signature>`: the engine invocation a cook made, checked by the
+ * SDK's `verifySvmSettleExecution` against the settle program recompiled for `minOut` and
+ * `splCount`. A rejection exits 1: `TX_FAILED` when the transaction failed, `NO_SETTLE` when it
+ * invokes no released engine or not with a settle's accounts, `NOT_GENUINE` with the SDK's reason
+ * otherwise.
+ */
+export declare function svmVerifyCommand(input: SvmVerifyInput): Promise<CommandOutput>;
+/** `sauce pot --chain solana`: the Pot PDA an owner and salt give, and its create instruction. */
+export declare function svmPotCommand(target: SvmTarget): Promise<CommandOutput>;
+/** `sauce pot --chain solana` with an endpoint: the prediction, and what the cluster has. */
+export declare function svmPotStatusCommand(target: SvmTarget & {
+    readonly rpcUrl: string;
+}): Promise<CommandOutput>;
+/** `sauce pot --deploy --chain solana`: creates the signer's Pot unless it is already there. */
+export declare function svmPotDeployCommand(target: SvmTarget & {
+    readonly rpcUrl: string;
+    readonly signer: KeyPairSigner;
+}): Promise<CommandOutput>;
+export {};
+//# sourceMappingURL=solana.d.ts.map

package/sdk/dist/cli/solana.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/cli/solana.ts"],"names":[],"mappings":"AAiBA,OAAO,EAGL,eAAe,EAaf,KAAK,OAAO,EAGZ,KAAK,aAAa,EAMnB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,OAAO,EAAgB,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAY3E,OAAO,EA2BL,KAAK,OAAO,EAIb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAwB,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAKL,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,YAAY,EAClB,MAAM,eAAe,CAAC;AAiBvB,yEAAyE;AACzE,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAM9D;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,CAkCvF;AAgBD,KAAK,GAAG,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAyC9C,yFAAyF;AACzF,eAAO,MAAM,YAAY;;;CAA+B,CAAC;AAEzD;;;;;GAKG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAiB,GACxE,OAAO,CAAC,IAAI,CAAC,CAUf;AAiFD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,UAAU,CAAC,EAAE,UAAU,GACtB,MAAM,CA6CR;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,oDAAoD;IACpD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB;AAoFD;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,EACrB,EAAE,EAAE;IAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACrF,OAAO,CAAC,OAAO,CAAC,CAuBlB;AAiDD,sHAAsH;AACtH,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAuB7E;AAED,kGAAkG;AAClG,UAAU,iBAAiB;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,mGAAmG;IACnG,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;CAC/C;AAED,8FAA8F;AAC9F,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAqBhE;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EACvC,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,cAAc,EACrB,GAAG,GAAE,SAAS,GAAG,QAAoB,EACrC,SAAS,GAAE,aAA4C,GACtD,OAAO,CAAC;IACT,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CACxD,CAAC,CAyDD;AAuDD,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAOD,qFAAqF;AACrF,wBAAsB,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEtF;AAED,qFAAqF;AACrF,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,4EAA4E;IAC5E,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,qFAAqF;IACrF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,gFAAgF;IAChF,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,SAAS,kBAAkB,EAAE,CAAC,CAyBxC;AAuJD,MAAM,WAAW,YAAa,SAAQ,YAAY,EAAE,SAAS;IAC3D,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;CACnC;AA4FD,uEAAuE;AACvE,MAAM,WAAW,WAAW;IAC1B,uEAAuE;IACvE,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,wEAAwE;IACxE,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,8EAA8E;IAC9E,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,UAAU,EACpB,QAAQ,EAAE,eAAe,EACzB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EACvC,GAAG,GAAE,OAAmB,GACvB,OAAO,CAAC,WAAW,CAAC,CAyEtB;AAyDD;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,QAAQ,GACd,OAAO,CAAC,aAAa,CAAC,CAmIxB;AAED,0FAA0F;AAC1F,wBAAsB,YAAY,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,CAuC/F;AAsHD,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B;AA+CD,gGAAgG;AAChG,wBAAsB,aAAa,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,CAiG/F;AA4BD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,oGAAoG;IACpG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CA+EpF;AAQD,kGAAkG;AAClG,wBAAsB,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,CA4B7E;AA6CD,6FAA6F;AAC7F,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,SAAS,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC9C,OAAO,CAAC,aAAa,CAAC,CAmBxB;AAED,gGAAgG;AAChG,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,SAAS,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;CAAE,GAC9E,OAAO,CAAC,aAAa,CAAC,CA8BxB"}