@effectstream/avail-contracts 0.100.14 → 0.100.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @effectstream/avail-contracts
|
|
2
|
+
|
|
3
|
+
Contract-interface package for Avail (data-availability layer) inside
|
|
4
|
+
EffectStream. Reserved as the home for Avail-side bindings, helpers, and
|
|
5
|
+
deployment scripts that an EffectStream app might use when posting data
|
|
6
|
+
blobs to or syncing rollup inputs from Avail.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
bun add @effectstream/avail-contracts
|
|
12
|
+
# or
|
|
13
|
+
npm install @effectstream/avail-contracts
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Standalone usage
|
|
17
|
+
|
|
18
|
+
This package is currently a **stub**. It ships so that
|
|
19
|
+
`@effectstream/sync` and `@effectstream/orchestrator` can declare a
|
|
20
|
+
stable dependency on the Avail integration namespace; concrete exports
|
|
21
|
+
(message-encoding helpers, address utilities) will land here as the
|
|
22
|
+
Avail integration evolves.
|
|
23
|
+
|
|
24
|
+
For sync-side Avail support today, see:
|
|
25
|
+
|
|
26
|
+
- `@effectstream/sync` — `AvailFetcher`, `AvailSyncState`.
|
|
27
|
+
- `@effectstream/npm-avail-node`, `@effectstream/npm-avail-light-client` — pinned binary wrappers.
|
|
28
|
+
- [`templates/avail/`](https://github.com/PaimaStudios/paima-engine/tree/main/templates/avail) — a working node configured against an Avail testnet.
|
|
29
|
+
|
|
30
|
+
## Inside EffectStream
|
|
31
|
+
|
|
32
|
+
The package's role inside the framework is the per-chain "contracts"
|
|
33
|
+
slot, mirroring the structure already used by `@effectstream/evm-contracts`,
|
|
34
|
+
`@effectstream/midnight-contracts`, `@effectstream/cardano-contracts`,
|
|
35
|
+
and `@effectstream/bitcoin-contracts`.
|
|
36
|
+
|
|
37
|
+
## Key exports
|
|
38
|
+
|
|
39
|
+
None at present — the module currently re-exports nothing. Watch the
|
|
40
|
+
`mod.ts` for future entry points, or open an issue if you need a specific
|
|
41
|
+
helper.
|
|
42
|
+
|
|
43
|
+
## Links
|
|
44
|
+
|
|
45
|
+
- Docs: https://effectstream.github.io/docs/packages/chains/avail-contracts
|
|
46
|
+
- Source: https://github.com/PaimaStudios/paima-engine/tree/main/packages/chains/avail-contracts
|
|
47
|
+
- Avail docs: https://docs.availproject.org/
|