Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api-references/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@
"localnet": "Localnet",
"estimate-fees": "estimate-fees",
"finalize": "finalize",
"finalize-batch": "finalize-batch"
"finalize-batch": "finalize-batch",
"vesting": "vesting"
}
2 changes: 1 addition & 1 deletion docs/api-references/accounts/account/send.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Send GEN to an address
| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --rpc <rpcUrl> | RPC URL for the network | No | |
| | --network <network> | Network to use (localnet, testnet-asimov) | No | |
| | --network <network> | built-in or custom network alias (see: genlayer network list) | No | |
| | --account <name> | Account to send from | No | |
| | --password <password> | Password to unlock account (skips interactive prompt) | No | |
| -h | --help | display help for command | No | |
4 changes: 3 additions & 1 deletion docs/api-references/configuration/network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Network configuration

### Subcommands

- `genlayer add` — Add a custom network profile
- `genlayer set` — Set the network to use
- `genlayer info` — Show current network configuration and contract addresses
- `genlayer info` — Show current network configuration and contract
- `genlayer list` — List available networks
- `genlayer remove` — Remove a custom network profile
32 changes: 32 additions & 0 deletions docs/api-references/configuration/network/add.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: network add
---

Add a custom network profile
Arguments:
alias Custom network alias

### Usage

`$ genlayer network add [options] <alias>`

### Arguments

- `<alias>`

### Options

| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --base &lt;built-in-alias&gt; | Built-in base network alias | No | |
| | --deployment &lt;path.json&gt; | Consensus deployments JSON file | No | |
| | --deployment-key &lt;dot.path&gt; | Deployment JSON sub-object to scan | No | |
| | --rpc &lt;url&gt; | Node RPC URL override | No | |
| | --consensus-main &lt;addr&gt; | ConsensusMain contract address override | No | |
| | --consensus-data &lt;addr&gt; | ConsensusData contract address override | No | |
| | --staking &lt;addr&gt; | Staking contract address override | No | |
| | --fee-manager &lt;addr&gt; | FeeManager contract address override | No | |
| | --rounds-storage &lt;addr&gt; | RoundsStorage contract address override | No | |
| | --appeals &lt;addr&gt; | Appeals contract address override | No | |
| | --chain-id &lt;n&gt; | Chain ID override | No | |
| -h | --help | display help for command | No | |
21 changes: 21 additions & 0 deletions docs/api-references/configuration/network/remove.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: network remove
---

Remove a custom network profile
Arguments:
alias Custom network alias to remove

### Usage

`$ genlayer network remove [options] <alias>`

### Arguments

- `<alias>`

### Options

| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| -h | --help | display help for command | No | |
1 change: 1 addition & 0 deletions docs/api-references/contracts/call.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ Call a contract method without sending a transaction or changing the state
| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --args &lt;args...&gt; | Contract arguments. Supported types: | No | |
| -h | --help | display help for command | No | |
23 changes: 12 additions & 11 deletions docs/api-references/contracts/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ Deploy intelligent contracts

### Options

| Short | Long | Description | Required | Default |
| ----- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | ------- |
| | --contract &lt;contractPath&gt; | Path to the smart contract to deploy | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --fees &lt;json&gt; | Transaction fee options JSON passed to genlayer-js. | No | |
| | --fee-profile &lt;path&gt; | Path to a fee profile generated by gltest --fee-profile. Deploy uses the profile deploy entry; write and targeted estimate-fees use the matching method entry. --fees can still be provided to override profile values. | No | |
| | --fee-preset &lt;preset&gt; | Fee profile appeal posture: low, standard, or high | No | |
| | --appeal-rounds &lt;count&gt; | Override fee profile appeal rounds | No | |
| | --fee-value &lt;wei&gt; | Fee deposit value to send with the transaction | No | |
| | --valid-until &lt;unixTimestamp&gt; | Unix timestamp after which the transaction is invalid | No | |
| -h | --help | display help for command | No | |
| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --contract &lt;contractPath&gt; | Path to the smart contract to deploy | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --fees &lt;json&gt; | Transaction fee options JSON passed to genlayer-js. | No | |
| | --fee-profile &lt;path&gt; | Path to a fee profile generated by gltest --fee-profile. Deploy uses the profile deploy entry; write and targeted estimate-fees use the matching method entry. --fees can still be provided to override profile values. | No | |
| | --fee-preset &lt;preset&gt; | Fee profile appeal posture: low, standard, or high | No | |
| | --appeal-rounds &lt;count&gt; | Override fee profile appeal rounds | No | |
| | --fee-value &lt;wei&gt; | Fee deposit value to send with the transaction | No | |
| | --valid-until &lt;unixTimestamp&gt; | Unix timestamp after which the transaction is invalid | No | |
| | --args &lt;args...&gt; | Contract arguments. Supported types: | No | |
| -h | --help | display help for command | No | |
21 changes: 11 additions & 10 deletions docs/api-references/contracts/write.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ Sends a transaction to a contract method that modifies the state

### Options

| Short | Long | Description | Required | Default |
| ----- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | ------- |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --fees &lt;json&gt; | Transaction fee options JSON passed to genlayer-js. | No | |
| | --fee-profile &lt;path&gt; | Path to a fee profile generated by gltest --fee-profile. Deploy uses the profile deploy entry; write and targeted estimate-fees use the matching method entry. --fees can still be provided to override profile values. | No | |
| | --fee-preset &lt;preset&gt; | Fee profile appeal posture: low, standard, or high | No | |
| | --appeal-rounds &lt;count&gt; | Override fee profile appeal rounds | No | |
| | --fee-value &lt;wei&gt; | Fee deposit value to send with the transaction | No | |
| | --valid-until &lt;unixTimestamp&gt; | Unix timestamp after which the transaction is invalid | No | |
| -h | --help | display help for command | No | |
| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --fees &lt;json&gt; | Transaction fee options JSON passed to genlayer-js. | No | |
| | --fee-profile &lt;path&gt; | Path to a fee profile generated by gltest --fee-profile. Deploy uses the profile deploy entry; write and targeted estimate-fees use the matching method entry. --fees can still be provided to override profile values. | No | |
| | --fee-preset &lt;preset&gt; | Fee profile appeal posture: low, standard, or high | No | |
| | --appeal-rounds &lt;count&gt; | Override fee profile appeal rounds | No | |
| | --fee-value &lt;wei&gt; | Fee deposit value to send with the transaction | No | |
| | --valid-until &lt;unixTimestamp&gt; | Unix timestamp after which the transaction is invalid | No | |
| | --args &lt;args...&gt; | Contract arguments. Supported types: | No | |
| -h | --help | display help for command | No | |
21 changes: 11 additions & 10 deletions docs/api-references/estimate-fees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@ simulation

### Options

| Short | Long | Description | Required | Default |
| ----- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | ------- |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --fees &lt;json&gt; | Fee estimate options JSON passed to genlayer-js estimateTransactionFees. | No | |
| | --fee-profile &lt;path&gt; | Path to a fee profile generated by gltest --fee-profile. Deploy uses the profile deploy entry; write and targeted estimate-fees use the matching method entry. --fees can still be provided to override profile values. | No | |
| | --fee-preset &lt;preset&gt; | Fee profile appeal posture: low, standard, or high | No | |
| | --appeal-rounds &lt;count&gt; | Override fee profile appeal rounds | No | |
| | --json | Print the fee estimate as JSON without spinner output | No | |
| | --include-report | Include simulation fee accounting/report in the generated estimate output | No | |
| -h | --help | display help for command | No | |
| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --fees &lt;json&gt; | Fee estimate options JSON passed to genlayer-js estimateTransactionFees. | No | |
| | --fee-profile &lt;path&gt; | Path to a fee profile generated by gltest --fee-profile. Deploy uses the profile deploy entry; write and targeted estimate-fees use the matching method entry. --fees can still be provided to override profile values. | No | |
| | --fee-preset &lt;preset&gt; | Fee profile appeal posture: low, standard, or high | No | |
| | --appeal-rounds &lt;count&gt; | Override fee profile appeal rounds | No | |
| | --json | Print the fee estimate as JSON without spinner output | No | |
| | --include-report | Include simulation fee accounting/report in the generated estimate output | No | |
| | --args &lt;args...&gt; | Contract arguments. Supported types: | No | |
| -h | --help | display help for command | No | |
1 change: 1 addition & 0 deletions docs/api-references/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Version: `0.39.1`
- `genlayer finalize` — Finalize a transaction that is ready to be finalized (public call)
- `genlayer finalize-batch` — Finalize a batch of idle transactions in a single call (public call)
- `genlayer staking` — Staking operations for validators and delegators
- `genlayer vesting` — Vesting operations for beneficiaries

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,7 @@ Create random validators

| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --count &lt;count&gt; | Number of validators to create openai ollama) gpt-4o) | No | `[]` |
| | --count &lt;count&gt; | Number of validators to create | No | `1` |
| | --providers &lt;providers...&gt; | Space-separated list of provider names (e.g., openai ollama) | No | `[]` |
| | --models &lt;models...&gt; | Space-separated list of model names (e.g., gpt-4 gpt-4o) | No | `[]` |
| -h | --help | display help for command | No | |
2 changes: 1 addition & 1 deletion docs/api-references/staking/staking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ Staking operations for validators and delegators
- `genlayer active-validators` — List all active validators
- `genlayer quarantined-validators` — List all quarantined validators
- `genlayer banned-validators` — List all banned validators
- `genlayer validators` — Show validator set with stake, status, and voting power
- `genlayer validators` — List validators with stake, status, and optional explorer performance
- `genlayer validator-history` — Show slash and reward history for a validator (default: last 10 epochs)
2 changes: 1 addition & 1 deletion docs/api-references/staking/staking/active-validators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ List all active validators

| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --network &lt;network&gt; | Network to use (localnet, testnet-asimov) | No | |
| | --network &lt;network&gt; | built-in or custom network alias (see: genlayer network list) | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --staking-address &lt;address&gt; | Staking contract address (overrides chain config) | No | |
| -h | --help | display help for command | No | |
2 changes: 1 addition & 1 deletion docs/api-references/staking/staking/banned-validators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ List all banned validators

| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --network &lt;network&gt; | Network to use (localnet, testnet-asimov) | No | |
| | --network &lt;network&gt; | built-in or custom network alias (see: genlayer network list) | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --staking-address &lt;address&gt; | Staking contract address (overrides chain config) | No | |
| -h | --help | display help for command | No | |
2 changes: 1 addition & 1 deletion docs/api-references/staking/staking/delegation-info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Get delegation info for a delegator with a validator
| | --validator &lt;address&gt; | Validator address (deprecated, use positional arg) | No | |
| | --delegator &lt;address&gt; | Delegator address (defaults to signer) | No | |
| | --account &lt;name&gt; | Account to use (for default delegator address) | No | |
| | --network &lt;network&gt; | Network to use (localnet, testnet-asimov) | No | |
| | --network &lt;network&gt; | built-in or custom network alias (see: genlayer network list) | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --staking-address &lt;address&gt; | Staking contract address (overrides chain config) | No | |
| -h | --help | display help for command | No | |
2 changes: 1 addition & 1 deletion docs/api-references/staking/staking/delegator-claim.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Claim delegator withdrawals after unbonding period
| | --delegator &lt;address&gt; | Delegator address (defaults to signer) | No | |
| | --account &lt;name&gt; | Account to use | No | |
| | --password &lt;password&gt; | Password to unlock account (skips interactive prompt) | No | |
| | --network &lt;network&gt; | Network to use (localnet, testnet-asimov) | No | |
| | --network &lt;network&gt; | built-in or custom network alias (see: genlayer network list) | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --staking-address &lt;address&gt; | Staking contract address (overrides chain config) | No | |
| -h | --help | display help for command | No | |
2 changes: 1 addition & 1 deletion docs/api-references/staking/staking/delegator-exit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Exit as a delegator by withdrawing shares from a validator
| | --shares &lt;shares&gt; | Number of shares to withdraw | No | |
| | --account &lt;name&gt; | Account to use | No | |
| | --password &lt;password&gt; | Password to unlock account (skips interactive prompt) | No | |
| | --network &lt;network&gt; | Network to use (localnet, testnet-asimov) | No | |
| | --network &lt;network&gt; | built-in or custom network alias (see: genlayer network list) | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| | --staking-address &lt;address&gt; | Staking contract address (overrides chain config) | No | |
| -h | --help | display help for command | No | |
Loading
Loading