Request-network
This example demonstrates payments using NEAR tokens and viewing the transaction log with a RequestProxy smart contract deployed in NEAR.
Demo: https://nicepay.beskyd.com:8080/
Quick Start
To run this project locally:
- Prerequisites: Make sure you've installed Node.js ≥ 12
- Install dependencies:
yarn install
- Run the local development server:
yarn dev
(seepackage.json
for a full list ofscripts
you can run withyarn
) - Run the local utility server:
cd server && yarn && yarn start
. This server provides transaction log data from the NEAR blockchain.
Now you'll have a local development environment backed by the NEAR TestNet!
Go ahead and play with the app and the code. As you make code changes, the app will automatically reload.
Exploring The Code
- The "backend" code lives in the
/contract
folder. See the README there for more info. - The frontend code lives in the
/src
folder./src/index.html
is a great place to start exploring. Note that it loads in/src/index.js
, where you can learn how the frontend connects to the NEAR blockchain. - The utility server that provides transaction log data from the NEAR blockchain lives in the /server folder. The utility server uses a public NEAR Indexer database (see: NEAR Indexer for Explorer).
- Tests: there are different kinds of tests for the frontend and the smart
contract. See
contract/README
for info about how it's tested. The frontend code gets tested with jest. You can run both of these at once withyarn run test
.
Deploy
Every smart contract in NEAR has its own associated account. When you run yarn dev
, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how.
Step 0: Install near-cli (optional)
near-cli is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local node_modules
folder when you ran yarn install
, but for best ergonomics you may want to install it globally:
yarn install --global near-cli
Or, if you'd rather use the locally-installed version, you can prefix all near
commands with npx
Ensure that it's installed with near --version
(or npx near --version
)
Step 1: Create an account for the contract
Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as your-name.testnet
, you can deploy your contract to request-network.your-name.testnet
. Assuming you've already created an account on NEAR Wallet, here's how to create request-network.your-name.testnet
:
-
Authorize NEAR CLI, following the commands it gives you:
near login
-
Create a subaccount (replace
YOUR-NAME
below with your actual account name):near create-account request-network.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet
Step 2: set contract name in code
Modify the line in src/config.js
that sets the account name of the contract. Set it to the account id you used above.
const CONTRACT_NAME = process.env.CONTRACT_NAME || 'request-network.YOUR-NAME.testnet'
Step 3: deploy!
One command:
yarn deploy
As you can see in package.json
, this does two things:
- builds & deploys smart contract to NEAR TestNet
- builds & deploys frontend code to GitHub using gh-pages. This will only work if the project already has a repository set up on GitHub. Feel free to modify the
deploy
script inpackage.json
to deploy elsewhere.
Docker Deploys
Using Docker to deploy your app has several benefits:
- Your dockerized app can be spun up reliably using the same commands on any platform with a Docker Daemon -- namely, Linux (CentOS, Debian, Fedora, Ubuntu), macOS, and Windows.
- This technology allows you to work in a single Docker container - a server that provides a user interface and a utility server.
- It is easy to test your app's ability to scale horizontally, even locally on your development machine.
##The sequence of creating a container:
Preload
cd docker
./prepare.sh
Build Docker image
./build.sh
docker/Dockerfile - contains all the commands a user could call on the command line to assemble an image.
Run a new container
./run_server.sh
Troubleshooting
On Windows, if you're seeing an error containing EPERM
it may be related to spaces in your path. Please see this issue for more details.