+ +### Building & Deploying + +Once you created an account to host the contract, you can build and deploy it: + +
+ +### Interacting via CLI + +Once your contract is deployed, check the `README.md` of each repository to see the available methods you can call. + +As a general guide, the `NEAR CLI` has two main ways to interact with smart contracts: + +```bash +# Call a read-only (view) method +near view
- -The good news is the Rust SDK takes care of a lot of the heavy lifting. - -We'll also have the compiler on our side, often telling us exactly what went wrong and offering suggestions. As we go through this tutorial, you'll begin to see patterns that we'll use over and over again. - -So don't worry, writing smart contracts in Rust on NEAR doesn't require a heavy engineering background. - -
Animation by iambon.near
- -:::info Batch Actions in use -Batch Actions are common in this instance, where we want to deploy and call an initialization function. They're also common when using a factory pattern, where a subaccount is created, a smart contract is deployed to it, a key is added, and a function is called. - -Here's a truncated snippet from a useful (though somewhat advanced) repository with a wealth of useful code: -
- -Rust has an interesting feature where enums can contain additional data. You can see [examples of that here](https://doc.rust-lang.org/rust-by-example/custom_types/enum.html). - -## Using structs - -### Storing contract state - -We're going to introduce several structs all at once. These structs are addressing a need from the previous chapter, where the puzzle itself was hardcoded and looked like this: - -
- -We've already used Actions in the [previous chapter](/tutorials/crosswords/basics/hashing-and-unit-tests#first-use-of-batch-actions), when we deployed and initialized the contract, which used the `DeployContract` and `FunctionCall` Action, respectively. - -The full list of Actions are available at the [NEAR specification site](https://nomicon.io/RuntimeSpec/Actions.html). - -By the end of this entire tutorial we'll have used all the Actions highlighted below: - -
From the perspective of a contract on cucumber.near, we see a list of the predecessor, signer, and current account.
Art by yasuoarts.near
- -1. [predecessor account](https://docs.rs/near-sdk/latest/near_sdk/env/fn.predecessor_account_id.html) — `env::predecessor_account_id()` - - This is the account that was the immediate caller to the smart contract. If this is a simple transaction (no cross-contract calls) from **alice.near** to **banana.near**, the smart contract at **banana.near** considers Alice the predecessor. In this case, Alice would *also* be the signer. - - :::tip When in doubt, use predecessor - As we explore the differences between predecessor and signer, know that it's a more common **best practice to choose the predecessor**. - - Using the predecessor guards against a potentially malicious contract trying to "fool" another contract that only checks the signer. - ::: - -2. [signer account](https://docs.rs/near-sdk/latest/near_sdk/env/fn.signer_account_id.html) — `env::signer_account_id()` - - The signer is the account that originally *signed* the transaction that began the blockchain activity, which may or may not include cross-contract calls. If a function calls results in several cross-contract calls, think of the signer as the account that pushed over the first domino in that chain reaction. - - :::caution Beware of middlemen - If your smart contract is checking the ownership over some assets (fungible token, NFTs, etc.) it's probably a bad idea to use the signer account. - - A confused or malicious contract might act as a middleman and cause unexpected behavior. If **alice.near** accidentally calls **evil.near**, the contract at that account might do a cross-contract call to **vulnerable-nft.near**, instructing it to transfer an NFT. - - If **vulnerable-nft.near** only checks the signer account to determine ownership of the NFT, it might unwittingly give away Alice's property. Checking the predecessor account eliminates this problem. - ::: - -3. [current account](https://docs.rs/near-sdk/latest/near_sdk/env/fn.current_account_id.html) — `env::current_account_id()` - - The current account is "me" from the perspective of a smart contract. - - :::tip Why would I use that? - There might be various reasons to use the current account, but a common use case is checking ownership or handling callbacks to cross-contract calls. - - Many smart contracts will want to implement some sort of permission system. A common, rudimentary permission allows certain functions to only be called by the contract owner, AKA the person who owns a private key to the account for this contract. - - The contract can check that the predecessor and current account are the same, and trust offer more permissions like changing contract settings, upgrading the contract, or other privileged modifications. - ::: diff --git a/docs/tutorials/crosswords/03-intermediate/02-use-seed-phrase.md b/docs/tutorials/crosswords/03-intermediate/02-use-seed-phrase.md deleted file mode 100644 index b367b81e9d5..00000000000 --- a/docs/tutorials/crosswords/03-intermediate/02-use-seed-phrase.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -sidebar_position: 3 -sidebar_label: Seed phrase logic -title: Implementing the seed phrase logic from the necessary libraries -description: "Learn how to use seed phrases in NEAR to generate new accounts and securely derive keys from puzzle solutions." ---- - -In this chapter, we will implement the seed phrase logic necessary for the crossword puzzle. This includes generating a random seed phrase for new accounts and parsing the solution as a seed phrase to derive keys for submitting solutions. We will use the `near-seed-phrase` library to handle these tasks. - -# Seed phrase and key derivation - -There are two separate things we'll want to do: - -1. **Create a random seed phrase** for the user when they visit the crossword puzzle. This will be used if they win and don't have a NEAR account and wish to create one. They can then paste this seed phrase into NEAR Wallet afterward to import their account (which is basically like "logging in" and is currently possible at https://testnet.mynearwallet.com/recover-seed-phrase). -2. **Turn the crossword solution into a key pair**, instead of just hashing it. - -## near-seed-phrase library - -We can add the `near-seed-phrase` package to our project with: - -```bash -npm install near-seed-phrase --save -``` - -:::note Code snippets for this chapter -At this point in the tutorial, it's more difficult to share code snippets that are both meaningful and meant to be copy/pasted into a project. - -The snippets provided might differ slightly from the implementation of the [completed code for chapter 3](https://github.com/near-examples/crossword-tutorial-chapter-3), which might be the best place to look for the functioning code. -::: - -## Generate random seed phrase for new account creation (if the winner doesn't already have an account) - -```js -import { generateSeedPhrase } from 'near-seed-phrase'; - -// Create a random key in here -let seedPhrase = generateSeedPhrase(); // generateSeedPhrase() returns an object {seedPhrase, publicKey, secretKey} -localStorage.setItem('playerKeyPair', JSON.stringify(seedPhrase)); -``` - -## Parse solution as seed phrase - -(This security measure prevents front-running.) - -```js -import { parseSeedPhrase } from 'near-seed-phrase'; -// Get the seed phrase from the completed puzzle. -// The original puzzle creator would have already called this same function with the same inputs and would have -// already called `AddKey` on this contract to add the key related to this seed phrase. Here, using this deterministic -// function, the front-end will automatically generate that same key based on the inputs from the winner. -const seedPhrase = parseSolutionSeedPhrase(data, gridData); // returns a string of space-separated words -// Get the public and private key derived from the seed phrase -const {secretKey, publicKey} = parseSeedPhrase(seedPhrase); - -// Set up the account and connection, acting on behalf of the crossword account -const keyStore = new nearAPI.keyStores.InMemoryKeyStore(); // Another type of key -const keyPair = nearAPI.utils.key_pair.KeyPair.fromString(secretKey); -await keyStore.setKey(nearConfig.networkId, nearConfig.contractName, keyPair); -nearConfig.keyStore = keyStore; -const near = await nearAPI.connect(nearConfig); -const crosswordAccount = await near.account(nearConfig.contractName); - -// Call the submit_solution method using the discovered function-call access key -let transaction = await crosswordAccount.functionCall(…); -``` - -The last line should look familiar. We did something similar in the last chapter, except we used the `WalletConnection`'s account to do the function call. - -This time we're using an `InMemoryKeyStore` instead of the browser, as you can see toward the middle of the snippet. - -### Key stores - -We have now used almost all the key stores available in `near-api-js`: - -1. `UnencryptedFileSystemKeyStore` — early on, when we used the NEAR CLI command `near login`, this created a file in our operating system's home directory containing a private, full-access key to our account. -2. `BrowserLocalStorageKeyStore` — in the last chapter, when the user first logs in, the function-call access key is saved in the browser's local storage. -3. `InMemoryKeyStore` — for this chapter, we'll simply use the computer's memory to store the private key derived from the crossword solution. - -:::tip You can have multiple key stores -Technically, there's another type of key store called the `MergeKeyStore`. - -Say you want to look for private keys in various directories. You can essentially have a list of `UnencryptedFileSystemKeyStore` key stores that look in different places. - -Use the `MergeKeyStore` when you might want to look for a private key in more than one place. -::: diff --git a/docs/tutorials/crosswords/03-intermediate/03-linkdrop.md b/docs/tutorials/crosswords/03-intermediate/03-linkdrop.md deleted file mode 100644 index d7036921540..00000000000 --- a/docs/tutorials/crosswords/03-intermediate/03-linkdrop.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -sidebar_position: 4 -sidebar_label: Linkdrop contract -title: Introducing the linkdrop contract we can use -description: "Learn how the linkdrop contract enables creating new NEAR accounts through cross-contract calls." ---- -import {Github} from "@site/src/components/UI/Codetabs"; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -import createMainnetAccount from '/assets/docs/tutorials/crosswords/create-mainnet-account.png'; -import createTestnetAccount from '/assets/docs/tutorials/crosswords/create-testnet-wallet-account.png'; - -We're going to take a small detour to talk about the linkdrop smart contract. It's best that we first understand this contract and its purpose, then discuss calling a method on this contract. - -# The linkdrop contract - -[The linkdrop contract](https://github.com/near/near-linkdrop) is deployed to the accounts `testnet` and `near`, which are known as the top-level accounts of the testnet and mainnet network, respectively. (Anyone can create a linkdrop-style contract elsewhere, but the one shown here is the main one that others are patterned off of.) - -## Testnet - -There’s nothing special about testnet accounts; there is no real-world cost to you as a developer when creating testnet accounts, so feel free to create or delete at your convenience. - -When a user signs up for a testnet account on NEAR Wallet, they'll see this: - -
| `https://github.com/near-examples/coin-flip-examples.git` |
-
-
-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, you should build and deploy a contract (JavaScript or Rust version) and a client manually.
-
----
-
-## Interacting With the Counter
-Go ahead and log in with your NEAR account. If you don't have one, you can create one on the fly. Once logged in, use the `tails` and `heads` buttons to try to guess the next coin flip outcome.
-
-
-*Frontend of the Game*
-
----
-
-## Structure of a dApp
-
-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 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`.
-
-- -### Understanding the Frontend - -The frontend is a [Next.JS](https://nextjs.org/) project generated by [create-near-app](https://github.com/near/create-near-app). Check `_app.js` and `index.js` to understand how components are displayed and interacting with the contract. - -
- -### Running the Frontend - -To start the frontend you will need to install the dependencies and start the server. - -```bash -cd frontend -yarn -yarn dev -``` - -Go ahead and login with your NEAR account. If you don't have one, you will be able to create one in the moment. Once logged in, use the `+` and `-` buttons to increase and decrease the counter. Then, use the Gameboy buttons to reset it and make the counter blink an eye! - - -_Frontend of the Counter_ - -
- -### Understanding the Frontend - -The frontend is a [Next.JS](https://nextjs.org/) project generated by [create-near-app](https://github.com/near/create-near-app). Check `_app.js` and `index.js` to understand how components are displayed and interacting with the contract. - -
- -### Deploying the Contract to the NEAR network - -In order to deploy the contract you will need to create a NEAR account. - -
- -### CLI: Interacting with the Contract - -To interact with the contract through the console, you can use the following commands. - -#### Get the current number of the counter - -
- -#### Increment the counter - -
- -#### Decrement the counter - -
- -#### Reset the counter to zero - -
- -### Running the Frontend - -To start the frontend you will need to install the dependencies and start the server. - -```bash -cd frontend -yarn -yarn dev -``` - -Go ahead and login with your NEAR account. If you don't have one, you will be able to create one in the moment. Once logged in, input the amount of NEAR you want to donate and press the donate button. You will be redirected to the NEAR Wallet to confirm the transaction. After confirming it, the donation will be listed in the "Latest Donations". - -
- -### Understanding the Frontend - -The frontend is a [Next.JS](https://nextjs.org/) project generated by [create-near-app](https://github.com/near/create-near-app). Check `DonationsTable.jsx` and `DonationsForm.jsx` to understand how components are displayed and interacting with the contract. - -
- -### Testing the Contract - -The contract readily includes a set of unit and sandbox testing to validate its functionality. To execute the tests, run the following commands: - -
- -### Deploying the Contract to the NEAR network - -In order to deploy the contract you will need to create a NEAR account. - -
- -### CLI: Interacting with the Contract - -To interact with the contract through the console, you can use the following commands - -#### Get donations - -
- -#### Get beneficiary - -
- -#### Get number of donors - -
- -#### Get donation for an account - -
- -#### Donate to the contract - -
- -:::tip -If you're using your own account, replace `donation.near-examples.testnet` with your `accountId`. -::: - ---- - -## Moving Forward - -A nice way to learn is by trying to expand a contract. Modify the donation example so it accumulates the tokens in the contract -instead of sending it immediately. Then, make a method that only the `beneficiary` can call to retrieve the tokens. - -
- -### Running the Frontend - -To start the frontend you will need to install the dependencies and start the server. - -```bash -cd frontend -yarn -yarn dev -``` - -Go ahead and login with your NEAR account. If you don't have one, you will be able to create one in the moment. Once logged in, you will be able to sign a message in the guest book. You can further send some money alongside your message. If you attach more than 0.01Ⓝ then your message will be marked as "premium". - -
- -### Understanding the Frontend - -The frontend is a [Next.JS](https://nextjs.org/) project generated by [create-near-app](https://github.com/near/create-near-app). Check `_app.js` and `index.js` to understand how components are displayed and interacting with the contract. - -
- -### Testing the Contract - -The contract readily includes a set of unit and sandbox testing to validate its functionality. To execute the tests, run the following commands: - -
- -### Deploying the Contract to the NEAR network - -In order to deploy the contract you will need to create a NEAR account. - -
- -### CLI: Interacting with the Contract - -To interact with the contract through the console, you can use the following commands. - -#### Get messages - -
- -#### Get total number of messages - -
- -#### Add a message - -
- -:::tip -If you're using your own account, replace `guestbook.near-examples.testnet` with your `accountId`. -::: - ---- - -## Moving Forward - -A nice way to learn is by trying to expand a contract. You can modify the guestbook example to incorporate a feature where users can give likes to messages. Additionally, implement a method to toggle the like. - -
-
-
diff --git a/website/sidebars.js b/website/sidebars.js
index d8803b2b1bb..d0e2a2532c7 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -317,23 +317,10 @@ const sidebar = {
]
},
{
- type: 'category',
- label: 'Tutorials',
- link: {
- type: 'doc',
- id: 'tutorials/welcome',
- },
- items: [
- {
- "Beginner": [
- 'tutorials/examples/count-near',
- 'tutorials/examples/guest-book',
- 'tutorials/examples/coin-flip',
- ]
- },
+ "Tutorials": [
+ 'smart-contracts/tutorials/basic-contracts',
{
"Advanced": [
- 'tutorials/examples/donation',
'tutorials/examples/near-drop',
'tutorials/examples/update-contract-migrate-state',
]
diff --git a/website/src/components/UI/Card/index.jsx b/website/src/components/UI/Card/index.jsx
index 7901a9c9c24..710c619ee7e 100644
--- a/website/src/components/UI/Card/index.jsx
+++ b/website/src/components/UI/Card/index.jsx
@@ -12,7 +12,6 @@ const Card = ({
variant = 'default', // 'default', 'icon', 'image'
color = 'default', // 'default', 'mint', 'purple', 'orange'
className = '',
- links,
...props
}) => {
// Determine if card should be clickable
diff --git a/website/static/assets/docs/smart-contracts/tutorials/basic-contracts.png b/website/static/assets/docs/smart-contracts/tutorials/basic-contracts.png
new file mode 100644
index 00000000000..5d92f85887d
Binary files /dev/null and b/website/static/assets/docs/smart-contracts/tutorials/basic-contracts.png differ
diff --git a/website/static/assets/docs/tutorials/examples/coin-flip.png b/website/static/assets/docs/tutorials/examples/coin-flip.png
deleted file mode 100644
index 00b997276b5..00000000000
Binary files a/website/static/assets/docs/tutorials/examples/coin-flip.png and /dev/null differ
diff --git a/website/static/assets/docs/tutorials/examples/count-on-near-banner.png b/website/static/assets/docs/tutorials/examples/count-on-near-banner.png
deleted file mode 100644
index b81ba064bd7..00000000000
Binary files a/website/static/assets/docs/tutorials/examples/count-on-near-banner.png and /dev/null differ
diff --git a/website/static/assets/docs/tutorials/examples/count-on-near.png b/website/static/assets/docs/tutorials/examples/count-on-near.png
deleted file mode 100644
index 1f7a39abb6a..00000000000
Binary files a/website/static/assets/docs/tutorials/examples/count-on-near.png and /dev/null differ
diff --git a/website/static/assets/docs/tutorials/examples/donation.png b/website/static/assets/docs/tutorials/examples/donation.png
deleted file mode 100644
index 03be4c4823e..00000000000
Binary files a/website/static/assets/docs/tutorials/examples/donation.png and /dev/null differ
diff --git a/website/static/assets/docs/tutorials/examples/guest-book.png b/website/static/assets/docs/tutorials/examples/guest-book.png
deleted file mode 100644
index 191b79b9a5e..00000000000
Binary files a/website/static/assets/docs/tutorials/examples/guest-book.png and /dev/null differ
diff --git a/website/static/css/custom.scss b/website/static/css/custom.scss
index a645303e01b..b006d6aa7d0 100644
--- a/website/static/css/custom.scss
+++ b/website/static/css/custom.scss
@@ -239,7 +239,7 @@ h2 {
@media (min-width: 1201px) {
flex: 1 1 calc(33.333%);
- max-width: calc(33.333%);
+ max-width: calc(50%);
}
}
-
-
-
-
-
- -
-
- Count on NEAR -
- Guest Book -
- Coin Flip -
-
-
-
-
-
- -
-
- Factory -
- Global Contracts -
-
-