Vertex Protocol Rust SDK

This is the Rust SDK for the Vertex Protocol API.

Documentation

Installation

Add the following line to your Cargo.toml file:

[dependencies]
vertex_sdk = "0.1.3"

Usage

See the examples and sanity directories.

Running locally

Run sanity checks

• cargo run -- --execute-sanity: runs sanity checks for executes.
• cargo run -- --query-sanity: runs sanity checks for engine queries.
• cargo run -- --indexer-sanity: runs sanity checks for indexer queries.

lib.rs:

vertex_sdk

Usage

See the examples and sanity directories.

Quickstart: prelude

A prelude is provided which imports all the important data types and traits for you. Use this when you want to quickly bootstrap a new project.

use vertex_sdk::prelude::*;

Modules

core

Core traits that define API interaction. These traits must be imported when using the client. The simplest way to import the traits is by using the prelude.

vertex-utils

Contains request and response models.

builders

Use builders for improved UX when writing complex queries or executes. You can build each query or execute struct for later use or send it directly from the builder.

vertex_client

REST implementation of core traits.

sanity

Sanity checks for core SDK functionality.