NEAR Workspaces (Rust Edition)

A set of functions provided to automate workflows and write tests, such as the ability to deploy and run NEAR contracts, along with several other functions to aid in development and maintenance.

This software is in very early alpha (use at your own risk). Only local sandboxed environments and testnet are available currently to run this library on.

Requirements

rust v1.56 and up
MacOS (x86) or Linux (x86) for sandbox tests. Testnet is available regardless

Include it in our project

NOTE: since this is still alpha, we'll need to pull it down from github instead:

[dependencies]
workspaces = "0.1"

Remember to grab the current revision since things are likely to change until published.

Testing

A simple test to get us going and familiar with the features:

#![cfg(test)]

use workspaces::prelude::*;

#[tokio::test]
async fn test_deploy_and_view() {
    let worker = workspaces::sandbox();

    let contract = worker.dev_deploy(std::fs::read("path/to/file.wasm"))
        .await
        .expect("could not dev-deploy contract");

    let result: String = contract.view(
        "function_name",
        serde_json::json!({
            "some_arg": "some_value",
        })
        .to_string()
        .into_bytes(),
    )
    .await?
    .json()?;

    assert_eq!(result, OUR_EXPECTED_RESULT);
}

Examples

Some examples can be found examples/src/*.rs to run it standalone.

To run the NFT example, run:

cargo run --example nft

Features

Choosing a network

#[tokio::main]  # or whatever runtime we want
async fn main() {
    // Create a sandboxed environment.
    // NOTE: Each call will create a new sandboxed environment
    let worker = workspaces::sandbox();
    // or for testnet:
    let worker = workspaces::testnet();
}

Helper Functions

Need to make a helper function regardless of whatever Network?

use workspaces::prelude::*;
use workspaces::{Contract, DevNetwork, Network, Worker};

// Helper function that calls into a contract we give it
async fn call_my_func(worker: Worker<impl Network>, contract: &Contract) -> anyhow::Result<()> {
    // Call into the function `contract_function` with args:
    contract.call(&worker, "contract_function")
        .args_json(serde_json::json!({
            "message": msg,
        })?
        .transact()
        .await?;
    Ok(())
}

// Create a helper function that deploys a specific contract
// NOTE: `dev_deploy` is only available on `DevNetwork`s such sandbox and testnet.
async fn deploy_my_contract(worker: Worker<impl DevNetwork>) -> anyhow::Result<Contract> {
    worker.dev_deploy(std::fs::read(CONTRACT_FILE)).await
}

miraclx/workspaces-rs