@bitgo-beta/abstract-substrate 1.0.1-beta.14 → 1.0.1-beta.1400

package/dist/src/abstractSubstrateCoin.d.ts

@@ -1,9 +1,15 @@
-import { BaseCoin, BitGoBase, KeyPair, MPCAlgorithm, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
-import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
+import { AuditDecryptedKeyParams, BaseCoin, BitGoBase, KeyPair, MPCAlgorithm, MPCConsolidationRecoveryOptions, MPCRecoveryOptions, MPCSweepRecoveryOptions, MPCSweepTxs, MPCTx, MPCTxs, MultisigType, ParsedTransaction, ParseTransactionOptions, SignedTransaction, TssVerifyAddressOptions, VerifyTransactionOptions, signEddsaMpcV2RecoveryTx, EddsaSigningMaterial } from '@bitgo-beta/sdk-core';
+import { CoinFamily, BaseCoin as StaticsBaseCoin } from '@bitgo-beta/statics';
+import { Transaction } from './lib';
+import { NativeTransferBuilder } from './lib/nativeTransferBuilder';
+import { SignTransactionOptions, VerifiedTransactionParameters, Material } from './lib/iface';
+import { ApiPromise } from '@polkadot/api';
+export declare const DEFAULT_SCAN_FACTOR = 20;
 export declare class SubstrateCoin extends BaseCoin {
     protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
+    readonly MAX_VALIDITY_DURATION = 2400;
+    readonly SWEEP_TXN_DURATION = 64;
     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
      */
@@ -18,6 +24,8 @@ export declare class SubstrateCoin extends BaseCoin {
     getFullName(): string;
     /** @inheritDoc */
     supportsTss(): boolean;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
     /** @inheritDoc **/
     getMPCAlgorithm(): MPCAlgorithm;
     /** @inheritDoc **/
@@ -25,14 +33,79 @@ export declare class SubstrateCoin extends BaseCoin {
     /** @inheritDoc **/
     isValidPub(pub: string): boolean;
     /** @inheritDoc **/
-    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
+    isWalletAddress(params: TssVerifyAddressOptions): Promise<boolean>;
     /** @inheritDoc **/
     parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
     /** @inheritDoc **/
     verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
     /** @inheritDoc **/
     isValidAddress(address: string): boolean;
+    verifySignTransactionParams(params: SignTransactionOptions): VerifiedTransactionParameters;
     /** @inheritDoc **/
     signTransaction(params: SignTransactionOptions): Promise<SignedTransaction>;
+    /**
+     * Retrieves the address format for the substrate coin.
+     *
+     * @returns {number} The address format as a number.
+     */
+    protected getAddressFormat(): number;
+    /**
+     * Retrieves the maximum validity duration in blocks.
+     *
+     * This method is intended to be overridden by subclasses to provide the specific
+     * maximum validity duration for different types of Substrate-based coins.
+     *
+     * @returns {number} The maximum validity duration in blocks.
+     * @throws {Error} If the method is not implemented by the subclass.
+     */
+    protected getMaxValidityDurationBlocks(): number;
+    protected getAddressFromPublicKey(Pubkey: string): string;
+    protected getInitializedNodeAPI(): Promise<ApiPromise>;
+    protected getAccountInfo(walletAddr: string): Promise<{
+        nonce: number;
+        freeBalance: number;
+    }>;
+    protected getFee(destAddr: string, srcAddr: string, amount: number): Promise<number>;
+    protected getHeaderInfo(): Promise<{
+        headerNumber: number;
+        headerHash: string;
+    }>;
+    protected getMaterial(): Promise<Material>;
+    /**
+     * Builds a funds recovery transaction without BitGo
+     * @param {MPCRecoveryOptions} params parameters needed to construct and
+     * (maybe) sign the transaction
+     *
+     * @returns {MPCTx} the serialized transaction hex string and index
+     * of the address being swept
+     */
+    recover(params: MPCRecoveryOptions): Promise<MPCTx | MPCSweepTxs>;
+    /**
+     * Builds native TAO recoveries of receive addresses in batch without BitGo.
+     * Funds will be recovered to base address first. You need to initiate another sweep txn after that.
+     *
+     * @param {MPCConsolidationRecoveryOptions} params - options for consolidation recovery.
+     * @param {string} [params.startingScanIndex] - receive address index to start scanning from. default to 1 (inclusive).
+     * @param {string} [params.endingScanIndex] - receive address index to end scanning at. default to startingScanIndex + 20 (exclusive).
+     */
+    recoverConsolidations(params: MPCConsolidationRecoveryOptions): Promise<MPCTxs | MPCSweepTxs>;
+    protected getEddsaSigningMaterial(userKey: string, walletPassphrase: string): Promise<EddsaSigningMaterial>;
+    protected signSubstrateMpcV2Recovery(params: Parameters<typeof signEddsaMpcV2RecoveryTx>[0]): Promise<Buffer>;
+    /**
+     * Adds an MPCv1 or MPCv2 signature to a Substrate transaction builder.
+     *
+     * Both branches hand off the raw 64-byte Ed25519 signature untouched.
+     * Transaction#constructSignedPayload already prepends the 0x00 type-tag
+     * (the Substrate MultiSignature enum discriminant for Ed25519) to whatever
+     * signature buffer is passed to addSignature, so wrapping the signature
+     * here would produce a double discriminant, corrupting the on-wire sig
+     * bytes and causing the chain to reject the extrinsic with `1010: Bad
+     * signature`.
+     */
+    protected addSubstrateRecoverySignature(txBuilder: NativeTransferBuilder, signingMaterial: EddsaSigningMaterial, backupKey: string, walletPassphrase: string, unsignedTransaction: Transaction, currPath: string, bitgoKey: string, accountId: string): Promise<void>;
+    /** inherited doc */
+    createBroadcastableSweepTransaction(params: MPCSweepRecoveryOptions): Promise<MPCTxs>;
+    /** inherited doc */
+    auditDecryptedKey({ publicKey, prv, multiSigType }: AuditDecryptedKeyParams): void;
 }
 //# sourceMappingURL=abstractSubstrateCoin.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"abstractSubstrateCoin.d.ts","sourceRoot":"","sources":["../../src/abstractSubstrateCoin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,SAAS,EACT,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE9E,qBAAa,aAAc,SAAQ,QAAQ;IACzC,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,mBAAmB;IACnB,eAAe,IAAI,YAAY;IAI/B,mBAAmB;IACnB,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAIvC,mBAAmB;IACnB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,mBAAmB;IACnB,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,mBAAmB;IACnB,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E,mBAAmB;IACnB,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrE,mBAAmB;IACnB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC,mBAAmB;IACnB,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAG5E"}
+{"version":3,"file":"abstractSubstrateCoin.d.ts","sourceRoot":"","sources":["../../src/abstractSubstrateCoin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,QAAQ,EACR,SAAS,EAGT,OAAO,EACP,YAAY,EACZ,+BAA+B,EAC/B,kBAAkB,EAClB,uBAAuB,EACvB,WAAW,EACX,KAAK,EACL,MAAM,EAEN,YAAY,EAEZ,iBAAiB,EACjB,uBAAuB,EAEvB,iBAAiB,EACjB,uBAAuB,EAKvB,wBAAwB,EAGxB,wBAAwB,EACxB,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAA+B,WAAW,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAI9F,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAEtC,qBAAa,aAAc,SAAQ,QAAQ;IACzC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC3D,QAAQ,CAAC,qBAAqB,QAAQ;IACtC,QAAQ,CAAC,kBAAkB,MAAM;IAEjC,SAAS,aAAa,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAU/E;;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,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAYvC,mBAAmB;IACnB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,mBAAmB;IACb,eAAe,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAcxE,mBAAmB;IACb,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAInF,mBAAmB;IACb,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAqE3E,mBAAmB;IACnB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC,2BAA2B,CAAC,MAAM,EAAE,sBAAsB,GAAG,6BAA6B;IAe1F,mBAAmB;IACb,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAqBjF;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAIpC;;;;;;;;OAQG;IACH,SAAS,CAAC,4BAA4B,IAAI,MAAM;IAIhD,SAAS,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;cAIzC,qBAAqB,IAAI,OAAO,CAAC,UAAU,CAAC;cAI5C,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;cAInF,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;cAI1E,aAAa,IAAI,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;cAItE,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAIhD;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,GAAG,WAAW,CAAC;IAmHvE;;;;;;;OAOG;IACG,qBAAqB,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAAC,MAAM,GAAG,WAAW,CAAC;cA+EnF,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;cAMjG,0BAA0B,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAInH;;;;;;;;;;OAUG;cACa,6BAA6B,CAC3C,SAAS,EAAE,qBAAqB,EAChC,eAAe,EAAE,oBAAoB,EACrC,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,mBAAmB,EAAE,WAAW,EAChC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAgChB,oBAAoB;IACd,mCAAmC,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;IAmE3F,oBAAoB;IACpB,iBAAiB,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,uBAAuB;CAM5E"}