Skip to main content

How it Works

By using Deploy, your contract metadata is automatically uploaded to IPFS and verified making your contract usable in any web3 app without having to copy your contract ABI.

This works by:

  1. Using the default behavior of solc (the solidity compiler) - appending the encoded contract metadata to the contract bytecode.
  2. Uploading the contracts metadata to IPFS

Encoding & Extracting the Contract Metadata

By default, when compiling any solidity contract, the solc compiler:

  1. Computes the IPFS hash of the contract metadata JSON artifact (containing information including the contract name, ABI, source code, comments and compiler settings).
  2. Encodes the computed IPFS hash using CBOR encoding
  3. Appends the encoded bytes at the end of the compiled bytecode

This means that from any deployed contract, you can:

  1. Get the contract bytecode using the standard RPC call eth_getCode.
  2. Decode the data at the end of the bytecode using a CBOR decoder.
  3. Extract the IPFS hash from the decoded data.
  4. Download the original contract metadata which contains source code, ABI, etc.

Since IPFS hashes are immutable, the encoded contract metadata is guaranteed to be correct and unmodified. This means that all contracts are auto-verifiable by design and without needing any third party! However, the compiler only computes the IPFS hash and encodes it, it does not upload anything to IPFS!

Uploading Contract Metadata to IPFS

By using Deploy:

  1. Your contract metadata is automatically uploaded to IPFS meaning that we can make use of solc's default behavior to unlock our SDKs.
  2. Your contract is automatically verified on Sourcify.

This makes it easy to build web3 apps, using our SDKs, without having to copy or update the contract ABI. Instead, the ABI is retrieved from the contract metadata uploaded to IPFS! This acts as a source of truth and thus is always up to date.

For more information on how contracts are automatically verified using Deploy, visit the "Self-verifiable contracts using solc and IPFS" blog post.