@bitgo-beta/sdk-coin-ada 2.3.14-beta.1223 → 2.3.14-beta.1224

package/dist/src/ada.d.ts

@@ -0,0 +1,116 @@
+import { BaseCoin, BitGoBase, KeyPair, MPCAlgorithm, ParsedTransaction, ParseTransactionOptions as BaseParseTransactionOptions, SignedTransaction, SignTransactionOptions as BaseSignTransactionOptions, TransactionExplanation, VerifyAddressOptions, VerifyTransactionOptions, MPCTx, MPCRecoveryOptions, MPCConsolidationRecoveryOptions, MPCSweepTxs, MPCSweepRecoveryOptions, MPCTxs, PopulatedIntent, PrebuildTransactionWithIntentOptions, MultisigType, AuditDecryptedKeyParams } from '@bitgo-beta/sdk-core';
+import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
+import * as request from 'superagent';
+export declare const DEFAULT_SCAN_FACTOR = 20;
+export interface TransactionPrebuild {
+    txHex: string;
+}
+export interface ExplainTransactionOptions {
+    txPrebuild: TransactionPrebuild;
+}
+export interface AdaParseTransactionOptions extends BaseParseTransactionOptions {
+    txPrebuild: TransactionPrebuild;
+}
+export interface SignTransactionOptions extends BaseSignTransactionOptions {
+    txPrebuild: TransactionPrebuild;
+    prv: string;
+}
+interface AdaAddressParams {
+    bitgoKey: string;
+    index: number;
+    seed?: string;
+}
+interface AdaAddressAndAccountId {
+    address: string;
+    accountId: string;
+}
+export type AdaTransactionExplanation = TransactionExplanation;
+export declare class Ada 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
+     */
+    getBaseFactor(): number;
+    getChain(): string;
+    getFamily(): CoinFamily;
+    getFullName(): string;
+    getBaseChain(): string;
+    /**
+     * Verify that a transaction prebuild complies with the original intention
+     *  A prebuild transaction has to be parsed correctly and intended recipients has to be
+     *  in the transaction output
+     *
+     * @param params.txPrebuild prebuild transaction
+     * @param params.txParams transaction parameters
+     * @return true if verification success
+     *
+     */
+    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
+    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
+    /** @inheritDoc */
+    signMessage(key: KeyPair, message: string | Buffer): Promise<Buffer>;
+    /**
+     * Explain/parse transaction
+     * @param params
+     */
+    explainTransaction(params: ExplainTransactionOptions): Promise<AdaTransactionExplanation>;
+    parseTransaction(params: AdaParseTransactionOptions): Promise<ParsedTransaction>;
+    generateKeyPair(seed?: Buffer): KeyPair;
+    isValidPub(pub: string): boolean;
+    isValidPrv(prv: string): boolean;
+    isValidAddress(address: string): boolean;
+    signTransaction(params: SignTransactionOptions): Promise<SignedTransaction>;
+    protected getPublicNodeUrl(): string;
+    protected getDataFromNode(endpoint: string, requestBody?: Record<string, unknown>): Promise<request.Response>;
+    protected getAddressInfo(walletAddr: string): Promise<{
+        balance: number;
+        utxoSet: Array<Record<string, any>>;
+    }>;
+    protected getChainTipInfo(): Promise<Record<string, string>>;
+    /** inherited doc */
+    createBroadcastableSweepTransaction(params: MPCSweepRecoveryOptions): Promise<MPCTxs>;
+    /**
+     * Builds funds recovery transaction(s) without BitGo
+     *
+     * @param {MPCRecoveryOptions} params parameters needed to construct and
+     * (maybe) sign the transaction
+     *
+     * @returns {MPCTx | MPCSweepTxs} array of the serialized transaction hex strings and indices
+     * of the addresses being swept
+     */
+    recover(params: MPCRecoveryOptions): Promise<MPCTx | MPCSweepTxs>;
+    /**
+     * Builds native ADA 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>;
+    /**
+     * Obtains ADA address and account id from provided bitgo key for the given index and seed (optional).
+     *
+     * @param {AdaAddressParams} params - params to obtain ada address and account id
+     */
+    getAdaAddressAndAccountId(params: AdaAddressParams): Promise<AdaAddressAndAccountId>;
+    /** inherited doc */
+    supportsTss(): boolean;
+    /** @inheritDoc */
+    supportsMessageSigning(): boolean;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
+    /** inherited doc */
+    getMPCAlgorithm(): MPCAlgorithm;
+    /** inherited doc */
+    allowsAccountConsolidations(): boolean;
+    private getBuilder;
+    /** inherited doc */
+    setCoinSpecificFieldsInIntent(intent: PopulatedIntent, params: PrebuildTransactionWithIntentOptions): void;
+    /** inherited doc */
+    auditDecryptedKey({ publicKey, prv, multiSigType }: AuditDecryptedKeyParams): void;
+}
+export {};
+//# sourceMappingURL=ada.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ada.d.ts","sourceRoot":"","sources":["../../src/ada.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EAER,SAAS,EAET,OAAO,EACP,YAAY,EAEZ,iBAAiB,EACjB,uBAAuB,IAAI,2BAA2B,EACtD,iBAAiB,EACjB,sBAAsB,IAAI,0BAA0B,EACpD,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EAMxB,KAAK,EACL,kBAAkB,EAClB,+BAA+B,EAC/B,WAAW,EAGX,uBAAuB,EACvB,MAAM,EACN,eAAe,EACf,oCAAoC,EACpC,YAAY,EAEZ,uBAAuB,EACxB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAS,MAAM,qBAAqB,CAAC;AAErF,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAItC,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAEtC,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,mBAAmB,CAAC;CACjC;AAED,MAAM,WAAW,0BAA2B,SAAQ,2BAA2B;IAC7E,UAAU,EAAE,mBAAmB,CAAC;CACjC;AAED,MAAM,WAAW,sBAAuB,SAAQ,0BAA0B;IACxE,UAAU,EAAE,mBAAmB,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,UAAU,gBAAgB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,UAAU,sBAAsB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,yBAAyB,GAAG,sBAAsB,CAAC;AAE/D,qBAAa,GAAI,SAAQ,QAAQ;IAC/B,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;IAS/E,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F;;OAEG;IACI,aAAa,IAAI,MAAM;IAIvB,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,UAAU;IAIvB,WAAW,IAAI,MAAM;IAI5B,YAAY,IAAI,MAAM;IAGtB;;;;;;;;;OASG;IACG,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IA0CrE,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQrE,kBAAkB;IACZ,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO1E;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAezF,gBAAgB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAYtF,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAYvC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIlC,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAiBjF,SAAS,CAAC,gBAAgB,IAAI,MAAM;cAIpB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;cAWnG,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;KAAE,CAAC;cAapD,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IASlE,oBAAoB;IACd,mCAAmC,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;IAmD3F;;;;;;;;OAQG;IACG,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,GAAG,WAAW,CAAC;IAsJvE;;;;;;;OAOG;IACG,qBAAqB,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAAC,MAAM,GAAG,WAAW,CAAC;IAwEnG;;;;OAIG;IACG,yBAAyB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAwB1F,oBAAoB;IACpB,WAAW,IAAI,OAAO;IAItB,kBAAkB;IAClB,sBAAsB,IAAI,OAAO;IAIjC,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,oBAAoB;IACpB,eAAe,IAAI,YAAY;IAI/B,oBAAoB;IACpB,2BAA2B,IAAI,OAAO;IAItC,OAAO,CAAC,UAAU;IAIlB,oBAAoB;IACpB,6BAA6B,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,oCAAoC,GAAG,IAAI;IAK1G,oBAAoB;IACpB,iBAAiB,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,uBAAuB;CAO5E"}