basm-go-sdk

module
v0.1.0-beta.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 3, 2025 License: MIT

README

Go SDK for the Blocky Attestation Service Wasm Runtime (BASM)

This SDK provides functions for interacting with Blocky Attestation Service WASM runtime.

Contributing

Dependencies
  • Go (see go.mod for version)
  • Tinygo v0.34.0
  • jq
  • golangci-lint
  • easyjson v0.9.0
    • Used for generating JSON serialization code
  • bky-as - Blocky Attestation Service
    • The SDK is designed to work with the Blocky Attestation Service
    • The version compatible with this SDK is pinned in the shell.nix file.
  • testscript
    • Used for running executable and filesystem tests.

Additional project dependencies are specified in tbe shell.nix file.

Nix Shell

To enter a development shell with all dependencies, run:

nix-shell --pure

The development shell can be started with a specific version of bky-as by specifying the version via the --argstr flag:

nix-shell --pure --argstr bkyAsVersion v0.1.0-beta.5 # stable version
nix-shell --pure --argstr bkyAsVersion <full git commit sha> # specific unstable version
nix-shell --pure --argstr bkyAsVersion latest # latest unstable version

Note that any command can be run using the shell via the --run flag:

nix-shell --pure --run "make pre-pr"
Testing

SDK examples are compiled to wasm and tested against the Blocky Attestation Service using the bky-as CLI. The tests are run using the testscript CLI tool.

Run the test scripts with:

make test

Directories

Path Synopsis
x

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL