Options
Public
  • Public
  • Public/Protected
  • All
Menu

Interface ProjectInfo

This type represents information about a Truffle project that can be used to construct and initialize a decoder for that project. This information may be passed in various ways; this type is given here as an interface rahter than a union, but note that really you only need to include one of these fields. (The compilations field will be used if present, then artifacts if not, etc.) Further options for how to specify project information are intended to be added in the future.

Hierarchy

  • ProjectInfo

Index

Properties

Optional artifacts

artifacts: Artifact[]

A list of contract artifacts for contracts in the project. Contract constructor objects may be substituted for artifacts, so if you're not sure which you're dealing with, it's OK.

Optional compilations

compilations: Compilation[]

An list of compilations, as specified in codec; this method of specifying a project is mostly intended for internal Truffle use for now, but you can see the documentation of the Compilations type if you want to use it.

Optional config

config: TruffleConfig

The project's config object. If present, and it has the contracts_build_directory property, the decoder will automatically read all the artifacts from there and use those as the project information. Further, smarter use of the config object are intended to be added in the future.

Generated using TypeDoc