Go SDK

Functions to manage your allocations

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 on Discord.

GoSDK - Züs Client SDK for Go

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/zboxcore/sdk/allocation.go at staging · 0chain/gosdkGitHub

Installation

Supported Platforms

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)

Prerequisites

Before installing GoSDK, ensure you have:

• Go (Golang) installed: Install Go
• Go Modules enabled: Run export GO111MODULE=on in your terminal

Setup Instructions

1. Install GoSDK:

   go get github.com/0chain/gosdk

2. Create a file named sdkversion.go and add the following code:

   package main
   
   import (
       "fmt"
       "github.com/0chain/gosdk/zcncore"
   )
   
   func main() {
       fmt.Println("gosdk version: ", zcncore.GetVersion())
   }

3. Build the sample application:

   go build -o sdkversion sdkversion.go

4. Run the executable:

   ./sdkversion

If the GoSDK version is printed successfully, the installation is complete.

Mobile SDK (iOS & Android)

Building GoSDK for Mobile

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

Steps to Build for Mobile

1. Setup the Go Mobile environment:

   make setup-gomobile

   (If golang.org/x/mobile/bind is missing, install it using go get golang.org/x/mobile/bind)

2. Build the SDK:

   • For iOS:

     make build-ios

   • For Android:

     make build-android

Exporting GoSDK Functions

Expose a GoSDK Function to Mobile SDK

To expose GoSDK functions in Mobile SDK, follow these steps:

1. For an existing file function (e.g., zboxcore/sdk/allocation.go):

   • Add a wrapper function inside mobilesdk/sdk/zbox/allocation.go

2. For a new function:

   • Create a new Go file in mobilesdk/sdk/zbox/

   • Implement the function to call the respective GoSDK method.

3. Build the SDK again (make build-ios or make build-android).

Exporting GoSDK Functions to WebAssembly (WASM)

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

1. Modify wasmsdk/wallet.go or create a new file.

2. Register the function in WebAssembly (proxy.go):

js.Global().Set("YOUR_FUNCTION", js.FuncOf(YOUR_FUNCTION))

1. Compile the WebAssembly binary:

GOOS=js CGO_ENABLED=0 GOARCH=wasm go build -o proxy.wasm github.com/0chain/gosdk/wasmsdk

1. Test the WASM function:

   1. Replace proxy.wasm in the test client.

   2. Run a local server (php -S localhost:82 test/server.php).

   3. Execute the exported function via JavaScript.

Running Unit Tests

GoSDK includes a test suite to validate functionality.

Running General Unit Tests

go test github.com/0chain/gosdk/zboxcore/sdk -v

Running Specific Tests

• Run all unit tests in bls0chain_test.go:

  go test github.com/0chain/gosdk/core/zcncrypto -v

• Run a single test (e.g., TestSignatureScheme):

  go test github.com/0chain/gosdk/core/zcncrypto -v -run TestSignatureScheme

Running Coverage Tests

go test <path_to_folder> -coverprofile=coverage.out
go tool cover -html=coverage.out

WebAssembly Testing

Using go test for WASM

1. Install Node.js (Required for testing)

2. Set environment variables for WASM testing:

   export PATH=$PATH:/usr/local/go/misc/wasm/

3. Run the WASM test suite:

   GOOS=js CGO_ENABLED=0 GOARCH=wasm go test -tags test -v github.com/0chain/gosdk/wasmsdk

Other Dependencies

Installing FFmpeg (for media processing)

sudo apt-get install ffmpeg
sudo apt-get install v4l-utils

---