@ethercast/model
v3.0.2
Published
models and json schemas for ethercast.io and ethercast.io subscribers
Downloads
1,301
Readme
@ethercast/model
Models for the Ethercast service
These models are delivered to the subscribed webhooks (particularly, Logs and Transactions) and also used in the API
Installation
npm install --save @ethercast/model
Usage
The exports of @ethercast/model
are:
- a set of TypeScript interfaces representing the types passed around by Ethercast, e.g. Logs, Transactions and Blocks:
EthereumTypes
- a set of TypeScript interfaces representing the schema of the public Ethercast API
EthercastTypes
You can use the TypeScript interfaces when writing TypeScript code to handle Webhooks or communicate with the API.
The standard draft 6 JSON schemas are useful for a variety of use cases, including validating requests sent to your webhooks.
To use the JSON schemas, you must import one of:
@ethercast/model/ethercast-api-types-schema.json
@ethercast/model/ethereum-types.json
API Docs
https://docs.ethercast.io/model/index.html