@bitgo-beta/sdk-coin-atom 1.1.2-alpha.4 → 1.1.2-alpha.41

package/CHANGELOG.md

@@ -3,6 +3,80 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.3.4](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.3.3...@bitgo/sdk-coin-atom@3.3.4) (2023-06-21)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+## [3.3.3](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.3.2...@bitgo/sdk-coin-atom@3.3.3) (2023-06-14)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+## [3.3.2](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.3.1...@bitgo/sdk-coin-atom@3.3.2) (2023-06-13)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+## [3.3.1](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.3.0...@bitgo/sdk-coin-atom@3.3.1) (2023-06-07)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+# [3.3.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.2.0...@bitgo/sdk-coin-atom@3.3.0) (2023-06-05)
+
+### Features
+
+- **sdk-core:** paillier proof user<>backup ([8c0a381](https://github.com/BitGo/BitGoJS/commit/8c0a381318be2088572e06e34c3627323d7bfe38))
+- **sdk-core:** refactor signConvert to steps ([94e2cae](https://github.com/BitGo/BitGoJS/commit/94e2cae6e1292a4e9684c3c2ab7141221137d52e))
+- **sdk-core:** simplify mpc.appendChallenge ([67bee8f](https://github.com/BitGo/BitGoJS/commit/67bee8f1b4f37cd12d6d14ea4d51ddcfde679563))
+- **sdk-lib-mpc:** make rangeProof challenges mandatory for appendChallenge ([1f68b30](https://github.com/BitGo/BitGoJS/commit/1f68b30676966720cb1a42c039e35d3ddeea4974))
+
+# [3.2.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.1.4...@bitgo/sdk-coin-atom@3.2.0) (2023-05-25)
+
+### Features
+
+- **sdk-coin-atom:** add recover mechanism for ATOM ([0e4cfc7](https://github.com/BitGo/BitGoJS/commit/0e4cfc74201f9a44ec3b4b9c7591a6fbd3f2efb6))
+
+## [3.1.4](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.1.3...@bitgo/sdk-coin-atom@3.1.4) (2023-05-17)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+## [3.1.3](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.1.2...@bitgo/sdk-coin-atom@3.1.3) (2023-05-10)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+## [3.1.2](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.1.1...@bitgo/sdk-coin-atom@3.1.2) (2023-05-03)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+## [3.1.1](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.1.0...@bitgo/sdk-coin-atom@3.1.1) (2023-04-25)
+
+**Note:** Version bump only for package @bitgo/sdk-coin-atom
+
+# [3.1.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@3.0.0...@bitgo/sdk-coin-atom@3.1.0) (2023-04-20)
+
+### Features
+
+- **sdk-coin-atom:** add memo support for atom ([0287361](https://github.com/BitGo/BitGoJS/commit/0287361265de70a57c833f0ec1598648a88f1c24))
+
+# [3.0.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@2.1.0...@bitgo/sdk-coin-atom@3.0.0) (2023-04-13)
+
+### Bug Fixes
+
+- **sdk-coin-atom:** allow transaction creation from both Hex and Base64 ([91fae07](https://github.com/BitGo/BitGoJS/commit/91fae072387bcf79d571ce7537b2de42e8ed1166))
+- **sdk-coin-atom:** fix getAddress of KeyPair ([b966658](https://github.com/BitGo/BitGoJS/commit/b9666588cc0f5f6965f57af50e0c0da5dfe0cc2b))
+- **sdk-core:** add new function in BaseCoin to get hash-function ([e028b31](https://github.com/BitGo/BitGoJS/commit/e028b31b3954810ee6c3fd7fdfa6ed4a07aa458e))
+
+### Features
+
+- **sdk-coin-atom:** add function to load inputs and outputs of a transaction ([c3e3c1d](https://github.com/BitGo/BitGoJS/commit/c3e3c1d0632f5f7490f1aad6c0d1042533f222ab))
+- **sdk-coin-atom:** add staking transaction builders ([5fe2e35](https://github.com/BitGo/BitGoJS/commit/5fe2e3589b1ac47031d82e1869dff1e676a4f318))
+- **sdk-coin-atom:** add support to serialise unsigned txn ([f46c31b](https://github.com/BitGo/BitGoJS/commit/f46c31b3a22096b193e521d259fdc8f5c030ab02))
+- **sdk-coin-atom:** implement isValidAddress for atom ([2fb8a93](https://github.com/BitGo/BitGoJS/commit/2fb8a93f05f024e12b72c7ee85ec8563a2e65275))
+- **sdk-coin-atom:** implement remaining methods ([7c03501](https://github.com/BitGo/BitGoJS/commit/7c035019c76a1bbf4fbaa3da7e5823823637d2be))
+
+### BREAKING CHANGES
+
+- **sdk-coin-atom:** type MessageData is changed
+- **sdk-coin-atom:** Renamed type interface GasFeeLimitData to FeeData and parameter gas to gasLimit
+
 # [2.1.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/sdk-coin-atom@2.0.0...@bitgo/sdk-coin-atom@2.1.0) (2023-02-17)
 
 ### Features

package/dist/src/atom.d.ts

@@ -1,28 +1,133 @@
 /// <reference types="node" />
-import { BaseCoin, BitGoBase, ExplanationResult, KeyPair, MPCAlgorithm, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions, UnsignedTransaction, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
+import { BaseCoin, BitGoBase, ExplanationResult, KeyPair, MPCAlgorithm, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
 import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
+import { Hash } from 'crypto';
+import { TransactionBuilderFactory } from './lib';
+import * as request from 'superagent';
+/**
+ * Atom accounts support memo Id based addresses
+ */
+interface AddressDetails {
+    address: string;
+    memoId?: string | undefined;
+}
+interface RecoveryOptions {
+    userKey?: string;
+    backupKey?: string;
+    bitgoKey: string;
+    recoveryDestination: string;
+    krsProvider?: string;
+    walletPassphrase?: string;
+    startingScanIndex?: number;
+    scan?: number;
+}
+interface AtomTx {
+    serializedTx: string;
+    scanIndex: number;
+}
 export declare class Atom extends BaseCoin {
     protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
     protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
     static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
-    /**
-     * Factor between the coin's base unit and its smallest subdivison
-     */
+    /** @inheritDoc **/
     getBaseFactor(): string | number;
+    /** @inheritDoc **/
     getChain(): string;
+    /** @inheritDoc **/
     getFamily(): CoinFamily;
+    /** @inheritDoc **/
     getFullName(): string;
     /** @inheritDoc */
     supportsTss(): boolean;
+    /** @inheritDoc **/
     getMPCAlgorithm(): MPCAlgorithm;
-    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
-    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
-    parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
-    generateKeyPair(seed?: Buffer): KeyPair;
+    /** @inheritDoc **/
     isValidPub(pub: string): boolean;
+    /** @inheritDoc **/
     isValidPrv(prv: string): boolean;
+    getBuilder(): TransactionBuilderFactory;
+    /** @inheritDoc **/
     isValidAddress(address: string): boolean;
-    signTransaction(params: SignTransactionOptions): Promise<SignedTransaction>;
-    explainTransaction(unsignedTransaction: UnsignedTransaction): Promise<ExplanationResult>;
+    /** @inheritDoc **/
+    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
+    /** @inheritDoc **/
+    parseTransaction(params: ParseTransactionOptions & {
+        txHex: string;
+    }): Promise<ParsedTransaction>;
+    /** @inheritDoc **/
+    explainTransaction(options: {
+        txHex: string;
+    }): Promise<ExplanationResult>;
+    /** @inheritDoc **/
+    generateKeyPair(seed?: Buffer): KeyPair;
+    /**
+     * 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>;
+    /**
+     * Builds a funds recovery transaction without BitGo
+     * @param {RecoveryOptions} params parameters needed to construct and
+     * (maybe) sign the transaction
+     *
+     * @returns {AtomTx} the serialized transaction hex string and index
+     * of the address being swept
+     */
+    recover(params: RecoveryOptions): Promise<AtomTx>;
+    /**
+     * Get balance from public node
+     */
+    protected getBalanceFromNode(senderAddress: string): Promise<request.Response>;
+    /**
+     * Helper to fetch chainId
+     */
+    protected getChainId(): Promise<string>;
+    /**
+     * Get chain id from public node
+     */
+    protected getChainIdFromNode(): Promise<request.Response>;
+    /**
+     * Helper to fetch account number
+     */
+    protected getAccountDetails(senderAddress: string): Promise<string[]>;
+    /**
+     * Get account number from public node
+     */
+    protected getAccountFromNode(senderAddress: string): Promise<request.Response>;
+    /**
+     * Helper to fetch account balance
+     */
+    protected getAccountBalance(senderAddress: string): Promise<string>;
+    /**
+     * Get the public node url from the Environments constant we have defined
+     */
+    protected getPublicNodeUrl(): string;
+    getAddressFromPublicKey(pubKey: string): string;
+    /** @inheritDoc **/
+    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
+    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;
+    private getKeyCombinedFromTssKeyShares;
+    private signRecoveryTSS;
 }
+export {};
 //# sourceMappingURL=atom.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"atom.d.ts","sourceRoot":"","sources":["../../src/atom.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,QAAQ,EACR,SAAS,EACT,iBAAiB,EACjB,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE9E,qBAAa,IAAK,SAAQ,QAAQ;IAChC,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,aAAa,IAAI,MAAM,GAAG,MAAM;IAIhC,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,UAAU;IAIvB,WAAW,IAAI,MAAM;IAIrB,kBAAkB;IAClB,WAAW,IAAI,OAAO;IAItB,eAAe,IAAI,YAAY;IAI/B,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrE,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAIvC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI3E,kBAAkB,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAGzF"}
+{"version":3,"file":"atom.d.ts","sourceRoot":"","sources":["../../src/atom.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,QAAQ,EAER,SAAS,EAKT,iBAAiB,EAIjB,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EAEjB,sBAAsB,EAGtB,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAS,MAAM,qBAAqB,CAAC;AAGrF,OAAO,EAAc,IAAI,EAAe,MAAM,QAAQ,CAAC;AAKvD,OAAO,EAAuC,yBAAyB,EAAE,MAAM,OAAO,CAAC;AACvF,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAMtC;;GAEG;AACH,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AASD,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,UAAU,MAAM;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,IAAK,SAAQ,QAAQ;IAChC,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,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,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,UAAU,IAAI,yBAAyB;IAIvC,mBAAmB;IACnB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC,mBAAmB;IACb,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IA+B3E,mBAAmB;IACb,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAgCvG,mBAAmB;IACb,kBAAkB,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAahF,mBAAmB;IACnB,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC;;;;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;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuGvD;;OAEG;cACa,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IAYpF;;OAEG;cACa,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ7C;;OAEG;cACa,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IAY/D;;OAEG;cACa,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ3E;;OAEG;cACa,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IAYpF;;OAEG;cACa,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQzE;;OAEG;IACH,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAIpC,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI/C,mBAAmB;IACb,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAarE,eAAe,IAAI,IAAI;IAIvB;;;;;OAKG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc;IA4ClD;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAUtC,OAAO,CAAC,8BAA8B;YAiExB,eAAe;CAwF9B"}