@bitgo-beta/sdk-coin-sol 7.6.4-beta.78 → 7.6.4-beta.781

package/dist/esm/lib/transactionBuilder.d.ts

@@ -0,0 +1,169 @@
+import BigNumber from 'bignumber.js';
+import { BaseCoin as CoinConfig } from '@bitgo-beta/statics';
+import { BaseAddress, BaseKey, BaseTransactionBuilder, FeeOptions, PublicKey as BasePublicKey, Signature, TransactionType } from '@bitgo-beta/sdk-core';
+import { Transaction } from './transaction';
+import { Blockhash, Transaction as SolTransaction, VersionedTransaction } from '@solana/web3.js';
+import { KeyPair } from '.';
+import { DurableNonceParams, InstructionParams, Nonce } from './iface';
+export declare abstract class TransactionBuilder extends BaseTransactionBuilder {
+    protected _transaction: Transaction;
+    private _signatures;
+    private _lamportsPerSignature;
+    private _tokenAccountRentExemptAmount;
+    protected _sender: string;
+    protected _recentBlockhash: Blockhash;
+    protected _nonceInfo: Nonce;
+    protected _instructionsData: InstructionParams[];
+    protected _signers: KeyPair[];
+    protected _memo?: string;
+    protected _feePayer?: string;
+    protected _priorityFee: number;
+    /** Explicit compute-unit limit requested for the transaction, in compute units */
+    protected _computeUnitLimit?: number;
+    /** 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;
+    /**
+     * Initialize the transaction builder fields using the decoded transaction data
+     *
+     * @param {Transaction} tx the transaction data
+     */
+    initBuilder(tx: Transaction): void;
+    /** @inheritdoc */
+    protected fromImplementation(rawTransaction: string): Transaction;
+    /** @inheritdoc */
+    protected buildImplementation(): Promise<Transaction>;
+    /**
+     * Builds the solana transaction.
+     */
+    protected buildSolTransaction(): SolTransaction | VersionedTransaction;
+    /**
+     * Builds a legacy Solana transaction.
+     */
+    private buildLegacyTransaction;
+    /**
+     * Builds a VersionedTransaction.
+     *
+     * @returns {VersionedTransaction} The built versioned transaction
+     */
+    private buildVersionedTransaction;
+    /**
+     * Build a VersionedTransaction from deconstructed VersionedTransactionData
+     * @param data The versioned transaction data
+     * @returns The built versioned transaction
+     */
+    private buildFromVersionedData;
+    /** @inheritdoc */
+    protected get transaction(): Transaction;
+    /** @inheritdoc */
+    protected set transaction(transaction: Transaction);
+    /** @inheritdoc */
+    protected signImplementation(key: BaseKey): Transaction;
+    /** @inheritDoc */
+    addSignature(publicKey: BasePublicKey, signature: Buffer): void;
+    /**
+     * Get the externally-added signatures (via addSignature) in order.
+     *
+     * @returns {Signature[]} The list of external signatures
+     */
+    protected getAdditionalSignatures(): Signature[];
+    /**
+     * Add a signature produced by the fee payer of the transaction being built.
+     * The fee payer is account 0 of the transaction message, so its signature belongs in slot 0.
+     * Use this for signatures produced by the enterprise fee address key (HSM single-sig) of a
+     * sponsored transaction; the key must match account 0.
+     *
+     * @param {BasePublicKey} publicKey The public key of the fee payer; must be account 0 of the message
+     * @param {Buffer} signature The signature of the transaction payload
+     */
+    addFeePayerSignature(publicKey: BasePublicKey, signature: Buffer): void;
+    /**
+     * The account 0 key of the message being built, i.e. the fee payer: the first static account
+     * key of a versioned transaction, or the fee payer of a legacy transaction.
+     */
+    private getFeePayerAccountKey;
+    /**
+     * 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 {TransactionBuilder} This transaction builder
+     */
+    sender(senderAddress: string): this;
+    /**
+     * Set the transaction nonce
+     * Requires both optional params in order to use the durable nonce
+     *
+     * @param {Blockhash} blockHash The latest blockHash
+     * @param {DurableNonceParams} [durableNonceParams] An object containing the walletNonceAddress and the authWalletAddress (required for durable nonce)
+     * @returns {TransactionBuilder} This transaction builder
+     */
+    nonce(blockHash: Blockhash, durableNonceParams?: DurableNonceParams): this;
+    /**
+     *  Set the memo
+     *
+     * @param {string} memo
+     * @returns {TransactionBuilder} This transaction builder
+     */
+    memo(memo: string): this;
+    fee(feeOptions: FeeOptions): this;
+    setPriorityFee(feeOptions: FeeOptions): this;
+    /**
+     * Set an explicit compute-unit limit for this transaction.
+     *
+     * The priority fee is charged on the requested compute-unit limit rather than the
+     * units actually consumed, so every sponsored transaction must set an intent-sized
+     * limit. When set, the built transaction prepends a SetComputeUnitLimit instruction
+     * ahead of all other instructions (after the durable-nonce AdvanceNonceAccount):
+     * [AdvanceNonce?, SetComputeUnitLimit, SetComputeUnitPrice?, ...]. When unset, the
+     * built transaction bytes are unchanged.
+     *
+     * @param {number} units the requested compute-unit limit, an integer between
+     * 1 and 1,400,000 (the on-chain per-transaction maximum)
+     * @returns {TransactionBuilder} This transaction builder
+     */
+    setComputeUnitLimit(units: number): this;
+    private validateComputeUnitLimit;
+    feePayer(feePayer: string): this;
+    /**
+     * Used to set the minimum rent exempt amount for an ATA
+     *
+     * @param tokenAccountRentExemptAmount minimum rent exempt amount in lamports
+     */
+    associatedTokenAccountRent(tokenAccountRentExemptAmount: string): this;
+    private validateRentExemptAmount;
+    /** @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=transactionBuilder.d.ts.map

package/dist/esm/lib/transactionBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionBuilder.d.ts","sourceRoot":"","sources":["../../../src/lib/transactionBuilder.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,EAC1B,SAAS,EAGT,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EACL,SAAS,EAIT,WAAW,IAAI,cAAc,EAC7B,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAUzB,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC;AAI5B,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EAEjB,KAAK,EAIN,MAAM,SAAS,CAAC;AAGjB,8BAAsB,kBAAmB,SAAQ,sBAAsB;IACrE,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC;IACpC,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,6BAA6B,CAAS;IAE9C,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,gBAAgB,EAAE,SAAS,CAAC;IACtC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC;IAC5B,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,CAAM;IACtD,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAM;IACnC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,kFAAkF;IAClF,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,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;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,WAAW,GAAG,IAAI;IAsDlC,kBAAkB;IAClB,SAAS,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,WAAW;IAQjE,kBAAkB;cACF,mBAAmB,IAAI,OAAO,CAAC,WAAW,CAAC;IAgB3D;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,cAAc,GAAG,oBAAoB;IAYtE;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAqE9B;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IA0BjC;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAqC9B,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;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,IAAI,SAAS,EAAE;IAIhD;;;;;;;;OAQG;IACH,oBAAoB,CAAC,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAOvE;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAQ7B;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAMnC;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,IAAI;IAmB1E;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMxB,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAK1B,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKnD;;;;;;;;;;;;;OAaG;IACI,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM/C,OAAO,CAAC,wBAAwB;IAQhC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKhC;;;;OAIG;IACH,0BAA0B,CAAC,4BAA4B,EAAE,MAAM,GAAG,IAAI;IAMtE,OAAO,CAAC,wBAAwB;IAUhC,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;IAIpD,kBAAkB;IAClB,mBAAmB,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI;IAMpD,kBAAkB;IAClB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAKrC;;;OAGG;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"}