proxy-wasm-go-sdk

This project is in its early stage, and the API is likely to change and not stable.

WebAssembly for Proxies (Go SDK)

The Go SDK for Proxy-Wasm, enabling developers to write Proxy-Wasm plugins in Go. This SDK is powered by TinyGo and does not support the official Go compiler.

Getting Started

• examples directory contains the example codes on top of this SDK.

Requirements

• TinyGo - This SDK depends on TinyGo and leverages its WASI (WebAssembly System Interface) target. Please follow the official instruction here for installing TinyGo.
• Envoy - To run compiled examples, you need to have Envoy binary. Please follow the official instruction.

Build and run Examples

# Build all examples.
make build.examples

# Build a specific example.
make build.example name=helloworld

# Run a specific example.
make run name=helloworld

Compatible Envoy builds (tested on CI)

Envoy is the first host side implementation of Proxy-Wasm ABI, and we run end-to-end tests with multiple Envoy versions in order to verify Proxy-Wasm Go SDK works as expected.

Contributing

We welcome contributions from the community! See CONTRIBUTING.md for how to contribute to this repository.

External links

• WebAssembly for Proxies (ABI specification)
• WebAssembly for Proxies (AssemblyScript SDK)
• WebAssembly for Proxies (C++ SDK)
• WebAssembly for Proxies (Rust SDK)
• WebAssembly for Proxies (Zig SDK)
• TinyGo - Go compiler for small places