@bitgo-beta/sdk-coin-flr 1.0.1-beta.81 → 1.0.1-beta.810

package/dist/src/flr.d.ts

@@ -6,18 +6,156 @@
  * @coinFullName Flare
  * @coinWebsite https://flare-explorer.flare.network
  */
-import { BaseCoin, BitGoBase, MPCAlgorithm } from '@bitgo-beta/sdk-core';
+import { BaseCoin, BitGoBase, FeeEstimateOptions, IWallet, MPCAlgorithm, MultisigType, Recipient, TransactionExplanation } from '@bitgo-beta/sdk-core';
 import { BaseCoin as StaticsBaseCoin } from '@bitgo-beta/statics';
-import { AbstractEthLikeNewCoins } from '@bitgo-beta/abstract-eth';
+import { AbstractEthLikeNewCoins, UnsignedSweepTxMPCv2, RecoverOptions, OfflineVaultTxInfo } from '@bitgo-beta/abstract-eth';
 import { TransactionBuilder } from './lib';
+import { FlrPLib } from '@bitgo-beta/sdk-coin-flrp';
+import { BuildOptions, ExplainTransactionOptions, FeeEstimate, HopParams, HopPrebuild, HopTransactionBuildOptions, PresignTransactionOptions, TransactionPrebuild, VerifyFlrTransactionOptions } from './iface';
 export declare class Flr extends AbstractEthLikeNewCoins {
     protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
     static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
     protected getTransactionBuilder(): TransactionBuilder;
     /** @inheritDoc */
     supportsTss(): boolean;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
     /** @inheritDoc */
     getMPCAlgorithm(): MPCAlgorithm;
-    recoveryBlockchainExplorerQuery(query: Record<string, string>): Promise<Record<string, unknown>>;
+    protected buildUnsignedSweepTxnTSS(params: RecoverOptions): Promise<OfflineVaultTxInfo | UnsignedSweepTxMPCv2>;
+    /**
+     * Validates if an address is valid for FLR
+     * Also validates P-chain addresses for cross-chain transactions
+     * @param {string} address - address to validate
+     * @returns {boolean} - validation result
+     */
+    isValidAddress(address: string): boolean;
+    /**
+     * Get the corresponding P-chain coin name
+     * @returns {string} flrp or tflrp depending on mainnet/testnet
+     */
+    getFlrP(): string;
+    /**
+     * Get the atomic transaction builder factory for cross-chain operations
+     * @returns {FlrPLib.TransactionBuilderFactory} the atomic builder factory
+     */
+    protected getAtomicBuilder(): FlrPLib.TransactionBuilderFactory;
+    /**
+     * Check if this coin is a token
+     * @returns {boolean} false for FLR (base chain)
+     */
+    isToken(): boolean;
+    /**
+     * Explains an atomic transaction using atomic builder.
+     * @param {string} txHex - the transaction hex
+     * @returns {Promise<AtomicTransactionExplanation>} the transaction explanation
+     * @private
+     */
+    private explainAtomicTransaction;
+    /**
+     * Verify signature for an atomic transaction using atomic builder.
+     * @param {string} txHex - the transaction hex
+     * @returns {Promise<boolean>} true if signature is from the input address
+     * @private
+     */
+    private verifySignatureForAtomicTransaction;
+    /**
+     * Explain a transaction from txHex, overriding BaseCoins
+     * transaction can be either atomic or eth txn.
+     * @param {ExplainTransactionOptions} params The options with which to explain the transaction
+     * @returns {Promise<TransactionExplanation>} the transaction explanation
+     */
+    explainTransaction(params: ExplainTransactionOptions): Promise<TransactionExplanation>;
+    /**
+     * Explains an EVM transaction using regular eth txn builder
+     * @param {BaseTransaction} tx - the transaction to explain
+     * @returns {Object} the transaction explanation
+     * @private
+     */
+    private explainEVMTransaction;
+    /**
+     * Verify that a transaction prebuild complies with the original intention
+     *
+     * @param {VerifyFlrTransactionOptions} params
+     * @param params.txParams params object passed to send
+     * @param params.txPrebuild prebuild object returned by server
+     * @param params.wallet Wallet object to obtain keys to verify against
+     * @returns {Promise<boolean>}
+     */
+    verifyTransaction(params: VerifyFlrTransactionOptions): Promise<boolean>;
+    /**
+     * Check if an address is a FLR C-chain address (0x format)
+     * @param {string} address - the address to check
+     * @returns {boolean} true if it's a C-chain address
+     * @private
+     */
+    private static isFLRAddress;
+    /**
+     * Verify that the coin matches in the prebuild
+     * @param {TransactionPrebuild} txPrebuild - the transaction prebuild
+     * @returns {boolean} true if coin matches
+     */
+    verifyCoin(txPrebuild: TransactionPrebuild): boolean;
+    /**
+     * Coin-specific things done before signing a transaction, i.e. verification
+     * @param {PresignTransactionOptions} params - the presign options
+     * @returns {Promise<PresignTransactionOptions>}
+     */
+    presignTransaction(params: PresignTransactionOptions): Promise<PresignTransactionOptions>;
+    /**
+     * Modify prebuild after receiving it from the server. Add things like nlocktime
+     * @param {TransactionPrebuild} params - the transaction prebuild
+     * @returns {Promise<TransactionPrebuild>}
+     */
+    postProcessPrebuild(params: TransactionPrebuild): Promise<TransactionPrebuild>;
+    /**
+     * Validates that the hop prebuild from the HSM is valid and correct
+     * @param {IWallet} wallet The wallet that the prebuild is for
+     * @param {HopPrebuild} hopPrebuild The prebuild to validate
+     * @param {Object} originalParams The original parameters passed to prebuildTransaction
+     * @returns {Promise<void>}
+     * @throws Error if The prebuild is invalid
+     */
+    validateHopPrebuild(wallet: IWallet, hopPrebuild: HopPrebuild, originalParams?: {
+        recipients: Recipient[];
+    }): Promise<void>;
+    /**
+     * Modify prebuild before sending it to the server. Add things like hop transaction params
+     * @param {BuildOptions} buildParams The whitelisted parameters for this prebuild
+     * @param {boolean} buildParams.hop True if this should prebuild a hop tx, else false
+     * @param {Recipient[]} buildParams.recipients The recipients array of this transaction
+     * @param {Wallet} buildParams.wallet The wallet sending this tx
+     * @param {string} buildParams.walletPassphrase the passphrase for this wallet
+     * @returns {Promise<BuildOptions>}
+     */
+    getExtraPrebuildParams(buildParams: BuildOptions): Promise<BuildOptions>;
+    /**
+     * Creates the extra parameters needed to build a hop transaction
+     * @param {HopTransactionBuildOptions} params The original build parameters
+     * @returns {Promise<HopParams>} extra parameters object to merge with the original build parameters object and send to the platform
+     */
+    createHopTransactionParams({ recipients, type }: HopTransactionBuildOptions): Promise<HopParams>;
+    /**
+     * Fetch fee estimate information from the server
+     * @param {FeeEstimateOptions} params The params passed into the function
+     * @param {Boolean} [params.hop] True if we should estimate fee for a hop transaction
+     * @param {String} [params.recipient] The recipient of the transaction to estimate a send to
+     * @param {String} [params.data] The data to estimate a send for
+     * @returns {Promise<FeeEstimate>} The fee info returned from the server
+     */
+    feeEstimate(params: FeeEstimateOptions): Promise<FeeEstimate>;
+    /**
+     * Calculate tx hash like evm from tx hex.
+     * @param {string} tx - the transaction hex
+     * @returns {Buffer} tx hash
+     */
+    static getTxHash(tx: string): Buffer;
+    /**
+     * Make a query to Flare explorer for information such as balance, token balance, solidity calls
+     * @param {Object} query key-value pairs of parameters to append after /api
+     * @param {string} apiKey optional API key to use instead of the one from the environment
+     * @returns {Promise<Object>} response from Flare explorer
+     */
+    recoveryBlockchainExplorerQuery(query: Record<string, string>, apiKey?: string): Promise<Record<string, unknown>>;
 }
 //# sourceMappingURL=flr.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"flr.d.ts","sourceRoot":"","sources":["../../src/flr.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAU,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAS,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,uBAAuB,EAAmC,MAAM,0BAA0B,CAAC;AACpG,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C,qBAAa,GAAI,SAAQ,uBAAuB;IAC9C,SAAS,aAAa,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAI/E,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,SAAS,CAAC,qBAAqB,IAAI,kBAAkB;IAIrD,kBAAkB;IAClB,WAAW,IAAI,OAAO;IAItB,kBAAkB;IAClB,eAAe,IAAI,YAAY;IAIzB,+BAA+B,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAKvG"}
+{"version":3,"file":"flr.d.ts","sourceRoot":"","sources":["../../src/flr.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,EACL,QAAQ,EAER,SAAS,EAET,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,YAAY,EAEZ,SAAS,EACT,sBAAsB,EAEvB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAuB,MAAM,qBAAqB,CAAC;AACvF,OAAO,EACL,uBAAuB,EAGvB,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEpD,OAAO,EACL,YAAY,EACZ,yBAAyB,EACzB,WAAW,EACX,SAAS,EACT,WAAW,EACX,0BAA0B,EAC1B,yBAAyB,EACzB,mBAAmB,EACnB,2BAA2B,EAC5B,MAAM,SAAS,CAAC;AASjB,qBAAa,GAAI,SAAQ,uBAAuB;IAC9C,SAAS,aAAa,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAI/E,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,SAAS,CAAC,qBAAqB,IAAI,kBAAkB;IAIrD,kBAAkB;IAClB,WAAW,IAAI,OAAO;IAItB,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,kBAAkB;IAClB,eAAe,IAAI,YAAY;cAIf,wBAAwB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAIpH;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAKxC;;;OAGG;IACH,OAAO,IAAI,MAAM;IAIjB;;;OAGG;IACH,SAAS,CAAC,gBAAgB,IAAI,OAAO,CAAC,yBAAyB;IAI/D;;;OAGG;IACH,OAAO,IAAI,OAAO;IAIlB;;;;;OAKG;YACW,wBAAwB;IAMtC;;;;;OAKG;YACW,mCAAmC;IAcjD;;;;;OAKG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAiB5F;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAoB7B;;;;;;;;OAQG;IACG,iBAAiB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,OAAO,CAAC;IAgF9E;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAI3B;;;;OAIG;IACH,UAAU,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO;IAIpD;;;;OAIG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAO/F;;;;OAIG;IACG,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAOpF;;;;;;;OAOG;IACG,mBAAmB,CACvB,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,WAAW,EACxB,cAAc,CAAC,EAAE;QAAE,UAAU,EAAE,SAAS,EAAE,CAAA;KAAE,GAC3C,OAAO,CAAC,IAAI,CAAC;IA0EhB;;;;;;;;OAQG;IACG,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB9E;;;;OAIG;IACG,0BAA0B,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,0BAA0B,GAAG,OAAO,CAAC,SAAS,CAAC;IAsCtG;;;;;;;OAOG;IACG,WAAW,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAqBnE;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAMpC;;;;;OAKG;IACG,+BAA+B,CACnC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAKpC"}