@bitgo-beta/sdk-coin-sol 7.6.4-beta.723 → 7.6.4-beta.725

package/dist/cjs/src/lib/v1TransactionBuilder.d.ts

@@ -0,0 +1,197 @@
+import BigNumber from 'bignumber.js';
+import { BaseCoin as CoinConfig } from '@bitgo-beta/statics';
+import { BaseAddress, BaseKey, BaseTransactionBuilder, FeeOptions, PublicKey as BasePublicKey, SolV1TransactionConfig, TransactionType } from '@bitgo-beta/sdk-core';
+import { TransactionInstruction } from '@solana/web3.js';
+import { Transaction } from './transaction';
+import { InstructionParams, Nonce } from './iface';
+/**
+ * Construct an AdvanceNonceAccount instruction for a durable nonce.
+ *
+ * The v0 path receives this instruction from web3.js / the Rust wasm core
+ * (`NonceSource` durable variant); the v1 path compiles via
+ * `compileTransactionMessage`, so the nonce instruction must be constructed in
+ * TypeScript and injected into the compile input. The nonce authority
+ * (`authWalletAddress`) MUST sign the instruction — it becomes a required
+ * signer of the compiled message.
+ *
+ * @param nonceAddress - the durable nonce account address
+ * @param authWalletAddress - the nonce authority (gas-tank root in BitGo's model)
+ * @returns the AdvanceNonceAccount instruction
+ */
+export declare function buildAdvanceNonceAccountInstruction(nonceAddress: string, authWalletAddress: string): TransactionInstruction;
+/**
+ * Base builder for Solana v1 (SIMD-0296/0385) transactions.
+ *
+ * Parallel to the v0 {@link TransactionBuilder}, which is bound to a
+ * `@solana/web3.js` v0 `Transaction` and cannot emit a v1 wire. This builder
+ * owns the v1 assembly:
+ *
+ * - intent-to-instruction derivation via the shared `solInstructionFactory`
+ *   (same `InstructionParams` representation as the v0 flows)
+ * - durable nonce: `AdvanceNonceAccount` instruction injection (first) plus the
+ *   nonce hash in the blockhash field
+ * - transaction config (compute unit limit, heap size, loaded accounts data
+ *   size limit, priority fee as total lamports)
+ * - signer management: private-key signers (`sign`) and external signatures
+ *   (`addSignature`), assembled in message-signer order
+ * - message compile via `compileTransactionMessage` and signed wire via
+ *   `serializeWireTransaction`
+ *
+ * Signature assembly is in message-signer order (fee payer first, then the
+ * remaining signers in the compiled account order), NOT insertion order —
+ * required for multi-signer v1 transactions such as durable-nonce CT
+ * (user + gas-tank nonce authority). Missing signatures are zero-filled in
+ * their slots so the wire shape stays valid for partial-sign flows; the
+ * broadcastable wire is only produced once every required signer has a
+ * signature.
+ */
+export declare abstract class V1TransactionBuilder extends BaseTransactionBuilder {
+    protected _transaction: Transaction;
+    private _instructionsData;
+    private _extraInstructions;
+    private _signers;
+    private _signatures;
+    private _lamportsPerSignature;
+    protected _sender: string;
+    protected _feePayer?: string;
+    protected _recentBlockhash: string;
+    protected _nonceInfo?: Nonce;
+    protected _memo?: string;
+    protected _transactionConfig?: SolV1TransactionConfig;
+    /** Optional override for the zk-elgamal-proof program id (used by CT instruction builders) */
+    protected _zkProofProgramId?: string;
+    constructor(_coinConfig: Readonly<CoinConfig>);
+    /**
+     * The transaction type.
+     */
+    protected abstract get transactionType(): TransactionType;
+    /** @inheritdoc */
+    protected buildImplementation(): Promise<Transaction>;
+    /**
+     * Assemble the v1 transaction: derive instructions, inject the durable-nonce
+     * instruction when present, compile the message, and assemble the signed
+     * wire in message-signer order.
+     *
+     * @returns {Transaction} The built transaction holding the v1 message and wire bytes
+     */
+    private buildV1;
+    /** @inheritdoc */
+    protected fromImplementation(rawTransaction: string): Transaction;
+    /** @inheritdoc */
+    protected get transaction(): Transaction;
+    /** @inheritdoc */
+    protected set transaction(transaction: Transaction);
+    /** @inheritdoc */
+    protected signImplementation(key: BaseKey): Transaction;
+    /** @inheritDoc */
+    addSignature(publicKey: BasePublicKey, signature: Buffer): void;
+    /**
+     * Sets the sender of this transaction.
+     * This account will be responsible for paying transaction fees.
+     *
+     * @param {string} senderAddress the account that is sending this transaction
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    sender(senderAddress: string): this;
+    /**
+     * Set the transaction nonce.
+     * Requires both optional params in order to use the durable nonce.
+     *
+     * @param {string} blockHash The latest blockHash or the durable nonce hash
+     * @param {DurableNonceParams} [durableNonceParams] An object containing the walletNonceAddress and the authWalletAddress (required for durable nonce)
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    nonce(blockHash: string, durableNonceParams?: {
+        walletNonceAddress: string;
+        authWalletAddress: string;
+    }): this;
+    /**
+     * Set the intent instructions to build, using the shared instruction params
+     * representation consumed by `solInstructionFactory` (same as the v0 flows).
+     *
+     * @param {InstructionParams[]} instructions the instruction params
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    instructions(instructions: InstructionParams[]): this;
+    /**
+     * Append a pre-built instruction (e.g. an envelope-derived instruction or a
+     * custom instruction) to the transaction.
+     *
+     * @param {TransactionInstruction} instruction the instruction to append
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    addInstruction(instruction: TransactionInstruction): this;
+    /**
+     * Set the v1 transaction config (compute unit limit, heap size, loaded
+     * accounts data size limit, and priority fee as total lamports). Required
+     * before building.
+     *
+     * @param {SolV1TransactionConfig} config the v1 transaction config
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    transactionConfig(config: SolV1TransactionConfig): this;
+    /**
+     * Set the priority fee (total lamports) on the v1 transaction config.
+     *
+     * @param {FeeOptions} feeOptions the priority fee
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    setPriorityFee(feeOptions: FeeOptions): this;
+    /**
+     * Set the fee (lamports per signature) for fee estimation.
+     *
+     * @param {FeeOptions} feeOptions the fee
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    fee(feeOptions: FeeOptions): this;
+    feePayer(feePayer: string): this;
+    /**
+     * Set the memo.
+     *
+     * @param {string} memo
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    memo(memo: string): this;
+    /**
+     * Override the zk-elgamal-proof program id.
+     *
+     * Defaults to the canonical on-chain program id (`ZkE1Gama1Proof111...`)
+     * which is the same across mainnet, devnet, and testnet. Override only
+     * when targeting a custom deployment.
+     *
+     * @param {string} programId base58 encoded program id
+     * @returns {V1TransactionBuilder} This transaction builder
+     */
+    zkProofProgramId(programId: string): this;
+    /** @inheritdoc */
+    validateAddress(address: BaseAddress, addressFormat?: string): void;
+    /** @inheritdoc */
+    validateKey(key: BaseKey): void;
+    /** @inheritdoc */
+    validateRawTransaction(rawTransaction: string): void;
+    /** @inheritdoc */
+    validateTransaction(transaction?: Transaction): void;
+    /** @inheritdoc */
+    validateValue(value: BigNumber): void;
+    /**
+     * Validates the memo.
+     *
+     * @param {string} memo - the memo as string
+     */
+    validateMemo(memo: string): void;
+    /**
+     * Validates that the given key is not already in this._signers.
+     *
+     * @param {BaseKey} key - The key to check
+     */
+    private checkDuplicatedSigner;
+    /**
+     * Validates that the sender field is defined.
+     */
+    private validateSender;
+    /**
+     * Validates that the nonce field is defined.
+     */
+    private validateNonce;
+}
+//# sourceMappingURL=v1TransactionBuilder.d.ts.map

package/dist/cjs/src/lib/v1TransactionBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1TransactionBuilder.d.ts","sourceRoot":"","sources":["../../../../src/lib/v1TransactionBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EACL,WAAW,EACX,OAAO,EACP,sBAAsB,EAEtB,UAAU,EACV,SAAS,IAAI,aAAa,EAE1B,sBAAsB,EACtB,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAA2D,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAGlH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,iBAAiB,EAAQ,KAAK,EAAE,MAAM,SAAS,CAAC;AASzD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mCAAmC,CACjD,YAAY,EAAE,MAAM,EACpB,iBAAiB,EAAE,MAAM,GACxB,sBAAsB,CAOxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,8BAAsB,oBAAqB,SAAQ,sBAAsB;IACvE,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC;IACpC,OAAO,CAAC,iBAAiB,CAA2B;IACpD,OAAO,CAAC,kBAAkB,CAAgC;IAC1D,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,qBAAqB,CAAS;IAEtC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;IACtD,8FAA8F;IAC9F,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAEzB,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC;IAK7C;;OAEG;IACH,SAAS,CAAC,QAAQ,KAAK,eAAe,IAAI,eAAe,CAAC;IAE1D,kBAAkB;cACF,mBAAmB,IAAI,OAAO,CAAC,WAAW,CAAC;IAI3D;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAmGf,kBAAkB;IAClB,SAAS,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,WAAW;IAqCjE,kBAAkB;IAClB,SAAS,KAAK,WAAW,IAAI,WAAW,CAEvC;IAED,kBAAkB;IAClB,SAAS,KAAK,WAAW,CAAC,WAAW,EAAE,WAAW,EAEjD;IAED,kBAAkB;IAClB,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,WAAW;IAUvD,kBAAkB;IAClB,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAI/D;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAMnC;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE;QAAE,kBAAkB,EAAE,MAAM,CAAC;QAAC,iBAAiB,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAmB9G;;;;;;OAMG;IACH,YAAY,CAAC,YAAY,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAKrD;;;;;;OAMG;IACH,cAAc,CAAC,WAAW,EAAE,sBAAsB,GAAG,IAAI;IAKzD;;;;;;;OAOG;IACH,iBAAiB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAKvD;;;;;OAKG;IACH,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAa5C;;;;;OAKG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKhC;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMxB;;;;;;;;;OASG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAQzC,kBAAkB;IAClB,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAMnE,kBAAkB;IAClB,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAa/B,kBAAkB;IAClB,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAWpD,kBAAkB;IAClB,mBAAmB,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI;IAKpD,kBAAkB;IAClB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAMrC;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAShC;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAQ7B;;OAEG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,aAAa;CAMtB"}