docs: updated GUIDE #469

FroVolod · 2025-04-07T14:10:00Z

No description provided.

frol

race-of-sloths · 2025-04-07T17:43:40Z

@FroVolod Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
Weekly streak is on the road, smart strategy! Secure your streak with another PR!

Current status: executed

Reviewer	Score
@frol	8
@dj8yfo	8

Your contribution is much appreciated with a final score of 8!
You have received 84 (80 base + 5% lifetime bonus) Sloth points for this contribution

@frol received 25 Sloth Points for reviewing and scoring this pull request.
@dj8yfo received 25 Sloth Points for reviewing and scoring this pull request.

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

Tag @race-of-sloths inside your pull requests
Wait for the maintainer to review and score your pull request
Check out your position in the Leaderboard
Keep weekly and monthly streaks to reach higher positions
Boast your contributions with a dynamic picture of your Profile

For maintainers:

Score pull requests that participate in the Race of Sloths and receive a reward
Engage contributors with fair scoring and fast responses so they keep their streaks
Promote the Race to the point where the Race starts promoting you
Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands

For contributors
- Include a PR: @race-of-sloths include to enter the Race with your PR
For maintainers:
- Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
- Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
- Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
- Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

dj8yfo · 2025-04-08T16:56:19Z

docs/GUIDE.en.md

+</a>
+</details>
+
+#### from-legacy-keychain - Get the public key stored in the legacy keychain (compatible with the old near CLI)


nit: this could provide a link to repo/pkg to disambiguate what old near CLI means

nit: i had most problems with this command until changing error msg on miss about which file specifically was queried.
Without full implementation details, doc can state that key is searched for in a file, whose path is computed from account-name + network + maybe smth else , according to some pattern.

dj8yfo · 2025-04-08T17:03:16Z

docs/GUIDE.en.md

+```txt
+near account \
+    get-public-key \
+    from-ledger --seed-phrase-hd-path 'm/44'\''/397'\''/0'\''/0'\''/1'\'''


nit: this could use non machine-generated form with double quotes "m/44'/397'/0'/0'/1'" , which is better readable as an example

it's the same nit in the spot with from-seed-phrase

dj8yfo

@race-of-sloths score 8

dj8yfo · 2025-04-08T17:07:04Z

docs/GUIDE.en.md

+```txt
+near account \
+    get-public-key \
+    from-ledger --seed-phrase-hd-path 'm/44'\''/397'\''/0'\''/0'\''/1'\'''


it's the same nit in the spot with from-seed-phrase

dj8yfo · 2025-04-08T17:13:11Z

docs/GUIDE.en.md

+```txt
+near account \
+    get-public-key \
+    from-ledger --seed-phrase-hd-path 'm/44'\''/397'\''/0'\''/0'\''/1'\'''


nit: it can be added in doc, that only paths with precisely 5 components are supported as from-ledger paths, that is "m/44'/397'/0'/0'/10'" will work but 'm/44'\''/397'\''/0'\''' will not, unlike e.g. from-seed-phrase hd path

dj8yfo · 2025-04-08T17:16:30Z

docs/GUIDE.en.md

+```txt
+near account \
+    get-public-key \
+    from-ledger --seed-phrase-hd-path 'm/44'\''/397'\''/0'\''/0'\''/1'\'''


nit: it can be added to doc, which category the hd paths belong too. It looks like from-ledger hd-path and from-seed-phrase hd-path share something in common, i.e. they can only start from m/44'/397' , but it's only a gut feeling, i don't have a proof for this statement

dj8yfo · 2025-04-08T17:19:05Z

docs/GUIDE.en.md

+    from-ledger --seed-phrase-hd-path 'm/44'\''/397'\''/0'\''/0'\''/1'\'''
+```
+
+<details><summary><i>The result of this command will be as follows:</i></summary>


nit: approximately as follows

dj8yfo · 2025-04-08T17:23:16Z

docs/GUIDE.en.md

+    network-config testnet
+```
+
+<details><summary><i>The result of this command will be as follows:</i></summary>


nit: for another account will be similar to one as follows

nit: doc can state, that command may block for unlocking keychain via gui-widget outside of cli input/output

dj8yfo · 2025-04-08T17:31:15Z

docs/GUIDE.en.md

+</a>
+</details>
+
+#### from-legacy-keychain - Get the public key stored in the legacy keychain (compatible with the old near CLI)


nit: i had most problems with this command until changing error msg on miss about which file specifically was queried.
Without full implementation details, doc can state that key is searched for in a file, whose path is computed from account-name + network + maybe smth else , according to some pattern.

dj8yfo · 2025-04-08T17:42:47Z

docs/GUIDE.en.md

+
+#### download-abi - Download contract ABI
+
+You can download the contract ABI for the current moment (***now***) and for a certain moment in the past by specifying the block (***at-block-height*** or ***at-block-hash***).


nit: could add a link to https://github.com/near/abi to try to give more details about what it was, that the command was downloading

## 🤖 New release * `near-cli-rs`: 0.19.0 -> 0.20.0 (⚠ API breaking changes) ### ⚠ `near-cli-rs` breaking changes ```text --- failure constructible_struct_adds_field: externally-constructible struct adds field --- Description: A pub struct constructible with a struct literal has a new pub field. Existing struct literals must be updated to include the new field. ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/constructible_struct_adds_field.ron Failed in: field CliContract.deploy_mode in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/deploy/mod.rs:6 --- failure derive_trait_impl_removed: built-in derived trait no longer implemented --- Description: A public type has stopped deriving one or more traits. This can break downstream code that depends on those types implementing those traits. ref: https://doc.rust-lang.org/reference/attributes/derive.html#derive impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/derive_trait_impl_removed.ron Failed in: type ContractFileContext no longer derives Debug, in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/deploy/mod.rs:92 type ContractFileContext no longer derives Clone, in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/deploy/mod.rs:92 --- failure enum_missing: pub enum removed or renamed --- Description: A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/enum_missing.ron Failed in: enum near_cli_rs::commands::contract::deploy::ClapNamedArgContractFileForContract, previously in file /tmp/.tmporyarC/near-cli-rs/src/commands/contract/deploy/mod.rs:5 --- failure enum_no_repr_variant_discriminant_changed: enum variant had its discriminant change value --- Description: The enum's variant had its discriminant value change. This breaks downstream code that used its value via a numeric cast like `as isize`. ref: https://doc.rust-lang.org/reference/items/enumerations.html#assigning-discriminant-values impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/enum_no_repr_variant_discriminant_changed.ron Failed in: variant ContractActionsDiscriminants::Inspect 2 -> 3 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:43 variant ContractActionsDiscriminants::DownloadAbi 3 -> 4 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:46 variant ContractActionsDiscriminants::DownloadWasm 4 -> 5 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:49 variant ContractActionsDiscriminants::ViewStorage 5 -> 6 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:52 variant ContractActionsDiscriminants::Inspect 2 -> 3 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:43 variant ContractActionsDiscriminants::DownloadAbi 3 -> 4 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:46 variant ContractActionsDiscriminants::DownloadWasm 4 -> 5 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:49 variant ContractActionsDiscriminants::ViewStorage 5 -> 6 in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:52 --- failure enum_variant_added: enum variant added on exhaustive enum --- Description: A publicly-visible enum without #[non_exhaustive] has a new variant. ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/enum_variant_added.ron Failed in: variant ContractActionsDiscriminants:DeployAsGlobal in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:38 variant ContractActionsDiscriminants:DeployAsGlobal in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:38 variant CliActionSubcommand:DeployGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:20 variant CliActionSubcommand:UseGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:20 variant ActionSubcommand:DeployGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:61 variant ActionSubcommand:UseGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:66 variant CliContractActions:DeployAsGlobal in /tmp/.tmpg27DR7/near-cli-rs/src/commands/contract/mod.rs:18 variant ActionSubcommandDiscriminants:DeployGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:61 variant ActionSubcommandDiscriminants:UseGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:66 variant ActionSubcommandDiscriminants:DeployGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:61 variant ActionSubcommandDiscriminants:UseGlobalContract in /tmp/.tmpg27DR7/near-cli-rs/src/commands/transaction/construct_transaction/add_action_1/add_action/mod.rs:66 --- failure struct_pub_field_missing: pub struct's pub field removed or renamed --- Description: A publicly-visible struct has at least one public field that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.41.0/src/lints/struct_pub_field_missing.ron Failed in: field use_file of struct CliContract, previously in file /tmp/.tmporyarC/near-cli-rs/src/commands/contract/deploy/mod.rs:5 field signer_public_key of struct CliSignPrivateKey, previously in file /tmp/.tmporyarC/near-cli-rs/src/transaction_signature_options/sign_with_private_key/mod.rs:9 field signer_public_key of struct InteractiveClapContextScopeForSignPrivateKey, previously in file /tmp/.tmporyarC/near-cli-rs/src/transaction_signature_options/sign_with_private_key/mod.rs:9 field signer_public_key of struct SignPrivateKey, previously in file /tmp/.tmporyarC/near-cli-rs/src/transaction_signature_options/sign_with_private_key/mod.rs:15 ``` <details><summary>Changelog</summary> <blockquote> ## [0.20.0](v0.19.0...v0.20.0) - 2025-05-13 ### Added - display global contracts info on account details query ([#483](#483)) - extended action builder with new released items ([#457](#457)) - deploy and use global contracts from UI excluding action builder. ([#456](#456)) - Do not require to explicitly provide public key during signing transactions with a plaintext private key (we can always extract it from the private key) ([#468](#468)) - Added new command "get public key from plaintext private key" ([#466](#466)) - Use free ARM64 GitHub Action runners for pre-built binaries ([#454](#454)) ### Fixed - Fixed returning the result of a function call ([#462](#462)) - Fixed canceling the CLI operation in retry prompts ([#478](#478)) - Fixed cli command `near tokens send-ft` without `memo` ([#474](#474)) - allow forks to leverage transfer-to-project workflow ([#464](#464)) ### Other - removed unsupported reconstruction for DeployGlobalContract ([#484](#484)) - [**breaking**] updates near-* dependencies to 0.30 release ([#481](#481)) - fixed reconstruction of transaction from contract deploy ([#476](#476)) - Refactored 'send-ft memo' command from using Option<String> to just String ([#477](#477)) - Replaced Linux x86-64 ubuntu-20.04 build environment with ubuntu-22.04 as 20.04 reached its end of life, so minimal supported glibc for pre-built binaries is now 2.35 - Linux users with older glibc will have to install CLIs from the source code or update their OS ([#470](#470)) - updated GUIDE ([#469](#469)) - Updated CI secret name in the devtools pipeline ([#460](#460)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

added get-public-key

7dc662d

thisisjoshford added this to DevTools Apr 7, 2025

github-project-automation bot moved this to NEW❗ in DevTools Apr 7, 2025

FroVolod added 3 commits April 7, 2025 18:28

added contract inspect

947ca28

added download-abi

2489a98

added print-transaction

1626184

FroVolod marked this pull request as ready for review April 7, 2025 16:35

FroVolod requested review from akorchyn, dj8yfo and PolyProgrammist as code owners April 7, 2025 16:35

frol approved these changes Apr 7, 2025

View reviewed changes

dj8yfo reviewed Apr 8, 2025

View reviewed changes

dj8yfo approved these changes Apr 8, 2025

View reviewed changes

refactoring according to comments from @dj8yfo

e68c763

frol merged commit 642159c into main Apr 10, 2025
11 checks passed

frol deleted the update-guide branch April 10, 2025 07:12

github-project-automation bot moved this from NEW❗ to Shipped 🚀 in DevTools Apr 10, 2025

This was referenced Apr 10, 2025

chore: release v0.19.1 #465

Closed

chore: release v0.20.0 #471

Closed

frol mentioned this pull request May 9, 2025

chore: release v0.20.0 #482

Merged


		#### download-abi - Download contract ABI

		You can download the contract ABI for the current moment (*now) and for a certain moment in the past by specifying the block (at-block-height* or *at-block-hash*).

docs: updated GUIDE #469

docs: updated GUIDE #469

Uh oh!

Conversation

FroVolod commented Apr 7, 2025

Uh oh!

frol left a comment

Choose a reason for hiding this comment

Uh oh!

race-of-sloths commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dj8yfo Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dj8yfo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

race-of-sloths commented Apr 7, 2025 •

edited

Loading

dj8yfo Apr 8, 2025 •

edited

Loading