#soroban #env

no-std soroban-env-common

Soroban contract environment common types and functionality

8 stable releases

20.2.2 Feb 13, 2024
20.1.1 Jan 24, 2024
20.0.2 Dec 20, 2023
20.0.0-rc2 Sep 18, 2023
0.0.3 Jul 29, 2022

#158 in Magic Beans

Download history 475/week @ 2023-11-03 454/week @ 2023-11-10 476/week @ 2023-11-17 657/week @ 2023-11-24 1351/week @ 2023-12-01 1080/week @ 2023-12-08 1378/week @ 2023-12-15 684/week @ 2023-12-22 506/week @ 2023-12-29 1157/week @ 2024-01-05 1503/week @ 2024-01-12 1377/week @ 2024-01-19 751/week @ 2024-01-26 1651/week @ 2024-02-02 1746/week @ 2024-02-09 1862/week @ 2024-02-16

6,127 downloads per month
Used in 43 crates (4 directly)

Apache-2.0

190KB
4K SLoC

rs-soroban-env

Rust contract-environment interface and (optional) host implementation for Soroban.

The soroban-env-common crate contains elements of the shared environment-interface between smart contract guest and host: the Env trait that defines the set of available environment functions as well as the Val type that can pass back and forth through the WASM calling convention. Additionally small wrappers around subtypes of Val are included: Object, Symbol, Error, etc.

The soroban-env-guest crate contains the guest-side stub implementation of the environment interface called Guest dependent on extern fns provided by the host implementation. This can be used in a WASM runtime that provides the extern fns.

The soroban-env-host crate contains the host-side full implementation of the environment interface called Host. This can be used either in the real blockchain host, or for local testing in the SDK.


lib.rs:

The environment-common crate contains three families of types:

  • The [Val] type, a 64-bit value type that is a union between several different types (numbers, booleans, symbols, object references), encoded via careful bit-packing.
  • Wrapper types ([Object], [Symbol], [Error]) that contain [Val] in a specific, known union state. These are also 64-bit values, but offer methods specific to the union state (eg. [Symbol] will interconvert with Rust string types).
  • The [Env] trait, which describes the interface between guest and host code. In other words, Env describes a set of host functions that must be implemented in a contract host, and can be called from a guest (or by the SDK). Methods on the [Env] trait can only pass 64-bit values, which are usually [Val] or one of the wrapper types.

The crate additionally contains functions for interconversion between the [Val] type and XDR types, and re-exports the XDR definitions from [stellar_xdr] under the module [xdr].

Dependencies

~6–37MB
~529K SLoC