Skip to content

Commit

Permalink
updating api-interface's README
Browse files Browse the repository at this point in the history
  • Loading branch information
silva-fj committed Dec 26, 2024
1 parent 4d3c341 commit 7587be3
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion tee-worker/omni-executor/parentchain/api-interface/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,18 @@ This crate contains auto-generated Substrate runtime API definitions for the Omn

The crate exports the generated interface from a scale encoded metadata file. The interface is used to interact with the parentchain's runtime API.

#### When to regenerate the interface?
Whenever the types of the relevant pallets (OmniAccount, Teebag) change, the interface should be regenerated. This can be done by following the steps in the Generation Process section.

Please note that the metadata fetched from the local node may not be the same as the metadata of the live chains. Therefore, when running the worker agains the live chains, the metadata should be fetched from the live chain and the interface should be regenerated.

## Generation Process

The API interface can be generated using the following commands:

1. First, get the pallet metadata (requires a running node):
```bash
make get-pallet-metadata
make get-metadata
```
This will fetch the metadata from a local node (http://localhost:9944) and save it as a scale file.

Expand Down

0 comments on commit 7587be3

Please sign in to comment.