@bitgo-beta/sdk-coin-iota 1.0.1-beta.324 → 1.0.1-beta.325

package/dist/src/lib/transaction.d.ts

@@ -2,9 +2,11 @@ import { BaseKey, BaseTransaction, PublicKey, TransactionType } from '@bitgo-bet
 import { BaseCoin as CoinConfig } from '@bitgo-beta/statics';
 import { Transaction as IotaTransaction } from '@iota/iota-sdk/transactions';
 import { TxData, TransactionObjectInput, TransactionExplanation } from './iface';
+/**
+ * Base class for IOTA transactions.
+ * Manages transaction state, gas data, signatures, and building/serialization.
+ */
 export declare abstract class Transaction extends BaseTransaction {
-    static EMPTY_PUBLIC_KEY: Buffer<ArrayBuffer>;
-    static EMPTY_SIGNATURE: Buffer<ArrayBuffer>;
     protected _rebuildRequired: boolean;
     protected _type: TransactionType;
     protected _iotaTransaction: IotaTransaction;
@@ -13,12 +15,12 @@ export declare abstract class Transaction extends BaseTransaction {
     private _gasPrice?;
     private _gasSponsor?;
     private _sender;
+    private _txDataBytes?;
+    private _isSimulateTx;
     private _signature?;
     private _serializedSignature?;
     private _gasSponsorSignature?;
     private _serializedGasSponsorSignature?;
-    private _txDataBytes?;
-    private _isSimulateTx;
     protected constructor(coinConfig: Readonly<CoinConfig>);
     get gasBudget(): number | undefined;
     set gasBudget(value: number | undefined);
@@ -30,46 +32,147 @@ export declare abstract class Transaction extends BaseTransaction {
     set gasSponsor(value: string | undefined);
     get sender(): string;
     set sender(value: string);
+    /**
+     * Indicates whether this is a simulate transaction (dry run) or a real transaction.
+     * Simulate transactions use maximum gas values for estimation purposes.
+     */
     get isSimulateTx(): boolean;
     set isSimulateTx(value: boolean);
+    /**
+     * Marks that the transaction needs to be rebuilt before it can be signed or broadcast.
+     */
+    private markRebuildRequired;
+    /**
+     * Validates transaction data when switching from simulate to real transaction mode.
+     */
+    private validateTxDataForRealTransaction;
+    /**
+     * Returns the signable payload for this transaction.
+     * This is the Blake2b hash of the transaction data with intent message.
+     * @throws Error if transaction is in simulate mode or not built
+     */
     get signablePayload(): Buffer;
-    /** @inheritDoc **/
+    /**
+     * Returns the transaction digest (ID).
+     * @throws Error if transaction is not built or needs rebuilding
+     */
     get id(): string;
+    /**
+     * Ensures the transaction is built and doesn't need rebuilding.
+     * @throws Error if transaction is not built or rebuild is required
+     */
+    private ensureTransactionIsBuilt;
+    /**
+     * Adds a signature from the transaction sender.
+     */
     addSignature(publicKey: PublicKey, signature: Buffer): void;
+    /**
+     * Adds a signature from the gas sponsor (if different from sender).
+     */
     addGasSponsorSignature(publicKey: PublicKey, signature: Buffer): void;
+    /**
+     * Checks if this transaction can be signed.
+     * Only real transactions (not simulate) can be signed.
+     */
     canSign(_key: BaseKey): boolean;
+    /**
+     * Returns the transaction fee (gas budget).
+     */
     getFee(): string | undefined;
     get serializedGasSponsorSignature(): string | undefined;
     get serializedSignature(): string | undefined;
+    /**
+     * Serializes all signatures for the transaction.
+     * Includes both sender signature and gas sponsor signature if present.
+     */
     serializeSignatures(): void;
+    /**
+     * Converts the transaction to broadcast format (base64 encoded).
+     */
     toBroadcastFormat(): Promise<string>;
+    /**
+     * Builds the transaction bytes.
+     * If in simulate mode, builds a dry run transaction with max gas values.
+     * Otherwise, builds a real transaction with actual gas data.
+     */
     build(): Promise<Uint8Array<ArrayBufferLike>>;
     toJson(): TxData;
     parseFromJSON(txData: TxData): void;
+    /**
+     * Parses transaction data from its broadcast format (base64 or raw bytes).
+     * Extracts sender, gas data, and gas sponsor information.
+     */
     parseFromBroadcastTx(tx: string | Uint8Array): void;
+    /**
+     * Parses the sender address from transaction data.
+     */
+    private parseSender;
+    /**
+     * Parses gas-related data from transaction data.
+     */
+    private parseGasData;
     /**
      * @inheritDoc
      */
     explainTransaction(): any;
+    /**
+     * Updates the simulate transaction flag based on gas data availability.
+     * If all gas data is present, switches to real transaction mode.
+     */
     protected updateIsSimulateTx(): void;
     protected abstract messageWithIntent(message: Uint8Array): Uint8Array;
     protected abstract populateTxInputsAndCommands(): void;
     protected abstract validateTxDataImplementation(): void;
-    /**
-     * Add the input and output entries for this transaction.
-     */
     abstract addInputsAndOutputs(): void;
+    protected abstract explainTransactionImplementation(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation;
     /**
-     * Returns a complete explanation for a transfer transaction
-     * @param {TxData} json The transaction data in json format
-     * @param {TransactionExplanation} explanationResult The transaction explanation to be completed
-     * @returns {TransactionExplanation}
+     * Builds a dry run (simulate) transaction with maximum gas values.
+     * Used for gas estimation without committing the transaction.
      */
-    protected abstract explainTransactionImplementation(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation;
     private buildDryRunTransaction;
-    private buildTransaction;
+    /**
+     * Builds a real transaction with actual gas data.
+     * Only builds if necessary (first time or rebuild required).
+     */
+    private buildRealTransaction;
+    /**
+     * Sets gas data on the IOTA transaction object.
+     */
+    private setGasDataOnTransaction;
+    /**
+     * Populates the IOTA transaction with inputs, commands, and gas sponsor if applicable.
+     */
     private populateTxData;
+    /**
+     * Checks if the transaction has a gas sponsor different from the sender.
+     */
+    private hasDifferentGasSponsor;
+    /**
+     * Sets up a gas-sponsored transaction by building the transaction kind
+     * and setting the gas owner.
+     */
+    private setupGasSponsoredTransaction;
+    /**
+     * Serializes a signature into IOTA's expected format.
+     * Format: [signature_scheme_flag (1 byte), signature, public_key]
+     * Currently hardcoded to EDDSA (0x00) as IOTA only supports this scheme.
+     */
     private serializeSignature;
+    /**
+     * Validates all transaction data required for a real (non-simulate) transaction.
+     */
     private validateTxData;
+    /**
+     * Validates common transaction data (sender, gas data).
+     */
+    private validateCommonTxData;
+    /**
+     * Validates sender and gas sponsor signatures if present.
+     */
+    private validateSignatures;
+    /**
+     * Checks if a signature has valid public key and signature data.
+     */
+    private isValidSignature;
 }
 //# sourceMappingURL=transaction.d.ts.map

package/dist/src/lib/transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../src/lib/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,eAAe,EAEf,SAAS,EAGT,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAEL,WAAW,IAAI,eAAe,EAE/B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAYjF,8BAAsB,WAAY,SAAQ,eAAe;IACvD,MAAM,CAAC,gBAAgB,sBAAuC;IAC9D,MAAM,CAAC,eAAe,sBAAuC;IAE7D,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACpC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC;IACjC,SAAS,CAAC,gBAAgB,EAAE,eAAe,CAAC;IAE5C,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,kBAAkB,CAAC,CAA2B;IACtD,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,WAAW,CAAC,CAAS;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAS;IACtC,OAAO,CAAC,oBAAoB,CAAC,CAAY;IACzC,OAAO,CAAC,8BAA8B,CAAC,CAAS;IAChD,OAAO,CAAC,YAAY,CAAC,CAA8B;IACnD,OAAO,CAAC,aAAa,CAAU;IAE/B,SAAS,aAAa,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IAOtD,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAGtC;IAED,IAAI,iBAAiB,IAAI,sBAAsB,EAAE,GAAG,SAAS,CAE5D;IAED,IAAI,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,SAAS,EAGhE;IAED,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAGrC;IAED,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAGvC;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAGvB;IAED,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,EAW9B;IAED,IAAI,eAAe,IAAI,MAAM,CAS5B;IAED,mBAAmB;IACnB,IAAI,EAAE,IAAI,MAAM,CAKf;IAED,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAI3D,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAIrE,OAAO,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO;IAI/B,MAAM,IAAI,MAAM,GAAG,SAAS;IAI5B,IAAI,6BAA6B,IAAI,MAAM,GAAG,SAAS,CAEtD;IAED,IAAI,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAE5C;IAED,mBAAmB,IAAI,IAAI;IAYrB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAKpC,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAOnD,MAAM,IAAI,MAAM;IAWhB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAUnC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IA2BnD;;OAEG;IACH,kBAAkB,IAAI,GAAG;IAqBzB,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAQpC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU;IACrE,SAAS,CAAC,QAAQ,CAAC,2BAA2B,IAAI,IAAI;IACtD,SAAS,CAAC,QAAQ,CAAC,4BAA4B,IAAI,IAAI;IAEvD;;OAEG;IACH,QAAQ,CAAC,mBAAmB,IAAI,IAAI;IAEpC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,gCAAgC,CACjD,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,sBAAsB,GACxC,sBAAsB;YAEX,sBAAsB;YAetB,gBAAgB;YAgBhB,cAAc;IAY5B,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,cAAc;CAsCvB"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../src/lib/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,eAAe,EAEf,SAAS,EAGT,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAEL,WAAW,IAAI,eAAe,EAE/B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAMjF;;;GAGG;AACH,8BAAsB,WAAY,SAAQ,eAAe;IAEvD,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACpC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC;IACjC,SAAS,CAAC,gBAAgB,EAAE,eAAe,CAAC;IAG5C,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,kBAAkB,CAAC,CAA2B;IACtD,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,WAAW,CAAC,CAAS;IAG7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAC,CAA8B;IACnD,OAAO,CAAC,aAAa,CAAU;IAG/B,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAS;IACtC,OAAO,CAAC,oBAAoB,CAAC,CAAY;IACzC,OAAO,CAAC,8BAA8B,CAAC,CAAS;IAEhD,SAAS,aAAa,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IAQtD,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAGtC;IAGD,IAAI,iBAAiB,IAAI,sBAAsB,EAAE,GAAG,SAAS,CAE5D;IAED,IAAI,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,SAAS,EAGhE;IAGD,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAGrC;IAGD,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAGvC;IAGD,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAGvB;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,EAM9B;IAED;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;OAEG;IACH,OAAO,CAAC,gCAAgC;IASxC;;;;OAIG;IACH,IAAI,eAAe,IAAI,MAAM,CAQ5B;IAED;;;OAGG;IACH,IAAI,EAAE,IAAI,MAAM,CAGf;IAED;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAMhC;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAI3D;;OAEG;IACH,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAIrE;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO;IAI/B;;OAEG;IACH,MAAM,IAAI,MAAM,GAAG,SAAS;IAI5B,IAAI,6BAA6B,IAAI,MAAM,GAAG,SAAS,CAEtD;IAED,IAAI,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAE5C;IAED;;;OAGG;IACH,mBAAmB,IAAI,IAAI;IAc3B;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAK1C;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAOnD,MAAM,IAAI,MAAM;IAWhB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAUnC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAOnD;;OAEG;IACH,OAAO,CAAC,WAAW;IAMnB;;OAEG;IACH,OAAO,CAAC,YAAY;IAsBpB;;OAEG;IACH,kBAAkB,IAAI,GAAG;IAqBzB;;;OAGG;IACH,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAQpC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU;IACrE,SAAS,CAAC,QAAQ,CAAC,2BAA2B,IAAI,IAAI;IACtD,SAAS,CAAC,QAAQ,CAAC,4BAA4B,IAAI,IAAI;IACvD,QAAQ,CAAC,mBAAmB,IAAI,IAAI;IACpC,SAAS,CAAC,QAAQ,CAAC,gCAAgC,CACjD,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,sBAAsB,GACxC,sBAAsB;IAEzB;;;OAGG;YACW,sBAAsB;IAgBpC;;;OAGG;YACW,oBAAoB;IAalC;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAQ/B;;OAEG;YACW,cAAc;IAY5B;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAI9B;;;OAGG;YACW,4BAA4B;IAM1C;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAY1B;;OAEG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAkB5B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;OAEG;IACH,OAAO,CAAC,gBAAgB;CAGzB"}