@bitgo-beta/abstract-eth 1.0.2-beta.210 → 1.0.2-beta.2101

package/dist/src/lib/transactionBuilder.d.ts

@@ -0,0 +1,313 @@
+import { BaseCoin as CoinConfig } from '@bitgo-beta/statics';
+import EthereumCommon from '@ethereumjs/common';
+import BigNumber from 'bignumber.js';
+import { BaseAddress, BaseKey, BaseTransaction, BaseTransactionBuilder, TransactionType } from '@bitgo-beta/sdk-core';
+import { KeyPair } from './keyPair';
+import { Fee, TxData } from './iface';
+import { ERC1155TransferBuilder } from './transferBuilders/transferBuilderERC1155';
+import { ERC721TransferBuilder } from './transferBuilders/transferBuilderERC721';
+import { TransferBuilderERC7984 } from './transferBuilders/transferBuilderERC7984';
+import { Transaction } from './transaction';
+import { TransferBuilder } from './transferBuilder';
+/**
+ * EthereumLike transaction builder.
+ */
+export declare abstract class TransactionBuilder extends BaseTransactionBuilder {
+    protected _type: TransactionType;
+    protected _common: EthereumCommon;
+    protected _sourceKeyPair: KeyPair;
+    private _transaction;
+    private _counter;
+    private _fee;
+    protected _value: string;
+    private _txSignature;
+    private _walletOwnerAddresses;
+    protected _walletVersion: number;
+    private _forwarderAddress;
+    private _tokenAddress;
+    private _tokenId;
+    private _tokenContractAddress;
+    private _encryptedHandle;
+    private _parentAddress;
+    protected _transfer: TransferBuilder | ERC721TransferBuilder | ERC1155TransferBuilder | TransferBuilderERC7984;
+    private _contractAddress;
+    private _contractCounter;
+    private _forwarderVersion;
+    private _initCode;
+    private _baseAddress;
+    private _feeAddress;
+    private _data;
+    private _salt;
+    protected _walletSimpleByteCode: string;
+    /**
+     * Public constructor.
+     *
+     * @param _coinConfig
+     */
+    constructor(_coinConfig: Readonly<CoinConfig>);
+    /** @inheritdoc */
+    protected buildImplementation(): Promise<BaseTransaction>;
+    protected getTransactionData(): TxData;
+    /** @inheritdoc */
+    protected fromImplementation(rawTransaction: string, isFirstSigner?: boolean): Transaction;
+    /**
+     * Load the builder data using the deserialized transaction
+     *
+     * @param {TxData} transactionJson the deserialized transaction json
+     * @param {boolean} isFirstSigner if the transaction is being signed by the first signer
+     */
+    protected loadBuilderInput(transactionJson: TxData, isFirstSigner?: boolean): void;
+    protected setTransactionTypeFields(decodedType: TransactionType, transactionJson: TxData, isFirstSigner?: boolean): void;
+    /** @inheritdoc */
+    protected signImplementation(key: BaseKey): BaseTransaction;
+    /** @inheritdoc */
+    validateAddress(address: BaseAddress): void;
+    /** @inheritdoc */
+    validateKey(key: BaseKey): void;
+    /**
+     * Validate the raw transaction is either a JSON or
+     * a hex encoded transaction
+     *
+     * @param {any} rawTransaction The raw transaction to be validated
+     */
+    validateRawTransaction(rawTransaction: any): void;
+    private isEip1559Txn;
+    private isRLPDecodable;
+    protected validateBaseTransactionFields(): void;
+    /** @inheritdoc */
+    validateTransaction(transaction: BaseTransaction): void;
+    /**
+     * Check wallet owner addresses for wallet initialization transactions are valid or throw.
+     */
+    private validateWalletInitializationFields;
+    /**
+     * Check if a token address for the tx was defined or throw.
+     */
+    private validateTokenAddress;
+    /**
+     * Check if a forwarder address for the tx was defined or throw.
+     */
+    private validateForwarderAddress;
+    /**
+     * Check if a contract address for the wallet was defined or throw.
+     */
+    private validateContractAddress;
+    /**
+     * Checks if a contract call data field was defined or throws otherwise
+     */
+    private validateDataField;
+    /**
+     * Check if a token contract address for ERC-7984 flush was defined or throw.
+     */
+    private validateTokenContractAddress;
+    /**
+     * Check if an encrypted handle for ERC-7984 flush was defined or throw.
+     */
+    private validateEncryptedHandle;
+    /**
+     * Check if a parent address for ERC-7984 flush was defined or throw.
+     */
+    private validateParentAddress;
+    private setContract;
+    validateValue(value: BigNumber): void;
+    /**
+     * The type of transaction being built.
+     *
+     * @param {TransactionType} type
+     */
+    type(type: TransactionType): void;
+    /**
+     * Set the transaction fees. Low fees may get a transaction rejected or never picked up by bakers.
+     *
+     * @param {Fee} fee Baker fees. May also include the maximum gas to pay
+     */
+    fee(fee: Fee): void;
+    /**
+     * Set the transaction counter to prevent submitting repeated transactions.
+     *
+     * @param {number} counter The counter to use
+     */
+    counter(counter: number): void;
+    /**
+     * The value to send along with this transaction. 0 by default
+     *
+     * @param {string} value The value to send along with this transaction
+     */
+    value(value: string): void;
+    protected buildBase(data: string): TxData;
+    /**
+     * Set one of the owners of the multisig wallet.
+     *
+     * @param {string} address An Ethereum address
+     */
+    owner(address: string): void;
+    /**
+     * Build a transaction for a generic multisig contract.
+     *
+     * @returns {TxData} The Ethereum transaction data
+     */
+    protected buildWalletInitializationTransaction(walletVersion?: number): TxData;
+    /**
+     * Returns the smart contract encoded data
+     *
+     * @param {string[]} addresses - the contract signers
+     * @returns {string} - the smart contract encoded data
+     */
+    protected getContractData(addresses: string[]): string;
+    contract(address: string): void;
+    /**
+     * Gets the transfer funds builder if exist, or creates a new one for this transaction and returns it
+     *
+     * @param {string} data transfer data to initialize the transfer builder with, empty if none given
+     * @param {boolean} isFirstSigner whether the transaction is being signed by the first signer
+     * @returns {TransferBuilder | ERC721TransferBuilder | ERC1155TransferBuilder | TransferBuilderERC7984} the transfer builder
+     */
+    abstract transfer(data?: string, isFirstSigner?: boolean): TransferBuilder | ERC721TransferBuilder | ERC1155TransferBuilder | TransferBuilderERC7984;
+    /**
+     * Returns the serialized sendMultiSig contract method data
+     *
+     * @returns {string} serialized sendMultiSig data
+     */
+    getSendData(): string;
+    /**
+     * Decide if the coin uses non-packed encoding for tx data
+     *
+     * @returns {boolean} true if the coin uses non-packed encoding for tx data
+     */
+    coinUsesNonPackedEncodingForTxData(): boolean;
+    private buildSendTransaction;
+    /**
+     * Set the contract transaction nonce to calculate the forwarder address.
+     *
+     * @param {number} contractCounter The counter to use
+     */
+    contractCounter(contractCounter: number): void;
+    /**
+     * Build a transaction to create a forwarder.
+     *
+     * @returns {TxData} The Ethereum transaction data
+     */
+    private buildAddressInitializationTransaction;
+    /**
+     * Set the forwarder address to flush
+     *
+     * @param {string} address The address to flush
+     */
+    forwarderAddress(address: string): void;
+    /**
+     * Set the address of the ERC20 token contract that we are flushing tokens for
+     *
+     * @param {string} address the contract address of the token to flush
+     */
+    tokenAddress(address: string): void;
+    /**
+     * Set the token ID for ERC721/ERC1155 token flush
+     *
+     * @param {string} tokenId the token ID to flush
+     */
+    tokenId(tokenId: string): void;
+    /**
+     * Build a transaction to flush tokens from a forwarder.
+     *
+     * @returns {TxData} The Ethereum transaction data
+     */
+    private buildFlushTokensTransaction;
+    /**
+     * Build a transaction to flush tokens from a forwarder.
+     *
+     * @returns {TxData} The Ethereum transaction data
+     */
+    private buildFlushCoinsTransaction;
+    /**
+     * Build a transaction to flush ERC721 NFTs from a forwarder.
+     *
+     * @returns {TxData} The Ethereum transaction data
+     */
+    private buildFlushERC721Transaction;
+    /**
+     * Build a transaction to flush ERC1155 tokens from a forwarder.
+     *
+     * @returns {TxData} The Ethereum transaction data
+     */
+    private buildFlushERC1155Transaction;
+    data(encodedCall: string): void;
+    private buildGenericContractCallTransaction;
+    /** @inheritdoc */
+    protected get transaction(): Transaction;
+    /** @inheritdoc */
+    protected set transaction(transaction: Transaction);
+    /**
+     * Get the final v value. Final v is described in EIP-155.
+     *
+     * @protected for internal use when the enableFinalVField flag is true.
+     */
+    protected getFinalV(): string;
+    /**
+     * Set the forwarder version for address to be initialized
+     *
+     * @param {number} version forwarder version
+     */
+    forwarderVersion(version: number): void;
+    /**
+     * Set the salt to create the address using create2
+     *
+     * @param {string} salt The salt to create the address using create2, hex string
+     */
+    salt(salt: string): void;
+    /**
+     * Take the implementation address for the proxy contract, and get the binary initcode for the associated proxy
+     *
+     * @param {string} implementationAddress The address of the implementation contract
+     */
+    initCode(implementationAddress: string): void;
+    /**
+     * Set the wallet version for wallet to be initialized
+     *
+     * @param {number} version wallet version
+     */
+    walletVersion(version: number): void;
+    /**
+     * Set the base address of the wallet
+     *
+     * @param {string} address The wallet contract address
+     */
+    baseAddress(address: string): void;
+    /**
+     * Set the fee address of the wallet
+     *
+     * @param {string} address The fee address of the wallet
+     */
+    feeAddress(address: string): void;
+    /**
+     * Get the wallet version for wallet
+     */
+    getWalletVersion(): number;
+    /**
+     * Set the ERC-7984 token contract address for forwarder flush transactions.
+     *
+     * @param {string} address The ERC-7984 token contract address
+     */
+    tokenContractAddress(address: string): void;
+    /**
+     * Set the encrypted balance handle (bytes32 hex) for forwarder flush transactions.
+     * This is the opaque handle returned by confidentialBalanceOf() on the ERC-7984 token contract.
+     *
+     * @param {string} handle The bytes32 hex encrypted balance handle
+     */
+    encryptedHandle(handle: string): void;
+    /**
+     * Set the parent address (root wallet) for ERC-7984 forwarder flush transactions.
+     * The flushed tokens will be transferred to this address.
+     *
+     * @param {string} address The parent wallet address
+     */
+    parentAddress(address: string): void;
+    /**
+     * Build a transaction to flush ERC-7984 tokens from a V4 forwarder to the parent wallet.
+     * Encodes: callFromParent(tokenContractAddress, 0, confidentialTransfer(parentAddress, encryptedHandle))
+     *
+     * @returns {TxData} The Ethereum transaction data
+     */
+    private buildFlushERC7984ForwarderTokenTransaction;
+}
+//# sourceMappingURL=transactionBuilder.d.ts.map

package/dist/src/lib/transactionBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionBuilder.d.ts","sourceRoot":"","sources":["../../../src/lib/transactionBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAgC,MAAM,qBAAqB,CAAC;AAC3F,OAAO,cAAc,MAAM,oBAAoB,CAAC;AAEhD,OAAO,SAAS,MAAM,cAAc,CAAC;AAIrC,OAAO,EACL,WAAW,EACX,OAAO,EACP,eAAe,EACf,sBAAsB,EAOtB,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAsB,GAAG,EAAkD,MAAM,EAAE,MAAM,SAAS,CAAC;AAyB1G,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKpD;;GAEG;AACH,8BAAsB,kBAAmB,SAAQ,sBAAsB;IACrE,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC;IAEjC,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC;IAClC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC;IAClC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,IAAI,CAAM;IAClB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAGzB,OAAO,CAAC,YAAY,CAAiB;IAGrC,OAAO,CAAC,qBAAqB,CAAW;IACxC,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IAGjC,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAS;IAGzB,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,cAAc,CAAS;IAG/B,SAAS,CAAC,SAAS,EAAE,eAAe,GAAG,qBAAqB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC;IAC/G,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,WAAW,CAAS;IAI5B,OAAO,CAAC,KAAK,CAAS;IAGtB,OAAO,CAAC,KAAK,CAAS;IAGtB,SAAS,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAExC;;;;OAIG;gBACS,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC;IAa7C,kBAAkB;cACF,mBAAmB,IAAI,OAAO,CAAC,eAAe,CAAC;IAoB/D,SAAS,CAAC,kBAAkB,IAAI,MAAM;IAiCtC,kBAAkB;IAClB,SAAS,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,WAAW;IAY1F;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,eAAe,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI;IA6BlF,SAAS,CAAC,wBAAwB,CAChC,WAAW,EAAE,eAAe,EAC5B,eAAe,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,IAAI;IAuGP,kBAAkB;IAClB,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,eAAe;IAc3D,kBAAkB;IAClB,eAAe,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAM3C,kBAAkB;IAClB,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAM/B;;;;;OAKG;IACH,sBAAsB,CAAC,cAAc,EAAE,GAAG,GAAG,IAAI;IAsBjD,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,cAAc;IAStB,SAAS,CAAC,6BAA6B,IAAI,IAAI;IAY/C,kBAAkB;IAClB,mBAAmB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI;IAqEvD;;OAEG;IACH,OAAO,CAAC,kCAAkC;IAY1C;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAM5B;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAMhC;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAM/B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAMzB;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAMpC;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAM/B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,WAAW;IAOnB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IASrC;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI;IAIjC;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAoBnB;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQ9B;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK1B,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IA8BzC;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAgB5B;;;;OAIG;IACH,SAAS,CAAC,oCAAoC,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM;IAQ9E;;;;;OAKG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM;IAYtD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAO/B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CACf,IAAI,CAAC,EAAE,MAAM,EACb,aAAa,CAAC,EAAE,OAAO,GACtB,eAAe,GAAG,qBAAqB,GAAG,sBAAsB,GAAG,sBAAsB;IAE5F;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAU5B;;;;OAIG;IACI,kCAAkC,IAAI,OAAO;IAMpD,OAAO,CAAC,oBAAoB;IAW5B;;;;OAIG;IACH,eAAe,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI;IAQ9C;;;;OAIG;IACH,OAAO,CAAC,qCAAqC;IAkC7C;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOvC;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOnC;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI9B;;;;OAIG;IACH,OAAO,CAAC,2BAA2B;IAOnC;;;;OAIG;IACH,OAAO,CAAC,0BAA0B;IAIlC;;;;OAIG;IACH,OAAO,CAAC,2BAA2B;IAenC;;;;OAIG;IACH,OAAO,CAAC,4BAA4B;IAiBpC,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAY/B,OAAO,CAAC,mCAAmC;IAK3C,kBAAkB;IAClB,SAAS,KAAK,WAAW,IAAI,WAAW,CAEvC;IAED,kBAAkB;IAClB,SAAS,KAAK,WAAW,CAAC,WAAW,EAAE,WAAW,EAEjD;IAED;;;;OAIG;IACH,SAAS,CAAC,SAAS,IAAI,MAAM;IAI7B;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQvC;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIxB;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,GAAG,IAAI;IAO7C;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQpC;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOlC;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOjC;;OAEG;IACI,gBAAgB,IAAI,MAAM;IAMjC;;;;OAIG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAO3C;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIrC;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOpC;;;;;OAKG;IACH,OAAO,CAAC,0CAA0C;CAanD"}