@bitgo/sdk-coin-atom 2.1.0 → 3.1.0

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

@@ -1,9 +1,11 @@
 /// <reference types="node" />
-import { BaseUtils, Signature } from '@bitgo/sdk-core';
+import { BaseUtils, TransactionType } from '@bitgo/sdk-core';
 import { DecodedTxRaw } from '@cosmjs/proto-signing';
-import { AtomTransaction, GasFeeLimitData, MessageData } from './iface';
-import { TxRaw, SignDoc } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
+import { Coin } from '@cosmjs/stargate';
+import { SignDoc, TxRaw } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
+import { AtomTransaction, DelegateOrUndelegeteMessage, FeeData, MessageData, SendMessage, WithdrawDelegatorRewardsMessage } from './iface';
 export declare class Utils implements BaseUtils {
+    private registry;
     /** @inheritdoc */
     isValidBlockId(hash: string): boolean;
     /** @inheritdoc */
@@ -14,78 +16,153 @@ export declare class Utils implements BaseUtils {
     isValidSignature(signature: string): boolean;
     /** @inheritdoc */
     isValidTransactionId(txId: string): boolean;
+    /**
+     * Checks if transaction hash is in valid black2b format
+     */
     validateBlake2b(hash: string): boolean;
     /**
-     * Checks if raw transaction can be deserialized
+     * Validates if the address matches with regex @see accountAddressRegex
      *
-     * @param {string} rawTransaction - transaction in base64 string format
+     * @param {string} address
      * @returns {boolean} - the validation result
      */
-    isValidRawTransaction(rawTransaction: string): boolean;
+    isValidAddress(address: string): boolean;
     /**
-     * Check the raw transaction has a valid format in the blockchain context, throw otherwise.
+     * Validates if the address matches with regex @see accountAddressRegex
      *
-     * @param {string} rawTransaction - Transaction in base64 string  format
+     * @param {string} address
+     * @returns {boolean} - the validation result
      */
-    validateRawTransaction(rawTransaction: string): void;
-    isValidAddress(address: string): boolean;
+    isValidValidatorAddress(address: string): boolean;
     /**
-     * Returns whether or not the string is a valid amount
+     * Validates whether amounts are in range
      *
      * @param {number[]} amounts - the amounts to validate
      * @returns {boolean} - the validation result
      */
     isValidAmounts(amounts: number[]): boolean;
+    /**
+     * Validates whether amount is in range
+     * @param {number} amount
+     * @returns {boolean} the validation result
+     */
     isValidAmount(amount: number): boolean;
     /**
      * Decodes raw tx data into messages, signing info, and fee data
-     * @param txHex - raw base64 tx
+     * @param {string} txHex - raw base64 tx
+     * @returns {DecodedTxRaw} Decoded transaction
      */
     getDecodedTxFromRawBase64(txRaw: string): DecodedTxRaw;
     /**
      * Returns the array of messages in the body of the decoded transaction
-     * @param decodedTx
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {EncodeObject[]} messages along with type url
      */
     private getEncodedMessagesFromDecodedTx;
-    /**
-     * Arranges a decoded message into our MessageData value interface
-     * @param decodedMessage
-     * @private
-     */
-    private getMessageValueDataFromDecodedMessage;
-    /**
-     * Returns an array of MessageData[] from an encoded messages array
-     * @param encodedMessages
-     * @private
-     */
-    private getMessageDataFromEncodedMessages;
     /**
      * Pulls the sequence number from a DecodedTxRaw AuthInfo property
-     * @param decodedTx
-     * @private
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {number} sequence
      */
     getSequenceFromDecodedTx(decodedTx: DecodedTxRaw): number;
     /**
      * Pulls the typeUrl from the encoded message of a DecodedTxRaw
-     * @param decodedTx
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {string} cosmos proto type url
      */
     getTypeUrlFromDecodedTx(decodedTx: DecodedTxRaw): string;
-    getGasBudgetFromDecodedTx(decodedTx: DecodedTxRaw): GasFeeLimitData;
+    /**
+     * Returns the fee data from the decoded transaction
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {FeeData} fee data
+     */
+    getGasBudgetFromDecodedTx(decodedTx: DecodedTxRaw): FeeData;
+    /**
+     * Returns the publicKey from the decoded transaction
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {string | undefined} publicKey in hex format if it exists, undefined otherwise
+     */
+    getPublicKeyFromDecodedTx(decodedTx: DecodedTxRaw): string | undefined;
+    /**
+     * Returns the array of MessageData[] from the decoded transaction
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {MessageData[]} Send transaction message data
+     */
+    getSendMessageDataFromDecodedTx(decodedTx: DecodedTxRaw): MessageData[];
     /**
      * Returns the array of MessageData[] from the decoded transaction
-     * @param decodedTx
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {MessageData[]} Delegate of undelegate transaction message data
+     */
+    getDelegateOrUndelegateMessageDataFromDecodedTx(decodedTx: DecodedTxRaw): MessageData[];
+    /**
+     * Returns the array of MessageData[] from the decoded transaction
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {MessageData[]} WithdrawDelegatorRewards transaction message data
+     */
+    getWithdrawRewardsMessageDataFromDecodedTx(decodedTx: DecodedTxRaw): MessageData[];
+    /**
+     * Returns the array of MessageData[] from the decoded transaction
+     * @param {DecodedTxRaw} decodedTx
+     * @returns {MessageData[]} Delegate of undelegate transaction message data
+     */
+    getWithdrawDelegatorRewardsMessageDataFromDecodedTx(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
+     */
+    getTransactionTypeFromTypeUrl(typeUrl: string): TransactionType | undefined;
+    /**
+     * Creates a txRaw from an atom transaction @see AtomTransaction
+     * @Precondition atomTransaction.publicKey must be defined
+     * @param {AtomTransaction} atomTransaction
+     * @returns {TxRaw} Unsigned raw transaction
+     */
+    createTxRawFromAtomTransaction(atomTransaction: AtomTransaction): TxRaw;
+    /**
+     * Encodes a signature into a txRaw
+     * @param {string} publicKeyHex publicKey in hex encoded string format
+     * @param {string} signatureHex signature in hex encoded string format
+     * @param {TxRaw} unsignedTx raw transaction
+     * @returns {TxRaw} Signed raw transaction
+     */
+    createSignedTxRaw(publicKeyHex: string, signatureHex: string, unsignedTx: {
+        bodyBytes: Uint8Array;
+        authInfoBytes: Uint8Array;
+    }): TxRaw;
+    /**
+     * Decodes a raw transaction into a DecodedTxRaw and checks if it has non empty signatures
+     * @param {string} rawTransaction
+     * @returns {boolean} true if transaction is signed else false
      */
-    getMessageDataFromDecodedTx(decodedTx: DecodedTxRaw): MessageData[];
-    createSignDocFromAtomTransaction(pubkey: any, atomTransaction: AtomTransaction): import("cosmjs-types/cosmos/tx/v1beta1/tx").SignDoc;
-    createSignedTxRaw(atomSignature: Signature, signDoc: SignDoc): TxRaw;
-    createBase64SignedTxBytesFromSignedTxRaw(signedTxRaw: TxRaw): string;
     isSignedRawTx(rawTransaction: string): boolean;
-    getSignerInfoFromRawSignedTx(rawTransaction: string): {
-        pubKey: {
-            pub: string;
-        };
-        signature: Buffer;
-    };
+    /**
+     * Deserializes base64 enocded raw transaction string into @see AtomTransaction
+     * @param {string} rawTx base64 enocded raw transaction string
+     * @returns {AtomTransaction} Deserialized atomTransaction
+     */
+    deserializeAtomTransaction(rawTx: string): AtomTransaction;
+    createAtomTransaction(sequence: number, messages: MessageData[], gasBudget: FeeData, publicKey?: string, memo?: string): AtomTransaction;
+    createAtomTransactionWithHash(sequence: number, messages: MessageData[], gasBudget: FeeData, publicKey?: string, signature?: Buffer, memo?: string): AtomTransaction;
+    validateAtomTransaction(tx: AtomTransaction): void;
+    validateMessageData(messageData: MessageData): void;
+    validateAmountData(amountArray: Coin[]): void;
+    validateAmount(amount: Coin): void;
+    validateGasBudget(gasBudget: FeeData): void;
+    validateSequence(sequence: number): void;
+    validatePublicKey(publicKey: string | undefined): void;
+    /**
+     * Creates a sign doc from an atom transaction @see AtomTransaction
+     * @Precondition atomTransaction.accountNumber and atomTransaction.chainId must be defined
+     * @param {AtomTransaction} atomTransaction
+     * @returns {SignDoc} sign doc
+     */
+    createSignDoc(atomTransaction: AtomTransaction, accountNumber: number | undefined, chainId: string | undefined): SignDoc;
+    validateDelegateOrUndelegateMessage(delegateMessage: DelegateOrUndelegeteMessage): void;
+    validateWithdrawRewardsMessage(withdrawRewardsMessage: WithdrawDelegatorRewardsMessage): void;
+    validateSendMessage(sendMessage: SendMessage): void;
+    isValidHexString(hexString: string): boolean;
 }
 declare const utils: Utils;
 export default utils;

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,EAAE,SAAS,EAAyB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG9E,OAAO,EACL,YAAY,EAOb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGxE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAGnE,qBAAa,KAAM,YAAW,SAAS;IACrC,kBAAkB;IAClB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC,kBAAkB;IAClB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIvC,kBAAkB;IAClB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAItC,kBAAkB;IAClB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI5C,kBAAkB;IAClB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3C,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAMtC;;;;;OAKG;IACH,qBAAqB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO;IAItD;;;;OAIG;IACH,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IASpD,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAOxC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAS1C,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAQtC;;;OAGG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAItD;;;OAGG;IACH,OAAO,CAAC,+BAA+B;IAIvC;;;;OAIG;IACH,OAAO,CAAC,qCAAqC;IAQ7C;;;;OAIG;IACH,OAAO,CAAC,iCAAiC;IAYzC;;;;OAIG;IACH,wBAAwB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM;IAIzD;;;OAGG;IACH,uBAAuB,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM;IAKxD,yBAAyB,CAAC,SAAS,EAAE,YAAY,GAAG,eAAe;IAOnE;;;OAGG;IACH,2BAA2B,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAKnE,gCAAgC,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,eAAe;IAqB9E,iBAAiB,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,KAAK;IASpE,wCAAwC,CAAC,WAAW,EAAE,KAAK,GAAG,MAAM;IAKpE,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO;IAQ9C,4BAA4B,CAAC,cAAc,EAAE,MAAM;;;;;;CAapD;AAED,QAAA,MAAM,KAAK,OAAc,CAAC;AAE1B,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,iBAAiB,CAAC;AAGzB,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;AAKnE,OAAO,EACL,eAAe,EACf,2BAA2B,EAC3B,OAAO,EACP,WAAW,EACX,WAAW,EACX,+BAA+B,EAChC,MAAM,SAAS,CAAC;AAGjB,qBAAa,KAAM,YAAW,SAAS;IACrC,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,GAAG,OAAO;IAIxC;;;;;OAKG;IACH,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIjD;;;;;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;;;;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,+BAA+B,CAAC,SAAS,EAAE,YAAY,GAAG,WAAW,EAAE;IAcvE;;;;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,8BAA8B,CAAC,eAAe,EAAE,eAAe,GAAG,KAAK;IAkCvE;;;;;;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;;;;OAIG;IACH,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe;IA4B1D,qBAAqB,CACnB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW,EAAE,EACvB,SAAS,EAAE,OAAO,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM,GACZ,eAAe;IAYlB,6BAA6B,CAC3B,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,eAAe;IAqBlB,uBAAuB,CAAC,EAAE,EAAE,eAAe,GAAG,IAAI;IAWlD,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;IAwCnD,kBAAkB,CAAC,WAAW,EAAE,IAAI,EAAE,GAAG,IAAI;IAM7C,cAAc,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI;IAUlC,iBAAiB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI;IAO3C,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAMjC,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAU/C;;;;;OAKG;IACH,aAAa,CACX,eAAe,EAAE,eAAe,EAChC,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,OAAO;IAcV,mCAAmC,CAAC,eAAe,EAAE,2BAA2B;IAchF,8BAA8B,CAAC,sBAAsB,EAAE,+BAA+B;IAgBtF,mBAAmB,CAAC,WAAW,EAAE,WAAW;IAU5C,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;CAG7C;AAED,QAAA,MAAM,KAAK,OAAc,CAAC;AAE1B,eAAe,KAAK,CAAC"}