@bitgo-beta/sdk-coin-avaxc 2.2.3-alpha.400 → 2.2.3-alpha.402

package/dist/src/avaxc.d.ts

@@ -0,0 +1,263 @@
+import { BaseCoin as StaticsBaseCoin, CoinFamily, EthereumNetwork } from '@bitgo-beta/statics';
+import { BaseCoin, BitGoBase, FeeEstimateOptions, FullySignedTransaction, IWallet, KeyPair, MultisigType, ParsedTransaction, ParseTransactionOptions, Recipient, TransactionExplanation, VerifyAddressOptions } from '@bitgo-beta/sdk-core';
+import { AbstractEthLikeNewCoins, GetSendMethodArgsOptions, RecoverOptions, RecoveryInfo, SendMethodArgs, TransactionBuilder as EthTransactionBuilder, TransactionPrebuild } from '@bitgo-beta/sdk-coin-eth';
+import { BN } from 'ethereumjs-util';
+import { Buffer } from 'buffer';
+import { AvaxSignTransactionOptions, BuildOptions, ExplainTransactionOptions, FeeEstimate, HopParams, HopPrebuild, HopTransactionBuildOptions, OfflineVaultTxInfo, PrecreateBitGoOptions, PresignTransactionOptions, SignedTransaction, SignFinalOptions, VerifyAvaxcTransactionOptions } from './iface';
+import { AvaxpLib } from '@bitgo-beta/sdk-coin-avaxp';
+import { SignTransactionOptions } from '@bitgo-beta/abstract-eth';
+/** COIN-1708 : Avaxc is added for CCR in WRW,
+ * hence adding the feature for AbstractEthLikeNewCoins
+ * Super class changed from BaseCoin to AbstractEthLikeNewCoins
+ * @since Sept 2024
+ */
+export declare class AvaxC extends AbstractEthLikeNewCoins {
+    static hopTransactionSalt: string;
+    protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
+    protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
+    static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
+    getBaseFactor(): number;
+    getChain(): string;
+    /**
+     * Method to return the coin's network object
+     * @returns {BaseNetwork}
+     */
+    getNetwork(): EthereumNetwork;
+    /**
+     * Get the base chain that the coin exists on.
+     */
+    getBaseChain(): string;
+    getFamily(): CoinFamily;
+    getFullName(): string;
+    valuelessTransferAllowed(): boolean;
+    isValidAddress(address: string): boolean;
+    isToken(): boolean;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
+    generateKeyPair(seed?: Buffer): KeyPair;
+    parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
+    verifyAddress({ address }: VerifyAddressOptions): Promise<boolean>;
+    /**
+     * Verify that a transaction prebuild complies with the original intention
+     *
+     * @param 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 {boolean}
+     */
+    verifyTransaction(params: VerifyAvaxcTransactionOptions): Promise<boolean>;
+    private static isAVAXCAddress;
+    verifyCoin(txPrebuild: TransactionPrebuild): boolean;
+    isValidPub(pub: string): boolean;
+    /**
+     * Check whether gas limit passed in by user are within our max and min bounds
+     * If they are not set, set them to the defaults
+     * @param {number} userGasLimit - user defined gas limit
+     * @returns {number} the gas limit to use for this transaction
+     */
+    setGasLimit(userGasLimit?: number): number;
+    /**
+     * Check whether the gas price passed in by user are within our max and min bounds
+     * If they are not set, set them to the defaults
+     * @param {number} userGasPrice - user defined gas price
+     * @returns the gas price to use for this transaction
+     */
+    setGasPrice(userGasPrice?: number): number;
+    /**
+     * Make a query to avax.network 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 avax.network
+     */
+    recoveryBlockchainExplorerQuery(query: Record<string, any>, apiKey?: string): Promise<any>;
+    /**
+     * Queries public block explorer to get the next nonce that should be used for
+     * the given AVAXC address
+     * @param {string} address — address to fetch for
+     * @returns {number} address nonce
+     */
+    getAddressNonce(address: string): Promise<number>;
+    /**
+     * Queries avax.network for the balance of an address
+     * @param {string} address - the AVAXC address
+     * @returns {Promise<BigNumber>} address balance
+     */
+    queryAddressBalance(address: string): Promise<BN>;
+    /**
+     * Queries avax.network for the token balance of an address
+     * @param {string} walletContractAddress - the AVAXC address
+     * @param {string} tokenContractAddress - the Token contract address
+     * @returns {Promise<BigNumber>} address balance
+     */
+    queryAddressTokenBalance(tokenContractAddress: string, walletContractAddress: string): Promise<BN>;
+    /**
+     * Queries the contract (via avax.network) for the next sequence ID
+     * @param {string} address - address of the contract
+     * @returns {Promise<number>} sequence ID
+     */
+    querySequenceId(address: string): Promise<number>;
+    /**
+     * @param {Object} recipient - recipient info
+     * @param {number} expireTime - expiry time
+     * @param {number} contractSequenceId - sequence id
+     * @returns {(string|Array)} operation array
+     */
+    getOperation(recipient: Recipient, expireTime: number, contractSequenceId: number): (string | Buffer)[][];
+    /**
+     * Calculate the operation hash in the same way solidity would
+     * @param {Recipient[]} recipients - tx recipients
+     * @param {number} expireTime - expiration time
+     * @param {number} contractSequenceId - contract sequence id
+     * @returns {string} operation hash
+     */
+    getOperationSha3ForExecuteAndConfirm(recipients: Recipient[], expireTime: number, contractSequenceId: number): string;
+    /**
+     * Default expire time for a contract call (1 week)
+     * @returns {number} Time in seconds
+     */
+    getDefaultExpireTime(): number;
+    /**
+     * Build arguments to call the send method on the wallet contract
+     * @param {Object} txInfo - data for send method args
+     * @returns {SendMethodArgs[]}
+     */
+    getSendMethodArgs(txInfo: GetSendMethodArgsOptions): SendMethodArgs[];
+    /**
+     * Builds a funds recovery transaction without BitGo
+     * Steps:
+     * 1) Node query - how much money is in the account
+     * 2) Build transaction - build our transaction for the amount
+     * 3) Send signed build - send our signed build to a public node
+     * @param {Object} params The options with which to recover
+     * @param {string} params.userKey - [encrypted] xprv
+     * @param {string} params.backupKey - [encrypted] xprv or xpub if the xprv is held by a KRS provider
+     * @param {string} params.walletPassphrase - used to decrypt userKey and backupKey
+     * @param {string} params.walletContractAddress - the AVAXC address of the wallet contract
+     * @param {string} params.recoveryDestination - target address to send recovered funds to
+     * @returns {Promise<RecoveryInfo>} - recovery tx info
+     */
+    recover(params: RecoverOptions): Promise<RecoveryInfo | OfflineVaultTxInfo>;
+    /**
+     * Create a new transaction builder for the current chain
+     * @return a new transaction builder
+     */
+    protected getTransactionBuilder(): EthTransactionBuilder;
+    protected getAtomicBuilder(): AvaxpLib.TransactionBuilderFactory;
+    /**
+     * Explain a transaction from txHex, overriding BaseCoins
+     * transaction can be either atomic or eth txn.
+     * @param params The options with which to explain the transaction
+     */
+    explainTransaction(params: ExplainTransactionOptions): Promise<TransactionExplanation>;
+    /**
+     * Explains an atomic transaction using atomic builder.
+     * @param txHex
+     * @private
+     */
+    private explainAtomicTransaction;
+    /**
+     * Verify signature for an atomic transaction using atomic builder.
+     * @param txHex
+     * @return true if signature is from the input address
+     * @private
+     */
+    private verifySignatureForAtomicTransaction;
+    /**
+     * Explains an EVM transaction using regular eth txn builder
+     * @param tx
+     * @private
+     */
+    private explainEVMTransaction;
+    /**
+     * Above is standard BaseCoins functions
+     * ================================================================================================================
+     * ================================================================================================================
+     * Below is transaction functions
+     */
+    /**
+     * Coin-specific things done before signing a transaction, i.e. verification
+     * @param params
+     */
+    presignTransaction(params: PresignTransactionOptions): Promise<PresignTransactionOptions>;
+    /**
+     * Modify prebuild after receiving it from the server. Add things like nlocktime
+     */
+    postProcessPrebuild(params: TransactionPrebuild): Promise<TransactionPrebuild>;
+    /**
+     * Validates that the hop prebuild from the HSM is valid and correct
+     * @param wallet The wallet that the prebuild is for
+     * @param hopPrebuild The prebuild to validate
+     * @param originalParams The original parameters passed to prebuildTransaction
+     * @returns void
+     * @throws Error if The prebuild is invalid
+     */
+    validateHopPrebuild(wallet: IWallet, hopPrebuild: HopPrebuild, originalParams?: {
+        recipients: Recipient[];
+    }): Promise<void>;
+    /**
+     * Helper function for signTransaction for the rare case that SDK is doing the second signature
+     * Note: we are expecting this to be called from the offline vault
+     * @param params.txPrebuild
+     * @param params.prv
+     * @returns {{txHex: string}}
+     */
+    signFinal(params: SignFinalOptions): Promise<FullySignedTransaction>;
+    /**
+     * Assemble half-sign prebuilt transaction
+     * @param params
+     */
+    signTransaction(params: AvaxSignTransactionOptions | SignTransactionOptions): Promise<SignedTransaction>;
+    /**
+     * Modify prebuild before sending it to the server. Add things like hop transaction params
+     * @param buildParams The whitelisted parameters for this prebuild
+     * @param buildParams.hop True if this should prebuild a hop tx, else false
+     * @param buildParams.recipients The recipients array of this transaction
+     * @param buildParams.wallet The wallet sending this tx
+     * @param buildParams.walletPassphrase the passphrase for this wallet
+     */
+    getExtraPrebuildParams(buildParams: BuildOptions): Promise<BuildOptions>;
+    /**
+     * Creates the extra parameters needed to build a hop transaction
+     * @param {HopTransactionBuildOptions} The original build parameters
+     * @returns 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 {Object} 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 ETH tx data to estimate a send for
+     * @returns {Object} The fee info returned from the server
+     */
+    feeEstimate(params: FeeEstimateOptions): Promise<FeeEstimate>;
+    /**
+     * Calculate tx hash like evm from tx hex.
+     * @param {string} tx
+     * @returns {Buffer} tx hash
+     */
+    static getTxHash(tx: string): Buffer;
+    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
+    /**
+     * Ensure either enterprise or newFeeAddress is passed, to know whether to create new key or use enterprise key
+     * @param params
+     * @param params.enterprise {String} the enterprise id to associate with this key
+     * @param params.newFeeAddress {Boolean} create a new fee address (enterprise not needed in this case)
+     */
+    preCreateBitGo(params: PrecreateBitGoOptions): void;
+    getAvaxP(): string;
+    /**
+     * Fetch the gas price from the explorer
+     */
+    getGasPriceFromExternalAPI(): Promise<BN>;
+    /**
+     * Fetch the gas limit from the explorer
+     * @param intendedChain
+     * @param from
+     * @param to
+     * @param data
+     */
+    getGasLimitFromExternalAPI(intendedChain: string, from: string, to: string, data: string): Promise<BN>;
+}
+//# sourceMappingURL=avaxc.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"avaxc.d.ts","sourceRoot":"","sources":["../../src/avaxc.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,QAAQ,IAAI,eAAe,EAC3B,UAAU,EAGV,eAAe,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,QAAQ,EAER,SAAS,EAET,kBAAkB,EAClB,sBAAsB,EAGtB,OAAO,EACP,OAAO,EACP,YAAY,EAEZ,iBAAiB,EACjB,uBAAuB,EACvB,SAAS,EACT,sBAAsB,EAEtB,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EAExB,cAAc,EACd,YAAY,EACZ,cAAc,EACd,kBAAkB,IAAI,qBAAqB,EAC3C,mBAAmB,EACpB,MAAM,0BAA0B,CAAC;AAIlC,OAAO,EAAE,EAAE,EAAgB,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EACL,0BAA0B,EAC1B,YAAY,EACZ,yBAAyB,EACzB,WAAW,EACX,SAAS,EACT,WAAW,EACX,0BAA0B,EAC1B,kBAAkB,EAClB,qBAAqB,EACrB,yBAAyB,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,6BAA6B,EAC9B,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,uBAAuB;IAChD,MAAM,CAAC,kBAAkB,SAAgC;IAEzD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE3D,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,aAAa,IAAI,MAAM;IAIvB,QAAQ,IAAI,MAAM;IAIlB;;;OAGG;IACH,UAAU,IAAI,eAAe;IAI7B;;OAEG;IACH,YAAY,IAAI,MAAM;IAItB,SAAS,IAAI,UAAU;IAIvB,WAAW,IAAI,MAAM;IAIrB,wBAAwB,IAAI,OAAO;IAInC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAKxC,OAAO,IAAI,OAAO;IAIlB,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IASjC,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAOxE;;;;;;;;OAQG;IACG,iBAAiB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,OAAO,CAAC;IAgFhF,OAAO,CAAC,MAAM,CAAC,cAAc;IAI7B,UAAU,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO;IAIpD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAUhC;;;;;OAKG;IACH,WAAW,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM;IAY1C;;;;;OAKG;IACH,WAAW,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM;IAa1C;;;;;OAKG;IACG,+BAA+B,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAehG;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAevD;;;;OAIG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC;IAevD;;;;;OAKG;IACG,wBAAwB,CAAC,oBAAoB,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC;IA4BxG;;;;OAIG;IACG,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBvD;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE;IAczG;;;;;;OAMG;IACH,oCAAoC,CAClC,UAAU,EAAE,SAAS,EAAE,EACvB,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,MAAM,GACzB,MAAM;IA+CT;;;OAGG;IACH,oBAAoB,IAAI,MAAM;IAI9B;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,cAAc,EAAE;IAqCrE;;;;;;;;;;;;;OAaG;IACG,OAAO,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,GAAG,kBAAkB,CAAC;IAwNjF;;;OAGG;IACH,SAAS,CAAC,qBAAqB,IAAI,qBAAqB;IAIxD,SAAS,CAAC,gBAAgB,IAAI,QAAQ,CAAC,yBAAyB;IAIhE;;;;OAIG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAiB5F;;;;OAIG;YACW,wBAAwB;IAMtC;;;;;OAKG;YACW,mCAAmC;IAcjD;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAoB7B;;;;;OAKG;IAEH;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAO/F;;OAEG;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;IAwEhB;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAqB1E;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,0BAA0B,GAAG,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkC9G;;;;;;;OAOG;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;IAuCtG;;;;;;;OAOG;IACG,WAAW,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAqBnE;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAM9B,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAKrE;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,qBAAqB,GAAG,IAAI;IA4BnD,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACG,0BAA0B,IAAI,OAAO,CAAC,EAAE,CAAC;IAe/C;;;;;;OAMG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC;CAwB7G"}