XSEF Specification [WIP]¶

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

Design Principles¶

This specification makes the following assumptions about the document lifecycle.

Package manifests are intended to be generated programatically by package management software as part of the release process.
Package manifests will be consumed by package managers during tasks like installing package dependencies or building and deploying new releases.

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.

https://www.ietf.org/rfc/rfc2119.txt

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.
To ensure backwards compatibility, manifest_version is a forbidden top-level key.

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

XsefPM Manifest Version: `manifest`¶

The manifest field defines the specification version that this document conforms to.

Packages must include this field.

Required: Yes

Key: manifest

Type: String

Allowed Values: xsefpm/1

Package Name: `name`¶

The name field defines a human readable name for this package.

Packages should include this field to be released on an XsefPM registry.

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: If version is included.

Key: name

Type: String

Format: must match the regular expression ^[a-z][-a-z0-9]{0,255}$

Package Version: `version`¶

The version field declares the version number of this release.

Packages should include this field to be released on an XsefPM registry.

This value should conform to the semver version numbering specification.

Required: If name is included.

Key: version

Type: String

Package Metadata: `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

Sources: `sources`¶

The sources field defines a source tree that should comprise the full source tree necessary to recompile the transactions contained in this release.

Required: No

Key: sources

Type: Object (String: Sources Object)

Transaction Types: `transactionTypes`¶

The transactionTypes field hosts the Transaction Types which have been included in this release.

Packages should only include transaction types that can be found in the source files for this package.

Packages should not include transaction types from dependencies.

Packages should not include abstract transactions in the transaction types section of a release.

Required:
No

Key:
transactionTypes

Type:
Object (String: Transaction Type Object)

Format:

Keys must be valid Transaction Aliases.

Values must conform to the Transaction Type Object definition.

Transaction Groups: `transaction groups`¶

The transaction groups field holds the information about the transaction groups and their issuing agency (e.g. ASC or U.N). These determine the settings that can be used to generate the various transactionTypes included in this release.

Required: Yes

Key: transaction groups

Type: Array (the Transaction Group Information object)

Deployments: `deployments`¶

The deployments field holds the information for the |Trading Channel| insance on which this release has Transaction Instances as well as the Transaction Types and other deployment details for those deployed transaction instances. The set of insance 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.

Required:
No

Key:
deployments

Type:
Object (String: Object(String: Transaction Instance Object))

Format:

Keys must be a valid URI/BIP122 URI URL and/or chain definition.

Values must be objects which conform to the following format.

Keys must be valid Transaction Instance Names.

Values must be a valid Transaction Instance Object.

Build Dependencies: `buildDependencies`¶

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

Required:
No

Key:
buildDependencies

Type:
Object (String: String)

Format:

Keys must be valid package-names.

Values must be a Content Addressable URI which resolves to a valid package that conforms the same XsefPM manifest version as its parent.

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 Link Reference Object¶

A Link Reference object has the following key/value pairs. All link references are assumed to be associated with some corresponding Schema.

Offsets: `offsets`¶

The offsets field is an array of integers, corresponding to each of the start positions where the link reference appears in the schema. Locations are 0-indexed from the beginning of the bytes representation of the corresponding schema. This field is invalid if it references a position that is beyond the end of the schema.

Required: Yes

Type: Array

Length: `length`¶

The length field is an integer which defines the length in bytes of the link reference. This field is invalid if the end of the defined link reference exceeds the end of the schema.

Required: Yes

Type: Integer

Name: `name`¶

The name field is a string which must be a valid Identifier. Any link references which should be linked with the same link value should be given the same name.

Required: No

Type: String

Format: must conform to the Identifier format.

The Link Value Object¶

Describes a single Link Value.

A Link Value object is defined to have the following key/value pairs.

Offsets: `offsets`¶

The offsets field defines the locations within the corresponding schema where the value for this link value was written. These locations are 0-indexed from the beginning of the bytes representation of the corresponding schema.

Required: Yes

Type: Integer

Format: See Below.

Format

Array of integers, where each integer must conform to all of the following.

greater than or equal to zero

strictly less than the length of the unprefixed hexadecimal representation of the corresponding schema.

Type: `type`¶

The type field defines the value type for determining what is encoded when linking the corresponding schema.

Required:
Yes

Type:
String

Allowed Values:
"literal" for schema literals

"reference" for named references to a particular Transaction Instance

Value: `value`¶

The value field defines the value which should be written when linking the corresponding schema.

Required: Yes

Type: String

Format: Determined based on type, see below.

Format

For static value literals (e.g. address), value must be a byte string

To reference the address of a Transaction Instance from the current package the value should be the name of that transaction instance.

This value must be a valid Transaction Instance Name.

The chain definition under which the transaction instance that this link value belongs to must contain this value within its keys.

This value may not reference the same transaction instance that this link value belongs to.

To reference a transaction instance from a Package from somewhere within the dependency tree the value is constructed as follows.

Let [p1, p2, .. pn] define a path down the dependency tree.

Each of p1, p2, pn must be valid package names.

p1 must be present in keys of the build_dependencies for the current package.

For every pn where n > 1, pn must be present in the keys of the build_dependencies of the package for pn-1.

The value is represented by the string <p1>:<p2>:<...>:<pn>:<transaction-instance> where all of <p1>, <p2>, <pn> are valid package names and <transaction-instance> is a valid Transaction Name.

The <transaction-instance> value must be a valid Transaction Instance Name.

Within the package of the dependency defined by <pn>, all of the following must be satisfiable:

There must be exactly one chain defined under the deployments key which matches the chain definition that this link value is nested under.

The <transaction-instance> value must be present in the keys of the matching chain.

The Schema Object¶

A schema object has the following key/value pairs.

Schema: `schema`¶

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

Required: Yes

Type: String

Format: 0x prefixed hexadecimal.

Link References: `linkReferences`¶

The linkReferences field defines the locations in the corresponding schema which require linking.

Required: No

Type: Array

Format: All values must be valid Link Reference objects. See also below.

Format

This field is considered invalid if any of the Link References are invalid when applied to the corresponding schema field, or if any of the link references intersect.

Intersection is defined as two link references which overlap.

Link Dependencies: `linkDependencies`¶

The linkDependencies defines the Link Values that have been used to link the corresponding schema.

Required: No

Type: Array

Format: All values must be valid Link Value objects. See also below.

Format

Validation of this field includes the following:

Two link value objects must not contain any of the same values for offsets.
Each link value object must have a corresponding link reference object under the linkReferences field.
The length of the resolved value must be equal to the length of the corresponding Link Reference.

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 associated with this package. This value should conform to the SPDX format. Packages should include this field. If a file Source Object defines its own license, that license takes precedence for that particular file over this package-scoped meta license.

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: Array(String)

Links: `links`¶

The links field provides URIs to relevant resources associated with this package. When possible, authors should use the following keys for the following common resources.

website: Primary website for the package.

documentation: Package Documentation

repository: Location of the project source code.

Key: links

Type: Object (String: String)

The Sources Object¶

A Sources object is defined to have the following fields.

Key: A unique identifier for the source file. (string)

Value: SourceObject

Source Object¶

Checksum: `checksum`¶

Hash of the source file.

Required: If there are no URLs present that contain a content hash.

Key: checksum

Value: ChecksumObject

URLs: `urls`¶

Array of urls that resolve to the same source file.

Urls should be stored on a content-addressable filesystem. If they are not, then either content or checksum must be included.
Urls must be prefixed with a scheme.
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.

Required:	If `content` is not included.
Key:	`urls`
Value:	Array(string)

Content: `content`¶

Inlined transaction source.

Required: If urls is not included.

Key: content

Value: string

Install Path: `installPath`¶

Filesystem path of source file.

Must be a relative filesystem path that begins with a ./.
Must resolve to a path that is within the current virtual working directory.
Must be unique across all included sources.

Required:	This field must be included for the package to be writable to disk.
Key:	`installPath`
Value:	string

Type: `type`¶

The type field declares the type of the source file. The field should be one of the following values: solidity, vyper, abi-json, solidity-ast-json.

Required: No

Key: type

Type: String

License: `license`¶

The license field declares the type of license associated with this source file. When defined, this license overrides the package-scoped Meta License.

Required: No

Key: license

Type: String

The Checksum Object¶

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

Algorithm: `algorithm`¶

The algorithm used to generate the corresponding hash.

Required: Yes

Type: String

Hash: `hash`¶

The hash of a source files contents generated with the corresponding algorithm.

Required: Yes

Type: String

The Transaction Type Object¶

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

Transaction Name: `transactionName`¶

The transactionName field defines the Transaction Name for this Transaction Type.

Required: If the Transaction Name and Transaction Alias are not the same.

Type: String

Format: Must be a valid Transaction Name.

Source ID: `sourceId`¶

The global source identifier for the source file from which this transaction type was generated.

Required: No

Type: String

Value: Must match a unique source ID included in the Sources Object for this package.

Deployment Schema: `deploymentSchema`¶

The deploymentSchema field defines the schema for this Transaction Type.

Required: No

Type: Object

Format: Must conform to the Schema Object format.

Grammar Schema: `grammarSchema`¶

The grammarSchema field defines the unlinked 0x-prefixed grammar portion of Schema for this Transaction Type.

Required: Yes

Type: Object

Format: Must conform to the Schema Object format.

ABI: `abi`¶

Required: No

Type: Array

Format: Must conform to the Ethereum Transaction ABI JSON format.

UserDoc: `userdoc`¶

Required: No

Type: Object

Format: Must conform to the UserDoc format.

DevDoc: `devdoc`¶

Required: No

Type: Object

Format: Must conform to the DevDoc format.

The Transaction Instance Object¶

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

Transaction Type: `transactionType`¶

The transactionType field defines the Transaction Type for this Transaction Instance. This can reference any of the transaction types included in this Package or any of the transaction types found in any of the package dependencies from the buildDependencies 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 transaction type from this Package, use the format <transaction-alias>.

The <transaction-alias> value must be a valid Transaction Alias.
The value must be present in the keys of the transactionTypes section of this Package.

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

The <package-name> value must be present in the keys of the buildDependencies of this Package.
The <transaction-alias> value must be be a valid Transaction Alias.
The resolved package for <package-name> must contain the <transaction-alias> value in the keys of the transactionTypes section.

Contract Address: `contract_address`¶

The contract_address field defines the |Contract Address| of the Transaction 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 Transaction 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 transaction instance was mined.

Required: No

Type: String

Format: 0x prefixed hex encoded block hash.

grammar Schema: `grammarSchema`¶

The grammarSchema field defines the grammar portion of schema for this Transaction Instance. When present, the value from this field supersedes the grammarSchema from the Transaction Type for this Transaction Instance.

Required: No

Type: Object

Format: must conform to the Schema Object format.

Every entry in the linkReferences for this schema must have a corresponding entry in the linkDependencies section.

The Transaction Group Information Object¶

The transaction groups field defines the various transaction groups and settings used during compilation of any Transaction Types or Transaction Instance included in this pacakge.

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

Name `name`¶

The name field defines which transaction group was used in compilation.

Required: Yes

Key: name

Type: String

Version: `version`¶

The version field defines the version of the transaction group. 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.

Required: No

Key: settings

Type: Object

Transaction Types: `transactionTypes`¶

A list of the Transaction Alias in this package that used this transaction group to generate its outputs.

All transactionTypes that locally declare grammarSchema should be attributed for by a transaction group object.

A single transactionTypes must not be attributed to more than one transaction group.

Required: No

Key: transactionTypes

Type: Array(Transaction Alias)

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).

XSEF Specification [WIP]¶

Design Principles¶

Conventions¶

RFC2119¶

Prefixed vs Unprefixed¶

Document Format¶

Document Specification¶

XsefPM Manifest Version: manifest¶

Package Name: name¶

Package Version: version¶

Package Metadata: meta¶

Sources: sources¶

Transaction Types: transactionTypes¶

Transaction Groups: transaction groups¶

Deployments: deployments¶

Build Dependencies: buildDependencies¶

Definitions¶

The Link Reference Object¶

Offsets: offsets¶

Length: length¶

Name: name¶

The Link Value Object¶

Offsets: offsets¶

Type: type¶

Value: value¶

The Schema Object¶

Schema: schema¶

Link References: linkReferences¶

Link Dependencies: linkDependencies¶

The Package Meta Object¶

Authors: authors¶

License: license¶

Description: description¶

Keywords: keywords¶

Links: links¶

The Sources Object¶

Source Object¶

Checksum: checksum¶

URLs: urls¶

Content: content¶

Install Path: installPath¶

Type: type¶

License: license¶

The Checksum Object¶

Algorithm: algorithm¶

Hash: hash¶

The Transaction Type Object¶

Transaction Name: transactionName¶

Source ID: sourceId¶

Deployment Schema: deploymentSchema¶

Grammar Schema: grammarSchema¶

ABI: abi¶

UserDoc: userdoc¶

DevDoc: devdoc¶

The Transaction Instance Object¶

Transaction Type: transactionType¶

Contract Address: contract_address¶

Transaction: transaction¶

Block: block¶

grammar Schema: grammarSchema¶

The Transaction Group Information Object¶

Name name¶

Version: version¶

Settings: settings¶

Transaction Types: transactionTypes¶

BIP122 URIs¶

XsefPM Manifest Version: `manifest`¶

Package Name: `name`¶

Package Version: `version`¶

Package Metadata: `meta`¶

Sources: `sources`¶

Transaction Types: `transactionTypes`¶

Transaction Groups: `transaction groups`¶

Deployments: `deployments`¶

Build Dependencies: `buildDependencies`¶

Offsets: `offsets`¶

Length: `length`¶

Name: `name`¶

Offsets: `offsets`¶

Type: `type`¶

Value: `value`¶

Schema: `schema`¶

Link References: `linkReferences`¶

Link Dependencies: `linkDependencies`¶

Authors: `authors`¶

License: `license`¶

Description: `description`¶

Keywords: `keywords`¶

Links: `links`¶

Checksum: `checksum`¶

URLs: `urls`¶

Content: `content`¶

Install Path: `installPath`¶

Type: `type`¶

License: `license`¶

Algorithm: `algorithm`¶

Hash: `hash`¶

Transaction Name: `transactionName`¶

Source ID: `sourceId`¶

Deployment Schema: `deploymentSchema`¶

Grammar Schema: `grammarSchema`¶

ABI: `abi`¶

UserDoc: `userdoc`¶

DevDoc: `devdoc`¶

Transaction Type: `transactionType`¶

Contract Address: `contract_address`¶

Transaction: `transaction`¶

Block: `block`¶

grammar Schema: `grammarSchema`¶

Name `name`¶

Version: `version`¶

Settings: `settings`¶

Transaction Types: `transactionTypes`¶