Struct suibase::Helper

pub struct Helper(/* private fields */);

A lightweight API to suibase. Multiple instance can be created within the same app.

You interact with Suibase in 3 steps:

1. Check if suibase is_installed()
2. Call select_workdir() to pick among “localnet”, “devnet”, “testnet”, “mainnet” or the one currently set “active” by the user.
3. You can now call any other API functions (in any order). Most calls will relate to the selected workdir.

You can call again select_workdir() to switch to another workdir.

Implementations

impl Helper

pub fn new() -> Self

Constructs a new Helper.

Example

use suibase::Helper;
let sbh = Helper::new();
if sbh.is_installed()? {
   sbh.select_workdir("localnet")?;
   println!("active address is {}", sbh.client_address("active"));
}

pub fn is_installed(&self) -> Result<bool, Error>

Check first if suibase is installed, otherwise most of the other calls will fail in some ways.

pub fn select_workdir(&self, workdir_name: &str) -> Result<(), Error>

Select an existing workdir by name.

Possible values are: “active”, “cargobin”, “localnet”, “devnet”, “testnet”, “mainnet” and other custom names might be supported in future.

Note: “active” is special. It will resolve the active workdir at the moment of the call. Example: if “localnet” is the active, then this call is equivalent to to be done for “localnet”. The selection does not change even if the user externally change the active after this call.

pub fn workdir(&self) -> Result<String, Error>

Get the name of the selected workdir.

pub fn keystore_pathname(&self) -> Result<String, Error>

Get the pathname of the file keystore (when available).

Context: Selected Workdir by this API.

pub fn package_object_id(&self, package_name: &str) -> Result<ObjectID, Error>

Get the ObjectID of the last successfully published “package_name”.

package_name is the “name” field specified in the “Move.toml”.

Related path: ~/suibase/workdirs/<workdir_name>/published-data/<package_name>/

pub fn package_id(&self, package_name: &str) -> Result<String, Error>

Alternative for string-based API.

pub fn published_new_object_ids( &self, object_type: &str ) -> Result<Vec<ObjectID>, Error>

Get the ObjectID of the objects that were created when the package was published.

object_type format is the Sui Move “package::module::type”.

Example:

module acme::Tools { struct Anvil has key, drop { … } … fun init(ctx: &mut TxContext) { Anvil::new(ctx); … } }

The object_type is “acme::Tools::Anvil”

Related path: ~/suibase/workdirs/<workdir_name>/published-data/<package_name>/

pub fn published_new_objects( &self, object_type: &str ) -> Result<Vec<String>, Error>

Alternative to published_new_object_ids() for string-based API.

pub fn client_sui_address( &self, address_name: &str ) -> Result<SuiAddress, Error>

Get an address by name.

Suibase localnet/devnet/testnet/mainnet workdir are created with a set of pre-defined client addresses. These addresses are useful for testing. In particular, with a localnet, they are prefunded.

Values for the address_name argument can be: active | sb-[1-5]-[ed25519|scp256k1|scp256r1]

Examples: “active”, “sb-1-ed25519”, “sb-3-scp256r1”, “sb-5-scp256k1” …

Choosing “active” is same as doing “sui client active-address” for the selected workdir.

pub fn client_address(&self, address_name: &str) -> Result<String, Error>

Alternative to client_sui_address() for string-based API.

pub fn rpc_url(&self) -> Result<String, Error>

Get a RPC URL for the selected workdir.

pub fn ws_url(&self) -> Result<String, Error>

Get a Websocket URL for the selected workdir.

Trait Implementations

impl Default for Helper

This is the documentation for the impl Default

fn default() -> Self

Returns the “default value” for a type.