@zero-tech/zns-message-schemas
v1.5.5
Published
Typings for zNS Message Schema,
Downloads
8
Keywords
Readme
Message Strategy:
A unique event on a contract should have its own unique message type.
Event schema changes on contract result in a new message type of the same name, with an incremented version affix, and updated messageSchemaVersion
Message Naming Schema Rules:
Message names and their associated data types should adhere to the following rules:
- Message names contain both the noun being acted upon and the verb of the action taking place. E.g.
DomainCreated
,DomainRoyaltyChanged
- Message names that adhere to the above but cause a collision with an existing message name should be prefixed with the contract source. E.g.
EE_DomainCreated
- Message data types begin with the message name
- Message data types are affixed with their schema version - E.g.
DomainCreatedV1
- Message data types end with
Data
Identifying Messages:
The contents of a message can be identified by it's message name: event
, and the schema version messageSchemaVersion
. These correspond to a MsgDataType
that describe the schema of the message.