Skip to content

Commit 8c55898

Browse files
committed
updated readme
1 parent e3b231a commit 8c55898

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# aleo-devnode
22

3-
A standalone Aleo development node for local testing and development.
3+
The devnode is a standalone Aleo development node for local testing and development. Unlike a production node, it **does not verify proofs**. This means transactions can be built with placeholder proofs (for executions) and placeholder verifying keys (for deployments and upgrades), making quick local iteration and fast end-to-end testing by bypassing proof generation when creating a transaction.
44

55
## Build
66

@@ -86,6 +86,28 @@ This persists the ledger to a `devnode/` directory. To start fresh:
8686
aleo-devnode start --private-key APrivateKey1zkp8CZNn3yeCseEtxuVPbDCwSyhGW6yZKUYKfgXmcpoGPWH --storage --clear-storage
8787
```
8888

89+
## Building transactions for devnode
90+
91+
### Leo CLI
92+
93+
Add the appropriate flag when building transactions against a devnode:
94+
95+
| Command | Flag | Description |
96+
|---------|------|-------------|
97+
| `leo execute` | `--skip-execute-proof` | Skips execution proof generation |
98+
| `leo deploy` | `--skip-deploy-certificate` | Skips verifying key certificate for deployment |
99+
| `leo upgrade` | `--skip-deploy-certificate` | Skips verifying key certificate for upgrade |
100+
101+
### JavaScript/TypeScript SDK
102+
103+
Use the dedicated devnode transaction builder methods in [`ProgramManager`](https://github.com/ProvableHQ/sdk/blob/5a50b6f5a7f23ff48933557dfdc51315912e79ba/sdk/src/program-manager.ts):
104+
105+
| Method | Description |
106+
|--------|-------------|
107+
| [`buildDevnodeExecutionTransaction`](https://github.com/ProvableHQ/sdk/blob/5a50b6f5a7f23ff48933557dfdc51315912e79ba/sdk/src/program-manager.ts#L3425) | Builds an execution transaction with a placeholder proof |
108+
| [`buildDevnodeDeploymentTransaction`](https://github.com/ProvableHQ/sdk/blob/5a50b6f5a7f23ff48933557dfdc51315912e79ba/sdk/src/program-manager.ts#L3598) | Builds a deployment transaction with a placeholder verifying key |
109+
| [`buildDevnodeUpgradeTransaction`](https://github.com/ProvableHQ/sdk/blob/5a50b6f5a7f23ff48933557dfdc51315912e79ba/sdk/src/program-manager.ts#L3735) | Builds an upgrade transaction with a placeholder verifying key |
110+
89111
## Snapshots
90112

91113
Snapshots capture the ledger state at a specific block height and can be restored later. They require persistent storage (`--storage`).

0 commit comments

Comments
 (0)