How to encode callData parameters to programmatically interact with a smart contract

const Web3 = require('web3');

async function encodeFunction() {

  // generate function signature
  const hashedFunction = web3.utils.keccak256("transfer(address,uint256)")  // Function name and parameters
  const functionSignature = hashedFunction.substr(0, 10); // Extract the first 8 digits (4bytes) + 0x

  // Encode function parameters
  const firstParameter = '0xdfd5293d8e347dfe59e90efd55b2956a1343963d'
  const paddedFirstParameter = web3.utils.padLeft(firstParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam1= paddedFirstParameter.slice(2) // Slice(2) remove 0x

  const secondParameter = '1000000000000000000'
  const hexParameter = web3.utils.toHex(secondParameter); // Convert the input from decimal to hex
  const paddedSecondParameter = web3.utils.padLeft(hexParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam2= paddedSecondParameter.slice(2) // Slice(2) remove 0x

  // Generate calldata
  const functionCallData = functionSignature + encodedParam1 + encodedParam2

  console.log(`Encoded function signature: ${functionSignature}\n`); // Log the encoded function signature
  console.log(`Encoded parameter 1: ${encodedParam1}\n`); // Log the encoded first parameter
  console.log(`Encoded parameter 2: ${encodedParam2}\n`); // Log the encoded second parameter
  console.log(`Function calldata: ${functionCallData}`) // Log the complete calldata
}

encodeFunction()

$ node theory
Encoded function signature: 0xa9059cbb

Encoded parameter 1: 000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d

Encoded parameter 2: 0000000000000000000000000000000000000000000000000de0b6b3a7640000

Function calldata: 0xa9059cbb000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

$ node index
Function name: transfer
Function signature: 0xa9059cbb
Encoded parameters: 000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

Function calldata: 0xa9059cbb000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

Overview

Environment setup

Create a Web3 instance

Create a function to encode smart contract function signature and parameters

Generate the function's signature

The first step is to generate the signature of the smart contract function you intend to call.

The signature is generated by taking the first 8 characters (4 bytes) of the Keccak-256 hash of the function’s name and the type of its parameters.

See the comments in theory.js to learn more.

If you see the logic in index.js, you will notice that the signature is encoded directly using the function’s name and parameters, and it is much more efficient.

// generate function signature
  const hashedFunction = web3.utils.keccak256("transfer(address,uint256)")  // Function name and parameters
  const functionSignature = hashedFunction.substr(0, 10); // Extract the first 8 digits (4bytes) + 0x

Encode the parameters

Then we can encode the parameters. The principle is the same as for the logs topics: the parameters are encoded in a 32-bytes hexadecimal string.

You can see each step in theory.js, while, in index.js, everything is abstracted away and done in one line of code using the encodeParameters function.

  // Encode function parameters
  const firstParameter = '0xdfd5293d8e347dfe59e90efd55b2956a1343963d'
  const paddedFirstParameter = web3.utils.padLeft(firstParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam1= paddedFirstParameter.slice(2) // Slice(2) remove 0x

  const secondParameter = '1000000000000000000'
  const hexParameter = web3.utils.toHex(secondParameter); // Convert the input from decimal to hex
  const paddedSecondParameter = web3.utils.padLeft(hexParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam2= paddedSecondParameter.slice(2) // Slice(2) remove 0x

Log the results

The last portion simply puts together the outputs. As you can see, both scripts produce the same callData outcome.

Note that in index.js, we can pass more dynamic functions and parameters.

  console.log(`Encoded function signature: ${functionSignature}\n`); // Log the encoded function signature
  console.log(`Encoded parameter 1: ${encodedParam1}\n`); // Log the encoded first parameter
  console.log(`Encoded parameter 2: ${encodedParam2}\n`); // Log the encoded second parameter
  console.log(`Function calldata: ${functionCallData}`) // Log the complete calldata
}

const Web3 = require('web3');

async function encodeFunction() {

  // generate function signature
  const hashedFunction = web3.utils.keccak256("transfer(address,uint256)")  // Function name and parameters
  const functionSignature = hashedFunction.substr(0, 10); // Extract the first 8 digits (4bytes) + 0x

  // Encode function parameters
  const firstParameter = '0xdfd5293d8e347dfe59e90efd55b2956a1343963d'
  const paddedFirstParameter = web3.utils.padLeft(firstParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam1= paddedFirstParameter.slice(2) // Slice(2) remove 0x

  const secondParameter = '1000000000000000000'
  const hexParameter = web3.utils.toHex(secondParameter); // Convert the input from decimal to hex
  const paddedSecondParameter = web3.utils.padLeft(hexParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam2= paddedSecondParameter.slice(2) // Slice(2) remove 0x

  // Generate calldata
  const functionCallData = functionSignature + encodedParam1 + encodedParam2

  console.log(`Encoded function signature: ${functionSignature}\n`); // Log the encoded function signature
  console.log(`Encoded parameter 1: ${encodedParam1}\n`); // Log the encoded first parameter
  console.log(`Encoded parameter 2: ${encodedParam2}\n`); // Log the encoded second parameter
  console.log(`Function calldata: ${functionCallData}`) // Log the complete calldata
}

encodeFunction()

$ node theory
Encoded function signature: 0xa9059cbb

Encoded parameter 1: 000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d

Encoded parameter 2: 0000000000000000000000000000000000000000000000000de0b6b3a7640000

Function calldata: 0xa9059cbb000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

$ node index
Function name: transfer
Function signature: 0xa9059cbb
Encoded parameters: 000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

Function calldata: 0xa9059cbb000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

How to properly encode topics for eth_getLogs How to convert decimal numbers to hexadecimals strings using web3.js and ethers.js

const Web3 = require('web3');

async function encodeFunction() {

  // generate function signature
  const hashedFunction = web3.utils.keccak256("transfer(address,uint256)")  // Function name and parameters
  const functionSignature = hashedFunction.substr(0, 10); // Extract the first 8 digits (4bytes) + 0x

  // Encode function parameters
  const firstParameter = '0xdfd5293d8e347dfe59e90efd55b2956a1343963d'
  const paddedFirstParameter = web3.utils.padLeft(firstParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam1= paddedFirstParameter.slice(2) // Slice(2) remove 0x

  const secondParameter = '1000000000000000000'
  const hexParameter = web3.utils.toHex(secondParameter); // Convert the input from decimal to hex
  const paddedSecondParameter = web3.utils.padLeft(hexParameter, 64); // Pad to 32 bytes (64 hex characters)
  const encodedParam2= paddedSecondParameter.slice(2) // Slice(2) remove 0x

  // Generate calldata
  const functionCallData = functionSignature + encodedParam1 + encodedParam2

  console.log(`Encoded function signature: ${functionSignature}\n`); // Log the encoded function signature
  console.log(`Encoded parameter 1: ${encodedParam1}\n`); // Log the encoded first parameter
  console.log(`Encoded parameter 2: ${encodedParam2}\n`); // Log the encoded second parameter
  console.log(`Function calldata: ${functionCallData}`) // Log the complete calldata
}

encodeFunction()

$ node theory
Encoded function signature: 0xa9059cbb

Encoded parameter 1: 000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d

Encoded parameter 2: 0000000000000000000000000000000000000000000000000de0b6b3a7640000

Function calldata: 0xa9059cbb000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

$ node index
Function name: transfer
Function signature: 0xa9059cbb
Encoded parameters: 000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000

Function calldata: 0xa9059cbb000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d0000000000000000000000000000000000000000000000000de0b6b3a7640000