This page is an introduction. When ready, check the following for language-specific docs:
What is a Suibase Helper?
An API providing information to accelerate the development and testing of Sui apps.
Your app gets access to:
- Package ID of most recently published modules (can query by name).
- IDs of the shared objects created on last publish of your module.
- active client address (can also query by alias).
- A healthy RPC URL for a specific network (e.g. devnet).
- Various utility functions to help automate development.
How it works?
The magic happens when you do a workdir "publish" command (e.g. testnet publish). This is a drop-in replacement of the Sui binary approach (e.g. sui publish) and the same parameters can be specified.
The Suibase command calls the proper Mysten Labs Sui client version matching the network. It adds parameters to save the output in a JSON file. The data is copied in the Suibase workdir structure, and becomes accessible to your apps through a Helper API.
Example 1: What is the active client address for localnet?
Example 2: What is my last published package ID on testnet?
Example 3: Which URL should be used right now for testnet?
Suibase monitors RPC health of multiple servers and returns the best URL to use.