Entries have a scope, an identifier and some content.
The scope denotes what contracts the entry is valid for. The scope is the address of a contract, or the 0-address for global applicability. This allows overrides for specific contracts to be present in Erya.
The identifier is a 4-byte signature of the method that is being described.
The content is a JSON-document with the following required properties:
params
: An array of objects, each with their own two required properties, type
and name
. This array describes the types of the input parameters to the method, along with their name bindings in the Radspec description.en
: The English description of the method.Additionally, any number of properties keyed by ISO-639-1 codes may be present to provide internationalized descriptions of the method.
To add an entry manually, create a subdirectory (if not already present) for the scope of the entry in the entry
directory.
<aside> ⚠️ The scope must be a checksummed address.
</aside>
Next, create a file named by the 4-byte signature of the method that the entry is describing. The contents of this file should be a JSON-document of the structure described above.