Skip to main content

PayableMethodObject <Inputs, Outputs>

Index

Properties

Methods

Properties

arguments

arguments: Inputs

Methods

call

  • call<SpecialOutput>(tx?: PayableCallOptions, block?: string | number | bigint): Promise<SpecialOutput>

  • Will call a method and execute its smart contract method in the EVM without sending any transaction. Note calling cannot alter the smart contract state.

    // using the promise
    const result = await myContract.methods.myMethod(123).call({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'});

    // MULTI-ARGUMENT RETURN:
    // Solidity
    contract MyContract {
      function myFunction() returns(uint256 myNumber, string myString) {
          return (23456, "Hello!%");
      }
    }

    // web3.js
    var MyContract = new web3.eth.Contract(abi, address);
    const result = MyContract.methods.myFunction().call()
    console.log(result)
    > Result {
      myNumber: '23456',
      myString: 'Hello!%',
      0: '23456', // these are here as fallbacks if the name is not know or given
      1: 'Hello!%'
    }


    // SINGLE-ARGUMENT RETURN:
    // Solidity
    contract MyContract {
      function myFunction() returns(string myString) {
          return "Hello!%";
      }
    }

    // web3.js
    const MyContract = new web3.eth.Contract(abi, address);
    const result = await MyContract.methods.myFunction().call();
    console.log(result);
    > "Hello!%"

    Type parameters

    • SpecialOutput = Outputs

    Parameters

    • optionaltx: PayableCallOptions

      The options used for calling.

    • optionalblock: string | number | bigint

      If you pass this parameter it will not use the default block set with contract.defaultBlock. Pre-defined block numbers as earliest, latest, pending, safe or `finalized can also be used. Useful for requesting data from or replaying transactions in past blocks.

    Returns Promise<SpecialOutput>

    • The return value(s) of the smart contract method. If it returns a single value, it’s returned as is. If it has multiple return values they are returned as an object with properties and indices.

createAccessList

  • This method generates an access list for a transaction. You must specify a from address and gas if it’s not specified in options.

    Parameters

    • optionaltx: PayableCallOptions
    • optionalblock: string | number | bigint

      If you pass this parameter it will not use the default block set with contract.defaultBlock. Pre-defined block numbers as earliest, latest, pending, safe or `finalized can also be used. Useful for requesting data from or replaying transactions in past blocks.

    Returns Promise<AccessListResult>

    The returned data of the createAccessList, e.g. The generated access list for transaction.

     const result = await MyContract.methods.myFunction().createAccessList();
     console.log(result);

    > {
     "accessList": [
        {
          "address": "0x15859bdf5aff2080a9968f6a410361e9598df62f",
          "storageKeys": [
            "0x0000000000000000000000000000000000000000000000000000000000000000"
          ]
        }
      ],
      "gasUsed": "0x7671"
    }

decodeData

  • decodeData<SpecialInputs>(data: string): SpecialInputs

  • Decode raw result of method call into readable value(s).

    Type parameters

    • SpecialInputs = Inputs

    Parameters

    • data: string

      The data to decode.

    Returns SpecialInputs

    • The decoded data.

encodeABI

  • encodeABI(): string

  • Encodes the ABI for this method. The resulting hex string is 32-bit function signature hash plus the passed parameters in Solidity tightly packed format. This can be used to send a transaction, call a method, or pass it into another smart contract’s method as arguments. Set the data field on web3.eth.sendTransaction options as the encodeABI() result and it is the same as calling the contract method with contract.myMethod.send().

    Some use cases for encodeABI() include: preparing a smart contract transaction for a multi signature wallet, working with offline wallets and cold storage and creating transaction payload for complex smart contract proxy calls.

    Returns string

    • The encoded ABI byte code to send via a transaction or call.

estimateGas

  • Returns the amount of gas consumed by executing the method locally without creating a new transaction on the blockchain. The returned amount can be used as a gas estimate for executing the transaction publicly. The actual gas used can be different when sending the transaction later, as the state of the smart contract can be different at that time.

    const gasAmount = await myContract.methods.myMethod(123).estimateGas({gas: 5000000});
    if(gasAmount == 5000000) {
      console.log('Method ran out of gas');
    }

    Type parameters

    • ReturnFormat: DataFormat = { bytes: HEX; number: BIGINT }

    Parameters

    • optionaloptions: PayableCallOptions

      The options used for calling

    • optionalreturnFormat: ReturnFormat

      The data format you want the output in.

    Returns Promise<NumberTypes[ReturnFormat[number]]>

    • The gas amount estimated.

send

  • send(tx?: PayableCallOptions): Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; events?: {}; from: string; gasUsed: bigint; logs: { address?: string; blockHash?: string; blockNumber?: bigint; data?: string; id?: string; logIndex?: bigint; removed?: boolean; topics?: string[]; transactionHash?: string; transactionIndex?: bigint }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>

  • Will send a transaction to the smart contract and execute its method. Note this can alter the smart contract state.

    await myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'});

    const receipt = await myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'});


    // using the event emitter
    const sendObj = myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'})
    sendObj.on('transactionHash', function(hash){
      ...
    });

    sendObj.on('confirmation', function(confirmationNumber, receipt){
      ...
    });

    sendObj.on('receipt', function(receipt){
      // receipt example
      console.log(receipt);
      > {
          "transactionHash": "0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b",
          "transactionIndex": 0,
          "blockHash": "0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46",
          "blockNumber": 3,
          "contractAddress": "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe",
          "cumulativeGasUsed": 314159,
          "gasUsed": 30234,
          "events": {
              "MyEvent": {
                  returnValues: {
                      myIndexedParam: 20,
                      myOtherIndexedParam: '0x123456789...',
                      myNonIndexParam: 'My String'
                  },
                  raw: {
                      data: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
                      topics: ['0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7', '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385']
                  },
                  event: 'MyEvent',
                  signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
                  logIndex: 0,
                  transactionIndex: 0,
                  transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
                  blockHash: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
                  blockNumber: 1234,
                  address: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'
              },
              "MyOtherEvent": {
                  ...
              },
              "MyMultipleEvent":[{...}, {...}] // If there are multiple of the same event, they will be in an array
          }
      }
    });

    sendObj.on('error', function(error, receipt) { // If the transaction was rejected by the network with a receipt, the second parameter will be the receipt.
      ...
    });

    Parameters

    Returns Web3PromiEvent<{ blockHash: string; blockNumber: bigint; contractAddress?: string; cumulativeGasUsed: bigint; effectiveGasPrice?: bigint; events?: {}; from: string; gasUsed: bigint; logs: { address?: string; blockHash?: string; blockNumber?: bigint; data?: string; id?: string; logIndex?: bigint; removed?: boolean; topics?: string[]; transactionHash?: string; transactionIndex?: bigint }[]; logsBloom: string; root: string; status: bigint; to: string; transactionHash: string; transactionIndex: bigint; type?: bigint }, SendTransactionEvents<{ bytes: HEX; number: BIGINT }>>

    • Returns a PromiEvent object resolved with transaction receipt.