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

Update "Building Smart Contracts" Quickstart to use near-cli-rs #1638

Merged
merged 8 commits into from
Jan 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 61 additions & 6 deletions docs/2.develop/contracts/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,30 @@ This quickstart is dedicated to creating smart contracts. We also have one dedic
Before starting, make sure you have the following installed:

1. [Node.js](https://nodejs.org/en/download), to use our scaffolding tool.
2. [NEAR CLI](/tools/near-cli#installation), to deploy and interact with the contract.
2. [NEAR CLI](/tools/near-cli#installation) or [NEAR CLI-RS](/tools/near-cli-rs), to deploy and interact with the contract.
3. [cargo-near](https://github.com/near/cargo-near), to easily create testnet accounts.
4. (optional) [Rust](https://www.Rust-lang.org/tools/install), to create Rust contracts.

:::tip Easy Install
Install both `near-cli` and `cargo-near` tools using `npm i -g near-cli cargo-near`

- **NEAR-CLI:** Install both `near-cli` and `cargo-near` tools using
```
npm i -g near-cli cargo-near
```

- **NEAR-CLI-RS:** Install both `near-cli-rs` and `cargo-near` tools using
```
npm i -g near-cli-rs cargo-near
```

:::

:::info Testnet Account
There is no need to have a testnet account to follow this tutorial.

However, if you want to create one, you can do so through [a wallet](https://testnet.mynearwallet.com), and use it from the `near-cli` by invoking `near login`.
There is no need to have a `testnet` account to follow this tutorial.

However, if you want to create one, you can do so through [a wallet](https://testnet.mynearwallet.com), and use it from the `near-cli` by invoking `near login`. (if you prefer `near-cli-rs`, use `near account`)

:::

---
Expand Down Expand Up @@ -214,7 +226,9 @@ New account "lovely-event.testnet" created successfully.
</details>

:::tip
Here we are creating a random account since we do not care about the account's name. Remember that you can create a named account through any wallet (i.e. [MyNearWallet](https://testnet.mynearwallet.com)) and then use it from the `near-cli` by invoking `near login`.

Here we are creating a random account since we do not care about the account's name. Remember that you can create a named account through any wallet (i.e. [MyNearWallet](https://testnet.mynearwallet.com)) and then use it from the `near-cli` by invoking `near login`. (if you prefer `near-cli-rs`, use `near account`)

:::

---
Expand Down Expand Up @@ -250,20 +264,45 @@ Having our account created, we can now deploy the contract into it:

## Interacting with the Contract

To interact with your deployed smart contract you can call its methods using the `near-cli` tool.
To interact with your deployed smart contract you can call its methods using the `near-cli` or `near-cli-rs` tools.

#### Get Greeting

The `get_greeting` method is a [`view`](./anatomy.md#public-methods) method, meaning it only reads from the contract's state, and thus can be called for **free**.

<Tabs>

<TabItem value="near-cli">

```bash
> near view <created-account> get_greeting

"Hello" # Response
```

</TabItem>

<TabItem value="near-cli-rs">

```bash
> near contract call-function as-read-only <created-account> get_greeting

"Hello" # Response
```

</TabItem>

</Tabs>


#### Set Greeting

The `set_greeting` method is a [`change`](./anatomy.md#public-methods) method, meaning it modifies the contract's state, and thus requires a user to sign a transaction in order to be executed.

<Tabs>

<TabItem value="near-cli">

```bash
> near call <created-account> set_greeting '{"greeting": "Hola"}' --accountId <created-account>

Expand All @@ -272,6 +311,22 @@ Log: Saving greeting "Hola" # Response

In this case we are asking the account that stores the contract to call its own contract's method (`--accountId <created-account>`).

</TabItem>

<TabItem value="near-cli-rs">

```bash
> near contract call-function as-transaction <created-account> set_greeting '{"greeting": "Hola"}' sign-as <created-account>

Log: Saving greeting "Hola" # Response
```

In this case we are asking the account that stores the contract to call its own contract's method (`sign-as <created-account>`).

</TabItem>

</Tabs>

---

## Moving Forward
Expand Down
Loading