linobaby / switchboard

🔌 Libraries, SDKs, and Docs for interacting with the Switchboard deployments

Switchboard Core SDK

Umbrella repo for the multi-chain implementations of Switchboard.

Documentation: docs.switchboard.xyz

Getting Started

To get started, clone the core-sdk repository.

git clone --recurse-submodules https://github.com/switchboard-xyz/core-sdk.git
cd core-sdk

Then install the dependencies

cd core-sdk
pnpm install

SDKs

Chain	Name
Aptos	aptos-sdk
EVM (Arbitrum, CoreDAO)	evm-sdk
NEAR	near-sdk
Solana	solana-sdk
Sui	sui-sdk

To add SDKs,

git submodule add https://github.com/switchboard-xyz/switchboard-v2 sdks/solana

To update SDKs,

# All
git submodule update --remote
# Single SDK
git submodule update --remote sdks/solana

Packages

Lang	Name	Description
JS	@switchboard-xyz/cli [npmjs, Typedocs]	Command line interface to interact with Switchboard
JS	@switchboard-xyz/common [npmjs, Typedocs]	Contains the OracleJob protobufs and other types and utilities shared across chains
JS	@switchboard-xyz/oracle [npmjs, Typedocs]	A Typescript wrapper for the Switchboard V2 oracle

Troubleshooting

1. File a GitHub Issue. If chain specific, then file an issue in the SDK's respective repository.
2. Ask a question in Discord #dev-support