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

package/dist/src/iota.d.ts

@@ -1,69 +1,165 @@
 import { AuditDecryptedKeyParams, BaseCoin, BitGoBase, KeyPair, ParsedTransaction, SignTransactionOptions, SignedTransaction, VerifyTransactionOptions, MultisigType, MPCAlgorithm, TssVerifyAddressOptions, PopulatedIntent, PrebuildTransactionWithIntentOptions } from '@bitgo-beta/sdk-core';
 import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
 import { ExplainTransactionOptions, IotaParseTransactionOptions, TransactionExplanation } from './lib/iface';
+/**
+ * IOTA coin implementation.
+ * Supports TSS (Threshold Signature Scheme) with EDDSA algorithm.
+ */
 export declare class Iota extends BaseCoin {
     protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
     protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
+    /**
+     * Factory method to create an IOTA coin instance.
+     */
     static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
     getBaseFactor(): string | number;
     getChain(): string;
     getFamily(): CoinFamily;
     getFullName(): string;
-    /** @inheritDoc */
     supportsTss(): boolean;
-    /** inherited doc */
     getDefaultMultisigType(): MultisigType;
     getMPCAlgorithm(): MPCAlgorithm;
     /**
-     * Check if an address is valid
-     * @param address the address to be validated
+     * Validates an IOTA address.
+     * @param address - The address to validate (64-character hex string)
      * @returns true if the address is valid
      */
     isValidAddress(address: string): boolean;
     /**
-     * @inheritDoc
+     * Validates a public key.
+     * @param pub - The public key to validate
+     * @returns true if the public key is valid
      */
-    explainTransaction(params: ExplainTransactionOptions): Promise<TransactionExplanation>;
+    isValidPub(pub: string): boolean;
     /**
-     * Verifies that a transaction prebuild complies with the original intention
-     * @param params
+     * Verifies if an address belongs to a TSS wallet.
+     * @param params - Verification parameters including wallet address and user/backup public keys
+     * @returns true if the address belongs to the wallet
      */
-    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
+    isWalletAddress(params: TssVerifyAddressOptions): Promise<boolean>;
     /**
-     * Check if an address belongs to a wallet
-     * @param params
+     * Explains a transaction by parsing its hex representation.
+     * @param params - Parameters containing the transaction hex
+     * @returns Detailed explanation of the transaction
+     * @throws Error if txHex is missing or transaction cannot be explained
      */
-    isWalletAddress(params: TssVerifyAddressOptions): Promise<boolean>;
+    explainTransaction(params: ExplainTransactionOptions): Promise<TransactionExplanation>;
     /**
-     * Parse a transaction
-     * @param params
+     * Verifies that a transaction prebuild matches the original transaction parameters.
+     * Ensures recipients and amounts align with the intended transaction.
+     *
+     * @param params - Verification parameters containing prebuild and original params
+     * @returns true if verification succeeds
+     * @throws Error if verification fails
      */
-    parseTransaction(params: IotaParseTransactionOptions): Promise<ParsedTransaction>;
+    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
     /**
-     * Generate a key pair
-     * @param seed Optional seed to generate key pair from
+     * Parses a transaction and extracts inputs, outputs, and fees.
+     * @param params - Parameters containing the transaction hex
+     * @returns Parsed transaction with inputs, outputs, and fee information
      */
-    generateKeyPair(seed?: Buffer): KeyPair;
+    parseTransaction(params: IotaParseTransactionOptions): Promise<ParsedTransaction>;
     /**
-     * Check if a public key is valid
-     * @param pub Public key to check
+     * Generates a key pair for IOTA transactions.
+     * @param seed - Optional seed to generate deterministic key pair
+     * @returns Key pair with public and private keys
+     * @throws Error if private key generation fails
      */
-    isValidPub(pub: string): boolean;
+    generateKeyPair(seed?: Buffer): KeyPair;
     /**
-     * Sign a transaction
-     * @param params
+     * Signs a transaction (not implemented for IOTA).
+     * IOTA transactions are signed externally using TSS.
      */
     signTransaction(params: SignTransactionOptions): Promise<SignedTransaction>;
     /**
-     * Audit a decrypted private key to ensure it's valid
-     * @param params
+     * Audits a decrypted private key to ensure it's valid for the given public key.
+     * @param params - Parameters containing multiSigType, private key, and public key
+     * @throws Error if multiSigType is not TSS or if key validation fails
      */
     auditDecryptedKey({ multiSigType, prv, publicKey }: AuditDecryptedKeyParams): void;
-    /** @inheritDoc */
+    /**
+     * Extracts the signable payload from a serialized transaction.
+     * @param serializedTx - The serialized transaction hex
+     * @returns Buffer containing the signable payload
+     */
     getSignablePayload(serializedTx: string): Promise<Buffer>;
-    /** inherited doc */
+    /**
+     * Sets coin-specific fields in the transaction intent.
+     * @param intent - The populated intent object to modify
+     * @param params - Parameters containing unspents data
+     */
     setCoinSpecificFieldsInIntent(intent: PopulatedIntent, params: PrebuildTransactionWithIntentOptions): void;
+    /**
+     * Validates and extracts transaction hex from parameters.
+     * @param txHex - The transaction hex to validate
+     * @param operation - The operation being performed (for error messages)
+     * @returns The validated transaction hex
+     * @throws Error if txHex is missing
+     */
+    private validateAndExtractTxHex;
+    /**
+     * Validates that the transaction is a TransferTransaction.
+     * @param transaction - The transaction to validate
+     * @throws Error if transaction is not a TransferTransaction
+     */
+    private validateTransactionType;
+    /**
+     * Verifies that transaction recipients match the expected recipients.
+     * @param transaction - The transfer transaction to verify
+     * @param expectedRecipients - The expected recipients from transaction params
+     * @throws Error if recipients don't match
+     */
+    private verifyTransactionRecipients;
+    /**
+     * Normalizes recipients by extracting only relevant fields.
+     * @param recipients - Recipients to normalize
+     * @returns Normalized recipients with address, amount, and tokenName only
+     */
+    private normalizeRecipients;
+    /**
+     * Checks if expected recipients match actual recipients.
+     * @param expected - Expected recipients
+     * @param actual - Actual recipients from transaction
+     * @returns true if all expected recipients are found in actual recipients
+     */
+    private recipientsMatch;
+    /**
+     * Creates an empty parsed transaction result.
+     * Used when transaction has no outputs.
+     */
+    private createEmptyParsedTransaction;
+    /**
+     * Calculates the transaction fee from the explanation.
+     * @param explanation - The transaction explanation
+     * @returns The fee as a BigNumber
+     */
+    private calculateTransactionFee;
+    /**
+     * Builds the inputs array for a parsed transaction.
+     * Includes sender input and optionally sponsor input if present.
+     *
+     * @param explanation - The transaction explanation
+     * @param fee - The calculated transaction fee
+     * @returns Array of transaction inputs
+     */
+    private buildTransactionInputs;
+    /**
+     * Builds the outputs array for a parsed transaction.
+     * @param explanation - The transaction explanation
+     * @returns Array of transaction outputs
+     */
+    private buildTransactionOutputs;
+    /**
+     * Creates a transaction builder factory instance.
+     * @returns TransactionBuilderFactory for this coin
+     */
     private getTxBuilderFactory;
+    /**
+     * Rebuilds a transaction from its hex representation.
+     * @param txHex - The transaction hex to rebuild
+     * @returns The rebuilt transaction
+     * @throws Error if transaction cannot be rebuilt
+     */
     private rebuildTransaction;
 }
 //# sourceMappingURL=iota.d.ts.map

package/dist/src/iota.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"iota.d.ts","sourceRoot":"","sources":["../../src/iota.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,QAAQ,EACR,SAAS,EACT,OAAO,EACP,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,wBAAwB,EACxB,YAAY,EAEZ,YAAY,EACZ,uBAAuB,EAEvB,eAAe,EACf,oCAAoC,EAGrC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAS,MAAM,qBAAqB,CAAC;AAMrF,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,sBAAsB,EAEvB,MAAM,aAAa,CAAC;AAGrB,qBAAa,IAAK,SAAQ,QAAQ;IAChC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE3D,SAAS,aAAa,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAU/E,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,aAAa,IAAI,MAAM,GAAG,MAAM;IAIhC,QAAQ;IAIR,SAAS,IAAI,UAAU;IAIvB,WAAW;IAIX,kBAAkB;IAClB,WAAW,IAAI,OAAO;IAItB,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,eAAe,IAAI,YAAY;IAI/B;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAKxC;;OAEG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAY5F;;;OAGG;IACG,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAoC3E;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQxE;;;OAGG;IACG,gBAAgB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAwDvF;;;OAGG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAYvC;;;OAGG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIjF;;;OAGG;IACH,iBAAiB,CAAC,EAAE,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,uBAAuB,GAAG,IAAI;IAOlF,kBAAkB;IACZ,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAK/D,oBAAoB;IACpB,6BAA6B,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,oCAAoC,GAAG,IAAI;IAI1G,OAAO,CAAC,mBAAmB;YAIb,kBAAkB;CASjC"}
+{"version":3,"file":"iota.d.ts","sourceRoot":"","sources":["../../src/iota.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,QAAQ,EACR,SAAS,EACT,OAAO,EACP,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,wBAAwB,EACxB,YAAY,EAEZ,YAAY,EACZ,uBAAuB,EAEvB,eAAe,EACf,oCAAoC,EAGrC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAS,MAAM,qBAAqB,CAAC;AAMrF,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,sBAAsB,EAEvB,MAAM,aAAa,CAAC;AAGrB;;;GAGG;AACH,qBAAa,IAAK,SAAQ,QAAQ;IAChC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE3D,SAAS,aAAa,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAU/E;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAQ1F,aAAa,IAAI,MAAM,GAAG,MAAM;IAIhC,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,UAAU;IAIvB,WAAW,IAAI,MAAM;IAQrB,WAAW,IAAI,OAAO;IAItB,sBAAsB,IAAI,YAAY;IAItC,eAAe,IAAI,YAAY;IAQ/B;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;;;OAIG;IACG,eAAe,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAYxE;;;;;OAKG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAM5F;;;;;;;OAOG;IACG,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAc3E;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBvF;;;;;OAKG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIjF;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,uBAAuB,GAAG,IAAI;IAOlF;;;;OAIG;IACG,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAK/D;;;;OAIG;IACH,6BAA6B,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,oCAAoC,GAAG,IAAI;IAQ1G;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;IAO/B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAM/B;;;;;OAKG;IACH,OAAO,CAAC,2BAA2B;IAkBnC;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAMvB;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAQpC;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAO/B;;;;;;;OAOG;IACH,OAAO,CAAC,sBAAsB;IAgC9B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAU/B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;;OAKG;YACW,kBAAkB;CASjC"}