A Developer Guide to Smart Contract ABI

Posted By : Aman

Nov 23, 2022

What is ABI in a smart contract?


The Contract Application Binary Interface (ABI) is the customary thanks to act with contracts within the Ethereum system, each outside the blockchain and for interaction between contracts. Knowledge is coded in line with its sort.


Why will we use ABI for good contracts?


The EVM (Ethereum Virtual Machine) is a core part of the Ethereum network, and smart contracts are items of code kept on the Ethereum blockchain and run on the EVM. Smart contracts written in high-level languages "‹"‹such as Solidity or Vyper should be compiled into workable EVM bytecode; once a smart contract is deployed, this bytecode is kept on the blockchain related to an address. For Ethereum and EVM, the smart contract is exactly this sequence of bytecode. To access functions outlined in higher-level languages, users ought to translate names and arguments into computer memory unit representations so bytecode will work with them. So as to interpret the bytes sent as a response, users should convert back to values "‹"‹defined in higher-level languages. Languages "‹"‹that compile for EVMs maintain strict conventions relating to these conversions, however, so as to perform them, we want to grasp the precise names and kinds related to the operations. The ABI documents these names and kinds in a very precise, easy-to-parse format, creating translations between human-intended methodology calls and smart-contract operations that are detectable and reliable.


Understanding ABI Components


The JSON ABI format of the contract is given by numerous functions and/or event descriptors.


type: Defines the operation type. It will be one in all the subsequent functions, 'function', 'constructor', 'receive' (for the ether receive function), or 'fallback' (for the default function).
name: Defines the name of the operation.
inputs: It's an associated array of objects that outline the parameters; every object has:
name: Defines the name of the parameters.
type: Defines canonical parameter varieties. as an example uint256.
components: accustomed outline tuple varieties, if a tuple sort is reached, it's painted as sort = tuple [other tuple part properties like name, sort ar here].
outputs: this is often associated array of output objects like inputs.
stateMutability: Defines the changeableness of an operation. It will be one in all the subsequent values: 'pure' (intended to not browse or write the blockchain state), 'view' (specified once the blockchain state is to be browsed however no modification will be made), 'nonpayable' (this is that the default changeableness and doesn't ought to be mentioned once writing the operate within the code, that is, the operate doesn't settle for Ether; we are able to use it to browse and write blockchain state), 'payable' (mentioning it implies that the operate accepts Ether and may read/write blockchain state).

How to use ABI



In order to act with a sensible contract, we have a tendency to initial ought to generate the ABI (Application Binary Interface) of the contract and compile the ABI into a format that we are able to import into our Go application.

The first step is to put in the Solidity compiler (solc).

Solc is offered as a snapcraft package for Ubuntu.
Open a terminal and run the command below.

 sudo snap install solc --edge


Because the ABI acts as an associate interpreter between the EVM bytecode and also the Javascript of the online page, it's required after you wish to perform any good contract practicality. additionally to the ABI, the contract address on the blockchain is needed.


Coding -


The ABI tells the caller of an operation to cipher the required info, like operate signatures and variable declarations, in a very format that EVM understands for jobs that operates in bytecode; this is often known as ABI secret writing.

Solidity encompasses a world variable known as ABI that has an associated cipher methodology, therefore, we are able to use it to cipher the parameters of any operation. Let's begin with a straightforward example. For instance, we've got the subsequent operation

contract Encode {
 function encode (address _address, unit _unit) public pure returns(bytes memory){
 return (abi.encode(_address, _unit));
calling the function with the following values for address and unsigned integer:
 (0x5B38Da6a701c568545dCfcB03FcB875f56beddC4, 127), we get the result

expected result - 



ABI can oftentimes be an overlooked aspect of working with smart contracts but it plays an important role in the usability of this technology.  Building on smart contract tutorials is a great way to understand the power of this silent workhorse and a great way to apply your knowledge.

Leave a


Name is required

Invalid Name

Comment is required

Recaptcha is required.


June 10, 2024 at 05:31 pm

Your comment is awaiting moderation.

By using this site, you allow our use of cookies. For more information on the cookies we use and how to delete or block them, please read our cookie notice.

Chat with Us
Contact Us

Oodles | Blockchain Development Company

Name is required

Please enter a valid Name

Please enter a valid Phone Number

Please remove URL from text