Skip to content

fxadmin update decode command readme #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tock-ibm merged 1 commit into from
Sep 2, 2026
Merged

fxadmin update decode command readme #290

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 15 additions & 6 deletions tools/fxadmin/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,15 +195,24 @@ The decode command extracts the `common.Config` embedded in a binary config bloc
This command is typically used after retrieving the latest configuration from the ledger.

```bash
fxadmin decode \
--block last_config.pb \
--output current_config.json
fxadmin decode <config_block.pb> --output <current_config.json>
```

Example:
```bash
fxadmin decode last_config.pb --output current_config.json
```

**Arguments**

| Argument | Required | Description |
|---------------------| :------: |--------------------------------------------------|
| `<config_block.pb>` | yes | Path to the protobuf config block file to decode |

**Flags**

| Flag | Required | Description |
|------------| :------: |--------------------------------------------------|
| `--block` | yes | Path to the protobuf config block file to decode |
| `--output` | yes | Path to the output `common.Config` JSON file, derived from the block |

---
Expand Down Expand Up @@ -597,7 +606,7 @@ flow can be run by that admin:
fxadmin ledger --config=admin.yaml --current-block=current_block.pb config latest --output last_config.pb

# 2. Decode it to JSON.
fxadmin decode --block=last_config.pb --output=current_config.json
fxadmin decode last_config.pb --output=current_config.json

# 3. Edit manually: copy the current_config.json to modified_config.json and edit.

Expand Down Expand Up @@ -628,7 +637,7 @@ transaction:
fxadmin ledger --config=admin_org1.yaml --current-block=current_block.pb config latest --output last_config.pb

# 2. Decode it to JSON.
fxadmin decode --block=last_config.pb --output=current_config.json
fxadmin decode last_config.pb --output=current_config.json

# 3. Edit manually: copy the current_config.json to modified_config.json and edit.

Expand Down