@bitgo-beta/sdk-coin-dot 2.2.8-beta.167 → 2.2.8-beta.1670

package/dist/esm/dot.d.ts

@@ -0,0 +1,147 @@
+import { BaseCoin, BitGoBase, Eddsa, ExplanationResult, KeyPair, MPCAlgorithm, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions as BaseSignTransactionOptions, UnsignedTransaction, VerifyTransactionOptions, TssVerifyAddressOptions, MPCTx, MPCRecoveryOptions, MPCConsolidationRecoveryOptions, MPCSweepTxs, MPCSweepRecoveryOptions, MPCTxs, MultisigType, AuditDecryptedKeyParams } from '@bitgo-beta/sdk-core';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo-beta/statics';
+import { Interface } from './lib';
+import '@polkadot/api-augment';
+import { ApiPromise } from '@polkadot/api';
+import { Material } from './lib/iface';
+export declare const DEFAULT_SCAN_FACTOR = 20;
+export interface SignTransactionOptions extends BaseSignTransactionOptions {
+    txPrebuild: TransactionPrebuild;
+    prv: string;
+}
+export interface TransactionPrebuild {
+    txHex: string;
+    transaction: Interface.TxData;
+}
+export interface VerifiedTransactionParameters {
+    txHex: string;
+    prv: string;
+}
+export declare class Dot extends BaseCoin {
+    protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
+    readonly MAX_VALIDITY_DURATION = 2400;
+    readonly SWEEP_TXN_DURATION = 64;
+    constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
+    protected static initialized: boolean;
+    protected static MPC: Eddsa;
+    protected static nodeApiInitialized: boolean;
+    protected static API: ApiPromise;
+    static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
+    getChain(): string;
+    getBaseChain(): string;
+    getFamily(): string;
+    getFullName(): string;
+    getBaseFactor(): number;
+    /**
+     * Flag for sending value of 0
+     * @returns {boolean} True if okay to send 0 value, false otherwise
+     */
+    valuelessTransferAllowed(): boolean;
+    /** @inheritDoc */
+    supportsTss(): boolean;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
+    getMPCAlgorithm(): MPCAlgorithm;
+    allowsAccountConsolidations(): boolean;
+    /**
+     * Generate ed25519 key pair
+     *
+     * @param seed
+     * @returns {Object} object with generated pub, prv
+     */
+    generateKeyPair(seed?: Buffer): KeyPair;
+    /**
+     * Return boolean indicating whether input is valid public key for the coin.
+     *
+     * @param {String} pub the pub to be checked
+     * @returns {Boolean} is it valid?
+     */
+    isValidPub(pub: string): boolean;
+    /**
+     * Return boolean indicating whether the supplied private key is a valid dot private key
+     *
+     * @param {String} prv the prv to be checked
+     * @returns {Boolean} is it valid?
+     */
+    isValidPrv(prv: string): boolean;
+    /**
+     * Return boolean indicating whether input is valid public key for the coin
+     *
+     * @param {String} address the pub to be checked
+     * @returns {Boolean} is it valid?
+     */
+    isValidAddress(address: string): boolean;
+    /**
+     * Sign message with private key
+     *
+     * @param key
+     * @param message
+     * @return {Buffer} A signature over the given message using the given key
+     */
+    signMessage(key: KeyPair, message: string | Buffer): Promise<Buffer>;
+    /**
+     * Explain/parse transaction
+     * @param unsignedTransaction
+     */
+    explainTransaction(unsignedTransaction: UnsignedTransaction): Promise<ExplanationResult>;
+    verifySignTransactionParams(params: SignTransactionOptions): VerifiedTransactionParameters;
+    /**
+     * Assemble keychain and half-sign prebuilt transaction
+     *
+     * @param params
+     * @param params.txPrebuild {TransactionPrebuild} prebuild object returned by platform
+     * @param params.prv {String} user prv
+     * @returns {Promise<SignedTransaction>}
+     */
+    signTransaction(params: SignTransactionOptions): Promise<SignedTransaction>;
+    protected getInitializedNodeAPI(): Promise<ApiPromise>;
+    protected getAccountInfo(walletAddr: string): Promise<{
+        nonce: number;
+        freeBalance: number;
+    }>;
+    protected getHeaderInfo(): Promise<{
+        headerNumber: number;
+        headerHash: string;
+    }>;
+    /**
+     *
+     * Estimate the fee of the transaction
+     *
+     * @param {string} destAddr destination wallet address
+     * @param {string} srcAddr source wallet address
+     * @param {string} amount amount to transfer
+     * @returns {number} the estimated fee the transaction will cost
+     *
+     * @see https://polkadot.js.org/docs/api/cookbook/tx#how-do-i-estimate-the-transaction-fees
+     */
+    protected getFee(destAddr: string, srcAddr: string, amount: number): Promise<number>;
+    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 DOT 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>;
+    /** inherited doc */
+    createBroadcastableSweepTransaction(params: MPCSweepRecoveryOptions): Promise<MPCTxs>;
+    parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
+    isWalletAddress(params: TssVerifyAddressOptions): Promise<boolean>;
+    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
+    getAddressFromPublicKey(Pubkey: string): string;
+    private getBuilder;
+    /** @inheritDoc */
+    auditDecryptedKey({ publicKey, prv, multiSigType }: AuditDecryptedKeyParams): void;
+}
+//# sourceMappingURL=dot.d.ts.map

package/dist/esm/dot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dot.d.ts","sourceRoot":"","sources":["../../src/dot.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,SAAS,EAET,KAAK,EAEL,iBAAiB,EACjB,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,IAAI,0BAA0B,EACpD,mBAAmB,EACnB,wBAAwB,EACxB,uBAAuB,EAGvB,KAAK,EACL,kBAAkB,EAClB,+BAA+B,EAC/B,WAAW,EAGX,uBAAuB,EACvB,MAAM,EACN,YAAY,EAEZ,uBAAuB,EAGxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAA+B,MAAM,qBAAqB,CAAC;AAC/F,OAAO,EACL,SAAS,EAOV,MAAM,OAAO,CAAC;AACf,OAAO,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAc,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAIvC,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAEtC,MAAM,WAAW,sBAAuB,SAAQ,0BAA0B;IACxE,UAAU,EAAE,mBAAmB,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,SAAS,CAAC,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,6BAA6B;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAID,qBAAa,GAAI,SAAQ,QAAQ;IAC/B,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC3D,QAAQ,CAAC,qBAAqB,QAAQ;IACtC,QAAQ,CAAC,kBAAkB,MAAM;gBAErB,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAUrE,SAAS,CAAC,MAAM,CAAC,WAAW,UAAS;IACrC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC;IAC5B,SAAS,CAAC,MAAM,CAAC,kBAAkB,UAAS;IAC5C,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC;IAEjC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,QAAQ,IAAI,MAAM;IAIlB,YAAY,IAAI,MAAM;IAItB,SAAS,IAAI,MAAM;IAInB,WAAW,IAAI,MAAM;IAIrB,aAAa,IAAI,MAAM;IAIvB;;;OAGG;IACH,wBAAwB,IAAI,OAAO;IAInC,kBAAkB;IAClB,WAAW,IAAI,OAAO;IAItB,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,eAAe,IAAI,YAAY;IAI/B,2BAA2B,IAAI,OAAO;IAItC;;;;;OAKG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAYvC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;;;OAMG;IACG,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAM1E;;;OAGG;IACG,kBAAkB,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+B9F,2BAA2B,CAAC,MAAM,EAAE,sBAAsB,GAAG,6BAA6B;IA4B1F;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;cAqBjE,qBAAqB,IAAI,OAAO,CAAC,UAAU,CAAC;cAS5C,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;cAMnF,aAAa,IAAI,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAMtF;;;;;;;;;;OAUG;cACa,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;cAM1E,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAYhD;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,GAAG,WAAW,CAAC;IA2IvE;;;;;;;OAOG;IACG,qBAAqB,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAAC,MAAM,GAAG,WAAW,CAAC;IA+EnG,oBAAoB;IACd,mCAAmC,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;IAiErF,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E,eAAe,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQlE,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAmF3E,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI/C,OAAO,CAAC,UAAU;IAIlB,kBAAkB;IAClB,iBAAiB,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,uBAAuB;CAM5E"}