Go SDK
Functions to manage your allocations
Last updated
Functions to manage your allocations
Last updated
Please Note: This SDK is subject to tremendous changes in the next releases that can be backward incompatible. Please pay close attention to our announcements .
GoSDK is the official Go-based Software Development Kit (SDK) for the Züs decentralized storage network. It enables developers to integrate Züs storage functionalities into their applications while providing tools for wallet management, file operations, staking, and smart contract interactions.
The SDK supports various platforms, including Linux, macOS, and Windows. Additionally, GoSDK can be built for mobile (iOS/Android) and WebAssembly (WASM) to provide broader compatibility across different environments.
GoSDK is compatible with the following operating systems:
MacOS (10.14.5 or later)
Linux (Ubuntu 18+, CentOS 7+, Fedora 30+)
Windows (via WSL or native support)
Before installing GoSDK, ensure you have:
Go Modules enabled: Run export GO111MODULE=on
in your terminal
Step 1: Create a New Project Folder
Open your terminal and run:
This creates and enters a new folder named zus-go-demo
.
Step 2: Initialize a Go Module
Run:
This creates a go.mod
file that declares this folder as a Go module.
If you are using VS code, you can use code
CLI installed command to open the folder.
If not, open VS Code manually and open the zus-go-demo
folder from the File menu.
Step 3: Install Züs SDK from staging
Branch
In your terminal:
This tells Go to pull the latest code from the staging
branch of the SDK repo.
Expected output:
This is a pseudo-version that references a specific commit on the staging
branch.
Step 4: Create Your main.go
File
In the root of zus-go-demo
, create a file named main.go
and paste this:
This imports the SDK and prints its version.
Step 5: Tidy Up Your Dependencies
Run:
This cleans up the go.mod
and go.sum
files by removing unused and downloading used dependencies.
If you hadn’t imported anything yet, you might see a warning like:
go: warning: "all" matched no packages
If you see a missing go.sum entry
error (e.g., after importing packages), and go mod tidy
does not fetch dependencies, try:
The -e
flag tells Go to continue downloading even if errors are detected.
Step 6: Run Your Project
Run the Go file:
This confirms that the SDK is installed, imported, and running.
Alternatively you can also build the sample application:
Run the executable:
If the GoSDK version is printed successfully, the installation is complete.
GoSDK supports mobile app development through gomobile
, allowing integration with iOS and Android apps.
Prerequisites
iOS: Requires Xcode Command Line Tools
Android: Requires Android Studio with NDK
Verify Xcode Setup (macOS users)
To ensure Xcode is correctly referenced:
If it shows /Library/Developer/CommandLineTools
, run:
This ensures full Xcode paths are used.
Steps to Build for Mobile
Setup the Go Mobile environment:
(If golang.org/x/mobile/bind
is missing, install it using go get golang.org/x/mobile/bind
)
Build the SDK:
For iOS:
For Android:
To expose GoSDK functions in Mobile SDK, follow these steps:
For an existing file function (e.g., zboxcore/sdk/allocation.go
):
Add a wrapper function inside mobilesdk/sdk/zbox/allocation.go
For a new function:
Create a new Go file in mobilesdk/sdk/zbox/
Implement the function to call the respective GoSDK method.
Build the SDK again (make build-ios
or make build-android
).
GoSDK can be compiled into WASM for web applications. Example functions that have been exported include:
wasmsdk/ethwallet.go
(exports Ethereum wallet functions)
wasmsdk/wallet.go
(exports core wallet functionalities)
Steps to Export a GoSDK Function to WASM
Modify wasmsdk/wallet.go
or create a new file.
Register the function in WebAssembly (proxy.go
):
Compile the WebAssembly binary:
Test the WASM function:
Replace proxy.wasm
in the test client.
Run a local server (php -S localhost:82 test/server.php
).
Execute the exported function via JavaScript.
GoSDK includes a test suite to validate functionality.
Run all unit tests in bls0chain_test.go
:
Run a single test (e.g., TestSignatureScheme
):
go test
for WASMInstall Node.js (Required for testing)
Set environment variables for WASM testing:
Run the WASM test suite:
Go (Golang) installed: