nexus-sdk 2.0.0

Rust SDK for Nexus protocol types, RPC access, and transaction construction.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! This library contains all Nexus types that are shared between different
//! parts of Nexus. This includes the CLI, the Toolkits and the Leader node.

#[cfg(test)]
extern crate self as nexus_sdk;
#[cfg(test)]
#[path = "../tests/common/mod.rs"]
mod integration_test_support;

/// The ToolFqn type represents a fully qualified tool name. Contains the
/// logic for verifying, serializing and deserializing the FQN.
#[cfg(feature = "tool_fqn")]
mod tool_fqn;
#[cfg(feature = "tool_fqn")]
pub use tool_fqn::*;

/// Reexports Sui types into something that makes more sense.
#[cfg(feature = "sui_types")]
pub mod sui;

#[cfg(feature = "sui_types")]
pub use sui_transaction_builder;

/// Generated Move package bindings used as the SDK's Move ABI boundary.
#[cfg(feature = "types")]
pub mod move_bindings;

/// Nexus types represent the structure of various objects that are defined
/// onchain. It also provides the logic for serializing and deserializing these
/// objects.
#[cfg(feature = "types")]
pub mod types;

#[cfg(feature = "types")]
mod move_boundary;

#[cfg(any(feature = "nexus", feature = "signed_http"))]
mod commitments;

/// DAG JSON parsing and static validation helpers for SDK and CLI authoring flows.
#[cfg(feature = "dag")]
pub mod dag;

/// Move module introspection helpers for on chain tool schema generation.
#[cfg(feature = "onchain_schema_gen")]
pub mod onchain_schema_gen;

/// Nexus events that are fired by the Nexus workflow package and are used to
/// communicate between the onchain and offchain parts of Nexus. This module
/// also contains the logic for serializing and deserializing these events.
#[cfg(feature = "events")]
pub mod events;

/// Transactions module contains builders for PTBs that are submitted to Sui
/// and perform various operations on the Nexus ecosystem.
#[cfg(feature = "transactions")]
pub mod transactions;

/// Task authoring, scheduler results, and object backed inspection types.
#[cfg(feature = "transactions")]
pub mod scheduler;

/// Test utilities for Sui submission, containers, faucets, and mock services.
#[cfg(feature = "test_utils")]
pub mod test_utils;

/// Walrus client provides integration with the Walrus decentralized blob storage
/// system for storing and retrieving files.
#[cfg(feature = "walrus")]
pub mod walrus;

/// Provides various Nexus utilities like deployment and execution of workflows.
#[cfg(feature = "nexus")]
pub mod nexus;

/// Application layer request and response signatures for HTTP.
#[cfg(feature = "signed_http")]
pub mod signed_http;