interfaces

README

[!IMPORTANT] The interfaces in this repo are defined in Smithy and used for RPC between actors and providers on the stable ABI. For new providers and component actors, interfaces are defined using WIT, and codegen for providers is accomplished via the wasmcloud-provider-wit-bindgen macro. Note that support for WIT is considered experimental at this time.

wasmCloud API Interfaces

This repository contains the wasmCloud contract interface definitions (defined in the Smithy IDL) for those interfaces that are defined and supported by the wasmCloud team. These interfaces are definitely not the only interfaces available, as teams and companies can create their own private or bespoke interfaces as desired.

Smithy IDLs and Shared Libraries

Each interface is defined in a file with the .smithy extension. If the folder contains a codegen.toml file, a library and/or html documentation can be automatically generated from the .smithy file.

More information on code generation and the codegen.toml files is in the weld crate

The docs folder in this repository is published to github pages at Wasmcloud Interfaces, and contains copies of the interfaces available for direct download, and html generated documentation.

For more information on Smithy, see

• Smithy A language for defining services and SDKs
• IDL specification

For more on wasmcloud, see

• wasmCloud