@bitgo-beta/abstract-cosmos 1.0.1-beta.9 → 1.0.1-beta.91

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

@@ -1,9 +1,12 @@
+/// <reference types="node" />
 import { BaseUtils, TransactionType } from '@bitgo-beta/sdk-core';
 import { DecodedTxRaw } from '@cosmjs/proto-signing';
+import { Coin } from '@cosmjs/stargate';
 import { SignDoc, TxRaw } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
-import { CosmosLikeTransaction, FeeData, MessageData } from './iface';
-export declare class CosmosLikeUtils implements BaseUtils {
+import { CosmosLikeTransaction, DelegateOrUndelegeteMessage, ExecuteContractMessage, FeeData, MessageData, SendMessage, WithdrawDelegatorRewardsMessage } from './iface';
+export declare class CosmosUtils implements BaseUtils {
     private registry;
+    constructor();
     /** @inheritdoc */
     isValidBlockId(hash: string): boolean;
     /** @inheritdoc */
@@ -43,6 +46,10 @@ export declare class CosmosLikeUtils implements BaseUtils {
      * @returns {EncodeObject[]} messages along with type url
      */
     private getEncodedMessagesFromDecodedTx;
+    /**
+     * Checks the txn sequence is valid or not
+     * @param {number} sequence
+     */
     validateSequence(sequence: number): void;
     /**
      * Pulls the sequence number from a DecodedTxRaw AuthInfo property
@@ -53,7 +60,7 @@ export declare class CosmosLikeUtils implements BaseUtils {
     /**
      * Pulls the typeUrl from the encoded message of a DecodedTxRaw
      * @param {DecodedTxRaw} decodedTx
-     * @returns {string} osmosis proto type url
+     * @returns {string} cosmos proto type url
      */
     getTypeUrlFromDecodedTx(decodedTx: DecodedTxRaw): string;
     /**
@@ -93,7 +100,13 @@ export declare class CosmosLikeUtils implements BaseUtils {
      */
     getWithdrawDelegatorRewardsMessageDataFromDecodedTx(decodedTx: DecodedTxRaw): MessageData[];
     /**
-     * Determines bitgo transaction type based on osmosis proto type url
+     * Returns the array of MessageData[] from the decoded transaction
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {MessageData[]} Execute contract transaction message data
+     */
+    getExecuteContractMessageDataFromDecodedTx(decodedTx: DecodedTxRaw): MessageData[];
+    /**
+     * Determines bitgo transaction type based on cosmos proto type url
      * @param {string} typeUrl
      * @returns {TransactionType | undefined} TransactionType if url is supported else undefined
      */
@@ -122,14 +135,11 @@ export declare class CosmosLikeUtils implements BaseUtils {
      * @returns {boolean} true if transaction is signed else false
      */
     isSignedRawTx(rawTransaction: string): boolean;
-    validatePublicKey(publicKey: string | undefined): void;
     /**
-     * Validates if the address matches with regex @see accountAddressRegex
-     *
-     * @param {string} address
-     * @returns {boolean} - the validation result
+     * Returns whether or not the string is a valid protocol public key
+     * @param {string | undefined} publicKey - the  public key to be validated
      */
-    isValidAddress(address: string): boolean;
+    validatePublicKey(publicKey: string | undefined): void;
     /**
      * Creates a sign doc from an cosmos like transaction @see CosmosLikeTransaction
      * @Precondition cosmosLikeTransaction.accountNumber and cosmosLikeTransaction.chainId must be defined
@@ -137,8 +147,124 @@ export declare class CosmosLikeUtils implements BaseUtils {
      * @returns {SignDoc} sign doc
      */
     createSignDoc(cosmosLikeTransaction: CosmosLikeTransaction, accountNumber: number | undefined, chainId: string | undefined): SignDoc;
+    /**
+     * Returns whether or not the string is a valid hex
+     * @param hexString - hex string format
+     * @returns {boolean} true if string is hex else false
+     */
     isValidHexString(hexString: string): boolean;
+    /**
+     * Validates the WithdrawDelegatorRewardsMessage
+     * @param {WithdrawDelegatorRewardsMessage} withdrawRewardsMessage - The WithdrawDelegatorRewardsMessage to validate.
+     * @throws {InvalidTransactionError} Throws an error if the validatorAddress or delegatorAddress is invalid or missing.
+     */
+    validateWithdrawRewardsMessage(withdrawRewardsMessage: WithdrawDelegatorRewardsMessage): void;
+    /**
+     * Helper method to check if the specified properties in an object are missing or null.
+     * @param {Object} obj - The object to check.
+     * @param {string[]} keys - An array of property keys to check.
+     * @throws {Error} Throws an error if any of the specified properties are missing or null.
+     */
+    isObjPropertyNull(obj: {
+        [key: string]: any;
+    }, keys: Array<string>): void;
+    /**
+     * Validates the DelegateOrUndelegeteMessage
+     * @param {DelegateOrUndelegeteMessage} delegateMessage - The DelegateOrUndelegeteMessage to validate.
+     * @throws {InvalidTransactionError} Throws an error if the validatorAddress, delegatorAddress, or amount is invalid or missing.
+     */
+    validateDelegateOrUndelegateMessage(delegateMessage: DelegateOrUndelegeteMessage): void;
+    /**
+     * Validates the MessageData
+     * @param {MessageData} messageData - The MessageData to validate.
+     * @throws {InvalidTransactionError} Throws an error if the messageData is invalid or missing required fields.
+     */
+    validateMessageData(messageData: MessageData): void;
+    /**
+     * Validates the Cosmos-like transaction.
+     * @param {CosmosLikeTransaction} tx - The transaction to validate.
+     * @throws {InvalidTransactionError} Throws an error if the transaction is invalid or missing required fields.
+     */
+    validateTransaction(tx: CosmosLikeTransaction): void;
+    /**
+     * Creates a Cosmos-like transaction.
+     * @param {number} sequence - The sender address sequence number for the transaction.
+     * @param {MessageData[]} messages - The array of message data for the transaction.
+     * @param {FeeData} gasBudget - The fee data for the transaction.
+     * @param {string} [publicKey] - The public key associated with the sender.
+     * @param {string} [memo] - The memo for the transaction.
+     * @returns {CosmosLikeTransaction} Returns the created Cosmos-like transaction.
+     * @throws {InvalidTransactionError} Throws an error if the created transaction is invalid.
+     */
+    createTransaction(sequence: number, messages: MessageData[], gasBudget: FeeData, publicKey?: string, memo?: string): CosmosLikeTransaction;
+    /**
+     * Creates a Cosmos-like transaction with a hash.
+     * @param {number} sequence - The sender address sequence number for the transaction.
+     * @param {MessageData[]} messages - The array of message data for the transaction.
+     * @param {FeeData} gasBudget - The fee data for the transaction.
+     * @param {string} [publicKey] - The public key associated with the transaction.
+     * @param {Buffer} [signature] - The signature for the transaction.
+     * @param {string} [memo] - The memo for the transaction.
+     * @returns {CosmosLikeTransaction} Returns the created Cosmos-like transaction with the hash and signature if provided.
+     */
+    createTransactionWithHash(sequence: number, messages: MessageData[], gasBudget: FeeData, publicKey?: string, signature?: Buffer, memo?: string): CosmosLikeTransaction;
+    /**
+     * Deserializes base64 enocded raw transaction string into @see CosmosLikeTransaction
+     * @param {string} rawTx base64 enocded raw transaction string
+     * @returns {CosmosLikeTransaction} Deserialized cosmosLikeTransaction
+     */
+    deserializeTransaction(rawTx: string): CosmosLikeTransaction;
+    /**
+     * Validates an array of coin amounts.
+     * @param {Coin[]} amountArray - The array of coin amounts to validate.
+     * @param {TransactionType} transactionType - optional field for transaction type
+     */
+    validateAmountData(amountArray: Coin[], transactionType?: TransactionType): void;
+    /**
+     * Validates the gas limit and gas amount for a transaction.
+     * @param {FeeData} gasBudget - The gas budget to validate.
+     * @throws {InvalidTransactionError} Throws an error if the gas budget is invalid.
+     */
+    validateGasBudget(gasBudget: FeeData): void;
+    /**
+     * Validates a send message for a transaction.
+     * @param {SendMessage} sendMessage - The send message to validate.
+     * @throws {InvalidTransactionError} Throws an error if the send message is invalid.
+     */
+    validateSendMessage(sendMessage: SendMessage): void;
+    /**
+     * Validates a coin amount.
+     * @param {Coin} amount - The coin amount to validate.
+     * @param {TransactionType} transactionType - optional field for transaction type
+     * @throws {InvalidTransactionError} Throws an error if the coin amount is invalid.
+     */
+    validateAmount(amount: Coin, transactionType?: TransactionType): void;
+    /**
+     * Validates if the address matches with regex @see accountAddressRegex
+     * @param {string} address
+     * @returns {boolean} - the validation result
+     */
+    isValidValidatorAddress(address: string): boolean;
+    /**
+     * Validates if the address matches with regex @see accountAddressRegex
+     * @param {string} address
+     * @returns {boolean} - the validation result
+     */
+    isValidAddress(address: string): boolean;
+    /**
+     * Validates if the address matches with regex @see contractAddressRegex
+     * @param {string} address
+     * @returns {boolean} - the validation result
+     */
+    isValidContractAddress(address: string): boolean;
+    /**
+     * Validates a execute contract message
+     * @param {ExecuteContractMessage} message - The execute contract message to validate
+     * @param {TransactionType} transactionType - optional field for transaction type
+     * @throws {InvalidTransactionError} Throws an error if the message is invalid
+     */
+    validateExecuteContractMessage(message: ExecuteContractMessage, transactionType?: TransactionType): void;
 }
-declare const utils: CosmosLikeUtils;
+declare const utils: CosmosUtils;
 export default utils;
 //# sourceMappingURL=utils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAIT,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EACL,YAAY,EAQb,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAInE,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtE,qBAAa,eAAgB,YAAW,SAAS;IAC/C,OAAO,CAAC,QAAQ,CAA2C;IAE3D,kBAAkB;IAClB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC,kBAAkB;IAClB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IASvC,kBAAkB;IAClB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAStC,kBAAkB;IAClB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI5C,kBAAkB;IAClB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3C;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAOtC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAS1C;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAQtC;;;;OAIG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAQtD;;;;OAIG;IACH,OAAO,CAAC,+BAA+B;IAIvC,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAMjC;;;;OAIG;IACH,wBAAwB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM;IAIzD;;;;OAIG;IACH,uBAAuB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM;IAKxD;;;;OAIG;IACH,yBAAyB,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO;IAO3D;;;;OAIG;IACH,yBAAyB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAQtE;;;;OAIG;IACH,SAAS,CAAC,+BAA+B,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAcjF;;;;OAIG;IACH,+CAA+C,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAcvF;;;;OAIG;IACH,0CAA0C,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAalF;;;;OAIG;IACH,mDAAmD,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAa3F;;;;OAIG;IACH,6BAA6B,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAe3E;;;;;OAKG;IACH,oCAAoC,CAAC,qBAAqB,EAAE,qBAAqB,GAAG,KAAK;IAkCzF;;;;;;OAMG;IACH,iBAAiB,CACf,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE;QAAE,SAAS,EAAE,UAAU,CAAC;QAAC,aAAa,EAAE,UAAU,CAAA;KAAE,GAC/D,KAAK;IASR;;;;OAIG;IACH,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO;IAQ9C,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAU/C;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;;OAKG;IACH,aAAa,CACX,qBAAqB,EAAE,qBAAqB,EAC5C,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,OAAO;IAcV,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;CAG7C;AAED,QAAA,MAAM,KAAK,iBAAwB,CAAC;AAEpC,eAAe,KAAK,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,SAAS,EAIT,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EACL,YAAY,EAQb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAwB,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAMnE,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,sBAAsB,EACtB,OAAO,EACP,WAAW,EACX,WAAW,EACX,+BAA+B,EAChC,MAAM,SAAS,CAAC;AAGjB,qBAAa,WAAY,YAAW,SAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC;;IAOjB,kBAAkB;IAClB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC,kBAAkB;IAClB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IASvC,kBAAkB;IAClB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAStC,kBAAkB;IAClB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI5C,kBAAkB;IAClB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3C;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAOtC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAS1C;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAQtC;;;;OAIG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAQtD;;;;OAIG;IACH,OAAO,CAAC,+BAA+B;IAIvC;;;OAGG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAMjC;;;;OAIG;IACH,wBAAwB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM;IAIzD;;;;OAIG;IACH,uBAAuB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM;IAKxD;;;;OAIG;IACH,yBAAyB,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO;IAO3D;;;;OAIG;IACH,yBAAyB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAQtE;;;;OAIG;IACH,SAAS,CAAC,+BAA+B,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAcjF;;;;OAIG;IACH,+CAA+C,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAcvF;;;;OAIG;IACH,0CAA0C,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAalF;;;;OAIG;IACH,mDAAmD,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAa3F;;;;OAIG;IACH,0CAA0C,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAelF;;;;OAIG;IACH,6BAA6B,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAiB3E;;;;;OAKG;IACH,oCAAoC,CAAC,qBAAqB,EAAE,qBAAqB,GAAG,KAAK;IAkCzF;;;;;;OAMG;IACH,iBAAiB,CACf,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE;QAAE,SAAS,EAAE,UAAU,CAAC;QAAC,aAAa,EAAE,UAAU,CAAA;KAAE,GAC/D,KAAK;IASR;;;;OAIG;IACH,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO;IAQ9C;;;OAGG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAU/C;;;;;OAKG;IACH,aAAa,CACX,qBAAqB,EAAE,qBAAqB,EAC5C,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,OAAO;IAcV;;;;OAIG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI5C;;;;OAIG;IACH,8BAA8B,CAAC,sBAAsB,EAAE,+BAA+B;IAgBtF;;;;;OAKG;IACH,iBAAiB,CAAC,GAAG,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;IAQlE;;;;OAIG;IACH,mCAAmC,CAAC,eAAe,EAAE,2BAA2B;IAgBhF;;;;OAIG;IACH,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;IAoCnD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,EAAE,qBAAqB,GAAG,IAAI;IAWpD;;;;;;;;;OASG;IACH,iBAAiB,CACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW,EAAE,EACvB,SAAS,EAAE,OAAO,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM,GACZ,qBAAqB;IAYxB;;;;;;;;;OASG;IACH,yBAAyB,CACvB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW,EAAE,EACvB,SAAS,EAAE,OAAO,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM,GACZ,qBAAqB;IAqBxB;;;;OAIG;IACH,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,qBAAqB;IA8B5D;;;;OAIG;IACH,kBAAkB,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,eAAe,CAAC,EAAE,eAAe,GAAG,IAAI;IAMhF;;;;OAIG;IACH,iBAAiB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI;IAO3C;;;;OAIG;IACH,mBAAmB,CAAC,WAAW,EAAE,WAAW;IAU5C;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,EAAE,eAAe,GAAG,IAAI;IAIrE;;;;OAIG;IACH,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIjD;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;OAIG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIhD;;;;;OAKG;IACH,8BAA8B,CAAC,OAAO,EAAE,sBAAsB,EAAE,eAAe,CAAC,EAAE,eAAe;CAclG;AAED,QAAA,MAAM,KAAK,aAAoB,CAAC;AAEhC,eAAe,KAAK,CAAC"}