Skip to content

Commit 644e73c

Browse files
committed
data-drivers: Add top-level README
1 parent d2c4a0a commit 644e73c

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,18 @@ For more information on **running a node for main- or testnet**, see our
6767
| 🌒 [rusk](/rusk/) | Entrypoint for the blockchain node |
6868
| 🔗 [consensus](/consensus/) | Implementation of Dusk's succinct attestation consensus |
6969
| 📜 [contracts](/contracts/) | Dusk genesis contracts |
70+
| 🧩 [data-drivers](/data-drivers/) | Tools to encode/decode contract arguments between RKYV and JS I/O |
7071
| 🧬 [dusk-core](/core/) | Core types used for interacting with Dusk and writing smart contracts |
7172
| 🌐 [dusk-abi](/core/src/abi.rs) | Dusk application binary interface to develop smart contracts (part of core) |
7273
| 🧭 [explorer](/explorer/) | Dusk's blockchain explorer |
7374
| 📊 [node-data](/node-data/) | Core datatypes for the blockchain node |
74-
| ⚙️ [dusk-vm](/vm/) | The virtual machine to run Dusk smart contracts |
75+
| ⚙️ [dusk-vm](/vm/) | The virtual machine to run Dusk smart contracts |
7576
| 🪪 [rusk-profile](/rusk-profile/) | Utility to generate a genesis state based on a set profile |
7677
| 📨 [rusk-prover](/rusk-prover/) | Service exposing functionality to remotely prove zero knowledge proofs |
77-
| ⬇️ [rusk-recovery](/rusk-recovery/) | Utility to recover the state of a chain |
78+
| ⬇️ [rusk-recovery](/rusk-recovery/) | Utility to recover the state of a chain |
7879
| ⌨️ [rusk-wallet](/rusk-wallet/) | Dusk CLI wallet |
7980
| 🔨 [w3sper.js](/w3sper.js/) | Js SDK to integrate Dusk features into applications |
80-
| ⚙️ [wallet-core](/wallet-core/) | WASM library providing core logic for Dusk wallet implementations |
81+
| ⚙️ [wallet-core](/wallet-core/) | WASM library providing core logic for Dusk wallet implementations |
8182
| 📱 [web-wallet](/web-wallet/) | Cross platform Dusk wallet |
8283

8384

data-drivers/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# 🧩 Data Drivers
2+
3+
Tools to encode and decode arguments passed to Dusk contracts, bridging
4+
low-level RKYV bytes and JavaScript inputs/outputs.
5+
6+
This package acts as a collection of utilities and helpers that simplify
7+
interaction with contracts from both Rust and JavaScript contexts.
8+
9+
## 📦 Subpackages
10+
11+
Each folder inside `data-drivers/` is a local package with its own README
12+
and focus area:
13+
14+
- `data-driver/`: Utilities to encode & decode arguments.
15+
- `stake-contract/`: Library to encode/decode contract inputs/outputs for the stake contract.
16+
- `transfer-contract/`: Library to encode/decode contract inputs/outputs for the transfer contract.
17+
18+
For details on each, see their local README files.

0 commit comments

Comments
 (0)