Set and retrieve status messages per account with this simple smart contract.

License: MIT License

Rust 26.89% JavaScript 46.87% SCSS 10.88% HTML 3.98% TypeScript 11.39%

rust-status-message's Introduction

Status Message

This smart contract saves and records the status messages of NEAR accounts that call it.

Windows users: please visit the Windows-specific README file.

Prerequisites

Ensure near-cli is installed by running:

near --version

If needed, install near-cli:

npm install near-cli -g

Ensure Rust is installed by running:

rustc --version

If needed, install Rust:

curl https://sh.rustup.rs -sSf | sh

Install dependencies

npm install

Quick Start

To run this project locally:

Prerequisites: Make sure you have Node.js ≥ 12 installed (https://nodejs.org), then use it to install yarn: npm install --global yarn (or just npm i -g yarn)
Run the local development server: yarn && yarn dev (see package.json for a full list of scripts you can run with yarn) Now you'll have a local development environment backed by the NEAR TestNet! Running yarn dev will tell you the URL you can visit in your browser to see the app.

Building this contract

To make the build process compatible with multiple operating systems, the build process exists as a script in package.json. There are a number of special flags used to compile the smart contract into the wasm file. Run this command to build and place the wasm file in the res directory:

npm run build

Note: Instead of npm, users of yarn may run:

yarn build

Important

If you encounter an error similar to:

note: the wasm32-unknown-unknown target may not be installed

Then run:

rustup target add wasm32-unknown-unknown

Using this contract

Web app

Deploy the smart contract to a specific account created with the NEAR Wallet. Then interact with the smart contract using near-api-js on the frontend.

If you do not have a NEAR account, please create one with NEAR Wallet.

Make sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following near-cli command:

near login

Deploy the contract to your NEAR account:

near deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME

Build the frontend:

npm start

If all is successful the app should be live at localhost:1234!

Quickest deploy

Build and deploy this smart contract to an development account. This development account will be created automatically and is not intended to be permanent. Please see the "Standard deploy" section for creating a more personalized account to deploy to.

near dev-deploy --wasmFile res/status_message.wasm --helperUrl https://near-contract-helper.onrender.com

Behind the scenes, this is creating an account and deploying a contract to it. On the console, notice a message like:

Done deploying to dev-1234567890123

In this instance, the account is dev-1234567890123. A file has been created containing the key to the account, located at neardev/dev-account. To make the next few steps easier, we're going to set an environment variable containing this development account id and use that when copy/pasting commands. Run this command to the environment variable:

source neardev/dev-account.env

You can tell if the environment variable is set correctly if your command line prints the account name after this command:

echo $CONTRACT_NAME

The next command will call the contract's set_status method:

near call $CONTRACT_NAME set_status '{"message": "aloha!"}' --accountId $CONTRACT_NAME

To retrieve the message from the contract, call get_status with the following:

near view $CONTRACT_NAME get_status '{"account_id": "'$CONTRACT_NAME'"}'

Standard deploy

In this option, the smart contract will get deployed to a specific account created with the NEAR Wallet.

If you do not have a NEAR account, please create one with NEAR Wallet.

Make sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following near-cli command:

near login

Deploy the contract:

near deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME

Set a status for your account:

near call YOUR_ACCOUNT_NAME set_status '{"message": "aloha friend"}' --accountId YOUR_ACCOUNT_NAME

Get the status:

near view YOUR_ACCOUNT_NAME get_status '{"account_id": "YOUR_ACCOUNT_NAME"}'

Note that these status messages are stored per account in a HashMap. See src/lib.rs for the code. We can try the same steps with another account to verify. Note: we're adding NEW_ACCOUNT_NAME for the next couple steps.

There are two ways to create a new account:

the NEAR Wallet (as we did before)
near create_account NEW_ACCOUNT_NAME --masterAccount YOUR_ACCOUNT_NAME

Now call the contract on the first account (where it's deployed):

near call YOUR_ACCOUNT_NAME set_status '{"message": "bonjour"}' --accountId NEW_ACCOUNT_NAME

near view YOUR_ACCOUNT_NAME get_status '{"account_id": "NEW_ACCOUNT_NAME"}'

Returns bonjour.

Make sure the original status remains:

near view YOUR_ACCOUNT_NAME get_status '{"account_id": "YOUR_ACCOUNT_NAME"}'

Testing

To test run:

cargo test --package status-message -- --nocapture

rust-status-message's People

Contributors

Stargazers

Watchers

rust-status-message's Issues

Call Failure

Add a meaningful message for log usage.

We currently have, e.g. env::log(b"A");
this is a good example of usage of log function, but it would be better to add a readable message so that it's more clear what the parameter is.

npm start Error

Your .dependabot/config.yml contained invalid details

Dependabot encountered the following error when parsing your .dependabot/config.yml:

Automerging is not enabled for this account. You can enable it from the [account settings](https://app.dependabot.com/accounts/near-examples/settings) screen in your Dependabot dashboard.

Please update the config file to conform with Dependabot's specification using our docs and online validator.

Gitpod not configured correctly?

I tried out this repo's gitpod but it looks like maybe the environment is not set up correctly. The readme says that the following should echo the account but that variable is not set:

echo $CONTRACT_NAME

Also, it looks like the near tool is not installed:

gitpod /workspace/rust-status-message $ near
bash: near: command not found

Call method is failing.

Hi,
I tried to run this contract using std deploy method, But ended up with errors for call method.
(Tried using quick deploy, it worked fine)

Please help me
Thanks

Create simple frontend for example

This example currently has instructions in the README file. Let's get a frontend going.

A lot of the styling and theme can be borrowed from the Guest Book example. See live at: https://near-examples.github.io/guest-book

Note: the status message is not a "status message" in terms of Twitter where there are multiple statuses. Instead, each user only has one status for them. Here's an idea of what the frontend should look like:

Acceptance criteria:

If a user is not logged in, the button should allow them to log in
If the user is logged in, it'll "log them out" by removing the function-call access key in local storage
Each user should have their own status message. They should only see their own message when they're logged in. Logging out from one user and into another user who already has set a status message should show the message for the appropriate user.
The example can be cloned locally and work. Please see how the Guest Book does this with Parcel.
- See https://github.com/near-examples/guest-book/blob/8ec9131acb894bf7aafb377fabaec4dc7e8f5cb9/package.json#L31 and similar scripts: https://github.com/near-examples/guest-book/blob/8ec9131acb894bf7aafb377fabaec4dc7e8f5cb9/package.json#L5-L16
Update the README to include instructions on how to clone, start, etc. Ensure that the NEAR CLI instructions that currently exist in the README are still there (as an optional way to interact with the contract) and that the instructions all work.

If there are any questions about the proper colors to use (although probably not because this can just be borrowed from Guest Book wholesale) you may check out the branding at https://near.org/brand

Build Failure

Noticed the following issues:

Rust is not listed as a pre-requisite for this project. The build fails if rust is not installed.
After installing Rust and running the build (yarn build) again I got the following error and the build failed:

Error: Failed to find .env file at path: ./neardev/dev-account.env
    at getEnvFile (/Users/qiao/projects/rust-status-message/node_modules/env-cmd/dist/get-env-vars.js:40:19)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `npm run build && npm run build:web && env-cmd -f ./neardev/dev-account.env parcel ./frontend/index.html`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/qiao/.npm/_logs/2021-09-12T06_33_23_203Z-debug.log

solution:

run deploy:dev, all is successful.

deprecated-near-examples / rust-status-message Goto Github PK