Skip to content

Commit

Permalink
Fixed ON docs (#403)
Browse files Browse the repository at this point in the history
Fix ON and DELETE_MODEL docs
  • Loading branch information
ashcherbakov committed Aug 25, 2022
1 parent b35d453 commit d516d71
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ See
- [Deployment-detailed](docs/deployment-detailed.png).
- [Deployment Recommendations](https://github.com/zigbee-alliance/distributed-compliance-ledger/wiki/DCL-MainNet-Deployment)
- [Deployment Recommendations for AWS](./docs/deployment-design-aws.md)
- <https://docs.tendermint.com/master/nodes/validators.html>
- <https://docs.tendermint.com/v0.34/tendermint-core/validators.html>
- [Run Light Client Proxy](docs/running-light-client-proxy.md)

### Clients
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment-design-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- `Private Sentry` - Full Node to connect other(external) Validator Nodes ([Sentry Node Architecture](https://forum.cosmos.network/t/sentry-node-architecture-overview/454))
- `Public Sentry` - Full Node to connect other(external) Full Nodes
- `Observer` - Full Node for serving gRPC / REST / RPC clients
- `Seed` - Full Node for sharing IP addresses of `Public Sentry` Nodes ([Seed Node](https://docs.tendermint.com/master/nodes/#seed-nodes))
- `Seed` - Full Node for sharing IP addresses of `Public Sentry` Nodes ([Seed Node](https://docs.tendermint.com/))

> **_Note:_** Most of the nodes should enable `state sync` to avoid catching up with a network from scratch. Refer to [running-node-in-existing-network.md](./advanced/running-node-in-existing-network.md) for details.
Expand Down
8 changes: 4 additions & 4 deletions docs/running-node-manual/on.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ except:
- Set `<node-type>` to `"observer"` when using [run_dcl_node](./full-node.md#step-8-can-be-automated-using-rundclnode-script)
- Configure node specific parameters before running the node depending on the ON deployment option.

#### Option 1: an Observer node is connected to another organization's Public Sentries via Seed nodes**
#### Option 1: an Observer node is connected to another organization's Public Sentries via Seed nodes

This is the main option if you want to connect an ON to CSA public nodes.

Expand Down Expand Up @@ -46,12 +46,12 @@ seeds = "[email protected]:26656"
<summary>CSA `seeds` Example for MainNet (clickable) </summary>

```bash
seeds = "TBD@54.183.6.67:26656"
seeds = "ba1f547b83040904568f181a39ebe6d7e29dd438@54.183.6.67:26656"
```

</details>

#### Option 2: an Observer node is connected to another organization's public nodes**
#### Option 2: an Observer node is connected to another organization's public nodes

This option can be used if you have a trusted relationship with some organization and that organization
provided you with access to its nodes.
Expand All @@ -76,7 +76,7 @@ provided you with access to its nodes.
- another organization nodes with public IPs that this organization shared with you.


#### Option 3: an Observer node is connected to my organization nodes**
#### Option 3: an Observer node is connected to my organization nodes

This is the option when you have a VN and want to create an ON connected to it.

Expand Down
2 changes: 1 addition & 1 deletion docs/running-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- `Private Sentry` - Full Node to connect other (external) Validator Nodes ([Sentry Node Architecture](https://forum.cosmos.network/t/sentry-node-architecture-overview/454))
- `Public Sentry` - Full Node to connect other (external) Full Nodes
- `Observer` - Full Node for serving gRPC / REST / RPC clients
- `Seed` - Full Node for sharing IP addresses of `Public Sentry` Nodes ([Seed Node](https://docs.tendermint.com/master/nodes/#seed-nodes))
- `Seed` - Full Node for sharing IP addresses of `Public Sentry` Nodes ([Seed Node](https://docs.tendermint.com/))

## DCL network architecture overview

Expand Down
16 changes: 16 additions & 0 deletions docs/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,22 @@ All non-edited fields remain the same.
- CLI command:
- `dcld tx model update-model --vid=<uint16> --pid=<uint16> ... --from=<account>`

#### DELETE_MODEL

**Status: Implemented**

Deletes an existing Model identified by a unique combination of `vid` (vendor ID) and `pid` (product ID)
by the vendor account.

- Parameters:
- vid: `uint16` - model vendor ID (positive non-zero)
- pid: `uint16` - model product ID (positive non-zero)
- In State: `model/Model/value/<vid>/<pid>`
- Who can send:
- Vendor account associated with the same vid who has created the model
- CLI command:
- `dcld tx model delete-model --vid=<uint16> --pid=<uint16> --from=<account>`

#### ADD_MODEL_VERSION

**Status: Implemented**
Expand Down

0 comments on commit d516d71

Please sign in to comment.