API3-Rust

This is the repo for RUST implementation of API3's Beacon Server

Common

Common package used for all the subsequent chain implementations. To run all test

cd common
cargo test

Solana

Read up on anchors https://book.anchor-lang.com/. To build the solana code, do the following in docker container (.devcontainer/Solana-Dockerfile):

cd solana/beacon-server
anchor build
solana-keygen new
anchor test

Instead of docker, you can follow installation commands from docker image.

Near

Prerequisite

Read up on Near from these links:

• Get started: https://docs.near.org/docs/develop/contracts/overview
• Create account: https://docs.near.org/docs/develop/basics/create-account#creating-a-testnet-account
• Cross contract call: https://docs.near.org/docs/tutorials/contracts/xcc-receipts
• End to end test: https://docs.near.org/docs/develop/contracts/rust/testing-rust-contracts#end-to-end-tests After reading the above, you should be able to know:
• The basic syntax of writing a Near contract using rust
• How to create test accounts
• How and why we need cross contract call
• How end to end test with javascript is written and tested

Dev

To setup the dev env, checkout the dockerfile in .devcontainer/Near-Dockerfile, build and launch the docker. Alternatively, we recommend you use vscode remote docker plugin, you can open this folder in remote docker, then you can have the same dev env. Once in the docker, you can follow the subsection accordingly.

Compile

• go to the near contract folder: cd near/contract
• compile: cargo build --target wasm32-unknown-unknown --release Once done you should be able to see, relative to the repo root folder, target/wasm32-unknown-unknown/release/dapi_server.wasm.

Create test accounts

You need to create 3 accounts for testing:

CONTRACT_ACCOUNT: the account for the dapiServer contract.
ADMIN_ACCOUNT: the default admin of the contract.
USER_ACCOUNT: test util account, mainly for reading data points with unlimited access for data verification.

Now go to near testnet and create the above accounts, you can choose your own names. Remember to define the above env variables with the account names, i.e. for our dev env, it's:

export CONTRACT_ACCOUNT=dapi-contract1.testnet
export ADMIN_ACCOUNT=mocha-test1.testnet
export USER_ACCOUNT=user-test1.testnet

Login on CLI

Once the acconts are created, you need to login from CLI:

near login --account-id ${CONTRACT_ACCOUNT}
near login --account-id ${ADMIN_ACCOUNT}
near login --account-id ${USER_ACCOUNT}

Deploy the contracts

In the root folder, deploy the api3-contract using:

near deploy --wasmFile ./target/wasm32-unknown-unknown/release/dapi_server.wasm --accountId=${CONTRACT_ACCOUNT}

If you get error on not enough balance. Run near dev-deploy ... and delete generated dev-xxxx account in favour of your account: near delete dev-xxxx ${CONTRACT_ACCOUNT}

Once you have deployed the contract, perform some santiy checks to ensure proper deployment, such as:

# This should pass with no problem
near call <CONTRACT_ACCOUNT> grant_role '{"role":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"who":"user-test1.testnet"}' --accountId <ADMIN_ACCOUNT>
# This should return true
near view <CONTRACT_ACCOUNT> has_role '{"role":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"who":"user-test1.testnet"}'
# This should pass with no problem
near call <CONTRACT_ACCOUNT> revoke_role '{"role":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"who":"user-test1.testnet"}' --accountId <ADMIN_ACCOUNT>
# This should return false
near view <CONTRACT_ACCOUNT> has_role '{"role":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"who":"user-test1.testnet"}'

Run tests

The tests are located in near/client-test, the main for tests is near/client-test/tests/test.spec.js. Use npm install if you have not setup before.

To run the test: cd near/client-test && yarn jest. Please note that the tests will take around 10 minutes to finish. At the same time, it is also running against a live network, sometimes there will be timeout errors, but near would retry automatically.

When the contract reverts execution, the near client would log the contract execution error with console.warn. The tests would capture the exceptions thrown and check the expected error name appears in the error message. If you want to disable the warn logs, use yarn jest --silent.

Clean up

To clean up, just delete the accounts using near delete ... .... See https://docs.near.org/docs/tools/near-cli#near-delete.