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

chore: adjust raw near call to newer near js calls in README #54

Merged
merged 8 commits into from
May 26, 2022

Conversation

ChaoticTempest
Copy link
Member

Converted over most of the near call ... into near js ... ones. I also corrected some IDs that didn't look right, so let me know if those make sense.

Also, hid the output in html tags so that the README isn't too long and cognitive load becomes a problem when a new user comes to read it

node encode_call.js <your-account> <method-name> <args>

</p>
</details>
Copy link
Member

Choose a reason for hiding this comment

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

This content is correct, but I would suggest to only keep the awesome near js ... command here, to make getting started short and straightforward to learn. The raw CLI calls, will be interesting when user get more familiar, which can be put in the reference or advanced usage part.

```

<details>
<summary><strong>Example output</strong></summary>
Copy link
Member

@ailisp ailisp May 23, 2022

Choose a reason for hiding this comment

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

Nice I like the splitted example output! Much cleaner than before

near call jsvm.test.near call_js_contract --accountId <accountID> --base64 --args $(node encode_call.js <contract-account-id> <function-name> '[<parameter>]') --deposit 0.1
```

or with t<details>
Copy link
Member

Choose a reason for hiding this comment

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

typo here?

Copy link
Member

@ailisp ailisp May 23, 2022

Choose a reason for hiding this comment

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

Also I suggest to drop the raw commands in these example READMEs. I think just let advanced user know about the raw command in one place?

Copy link
Member

@ailisp ailisp left a comment

Choose a reason for hiding this comment

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

Thanks, it's a comprehensive update! Except the typo, the other comments are just my opinions, feel free to merge it if you think it's ready.

Copy link
Collaborator

@volovyks volovyks left a comment

Choose a reason for hiding this comment

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

Awesome! We will need to reorg README in the future. Move low-level APIs to a separate file, add simple contract examples, reorg examples READMEs, etc. But no blockers here!

@volovyks volovyks merged commit c09642c into master May 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants