Skip to content

Latest commit

 

History

History

bytecode-utils

README.md

bytecode-utils

Decode the CBOR encoded data at the end of an Ethereum contract's bytecode.

Install

yarn add @ethereum-sourcify/bytecode-utils

Usage

Solidity Contracts

import { decode, AuxdataStyle } from "@ethereum-sourcify/bytecode-utils";

const bytecodeRaw = "0x60806040526004361061003f5760003560e01...7265206c656e677468a2646970667358221220dceca8706b29e917dacf25fceef95acac8d90d765ac926663ce4096195952b6164736f6c634300060b0033"

// For Solidity contracts
decode(bytecodeRaw, AuxdataStyle.SOLIDITY);

Result example

{
  "ipfs": "QmdD3hpMj6mEFVy9DP4QqjHaoeYbhKsYvApX1YZNfjTVWp",
  "solcVersion": "0.6.11",
  "experimental": true,
  "bzzr0": "...",
  "bzzr1": "..."
}

Vyper Contracts

import { decode, AuxdataStyle } from "@ethereum-sourcify/bytecode-utils";

const vyperBytecodeRaw = "0x..."; // Your Vyper contract bytecode

// For Vyper contracts
decode(vyperBytecodeRaw, AuxdataStyle.VYPER);

Result example

{
  "integrity": "...",
  "runtimeSize": 1234,
  "dataSizes": [32, 64, 128],
  "immutableSize": 256,
  "vyperVersion": "0.3.10"
}

Vyper Version Compatibility Notes

Different Vyper compiler versions use different auxdata formats:

  • Before v0.3.5: Auxdata only contains version information in cbor, without length data after it
  • v0.3.5 to v0.3.9: Auxdata includes version and length information in cbor
  • v0.3.10 to v0.4.0: Auxdata is stored as a cbor array with version object as last element
  • v0.4.1 and later: Auxdata cbor array includes integrity check as first element