@superfluid-finance/sdk-core/dist/module/Operation.d.ts

SDK Core for building with Superfluid Protocol

import { ethers } from "ethers";
import { OperationStruct } from "./BatchCall";
export type BatchOperationType = "UNSUPPORTED" | "ERC20_APPROVE" | "ERC20_TRANSFER_FROM" | "ERC777_SEND" | "ERC20_INCREASE_ALLOWANCE" | "ERC20_DECREASE_ALLOWANCE" | "SUPERTOKEN_UPGRADE" | "SUPERTOKEN_DOWNGRADE" | "SUPERFLUID_CALL_AGREEMENT" | "CALL_APP_ACTION" | "SIMPLE_FORWARD_CALL" | "ERC2771_FORWARD_CALL";
/**
 * Operation Helper Class
 * @description A helper class to create `Operation` objects which can be executed or batched.
 */
export default class Operation {
    readonly populateTransactionPromise: Promise<ethers.PopulatedTransaction>;
    readonly type: BatchOperationType;
    readonly forwarderPopulatedPromise?: Promise<ethers.PopulatedTransaction>;
    constructor(txn: Promise<ethers.PopulatedTransaction>, type: BatchOperationType, forwarderPopulatedPromise?: Promise<ethers.PopulatedTransaction>);
    /**
     * Executes the operation via the provided signer.
     * @description Populates all fields of the transaction, signs it and sends it to the network.
     * @param signer The signer of the transaction
     * @param gasLimitMultiplier A multiplier to provide gasLimit buffer on top of the estimated gas limit (1.2x is the default)
     * @returns {ethers.providers.TransactionResponse} A TransactionResponse object which can be awaited
     */
    exec: (signer: ethers.Signer, gasLimitMultiplier?: number) => Promise<ethers.providers.TransactionResponse>;
    /**
     * Get the populated transaction by awaiting `populateTransactionPromise`.
     * `providerOrSigner` is used for gas estimation if necessary.
     * NOTE: we use the forwarder populated promise if this exists
     */
    getPopulatedTransactionRequest: (providerOrSigner: ethers.providers.Provider | ethers.Signer, gasLimitMultiplier?: number) => Promise<ethers.PopulatedTransaction>;
    /**
     * Signs the populated transaction via the provided signer (what you intend on sending to the network).
     * @param signer The signer of the transaction
     * @returns {Promise<string>} Fully serialized, signed transaction
     */
    getSignedTransaction: (signer: ethers.Signer, gasLimitMultiplier?: number) => Promise<string>;
    /**
     * Gets the transaction hash of the transaction.
     * @description Calculates this by getting the keccak256 hash of the signedTxn.
     * @param signer The signer of the transaction
     * @returns {Promise<string>} The transaction hash of the transaction
     */
    getTransactionHash: (signer: ethers.Signer) => Promise<string>;
    /**
     * Gets the `OperationStruct` object.
     * @param operation an `Operation` object
     * @param index the index of the `Operation` in the batchCall
     * @returns {Promise<OperationStruct>} OperationStruct object for batchCall
     */
    toOperationStruct: (index: number) => Promise<OperationStruct>;
}
//# sourceMappingURL=Operation.d.ts.map