Skip to content
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.

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

Docs Issues / Improvements #3247

Open
qlp opened this issue Nov 11, 2024 · 0 comments · Fixed by #3261
Open

Docs Issues / Improvements #3247

qlp opened this issue Nov 11, 2024 · 0 comments · Fixed by #3261
Assignees
Labels
A-docs Area: documentation for any part of the project C-feature-request Category: A feature request, i.e: not implemented / a PR.

Comments

@qlp
Copy link
Contributor

qlp commented Nov 11, 2024

below a list of improvements I found reading https://docs.union.build

✅ issue 1-9 are about https://docs.union.build/integrations/ucs01/cosmwasm
(used a fresh orbstack ubuntu arm image to review the instructions)

** ✅ issue 1: error: linker cc not found**
solution
$ sudo apt update
$ sudo apt install build-essential

** ✅ issue 2: need nightly rust**
$ rustup override set nightly-2024-10-11
$ rustup component add rust-src --toolchain nightly-2024-10-11-aarch64-unknown-linux-gnu

** ✅ issue 3: unused import in example**
use std::collections::BTreeMap;

** ✅ issue 4: missing wasm-opt**
$ cargo install wasm-pack
$ cargo install wasm-opt

✅ issue 5: no instruction to set WALLET_ADDRESS

✅ issue 6 rg only prints code_id, not the context. add -C 1 to the rg command to show line before and after
$ ./uniond query tx $DEPLOY_TX_HASH --node https://rpc.testnet-8.union.build:443 | rg -C 1 "code_id"

✅ issue 7 payload cannot be consumed by contract. changed to

{
  "transfer": {
    "receiver": "d8da6bf26964af9d7eed9e03e53415d37aa96045",
    "memo": "hello friend",
    "channel": "channel-86"
  }
}

✅ issue 8: use ‘not library feature’ recommendation in example 
recommended here: https://docs.cosmwasm.com/core/conventions/library-feature
#[cfg_attr(not(feature = "library"), entry_point)]

✅ issue 9: us jq to extract data from responses, like explained on https://docs.cosmwasm.com/wasmd/getting-started/cli
jq -r '.events[]| select(.type=="store_code").attributes[]| select(.key=="code_id").value'

--

issue 10: filling: https://docs.union.build/protocol/channels/ucs03-zkgm/#open-filling
maybe introduce / link ot the concept of filling

issue 11: about the sequence diagrams
a more detailed view (that includes all the messages and the role of the relayer) would be nice

issue 12: conditional light client: https://docs.union.build/concepts/conditional-light-clients/

  • explain l1a/l1b
  • a sequence diagram would really help

issue 13: https://docs.union.build/infrastructure/node-operators/getting-started/
repo is not private anymore?
maybe remove this whole ‘infrastructure’ section as it overlaps ‘joining the testnet’?

issue 14: https://docs.union.build/integrations/cometbft/connecting-a-cometbft-chain/
Title is a bit misleading: maybe Connecting New Cosmos Chain?

@qlp qlp added A-docs Area: documentation for any part of the project C-feature-request Category: A feature request, i.e: not implemented / a PR. labels Nov 11, 2024
@qlp qlp assigned o-az Nov 11, 2024
@qlp qlp linked a pull request Nov 13, 2024 that will close this issue
@qlp qlp closed this as completed in #3261 Nov 13, 2024
@qlp qlp reopened this Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project C-feature-request Category: A feature request, i.e: not implemented / a PR.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants