@bitgo-beta/abstract-cosmos 0.0.0-semantic-release-managed

package/dist/src/cosmosCoin.d.ts

@@ -0,0 +1,196 @@
+import { AuditDecryptedKeyParams, BaseCoin, BitGoBase, ExplanationResult, KeyPair, MPCAlgorithm, MultisigType, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
+import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
+import { Coin } from '@cosmjs/stargate';
+import { Buffer } from 'buffer';
+import { Hash } from 'crypto';
+import * as request from 'superagent';
+import { CosmosKeyPair, CosmosLikeCoinRecoveryOutput, CosmosTransaction, GasAmountDetails, RecoveryOptions, CosmosTransactionBuilder, KeyShares } from './lib';
+/**
+ * Cosmos accounts support memo Id based addresses
+ */
+interface AddressDetails {
+    address: string;
+    memoId?: string | undefined;
+}
+export declare class CosmosCoin<CustomMessage = never> extends BaseCoin {
+    protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
+    protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
+    static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
+    /**
+     * Creates an instance of TransactionBuilderFactory for the coin specific sdk
+     */
+    getBuilder(): any;
+    /** @inheritDoc **/
+    getBaseFactor(): string | number;
+    /** @inheritDoc **/
+    getChain(): string;
+    /** @inheritDoc **/
+    getFamily(): CoinFamily;
+    /** @inheritDoc **/
+    getFullName(): string;
+    /** @inheritDoc */
+    supportsTss(): boolean;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
+    /** @inheritDoc **/
+    getMPCAlgorithm(): MPCAlgorithm;
+    /** @inheritDoc **/
+    isValidPub(pub: string): boolean;
+    /** @inheritDoc **/
+    isValidPrv(prv: string): boolean;
+    isValidAddress(address: string): boolean;
+    /**
+     * Builds a funds recovery transaction without BitGo
+     * @param {RecoveryOptions} params parameters needed to construct and
+     * (maybe) sign the transaction
+     *
+     * @returns {CosmosLikeCoinRecoveryOutput} the serialized transaction hex string and index
+     * of the address being swept
+     */
+    recover(params: RecoveryOptions): Promise<CosmosLikeCoinRecoveryOutput>;
+    /**
+     * Validates the recovery parameters
+     */
+    private validateRecoveryParams;
+    /**
+     * Checks if this is an unsigned sweep operation
+     */
+    private isUnsignedSweep;
+    /**
+     * Gets sender details including address, public key and key shares
+     */
+    private getSenderDetails;
+    /**
+     * Gets key shares from recovery parameters
+     */
+    private getKeyShares;
+    /**
+     * Processes account balances and validates sufficient funds
+     */
+    private processBalances;
+    /**
+     * Builds transaction messages for all balances
+     */
+    private buildTransactionMessages;
+    /**
+     * Builds and signs the transaction
+     */
+    private buildAndSignTransaction;
+    /**
+     * Signs the transaction with MPC
+     */
+    /**
+     * Signs the transaction using MPC (Multi-Party Computation)
+     * @param unsignedTransaction The unsigned transaction to sign
+     * @param txnBuilder The transaction builder instance
+     * @param keyShares The key shares for MPC signing
+     * @param publicKey The public key for verification
+     * @returns The signed transaction output
+     * @throws Error if validation fails or signing process encounters an error
+     */
+    protected signTransactionWithMpc(unsignedTransaction: CosmosTransaction<CustomMessage>, txnBuilder: CosmosTransactionBuilder, keyShares: KeyShares, publicKey: string): Promise<CosmosLikeCoinRecoveryOutput>;
+    /**
+     * Builds a redelegate transaction
+     * @param {RecoveryOptions} params parameters needed to construct and
+     * (maybe) sign the transaction
+     *
+     * @returns {CosmosLikeCoinRecoveryOutput} the serialized transaction hex string
+     */
+    redelegate(params: RecoveryOptions & {
+        validatorSrcAddress: string;
+        validatorDstAddress: string;
+        amountToRedelegate: string;
+    }): Promise<CosmosLikeCoinRecoveryOutput>;
+    /** @inheritDoc **/
+    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
+    /** @inheritDoc **/
+    explainTransaction(options: {
+        txHex: string;
+    }): Promise<ExplanationResult>;
+    /**
+     * Sign a transaction with a single private key
+     * @param params parameters in the form of { txPrebuild: {txHex}, prv }
+     * @returns signed transaction in the form of { txHex }
+     */
+    signTransaction(params: SignTransactionOptions & {
+        txPrebuild: {
+            txHex: string;
+        };
+        prv: string;
+    }): Promise<SignedTransaction>;
+    /** @inheritDoc **/
+    parseTransaction(params: ParseTransactionOptions & {
+        txHex: string;
+    }): Promise<ParsedTransaction>;
+    /**
+     * Get the public node url from the Environments constant we have defined
+     */
+    protected getPublicNodeUrl(): string;
+    /**
+     * Get account number from public node
+     */
+    protected getAccountFromNode(senderAddress: string): Promise<request.Response>;
+    /**
+     * Get balance from public node
+     */
+    protected getBalanceFromNode(senderAddress: string): Promise<request.Response>;
+    /**
+     * Get chain id from public node
+     */
+    protected getChainIdFromNode(): Promise<request.Response>;
+    /**
+     * Helper to fetch account balance
+     */
+    protected getAccountBalance(senderAddress: string): Promise<Coin[]>;
+    /**
+     * Helper to fetch chainId
+     */
+    protected getChainId(): Promise<string>;
+    /**
+     * Helper to fetch account number
+     */
+    protected getAccountDetails(senderAddress: string): Promise<string[]>;
+    /** @inheritDoc **/
+    generateKeyPair(seed?: Buffer): KeyPair;
+    /**
+     * Retrieves the address from a public key.
+     * @param {string} pubKey - The public key.
+     * @returns {string} The corresponding address.
+     */
+    getAddressFromPublicKey(pubKey: string): string;
+    /** @inheritDoc **/
+    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
+    /** @inheritDoc **/
+    getHashFunction(): Hash;
+    /**
+     * Process address into address and memo id
+     *
+     * @param address the address
+     * @returns object containing address and memo id
+     */
+    getAddressDetails(address: string): AddressDetails;
+    /**
+     * Return boolean indicating whether a memo id is valid
+     *
+     * @param memoId memo id
+     * @returns true if memo id is valid
+     */
+    isValidMemoId(memoId: string): boolean;
+    /**
+     * Helper method to return the respective coin's base unit
+     */
+    getDenomination(): string;
+    /**
+     * Helper method to fetch gas amount details for respective coin
+     */
+    getGasAmountDetails(): GasAmountDetails;
+    /**
+     * Helper method to get key pair for individual coin
+     * @param publicKey
+     */
+    getKeyPair(publicKey: string): CosmosKeyPair;
+    /** @inheritDoc **/
+    auditDecryptedKey({ multiSigType, publicKey, prv }: AuditDecryptedKeyParams): void;
+}
+export {};
+//# sourceMappingURL=cosmosCoin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cosmosCoin.d.ts","sourceRoot":"","sources":["../../src/cosmosCoin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,QAAQ,EAER,SAAS,EAGT,iBAAiB,EAGjB,OAAO,EACP,YAAY,EACZ,YAAY,EAEZ,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EAEjB,sBAAsB,EAGtB,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE9E,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAc,IAAI,EAAe,MAAM,QAAQ,CAAC;AAGvD,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAEtC,OAAO,EACL,aAAa,EACb,4BAA4B,EAC5B,iBAAiB,EAEjB,gBAAgB,EAChB,eAAe,EAGf,wBAAwB,EACxB,SAAS,EAGV,MAAM,OAAO,CAAC;AAKf;;GAEG;AACH,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AASD,qBAAa,UAAU,CAAC,aAAa,GAAG,KAAK,CAAE,SAAQ,QAAQ;IAC7D,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC3D,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;;OAEG;IACH,UAAU,IAAI,GAAG;IAIjB,mBAAmB;IACnB,aAAa,IAAI,MAAM,GAAG,MAAM;IAIhC,mBAAmB;IACnB,QAAQ,IAAI,MAAM;IAIlB,mBAAmB;IACnB,SAAS,IAAI,UAAU;IAIvB,mBAAmB;IACnB,WAAW,IAAI,MAAM;IAIrB,kBAAkB;IAClB,WAAW,IAAI,OAAO;IAItB,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,mBAAmB;IACnB,eAAe,IAAI,YAAY;IAI/B,mBAAmB;IACnB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,mBAAmB;IACnB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,4BAA4B,CAAC;IA8B7E;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAY9B;;OAEG;IACH,OAAO,CAAC,eAAe;IAIvB;;OAEG;YACW,gBAAgB;IA2B9B;;OAEG;YACW,YAAY;IAgB1B;;OAEG;IACH,OAAO,CAAC,eAAe;IAuCvB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA0BhC;;OAEG;YACW,uBAAuB;IAiDrC;;OAEG;IACH;;;;;;;;OAQG;cACa,sBAAsB,CACpC,mBAAmB,EAAE,iBAAiB,CAAC,aAAa,CAAC,EACrD,UAAU,EAAE,wBAAwB,EACpC,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,4BAA4B,CAAC;IA6DxC;;;;;;OAMG;IACG,UAAU,CACd,MAAM,EAAE,eAAe,GAAG;QACxB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,kBAAkB,EAAE,MAAM,CAAC;KAC5B,GACA,OAAO,CAAC,4BAA4B,CAAC;IAoFxC,mBAAmB;IACb,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IA6B3E,mBAAmB;IACb,kBAAkB,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAahF;;;;OAIG;IACG,eAAe,CACnB,MAAM,EAAE,sBAAsB,GAAG;QAAE,UAAU,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAC9E,OAAO,CAAC,iBAAiB,CAAC;IAqB7B,mBAAmB;IACb,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAgCvG;;OAEG;IACH,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAIpC;;OAEG;cACa,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IAYpF;;OAEG;cACa,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IAYpF;;OAEG;cACa,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IAY/D;;OAEG;cACa,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAQzE;;OAEG;cACa,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ7C;;OAEG;cACa,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ3E,mBAAmB;IACnB,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC;;;;OAIG;IACH,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI/C,mBAAmB;IACb,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAarE,mBAAmB;IACnB,eAAe,IAAI,IAAI;IAIvB;;;;;OAKG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc;IA4ClD;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAItC;;OAEG;IACH,eAAe,IAAI,MAAM;IAIzB;;OAEG;IACH,mBAAmB,IAAI,gBAAgB;IAIvC;;;OAGG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa;IAI5C,mBAAmB;IACnB,iBAAiB,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,uBAAuB;CAO5E"}