V2 Specification

This document defines the specification for an EthPM package manifest. A package manifest provides metadata about a Package, and in most cases should provide sufficient information about the packaged contracts and its dependencies to do bytecode verification of its contracts.


Guiding Principles

This specification makes the following assumptions about the document lifecycle.

  1. Package manifests are intended to be generated programatically by package management software as part of the release process.
  2. Package manifests will be consumed by package managers during tasks like installing package dependencies or building and deploying new releases.
  3. Package manifests will typically not be stored alongside the source, but rather by package registries or referenced by package registries and stored in something akin to IPFS.

Conventions

RFC2119

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Prefixed vs Unprefixed

A prefixed hexadecimal value begins with 0x. Unprefixed values have no prefix. Unless otherwise specified, all hexadecimal values should be represented with the 0x prefix.

Prefixed:0xdeadbeef
Unprefixed:deadbeef

Document Format

The canonical format is a single JSON object. Packages must conform to the following serialization rules.

  • The document must be tightly packed, meaning no linebreaks or extra whitespace.
  • The keys in all objects must be sorted alphabetically.
  • Duplicate keys in the same object are invalid.
  • The document must use UTF-8 encoding.
  • The document must not have a trailing newline.

Document Specification

The following fields are defined for the package. Custom fields may be included. Custom fields should be prefixed with x- to prevent name collisions with future versions of the specification.

See Also:Formalized (JSON-Schema) version of this specification: package.spec.json
Jump To:Definitions

EthPM Manifest Version: manifest_version

The manifest_version field defines the specification version that this document conforms to. Packages must include this field.

Required:Yes
Key:manifest_version
Type:String
Allowed Values:2

Package Name: package_name

The package_name field defines a human readable name for this package. Packages must include this field. Package names must begin with a lowercase letter and be comprised of only lowercase letters, numeric characters, and the dash character -. Package names must not exceed 255 characters in length.

Required:Yes
Key:package_name
Type:String
Format:must match the regular expression ^[a-z][a-z0-9_-]{0,255}$

Package Meta: meta

The meta field defines a location for metadata about the package which is not integral in nature for package installation, but may be important or convenient to have on-hand for other reasons. This field should be included in all Packages.

Required:No
Key:meta
Type:package-meta-object-v2

Version: version

The version field declares the version number of this release. This value must be included in all Packages. This value should conform to the semver version numbering specification.

Required:Yes
Key:version
Type:String

Sources: sources

The sources field defines a source tree that should comprise the full source tree necessary to recompile the contracts contained in this release. Sources are declared in a key/value mapping.

Key:sources
Type:Object (String: String)
Format:See Below.

Format

Keys must be relative filesystem paths beginning with a ./.

Paths must resolve to a path that is within the current working directory.

Values must conform to one of the following formats.

When the value is a source string the key should be interpreted as a file path.

  • If the resulting document is a directory the key should be interpreted as a directory path.
  • If the resulting document is a file the key should be interpreted as a file path.

Contract Types: contract_types

The contract_types field holds the Contract Types which have been included in this release. Packages should only include contract types that can be found in the source files for this package. Packages should not include contract types from dependencies. Packages should not include abstract contracts in the contract types section of a release.

Key:

contract_types

Type:

Object (String: contract-type-object-v2)

Format:

Keys must be valid Contract Aliases.

Values must conform to the contract-type-object-v2 definition.


Deployments: deployments

The deployments field holds the information for the chains on which this release has Contract Instances as well as the Contract Types and other deployment details for those deployed contract instances. The set of chains defined by the BIP122 URI keys for this object must be unique. There cannot be two different URI keys in a deployments field representing the same blockchain.

Key:deployments
Type:Object (String: Object(String: contract-instance-object-v2))
Format:See Below.

Format

Keys must be a valid BIP122 URI chain definition.

Values must be objects which conform to the following format.


Build Dependencies: build_dependencies

The build_dependencies field defines a key/value mapping of Ethereum Packages that this project depends on.

Required:

No

Key:

build_dependencies

Type:

Object (String: String)

Format:

Keys must be valid package names matching the regular expression [a-z][-a-z0-9]{0,255}.

Values must be a Content Addressable URI which resolves to a valid package.


Definitions

Definitions for different objects used within the Package. All objects allow custom fields to be included. Custom fields should be prefixed with x- to prevent name collisions with future versions of the specification.



The Bytecode Object

A bytecode object has the following key/value pairs.

Bytecode: bytecode

The bytecode field is a string containing the 0x prefixed hexadecimal representation of the bytecode.

Required:Yes
Type:String
Format:0x prefixed hexadecimal.

The Package Meta Object

The Package Meta object is defined to have the following key/value pairs.

Authors: authors

The authors field defines a list of human readable names for the authors of this package. Packages may include this field.

Required:No
Key:authors
Type:Array (String)

License: license

The license field declares the license under which this package is released. This value should conform to the SPDX format. Packages should include this field.

Required:No
Key:license
Type:String

Description: description

The description field provides additional detail that may be relevant for the package. Packages may include this field.

Required:No
Key:description
Type:String

Keywords: keywords

The keywords field provides relevant keywords related to this package.

Required:No
Key:keywords
Type:List of Strings

The Contract Type Object

A Contract Type object is defined to have the following key/value pairs.

Contract Name: contract_name

The contract_name field defines the Contract Name for this Contract Type.

Required:If the Contract Name and Contract Alias are not the same.
Type:String
Format:must be a valid Contract Name.

Deployment Bytecode: deployment_bytecode

The deployment_bytecode field defines the bytecode for this Contract Type.

Required:No
Type:Object
Format:must conform to the Bytecode Object format.

Runtime Bytecode: runtime_bytecode

The runtime_bytecode field defines the unlinked 0x-prefixed runtime portion of Bytecode for this Contract Type.

Required:No
Type:Object
Format:must conform to the Bytecode Object format.

ABI: abi

Required:No
Type:List
Format:must conform to the Ethereum Contract ABI JSON format.

Natspec: natspec

Required:No
Type:Object
Format:The union of the UserDoc and DevDoc formats.

Compiler: compiler

Required:No
Type:Object
Format:must conform to the Compiler Information object format.

The Contract Instance Object

A Contract Instance Object represents a single deployed Contract Instance and is defined to have the following key/value pairs.

Contract Type: contract_type

The contract_type field defines the Contract Type for this Contract Instance. This can reference any of the contract types included in this Package or any of the contract types found in any of the package dependencies from the build_dependencies section of the Package Manifest.

Required:Yes
Type:String
Format:See Below.

Format

Values for this field must conform to one of the two formats herein.

To reference a contract type from this Package, use the format <contract-alias>.

  • The <contract-alias> value must be a valid Contract Alias.
  • The value must be present in the keys of the contract_types section of this Package.

To reference a contract type from a dependency, use the format <package-name>:<contract-alias>.

  • The <package-name> value must be present in the keys of the build_dependencies of this Package.
  • The <contract-alias> value must be be a valid Contract Alias.
  • The resolved package for <package-name> must contain the <contract-alias> value in the keys of the contract_types section.

Address: address

The address field defines the Address of the Contract Instance.

Required:Yes
Type:String
Format:Hex encoded 0x prefixed Ethereum address matching the regular expression 0x[0-9a-fA-F]{40}.

Transaction: transaction

The transaction field defines the transaction hash in which this Contract Instance was created.

Required:No
Type:String
Format:0x prefixed hex encoded transaction hash.

Block: block

The block field defines the block hash in which this the transaction which created this contract instance was mined.

Required:No
Type:String
Format:0x prefixed hex encoded block hash.

Runtime Bytecode: runtime_bytecode

The runtime_bytecode field defines the runtime portion of bytecode for this Contract Instance. When present, the value from this field supersedes the runtime_bytecode from the Contract Type for this Contract Instance.

Required:No
Type:Object
Format:must conform to the Bytecode Object format.

Every entry in the link_references for this bytecode must have a corresponding entry in the link_dependencies section.

Compiler: compiler

The compiler field defines the compiler information that was used during compilation of this Contract Instance. This field should be present in all Contract Types which include bytecode or runtime_bytecode.

Required:No
Type:Object
Format:must conform to the compiler-information-object-v2 format.

The Compiler Information Object

The compiler field defines the compiler information that was used during compilation of this Contract Instance. This field should be present in all contract instances that locally declare runtime_bytecode.

A Compiler Information object is defined to have the following key/value pairs.

Name name

The name field defines which compiler was used in compilation.

Required:Yes
Key:name
Type:String

Version: version

The version field defines the version of the compiler. The field should be OS agnostic (OS not included in the string) and take the form of either the stable version in semver format or if built on a nightly should be denoted in the form of <semver>-<commit-hash> ex: 0.4.8-commit.60cc1668.

Required:Yes
Key:version
Type:String

Settings: settings

The settings field defines any settings or configuration that was used in compilation. For the "solc" compiler, this should conform to the Compiler Input and Output Description.

Required:No
Key:settings
Type:Object

BIP122 URIs

BIP122 URIs are used to define a blockchain via a subset of the BIP-122 spec.

blockchain://<genesis_hash>/block/<latest confirmed block hash>

The <genesis hash> represents the blockhash of the first block on the chain, and <latest confirmed block hash> represents the hash of the latest block that’s been reliably confirmed (package managers should be free to choose their desired level of confirmations).