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.

Sign up for GitHub

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

Jump to bottom

Update coin-flip example #1792

Merged
merged 5 commits into from
Mar 15, 2024
Merged

Update coin-flip example #1792

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d123a68
Added rust version of coin-flip contract
garikbesson Mar 7, 2024
dd4fbf0
Merge branch 'master' into update-coin-flip-example
garikbesson Mar 7, 2024
cd09e81
Apply suggestions from code review
bucanero Mar 7, 2024
08b952a
Merge branch 'near:master' into update-coin-flip-example
garikbesson Mar 8, 2024
e06397a
Apply suggestions from code review
bucanero Mar 15, 2024
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
51 changes: 25 additions & 26 deletions docs/3.tutorials/examples/coin-flip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,16 @@ Coin Flip is a game where the player tries to guess the outcome of a coin flip.
## Starting the Game
You have two options to start the example:
1. **Recommended:** use the app through Gitpod (a web-based interactive environment)
2. Clone the project locally .


<Tabs className="language-tabs" groupId="code-tabs">
<TabItem value="🌐 JavaScript">
2. Clone the project locally.

| Gitpod | Clone locally |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| <a href="https://gitpod.io/#https://github.com/near-examples/coin-flip-js.git"><img src="https://gitpod.io/button/open-in-gitpod.svg" alt="Open in Gitpod" /></a> | 🌐 `https://github.com/near-examples/coin-flip-js.git` |
| <a href="https://gitpod.io/#https://github.com/near-examples/coin-flip-examples.git"><img src="https://gitpod.io/button/open-in-gitpod.svg" alt="Open in Gitpod" /></a> | `https://github.com/near-examples/coin-flip-examples.git` |

</TabItem>

</Tabs>

If you choose Gitpod, a new browser window will open automatically with the code. Give it a minute, and the front-end will pop up (ensure the pop-up window is not blocked).

If you are running the app locally, enter the directory where you cloned it and use `yarn` to install dependencies, and `yarn start` to start it.

```bash
cd coin-flip-js
yarn
yarn deploy
yarn start
```
Your contract will then be **compiled** and **deployed** to an **account** in the `testnet` network. When done, a browser window should open.
If you are running the app locally, you should build and deploy a contract (JavaScript or Rust version) and a client manually.

---

Expand All @@ -56,17 +41,27 @@ Go ahead and log in with your NEAR account. If you don't have one, you can creat
Now that you understand what the dApp does, let us take a closer look to its structure:

1. The frontend code lives in the `/frontend` folder.
2. The smart contract code is in the `/contract` folder.
2. The smart contract code in Rust is in the `/contract-rs` folder.
3. The smart contract code in JavaScript is in the `/contract-ts` folder.

:::note
Both Rust and JavaScript versions of the contract implement the same functionality.
:::

### Contract
The contract presents 2 methods: `flip_coin`, and `points_of`.

<CodeTabs>
<Language value="🌐 JavaScript" language="ts">
<Github fname="contract.ts"
url="https://github.com/near-examples/coin-flip-workshop-js/blob/main/contract/src/contract.ts"
url="https://github.com/near-examples/coin-flip-examples/blob/main/contract-ts/src/contract.ts"
start="23" end="56" />
</Language>
<Language value="🦀 Rust" language="rust">
<Github fname="lib.rs"
url="https://github.com/near-examples/coin-flip-examples/blob/main/contract-rs/src/lib.rs"
start="49" end="83" />
</Language>
</CodeTabs>

### Frontend
Expand All @@ -89,21 +84,25 @@ It indicates our app, when it starts, to check if the user is already logged in
## Testing

When writing smart contracts, it is very important to test all methods exhaustively. In this
project, you have two types: unit and integration tests. Before digging into them,
go ahead and perform the tests present in the dApp through the command `yarn test`.
project you have integration tests. Before digging into them, go ahead and perform the tests present in the dApp through the command `yarn test` for the JavaScript version, or `./test.sh` for the Rust version.

### Integration test

Integration tests are generally written in JavaScript. They automatically deploy a new
Integration tests can be written in both Rust and JavaScript. They automatically deploy a new
contract and execute methods on it. In this way, integration tests simulate interactions
from users in a realistic scenario. You will find the integration tests for the `coin-flip`
in `tests/integration-tests`.
in `contract-ts/integration-tests` (for the JavaScript contract) and `contract-rs/sandbox-rs` (for the Rust contract).

<CodeTabs>
<Language value="🌐 JavaScript" language="ts">
<Github fname="main.test.js"
url="https://github.com/near-examples/coin-flip-workshop-js/blob/main/integration-tests/src/main.ava.ts"
start="32" end="56" />
url="https://github.com/near-examples/coin-flip-examples/blob/main/contract-ts/integration-tests/src/main.ava.ts"
start="32" end="57" />
</Language>
<Language value="🦀 Rust" language="rust">
<Github fname="lib.rs"
url="https://github.com/near-examples/coin-flip-examples/blob/main/contract-rs/sandbox-rs/src/tests.rs"
start="27" end="83" />
</Language>
</CodeTabs>

Expand Down
Loading