### Install Dependencies for Switchboard Core SDK

Source: https://github.com/switchboard-xyz/switchboard/blob/main/README.md

After cloning the repository, this command installs the necessary Node Package Manager (npm) dependencies using pnpm. Ensure you have Node.js and pnpm installed.

```bash
cd core-sdk
pnpm install
```

--------------------------------

### Clone Switchboard Core SDK Repository

Source: https://github.com/switchboard-xyz/switchboard/blob/main/README.md

This command clones the Switchboard Core SDK repository and its submodules. It's the first step to getting started with the SDK.

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

--------------------------------

### sb solana network start

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Starts a Switchboard Solana network from a JSON configuration file. This command allows for various network configurations, including specifying RPC URLs, cluster types, and commitment levels.

```APIDOC
## POST /solana/network/start

### Description
Starts a Switchboard Solana network from a JSON file. Allows for configuration of RPC URLs, cluster types, and commitment levels.

### Method
POST

### Endpoint
/solana/network/start

### Parameters
#### Query Parameters
- **silent** (boolean) - Optional - Suppress docker logging.
- **verbose** (boolean) - Optional - Log everything.
- **mainnetBeta** (boolean) - Optional - Use mainnet-beta Solana cluster.
- **cluster** (string) - Optional - The Solana cluster to connect to (devnet, mainnet-beta, mainnet, localnet).
- **rpcUrl** (string) - Optional - Alternate RPC URL.
- **programId** (string) - Optional - Alternative Switchboard program ID.
- **attestationProgramId** (string) - Optional - Alternative Switchboard Attestation program ID.
- **commitment** (string) - Optional - Transaction commitment level (confirmed, finalized, processed).
- **keypair** (string) - Optional - Keypair that will pay for on-chain transactions.
- **ledgerPath** (string) - Optional - HID path to the ledger.
- **ledger** (boolean) - Optional - Enable ledger support.
- **json** (boolean) - Optional - Format output as JSON.
- **configFile** (string) - Optional - Path to the configuration file.
- **schemaFile** (string) - Optional - Path to the schema file.
- **nodeImage** (string) - Optional - Public key of the oracle to start-up.
- **arm** (boolean) - Optional - Use a docker image for linux/arm64 (for Apple Silicon).
- **timeout** (number) - Optional - Number of seconds before ending the docker process.
- **mainnetRpcUrl** (string) - Optional - Solana mainnet RPC URL for the oracle task runner.

### Request Example
```json
{
  "silent": true,
  "cluster": "devnet",
  "rpcUrl": "https://api.devnet.solana.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of network start.

#### Response Example
```json
{
  "message": "Switchboard network started successfully."
}
```
```

--------------------------------

### Install @switchboard-xyz/common Package

Source: https://github.com/switchboard-xyz/switchboard/blob/main/javascript/common/README.md

Installs the @switchboard-xyz/common package using npm. This is the first step to using the package's functionalities in your project.

```bash
npm i --save @switchboard-xyz/common
```

--------------------------------

### Fetch Pyth Oracle Price (JSON)

Source: https://github.com/switchboard-xyz/switchboard/blob/main/website/protos/examples/dex.mdx

Configure Switchboard to fetch price data from the Pyth oracle network. This example shows how to get the SOL/USD price and sets an allowed confidence interval.

```json
{
  "name": "Pyth SOL/USD",
  "tasks": [
    {
      "oracleTask": {
        "pythAddress": "H6ARHf6YXhGYeQfUzQNGk6rDNnLBQKrenN712K4AQJEG",
        "pythAllowedConfidenceInterval": 0.002
      }
    }
  ]
}
```

--------------------------------

### TypeScript Multi-Source Price Feed Implementation

Source: https://context7.com/switchboard-xyz/switchboard/llms.txt

An end-to-end TypeScript example demonstrating the creation of a production-ready multi-source price feed using the Switchboard SDK. It defines and simulates price jobs from Binance, Coinbase, and Kraken, and includes pseudo-code for deploying an aggregator.

```typescript
import {
  OracleJob,
  serializeOracleJob,
  simulateOracleJobs,
  networks
} from "@switchboard-xyz/common";
import { DockerOracle } from "@switchboard-xyz/oracle";

// Define multiple price sources
const binanceJob = {
  tasks: [
    {
      httpTask: {
        url: "https://api.binance.com/api/v3/ticker/price?symbol=BTCUSDT"
      }
    },
    {
      jsonParseTask: { path: "$.price" }
    }
  ]
};

const coinbaseJob = {
  tasks: [
    {
      httpTask: {
        url: "https://api.coinbase.com/v2/prices/BTC-USD/spot",
        headers: [
          { key: "Accept", value: "application/json" }
        ]
      }
    },
    {
      jsonParseTask: { path: "$.data.amount" }
    }
  ]
};

const krakenJob = {
  tasks: [
    {
      httpTask: {
        url: "https://api.kraken.com/0/public/Ticker?pair=XBTUSD"
      }
    },
    {
      jsonParseTask: { path: "$.result.XXBTZUSD.c[0]" }
    }
  ]
};

// Test all jobs
async function testJobs() {
  const jobs = [binanceJob, coinbaseJob, krakenJob].map(j =>
    serializeOracleJob(j)
  );

  console.log("Testing price feeds...");
  const result = await simulateOracleJobs(jobs, "mainnet-beta");

  if ("error" in result) {
    throw new Error(`Simulation failed: ${result.error}`);
  }

  console.log("Individual results:", result.results.map(r => r.toString()));
  console.log("Aggregated result:", result.result.toString());

  return result;
}

// Deploy aggregator (pseudo-code for CLI integration)
async function deployAggregator() {
  // Save jobs to files
  const fs = require("fs");
  fs.writeFileSync("btc-binance.json", JSON.stringify(binanceJob, null, 2));
  fs.writeFileSync("btc-coinbase.json", JSON.stringify(coinbaseJob, null, 2));
  fs.writeFileSync("btc-kraken.json", JSON.stringify(krakenJob, null, 2));

  console.log("Job files created. Deploy with:");
  console.log(`
    sb solana:aggregator:create $QUEUE_KEY \
      --name "BTC/USD Multi-Source" \
      --updateInterval 30 \
      --minOracles 3 \
      --minJobs 2 \
      --job btc-binance.json \
      --job btc-coinbase.json \
      --job btc-kraken.json \
      --enable
  `);
}

// Main execution
(async () => {
  try {
    // Test the jobs
    const testResult = await testJobs();
    console.log("All jobs passed simulation");

    // Deploy aggregator
    await deployAggregator();

    console.log("Setup complete!");
  } catch (error) {
    console.error("Error:", error.message);
    process.exit(1);
  }
})();

```

--------------------------------

### Initialize and Run Docker Oracle

Source: https://github.com/switchboard-xyz/switchboard/blob/main/javascript/oracle/README.md

Illustrates the initialization and execution of a Switchboard Oracle using Docker. Similar to the NodeJS version, it configures the oracle with release channel, network, RPC URL, oracle key, and secret path, then starts it and waits for it to become operational. Includes error handling and stopping procedures.

```typescript
import { DockerOracle } from "@switchboard-xyz/oracle";

const oracle = await DockerOracle.fromReleaseChannel({
  releaseChannel: "testnet",
  chain: "solana",
  network: "localnet",
  rpcUrl: "http://0.0.0.0:8899",
  oracleKey: "FKFPBD5WUUL5bSNwBH3AKY58KuY8nz2zkMCYR271CcVA",
  secretPath: "~/.config/solana/id.json",
});

try {
  await oracle.startAndAwait();
  console.log("oracle ready");
  await sleep(10000);
} catch (error) {
  console.error(error);
}

oracle.stop();
```

--------------------------------

### Initialize and Run NodeJS Oracle

Source: https://github.com/switchboard-xyz/switchboard/blob/main/javascript/oracle/README.md

Demonstrates how to initialize and run a Switchboard Oracle within a NodeJS environment. It configures the oracle with specific release channel, network, RPC URL, oracle key, and secret path, then starts it and awaits its readiness. Includes basic error handling and cleanup.

```typescript
import { NodeOracle } from "@switchboard-xyz/oracle";

const oracle = await NodeOracle.fromReleaseChannel({
  releaseChannel: "testnet",
  chain: "solana",
  network: "localnet",
  rpcUrl: "http://0.0.0.0:8899",
  oracleKey: "FKFPBD5WUUL5bSNwBH3AKY58KuY8nz2zkMCYR271CcVA",
  secretPath: "~/.config/solana/id.json",
});

try {
  await oracle.startAndAwait();
  console.log("oracle ready");
  await sleep(10000);
} catch (error) {
  console.error(error);
}

oracle.stop();
```

--------------------------------

### Install Switchboard CLI

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Installs or updates the Switchboard CLI globally using npm. This command ensures you have the latest version of the CLI available in your system's PATH for easy access.

```bash
npm install -g @switchboard-xyz/cli
sb update stable
```

--------------------------------

### Install Switchboard Oracle Package

Source: https://github.com/switchboard-xyz/switchboard/blob/main/javascript/oracle/README.md

Installs the @switchboard-xyz/oracle package as a development dependency using npm. This command is essential for projects that will utilize the Switchboard V2 oracle functionalities.

```bash
npm i --save-dev @switchboard-xyz/oracle
```

--------------------------------

### Fetch JupiterSwap Swap Price (JSON)

Source: https://github.com/switchboard-xyz/switchboard/blob/main/website/protos/examples/dex.mdx

Configure Switchboard to find the best swap price between two tokens on JupiterSwap. This example shows how to swap JSOL for USDC.

```json
{
  "name": "JupiterSwap JSOL to USDC",
  "tasks": [
    {
      "jupiterSwapTask": {
        "inTokenAddress": "7Q2afV64in6N6SeZsAAB81TJzwDoD6zpqmHkzi9Dcavn",
        "outTokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
      }
    }
  ]
}
```

--------------------------------

### Fetch Jet Lending Rate (JSON)

Source: https://github.com/switchboard-xyz/switchboard/blob/main/website/protos/examples/dex.mdx

Obtain the lending rate for a specified asset from the Jet lending protocol using Switchboard. This example retrieves the lending rate for BTC.

```json
{
  "name": "JET BTC Lend Rate",
  "tasks": [
    {
      "lendingRateTask": {
        "protocol": "jet",
        "assetMint": "9n4nbM75f5Ui33ZbPYXn59EwSgE8CGsHtAeTH5YFeJ9E",
        "field": 0
      }
    }
  ]
}
```

--------------------------------

### Create Solana Function Account CLI Command

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

This command-line interface (CLI) command is used to create a new function account on the Solana blockchain. It requires the public key of the attestation queue and various optional flags to configure the function's container, networking, and permissions. Ensure you have the Solana CLI and Switchboard SDK installed.

```bash
sb solana function create QUEUEKEY --container <value> [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--attestationProgramId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [-n <value>] [--metadata <value>] [-a <value>] [--fundAmount <value>] [--containerRegistry dockerhub|ipfs] [--version <value>] [--mrEnclave <value>] [--requestsDisabled] [--requestsFee <value>] [--requestsRequireAuthorization] [--routinesDisabled] [--routinesFee <value>] [--routinesRequireAuthorization]

ARGUMENTS:
  QUEUEKEY  public key of the attestation queue account

FLAGS:
  -a, --authority=<value>         keypair or public key to delegate authority to for managing the function account
  -h, --help                      Show CLI help.
  -k, --keypair=<value>           keypair that will pay for onchain transactions. defaults to new account authority if no alternate authority provided
  -n, --name=<value>              name of the function for easier identification
  -s, --silent                    suppress cli prompts
  -u, --rpcUrl=<value>            alternate RPC url
  -v, --verbose                   log everything
  --attestationProgramId=<value>  alternative Switchboard Attestation program ID to interact with
  --cluster=<option>              the solana cluster to connect to
                                  <options: devnet|mainnet-beta|mainnet|localnet>
  --commitment=<option>           [default: confirmed] transaction commitment level to use
                                  <options: confirmed|finalized|processed>
  --container=<value>             (required) the location of the container (Ex. switchboardlabs/basic-oracle-function)
  --containerRegistry=<option>    [default: dockerhub] the registry to pull the container from (Ex. Docker or IPFS)
                                  <options: dockerhub|ipfs>
  --fundAmount=<value>            [default: 0.0] token amount to load into the function's escrow wallet.
  --ledger                        enable ledger support
  --ledgerPath=<value>            HID path to the ledger
  --mainnetBeta                   WARNING: use mainnet-beta solana cluster
  --metadata=<value>              metadata of the function for easier identification
  --mrEnclave=<value>             the MrEnclave value to set for the function - if not provided, will be set automatically after its first run
  --programId=<value>             alternative Switchboard program ID to interact with
  --requestsDisabled              whether custom requests can be created for this function
  --requestsFee=<value>           [default: 0.0] the costs each request must pay the function authority for each sub-request (Ex. 0.00002)
  --requestsRequireAuthorization  whether custom requests require the function authority to authorize
  --routinesDisabled              whether custom routines can be created for this function
  --routinesFee=<value>           [default: 0.0] the costs each routine must pay the function authority for each sub-request (Ex. 0.00002)
  --routinesRequireAuthorization  whether custom routines require the function authority to authorize
  --version=<value>               [default: latest] the version of the container to pull from the registry (Ex. 'latest' or 'mainnet')

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  create a new function account for a given queue

EXAMPLES
  $ sb solana function create CkvizjVnm2zA5Wuwan34NhVT3zFc7vqUyGnA6tuEF5aE --name function-1 --fundAmount 1.25 --container switchboardlabs/basic-oracle-function --version solana
```

--------------------------------

### Fetch Solend Lending Rate (JSON)

Source: https://github.com/switchboard-xyz/switchboard/blob/main/website/protos/examples/dex.mdx

Configure Switchboard to get the lending rate for a specific asset from the Solend protocol. This example shows how to fetch the stSOL borrow rate.

```json
{
  "name": "Solend stSOL Borrow Rate",
  "tasks": [
    {
      "lendingRateTask": {
        "protocol": "solend",
        "assetMint": "7dHbWXmci3dT8UFYWYZweBLXgycu7Y3iL6trKn1Y7ARj",
        "field": 1
      }
    }
  ]
}
```

--------------------------------

### Initialize and Deploy EVM Function (Bash & TypeScript)

Source: https://context7.com/switchboard-xyz/switchboard/llms.txt

This section details the process of initializing a new Switchboard EVM function project using a TypeScript template, editing the function's code for custom logic (e.g., fetching and aggregating prices), and deploying the function on-chain. It covers initialization, code editing, on-chain creation, adding enclaves, funding, testing, and printing function details.

```bash
# Initialize a new function project
sb function-init my-price-function \
  --template typescript \
  --chain arbitrum

cd my-price-function

# Edit the function code (example: custom DeFi calculations)
cat > src/index.ts <<EOF
import { EnclaveFunction } from "@switchboard-xyz/evm-function";

export default async function handler(context: any) {
  // Fetch data from multiple sources
  const response1 = await fetch("https://api.exchange1.com/price");
  const data1 = await response1.json();

  const response2 = await fetch("https://api.exchange2.com/price");
  const data2 = await response2.json();

  // Custom aggregation logic
  const result = (data1.price + data2.price) / 2;

  // Return result
  return {
    success: true,
    result: Math.round(result * 1e8), // Convert to 8 decimals
    timestamp: Date.now()
  };
}
EOF

# Create function on-chain
sb evm:function:create \
  --chain arbitrum \
  --network mainnet \
  --name "Custom Price Oracle" \
  --schedule "*/5 * * * *" \
  --containerRegistry dockerhub \
  --container myusername/my-price-function:latest

# Output: Function created: 0x1234567890abcdef1234567890abcdef12345678

FUNCTION_ADDRESS="0x1234567890abcdef1234567890abcdef12345678"

# Add authorized enclave
sb evm:function:add-enclave $FUNCTION_ADDRESS \
  --enclave 0xABCDEF1234567890ABCDEF1234567890ABCDEF12

# Fund the function with tokens for gas
sb evm:function:fund $FUNCTION_ADDRESS \
  --amount 1.0 \
  --token native

# Test the function
sb evm:function:test $FUNCTION_ADDRESS

# Print function details
sb evm:function:print $FUNCTION_ADDRESS

# Create a routine (scheduled execution)
sb evm:routine:create $FUNCTION_ADDRESS \
  --schedule "0 */1 * * *" \
  --name "Hourly Price Update" \
  --params '{"source":"aggregated"}'

# Fund the routine
ROUTINE_ADDRESS="0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"
sb evm:routine:fund $ROUTINE_ADDRESS --amount 5.0
```

```typescript
import { EnclaveFunction } from "@switchboard-xyz/evm-function";

export default async function handler(context: any) {
  // Fetch data from multiple sources
  const response1 = await fetch("https://api.exchange1.com/price");
  const data1 = await response1.json();

  const response2 = await fetch("https://api.exchange2.com/price");
  const data2 = await response2.json();

  // Custom aggregation logic
  const result = (data1.price + data2.price) / 2;

  // Return result
  return {
    success: true,
    result: Math.round(result * 1e8), // Convert to 8 decimals
    timestamp: Date.now()
  };
}
```

--------------------------------

### Install docusaurus-plugin-typedoc-api

Source: https://github.com/switchboard-xyz/switchboard/blob/main/plugins/docusaurus-plugin-api-docs/README.md

Installs the docusaurus-plugin-typedoc-api package as a development dependency using Yarn.

```bash
yarn add --dev docusaurus-plugin-typedoc-api
```

--------------------------------

### Configure Solana Network Settings

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Sets up configuration for Solana networks (Devnet and Mainnet-beta), specifying the RPC endpoint and the default account keypair file. This allows the CLI to connect and interact with the specified Solana networks.

```bash
# Devnet
sb config set solana devnet rpc https://api.devnet.solana.com
sb config set solana devnet default-account "~/.config/solana/id.json"

# Mainnet
sb config set solana mainnet-beta rpc https://api.mainnet-beta.solana.com
sb config set solana mainnet-beta default-account "~/.config/solana/id.json"
```

--------------------------------

### Install switchboard-common using Cargo

Source: https://github.com/switchboard-xyz/switchboard/blob/main/rust/switchboard-common/README.md

This snippet shows how to add the switchboard-common crate as a dependency to your Rust project using the Cargo command-line tool.

```bash
cargo add switchboard-common

```

--------------------------------

### POST /api/solana/buffer/create

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Creates a new buffer relayer account on the Solana blockchain.

```APIDOC
## POST /api/solana/buffer/create

### Description
Creates a new buffer relayer account on the Solana blockchain.

### Method
POST

### Endpoint
/api/solana/buffer/create

### Parameters
#### Path Parameters
- **QUEUEKEY** (string) - Required - Public key of the oracle queue account.

#### Query Parameters
- **authority** (string) - Optional - Alternate keypair that will be the buffer relayer authority.
- **keypair** (string) - Optional - Keypair that will pay for onchain transactions. Defaults to new account authority if no alternate authority provided.
- **name** (string) - Optional - Name of the buffer account.
- **rpcUrl** (string) - Optional - Alternate RPC URL.
- **programId** (string) - Optional - Alternative Switchboard program ID to interact with.
- **attestationProgramId** (string) - Optional - Alternative Switchboard Attestation program ID to interact with.
- **commitment** (string) - Optional - Transaction commitment level to use. Defaults to 'confirmed'. Options: 'confirmed', 'finalized', 'processed'.
- **ledgerPath** (string) - Optional - HID path to the ledger.
- **minUpdateDelaySeconds** (number) - Optional - Minimum number of seconds between update calls. Defaults to 30.
- **jobDefinition** (string) - Optional - Filesystem path to job definition.
- **jobKey** (string) - Optional - Public key of existing job account.

#### Flags
- **silent** (boolean) - Optional - Suppress CLI prompts.
- **verbose** (boolean) - Optional - Log everything.
- **mainnetBeta** (boolean) - Optional - Use mainnet-beta Solana cluster.
- **cluster** (string) - Optional - The Solana cluster to connect to. Options: 'devnet', 'mainnet-beta', 'mainnet', 'localnet'.
- **ledger** (boolean) - Optional - Enable ledger support.
- **json** (boolean) - Optional - Format output as JSON.
- **bufferKeypair** (string) - Optional - Keypair to use for the buffer relayer account. This will be the account's publicKey.

### Request Example
```json
{
  "QUEUEKEY": "your_queue_key_here",
  "authority": "path/to/authority_keypair.json",
  "name": "my-buffer-account"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of buffer creation.

#### Response Example
```json
{
  "message": "Buffer account created successfully."
}
```
```

--------------------------------

### sb solana oracle create QUEUEKEY

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Creates a new oracle account for a given Switchboard oracle queue. Allows specifying various parameters like name, stake amount, authority, and metadata.

```APIDOC
## POST /solana/oracle/create

### Description
Creates a new oracle account for a given queue. Allows configuration of name, stake amount, authority, and metadata.

### Method
POST

### Endpoint
/solana/oracle/create

### Parameters
#### Path Parameters
- **QUEUEKEY** (string) - Required - Public key of the oracle queue account.

#### Query Parameters
- **authority** (string) - Optional - Keypair to delegate authority for managing the oracle account.
- **keypair** (string) - Optional - Keypair that will pay for on-chain transactions.
- **name** (string) - Optional - Name of the oracle for easier identification.
- **silent** (boolean) - Optional - Suppress CLI prompts.
- **rpcUrl** (string) - Optional - Alternate RPC URL.
- **verbose** (boolean) - Optional - Log everything.
- **mainnetBeta** (boolean) - Optional - Use mainnet-beta Solana cluster.
- **cluster** (string) - Optional - The Solana cluster to connect to (devnet, mainnet-beta, mainnet, localnet).
- **programId** (string) - Optional - Alternative Switchboard program ID.
- **attestationProgramId** (string) - Optional - Alternative Switchboard Attestation program ID.
- **commitment** (string) - Optional - Transaction commitment level (confirmed, finalized, processed).
- **ledgerPath** (string) - Optional - HID path to the ledger.
- **ledger** (boolean) - Optional - Enable ledger support.
- **json** (boolean) - Optional - Format output as JSON.
- **metadata** (string) - Optional - Metadata of the oracle for easier identification.
- **authority** (string) - Optional - Keypair to delegate authority for managing the oracle account.
- **enable** (boolean) - Optional - Enable oracle heartbeat permissions.
- **queueAuthority** (string) - Optional - Alternative keypair for queue authority.
- **stakeAmount** (number) - Optional - Token amount to load into the oracle's staking wallet.

### Request Example
```json
{
  "QUEUEKEY": "F8ce7MsckeZAbAGmxjJNetxYXQa9mKr9nnrC3qKubyYy",
  "name": "my-oracle",
  "stakeAmount": 1
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of oracle creation.

#### Response Example
```json
{
  "message": "Oracle account created successfully."
}
```
```

--------------------------------

### Configure docusaurus-plugin-typedoc-api Plugin

Source: https://github.com/switchboard-xyz/switchboard/blob/main/plugins/docusaurus-plugin-api-docs/README.md

Configures the docusaurus-plugin-typedoc-api by specifying the project root and a list of packages to document. This example shows configurations for both monorepo and polyrepo structures.

```javascript
module.exports = {
  // ...
  plugins: [
    [
      'docusaurus-plugin-typedoc-api',
      {
        projectRoot: path.join(__dirname, '..'),
        // Monorepo
        packages: ['packages/example', 'packages/other'],
        // Polyrepo
        packages: ['.'],
      },
    ],
  ],
};
```

--------------------------------

### sb solana crank create QUEUEKEY

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Creates a new crank account on a specified oracle queue.

```APIDOC
## POST /solana/crank/create

### Description
Creates a new crank account on a specified oracle queue.

### Method
POST

### Endpoint
/solana/crank/create

### Parameters
#### Path Parameters
- **QUEUEKEY** (string) - Required - Public key of the oracle queue to create a crank on.

#### Query Parameters
- **-h, --help** (boolean) - Optional - Show CLI help.
- **-v, --verbose** (boolean) - Optional - Log everything.
- **-s, --silent** (boolean) - Optional - Suppress CLI prompts.
- **--mainnetBeta** (boolean) - Optional - WARNING: use mainnet-beta solana cluster.
- **--cluster** (string) - Optional - The Solana cluster to connect to (devnet|mainnet-beta|mainnet|localnet).
- **-u, --rpcUrl** (string) - Optional - Alternate RPC URL.
- **--programId** (string) - Optional - Alternative Switchboard program ID to interact with.
- **--attestationProgramId** (string) - Optional - Alternative Switchboard Attestation program ID to interact with.
- **--commitment** (string) - Optional - Transaction commitment level to use (confirmed|finalized|processed). Defaults to 'confirmed'.
- **-k, --keypair** (string) - Optional - Keypair that will pay for on-chain transactions. Defaults to a new account authority if no alternate authority provided.
- **--ledgerPath** (string) - Optional - HID path to the ledger.
- **--ledger** (boolean) - Optional - Enable ledger support.
- **--json** (boolean) - Optional - Format output as JSON.
- **-n, --name** (string) - Optional - Name of the crank for easier identification.
- **--metadata** (string) - Optional - Metadata of the crank for easier identification.
- **--crankKeypair** (string) - Optional - Keypair to use for the crank account. This will be the account's public key.
- **--dataBufferKeypair** (string) - Optional - Keypair to use for the crank data buffer account.
- **-s, --size** (string) - Required - Maximum number of rows a crank can support.

### Request Example
```
{
  "command": "sb solana crank create",
  "arguments": {
    "QUEUEKEY": "<queue_public_key>"
  },
  "flags": {
    "size": "100",
    "name": "my-crank"
  }
}
```

### Response
#### Success Response (200)
(Response structure not defined in the provided text)

#### Response Example
(Response example not defined in the provided text)
```

--------------------------------

### Fetch Chainlink Oracle Price (JSON)

Source: https://github.com/switchboard-xyz/switchboard/blob/main/website/protos/examples/dex.mdx

Integrate with Switchboard to pull price data from a Chainlink oracle feed. This example specifies the Chainlink oracle address for SOL/USD.

```json
{
  "name": "Chainlink SOL/USD",
  "tasks": [
    {
      "oracleTask": {
        "chainlinkAddress": "CcPVS9bqyXbD9cLnTbhhHazLsrua8QMFUHTutPtjyDzq"
      }
    }
  ]
}
```

--------------------------------

### POST /aptos/aggregator/create

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Creates a new aggregator for a given queue on the Aptos network. Requires queue address and update interval.

```APIDOC
## POST /aptos/aggregator/create

### Description
Creates a new aggregator for a given queue on the Aptos network. This endpoint requires the queue's address and the desired update interval for the aggregator.

### Method
POST

### Endpoint
/aptos/aggregator/create

### Parameters
#### Path Parameters
- **QUEUEHEXSTRING** (string) - Required - HexString address of the queue

#### Query Parameters
- **keypair** (string) - Required - Path to AptosAccount keypair or config.yaml file
- **updateInterval** (integer) - Required - Set the aggregator's minimum update delay in seconds.
- **networkId** (string) - Optional - Aptos network to connect to (devnet, testnet, mainnet). Defaults to 'testnet'.
- **rpcUrl** (string) - Optional - Alternate RPC URL.
- **programId** (string) - Optional - Switchboard programId on the selected Aptos network.
- **profileName** (string) - Optional - If --keypair is pointing to a yaml file, provide an optional profile to load. Defaults to 'default'.
- **authority** (string) - Optional - Alternate named account that will be the authority for the oracle.
- **silent** (boolean) - Optional - Suppress CLI prompts.
- **verbose** (boolean) - Optional - Log everything.
- **json** (boolean) - Optional - Format output as JSON.
- **new** (boolean) - Optional - Create account at new AptosAccount with authority set to --account.
- **crankAddress** (string) - Optional - Optional, address of the crank to add the aggregator to.
- **name** (string) - Optional - Name of the aggregator for easier identification.
- **metadata** (string) - Optional - Metadata of the aggregator for easier identification.
- **forceReportPeriod** (integer) - Optional - Number of seconds for which, even if the variance threshold is not passed, accept new responses from oracles.
- **batchSize** (integer) - Optional - Number of oracles requested for each open round call.
- **minJobs** (integer) - Optional - Number of jobs that must respond before an oracle responds.
- **minOracles** (integer) - Optional - Number of oracles that must respond before a value is accepted on-chain.
- **varianceThreshold** (float) - Optional - Percentage change between a previous accepted result and the next round before an oracle reports a value on-chain. Used to conserve lease cost during low volatility. Defaults to 0.
- **job** (array of strings) - Optional - Filesystem path to job definition file(s).

### Request Example
```json
{
  "QUEUEHEXSTRING": "0x456...",
  "keypair": "~/.aptos/mainnet.key",
  "updateInterval": 60,
  "name": "MyAggregator",
  "minOracles": 5
}
```

### Response
#### Success Response (200)
- **data** (object) - Details of the transaction confirmation.

#### Response Example
```json
{
  "data": {
    "hash": "0xghijkl78901...",
    "status": "success"
  }
}
```
```

--------------------------------

### Configure Switchboard CLI for Solana and Aptos (Bash)

Source: https://context7.com/switchboard-xyz/switchboard/llms.txt

This bash script demonstrates how to configure the Switchboard CLI for different blockchain networks. It shows commands to set RPC URLs and cluster configurations for Solana mainnet and Aptos testnet, enabling the CLI to interact with these specific environments.

```bash
# Set Solana mainnet configuration
sb config:set \
  --chain solana \
  --network mainnet \
  --rpcUrl "https://solana-mainnet.rpc-provider.com" \
  --cluster mainnet-beta

# Set Aptos testnet configuration
sb config:set \
  --chain aptos \
  --network testnet \
  --rpcUrl "https://fullnode.testnet.aptoslabs.com/v1"

```

--------------------------------

### Binance.US BTC/USD Price Fetch (HTTP)

Source: https://github.com/switchboard-xyz/switchboard/blob/main/website/protos/examples/exchanges.mdx

Retrieves the BTC/USD ticker price from Binance.US using an HTTP GET request. It calls the exchange's ticker API and then parses the price from the JSON response. This is suitable for periodic data fetches.

```json
{
  "name": "BinanceUs BTC/USD",
  "tasks": [
    {
      "httpTask": {
        "url": "https://www.binance.us/api/v3/ticker/price?symbol=BTCUSD"
      }
    },
    {
      "jsonParseTask": {
        "path": "$.price"
      }
    }
  ]
}
```

--------------------------------

### POST /sb solana routine create

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Creates a new routine account for a given function on the Solana blockchain.

```APIDOC
## POST /sb solana routine create

### Description
Creates a new routine account for a given function.

### Method
POST

### Endpoint
/sb solana routine create FUNCTIONKEY

### Parameters
#### Path Parameters
- **FUNCTIONKEY** (string) - Required - public key of the function account

#### Query Parameters
- **schedule** (string) - Required - cron schedule
- **authority** (string) - Optional - keypair or public key to delegate authority to for managing the function account
- **keypair** (string) - Optional - keypair that will pay for onchain transactions. defaults to new account authority if no alternate authority provided
- **name** (string) - Optional - name of the function for easier identification
- **silent** (boolean) - Optional - suppress cli prompts
- **rpcUrl** (string) - Optional - alternate RPC url
- **verbose** (boolean) - Optional - log everything
- **attestationProgramId** (string) - Optional - alternative Switchboard Attestation program ID to interact with
- **cluster** (string) - Optional - the solana cluster to connect to (devnet|mainnet-beta|mainnet|localnet)
- **commitment** (string) - Optional - transaction commitment level to use (confirmed|finalized|processed), defaults to confirmed
- **ledger** (boolean) - Optional - enable ledger support
- **ledgerPath** (string) - Optional - HID path to the ledger
- **mainnetBeta** (boolean) - Optional - WARNING: use mainnet-beta solana cluster
- **metadata** (string) - Optional - metadata of the function for easier identification
- **parameters** (string) - Optional - parameters to pass to the function
- **programId** (string) - Optional - alternative Switchboard program ID to interact with

### Request Example
```json
{
  "FUNCTIONKEY": "CkvizjVnm2zA5Wuwan34NhVT3zFc7vqUyGnA6tuEF5aE",
  "name": "function-1",
  "fundAmount": "1.25",
  "container": "switchboardlabs/basic-oracle-function",
  "version": "solana",
  "schedule": "*/10 * * * * *",
  "params": "xyz"
}
```

### Response
#### Success Response (200)
- **data** (object) - Details of the created routine account

#### Response Example
```json
{
  "data": {
    "routineAccount": "FgW1x1a4y8yFp9f8q7N6x3z2y1b0a9c8d7e6f5g4h3",
    "transactionSignature": "tx1234567890abcdefg..."
  }
}
```
```

--------------------------------

### Create Near Switchboard Environment Script

Source: https://github.com/switchboard-xyz/switchboard/blob/main/scripts/README.md

This bash script facilitates the creation and configuration of a Near Switchboard environment. It allows users to specify various parameters such as account ID, network, queue name, staking details, and update intervals. Ensure you have the Near CLI installed and configured for the specified network.

```bash
./scripts/near.sh

Usage:
./scripts/near.sh  [-a accountId] [-c testnet|mainnet] [-n name] [-m minStake] [-r reward] [-s queueSize] [-u updateInterval]

Options:
-a accountId, named account used as the payer and authority


Example:
        ./scripts/near.sh -a sbv2-authority.testnet -c testnet -n 'Near Queue' -m 0 -r 0.000075 -s 250 -u 10 -o 3

        Account ID: sbv2-authority.testnet
        Network: testnet
        Queue Name: Near Queue
        Min Stake: 0
        Reward: 0.000075
        Size: 250
        Update Interval: 10
        Num Oracles: 3

```

```bash
./scripts/near.sh -a sbv2-authority.near -c mainnet -n 'Permissionless Queue' -m 0 -r 0.000075 -s 250 -u 10 -o 3
```

--------------------------------

### Use Configured Settings for Solana Commands

Source: https://context7.com/switchboard-xyz/switchboard/llms.txt

Demonstrates how to use the Switchboard CLI to list Solana oracles. When executed, this command automatically utilizes the RPC URL configured for the Solana mainnet, streamlining the process of interacting with the network.

```bash
sb solana:oracle:list \
  --chain solana \
  --network mainnet
```

--------------------------------

### Create Aptos Aggregator CLI

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Creates a new Aptos aggregator associated with a given queue. Requires the queue's hex string address and a keypair. Essential flags include updateInterval. Supports various configurations for batch size, min oracles, variance threshold, and optional crank integration.

```bash
sb aptos aggregator create QUEUEHEXSTRING --keypair <value> --updateInterval <value> [--networkId devnet|testnet|mainnet] [--programId <value>] [--rpcUrl <value>] [--profileName <value>] [--json] [--authority <value>] [--crankAddress <value>] [--name <value>] [--metadata <value>] [--forceReportPeriod <value>] [--batchSize <value>] [--minJobs <value>] [--minOracles <value>] [--varianceThreshold <value>] [--job <value>...] [--new]
```

--------------------------------

### POST /solana/queue/create

Source: https://github.com/switchboard-xyz/switchboard/blob/main/cli/README.md

Creates a new oracle queue on the Solana blockchain. This command supports numerous flags to configure the queue's behavior, permissions, and associated accounts.

```APIDOC
## POST /solana/queue/create

### Description
Creates a new oracle queue on the Solana blockchain. This command allows for detailed configuration of the queue, including network, program IDs, keypairs, and various operational parameters such as rewards, timeouts, and permission settings.

### Method
POST

### Endpoint
/solana/queue/create

### Parameters
#### Query Parameters
- **rpcUrl** (string) - Optional - Alternate RPC URL to connect to the Solana cluster.
- **programId** (string) - Optional - Alternative Switchboard program ID to interact with.
- **attestationProgramId** (string) - Optional - Alternative Switchboard Attestation program ID to interact with.
- **keypair** (string) - Optional - Keypair that will pay for on-chain transactions. Defaults to a new account authority if no alternate authority is provided.
- **authority** (string) - Optional - Alternate keypair that is the authority for the queue and is required to approve permissions.
- **queueKeypair** (string) - Optional - Keypair to use for the oracle queue account. This will be the account's public key.
- **dataBufferKeypair** (string) - Optional - Keypair to use for the oracle queue data buffer account.
- **cluster** (string) - Optional - The Solana cluster to connect to (e.g., devnet, mainnet-beta, mainnet, localnet).
- **commitment** (string) - Optional - Transaction commitment level to use (confirmed, finalized, processed). Defaults to 'confirmed'.
- **size** (number) - Optional - Set the size of the queue. Defaults to 100.
- **name** (string) - Optional - Name of the aggregator.
- **metadata** (string) - Optional - Metadata of the aggregator.
- **reward** (number) - Optional - The reward paid out to oracles for responding to an update request on-chain. Defaults to 0.
- **minStake** (number) - Optional - The minimum stake required for oracles in their staking wallet before heartbeating. Defaults to 0.
- **oracleTimeout** (number) - Optional - Time period in seconds after which an oracle is removed if no response is received. Defaults to 180.
- **slashingEnabled** (boolean) - Optional - Whether slashing is enabled on this queue.
- **permissionedFeeds** (boolean) - Optional - Enabling this setting means data feeds need explicit permission to join the queue.
- **unpermissionedVrf** (boolean) - Optional - Enabling this setting means data feeds do not need explicit permission to request VRF proofs and verifications from this queue.
- **enableBufferRelayers** (boolean) - Optional - Enabling this setting will allow buffer relayer accounts to call openRound.
- **feedProbationPeriod** (number) - Optional - After a feed lease is funded or re-funded, it must consecutively succeed N amount of times or its authorization to use the queue is auto-revoked. Defaults to 1000.
- **consecutiveFeedFailureLimit** (number) - Optional - Consecutive failure limit for a feed before feed permission is revoked. Defaults to 1000.
- **consecutiveOracleFailureLimit** (number) - Optional - Consecutive failure limit for an oracle before oracle permission is revoked. Defaults to 1000.
- **ledger** (boolean) - Optional - Enable ledger support.
- **ledgerPath** (string) - Optional - HID path to the ledger.
- **mainnetBeta** (boolean) - Optional - WARNING: use mainnet-beta Solana cluster.
- **silent** (boolean) - Optional - Suppress CLI prompts.
- **verbose** (boolean) - Optional - Log everything.
- **json** (boolean) - Optional - Format output as JSON.

### Request Example
```json
{
  "rpcUrl": "https://devnet.helius.xyz/YOUR_API_KEY",
  "cluster": "devnet",
  "keypair": "~/.config/solana/id.json",
  "programId": "SW1TCHBLd123456789012345678901234567890",
  "size": 50,
  "name": "my-new-queue",
  "reward": 0.00001,
  "oracleTimeout": 300,
  "permissionedFeeds": true
}
```

### Response
#### Success Response (200)
- **queueAddress** (string) - The public key address of the newly created oracle queue.
- **dataBufferAddress** (string) - The public key address of the data buffer account associated with the queue.

#### Response Example
```json
{
  "queueAddress": "A1b2C3d4E5f6G7H8I9j0K1l2M3n4O5p6Q7r8S9t0",
  "dataBufferAddress": "B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0u1"
}
```
```