CallGenericWriteFunctionTest

Description

This function can be used to estimate the Gas Limit and Gas Price that will be required by a CallGenericWriteFunction invocation. The information can be presented to users before they confirm the transaction.

Details

Signature

async CallGenericWriteFunctionTest(args, apiKey)

Arguments

Parameter	Type	Definition
args.contractAddress	String	Contract address of the smart contract to be called
args.functionABI	JSON	The JSON object for the smart contract ABI
args.functionName	String	Name of the function to be called
args.value?	BigNumber	The value to be sent along with the smart contract invocation. Please refer to the section below for more information.
args.chain	chain (class)	Which chain to broadcast the transaction on. Pick a chain from the supported chains list
args.params	array	Array of objects that will be sent as the arguments to the smart contract function. Please ensure that the order of params matches the contract ABI. For large numerical inputs, please refer to the section below.
apiKey	String	The API Key generated from the Developer Portal

Return Value

{
    "statusCode": 1/0,
    "data": {
        "estimatedGas": "estimatedGas", // the gas limit of the transaction in BigNumber
        "estimatedGasPrice": "estimatedGasPrice" // the gas price of the transaction in BigNumber
        "testExecutionResult": "testExecutionResult" // any return values from the smart contract 
    }
    "error": "error" // error if any
}

Handling Large Numerical Values

Applicable to EVM Chains only

While passing in large numerical values (values above 9007199254740991) in args.params, a conversion to BigNumber format needs to be made. You can use the following methods that convert the number to and from the appropriate format:

ConvertNumberToBigNumber(number, decimal) - Use this method while passing in numbers as params to a smart function that requires uint256 numbers

ConvertBigNumberToNumber(bigNumber, decimal) - Use this method while converting response values from a smart contract function call (which are in bigNumber format) to a JS Number

Example

import { 
    TransferTokens,
    EstimateTransferTokensGas,
    CallGenericWriteFunctionTest,
    ConvertBigNumberToNumber,
    assets
} from '@metafi/metafi-js-package';

function App() {

    // estimate gas fees
    const estimateGas = () => {
        const result = await CallGenericWriteFunctionTest(
            {
                chain: chains.eth,             
                contractAddress: "0xF5C9F957705bea56a7e806943f98F7877B995826",   
                functionABI: stakeContractAbi.abi,   
                functionName: "stake",
                value: ConvertNumberToBigNumber(1, 18),
                params: [],
            },
            "YOUR-API-KEY",
        );
        
        console.log(
            "gas fees are: ", 
            ConvertBigNumberToNumber(
                result.data.estimatedGas.mul(result.data.estimatedGasPrice)
            )
        );
    }
    
    // transfer tokens
    const stakeTokens = () => {
        CallGenericWriteFunction({
                chain: chains.eth,             
                contractAddress: "0xF5C9F957705bea56a7e806943f98F7877B995826",   
                functionABI: stakeContractAbi.abi,   
                functionName: "stake",
                value: ConvertNumberToBigNumber(1, 18),
                params: [],
                callback: (res) => {
                    console.log(res);
                }
            },
            "YOUR-API-KEY"
        );
    }
    
    return (
        <div>
            <button onClick={estimateGas}>Estimate Gas Fees</button>
	    <button onClick={stakeTokens}>stakeTokens</button>
        </div>
    );
}

export default App;