switchboard-v2

A monorepo containing APIs, Utils, and examples for Switchboard V2.

Table of Contents

Libraries

Package	Description
Typescript	Typescript client to interact with Switchboard V2.
Typescript Lite	Typescript "Lite" client to deserialize aggregator accounts
Python	Python client to interact with Switchboard V2.
Rust	Rust client to interact with Switchboard V2.
CLI	Command Line Interface (CLI) to interact with Switchboard V2.

Program Examples

Package	Description
anchor-feed-parser	Anchor example program demonstrating how to deserialize and read an onchain aggregator.
spl-feed-parser	Solana Program Library example demonstrating how to deserialize and read an onchain aggregator.
anchor-vrf-parser	Anchor example program demonstrating how to deserialize and read an onchain verifiable randomness function (VRF) account.

Client Examples

Package	Description
feed-parser	Typescript example demonstrating how to read an aggregator account.
feed-walkthrough	Typescript example demonstrating how to create and manage your own oracle queue.
lease-observer	Typescript example demonstrating how to send PagerDuty alerts when your aggregator lease is low on funds.

Dependencies

• Node and Yarn
• Docker Compose
• Rust
• Solana
• Anchor
• Python3

Setup

Typescript Setup

yarn install
yarn workspaces run build
yarn workspace @switchboard-xyz/switchboardv2-cli link

Rust Setup

The following command will build the anchor projects and update the program IDs

anchor build
node scripts/setup-example-programs
anchor test

Python Setup

pip install poetry
cd libraries/py
poetry install

Localnet Testing Setup

You may wish to run your own oracle for integration test. The following command will create a devnet Switchboard environment and output a Switchboard.env file to assist copying

sbv2 localnet:env --keypair ../payer-keypair.json
chmod +x ./start-local-validator.sh && chmod +x ./start-oracle.sh

Test

Libraries

yarn test:libraries

Programs

sbv2 localnet:env --keypair ../payer-keypair.json
chmod +x ./start-local-validator.sh && chmod +x ./start-oracle.sh

Run each of the commands in a separate shell

• ./start-local-validator.sh
• ./start-oracle.sh
• yarn test:anchor

Website

yarn workspace website start