Skip to content

Commit e843433

Browse files
committed
Add trin-types note into the ethportal-api README
1 parent 39dc7fa commit e843433

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

ethportal-api/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ethportal-api
22

33
> **Warning!**
4-
> This crate is with experimental status! Do not rely on it in a production setting.
4+
> This crate is experimental! Do not rely on it in a production setting.
55
66
This crate contains definitions for various Portal Network JSON-RPC APIs using [jsonrpsee](https://github.com/paritytech/jsonrpsee) framework.
77

@@ -46,5 +46,22 @@ async fn main() {
4646
}
4747
```
4848

49+
## Types
50+
51+
A variety of types are published in the `types` module. For now, types go into
52+
this module if either 1) they are used by multiple crates, or 2) it's part of
53+
the ethportal-api type signatures. Importantly, ethportal-api shouldn't have
54+
andy dependencies on other crates in the workspace. It's a goal to be able to
55+
publish ethportal-api without also publishing any other supporting crates.
56+
57+
Especially during this experimental period, the types are subject to change, as
58+
many of them are used internally by trin. When ethportal-api becomes
59+
production-ready, the types will follow semantic versioning as usual: any
60+
incompatible change will be introduced with a major version increase.
61+
62+
Utilities used throughout trin are still generally kept in trin-utils, unless
63+
they are used by ethportal-api. Then they are published into ethportal-api,
64+
like the hex utilities.
65+
4966
## License
50-
The entire code within this repository is licensed under the [GNU General Public License v3.0](./LICENSE)
67+
The entire code within this repository is licensed under the [GNU General Public License v3.0](./LICENSE)

0 commit comments

Comments
 (0)