Skip to content
This repository has been archived by the owner on Jan 11, 2024. It is now read-only.

docs for cross-net messages #167

Merged
merged 14 commits into from
Apr 20, 2023
Merged

docs for cross-net messages #167

merged 14 commits into from
Apr 20, 2023

Conversation

adlrocha
Copy link
Contributor

This PR includes some docs for the usage and operation of cross-net messages.

@adlrocha adlrocha requested a review from jsoares April 18, 2023 17:42
Copy link
Contributor

@jsoares jsoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies as I started fixing multiple things I bumped into while testing this and went a bit outside of the scope. Anyhow, simplified instructions for cross-msgs and beyond, and fixed a few bugs.

Beyond docs, note change to config/mod.rs, which was a bit misleading: our docs use 1234 and the API port and 1234 as the validator port, but the config defaulted to 1234 for the API, which might confuse users. This is more in line with our tutorials.

docs/subnet.md Show resolved Hide resolved
docs/subnet.md Show resolved Hide resolved
docs/usage.md Outdated
@@ -27,6 +27,9 @@ $ ./bin/ipc-agent subnet join --subnet /root/t01002 --collateral 2 --validator-n
```
This command specifies the subnet to join, the amount of collateral to provide and the validator net address used by other validators to dial them.

## Listing your balance in a subnet
> TODO: Add a note on how `wallet list` can be used to check your funds in a subnet. This should be implemented tomorrow (if things go well).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO

docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
jsoares and others added 3 commits April 19, 2023 03:22
Co-authored-by: Jorge Soares <547492+jsoares@users.noreply.github.com>
@adlrocha
Copy link
Contributor Author

@jsoares, comments addressed. Feel free to merge if you see they are fine 🙏

Copy link
Contributor

@jsoares jsoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For external consistency in the interface (last-topdown, list-bottomup, but also things like send-value), I think we should reverse the order here. I don't feel very strongly about it but it's my final suggestion -- everything looks and tests good otherwise.

src/cli/commands/checkpoint/mod.rs Outdated Show resolved Hide resolved
src/cli/commands/checkpoint/mod.rs Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
Co-authored-by: Jorge Soares <547492+jsoares@users.noreply.github.com>
@adlrocha adlrocha merged commit 972e219 into main Apr 20, 2023
@adlrocha adlrocha deleted the adlrocha/cross-docs branch April 20, 2023 06:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants