Setup
Quick Links
Install
- npm
- Yarn
npm install -g @switchboard-xyz/cli^2
yarn add -g @switchboard-xyz/cli^2
Aptos
Config
# Testnet
sbv2 config set aptos testnet rpc https://fullnode.testnet.aptoslabs.com/v1
sbv2 config set aptos testnet default-account ".aptos/config.yaml"
# Devnet
sbv2 config set aptos devnet rpc https://fullnode.devnet.aptoslabs.com/v1
sbv2 config set aptos devnet default-account ".aptos/config.yaml"
Commands
sbv2 aptos
interact with switchboard on Aptos
sbv2 aptos account airdropsbv2 aptos aggregator add job AGGREGATORHEXSTRINGsbv2 aptos aggregator create QUEUEHEXSTRINGsbv2 aptos aggregator job add AGGREGATORHEXSTRINGsbv2 aptos aggregator update AGGREGATORHEXSTRINGsbv2 aptos crank create QUEUEHEXSTRINGsbv2 aptos crank list CRANKHEXSTRINGsbv2 aptos crank pop CRANKHEXSTRINGsbv2 aptos crank push CRANKHEXSTRINGsbv2 aptos create aggregator QUEUEHEXSTRINGsbv2 aptos create crank QUEUEHEXSTRINGsbv2 aptos create job QUEUEHEXSTRING JOBDEFINITIONsbv2 aptos create oracle QUEUEHEXSTRINGsbv2 aptos create queuesbv2 aptos job create QUEUEHEXSTRING JOBDEFINITIONsbv2 aptos list crank CRANKHEXSTRINGsbv2 aptos oracle create QUEUEHEXSTRINGsbv2 aptos oracle metrics ORACLEHEXSTRINGsbv2 aptos oracle up ORACLEHEXSTRINGsbv2 aptos permission create GRANTERsbv2 aptos permission set GRANTERsbv2 aptos pop crank CRANKHEXSTRINGsbv2 aptos print ACCOUNTTYPE ADDRESSsbv2 aptos push crank CRANKHEXSTRINGsbv2 aptos queue createsbv2 aptos update aggregator AGGREGATORHEXSTRING
sbv2 aptos account airdrop
request an airdrop
USAGE
$ sbv2 aptos account airdrop --address <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId <value>]
[-u <value>] [--json] [-n <value>]
FLAGS
-h, --help Show CLI help.
-n, --amount=<value> [default: 1000000] number of airdrops to request, 10_000 coins each
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--address=<value> (required) HexString address of account to fund
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
request an airdrop
sbv2 aptos aggregator add job AGGREGATORHEXSTRING
add a job to an aggregator
USAGE
$ sbv2 aptos aggregator add job AGGREGATORHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [-a <value>] [--name <value> | --jobKey <value>]
[--metadata <value> | ] [--jobDefinition <value> | ] [--jobWeight <value>]
ARGUMENTS
AGGREGATORHEXSTRING HexString address of the aggregator
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--jobDefinition=<value> filesystem path of job json definition file
--jobKey=<value> public key of an existing job account to add to an aggregator
--jobWeight=<value> [default: 1] job weight
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the job account
--name=<value> name of the job account
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
DESCRIPTION
add a job to an aggregator
ALIASES
$ sbv2 aptos aggregator job add
sbv2 aptos aggregator create QUEUEHEXSTRING
create an aptos aggregator for a given queue
USAGE
$ sbv2 aptos aggregator create QUEUEHEXSTRING --keypair <value> --updateInterval <value> [-h] [-v] [-s] [--networkId
devnet|testnet|mainnet] [--programId <value>] [-u <value>] [--profileName <value>] [--json] [-a <value>]
[--crankAddress <value>] [--name <value>] [--metadata <value>] [--forceReportPeriod <value>] [--batchSize <value>]
[--minJobs <value>] [--minOracles <value>] [--varianceThreshold <value>] [-j <value>] [--new]
ARGUMENTS
QUEUEHEXSTRING HexString address of the queue
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-j, --job=<value>... filesystem path to job definition file
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--batchSize=<value> number of oracles requested for each open round call
--crankAddress=<value> optional, address of the crank to add the aggregator to
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept new
responses from oracles.
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the aggregator for easier identification
--minJobs=<value> number of jobs that must respond before an oracle responds
--minOracles=<value> number of oracles that must respond before a value is accepted on-chain
--name=<value> name of the aggregator for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile
to load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
--updateInterval=<value> (required) set an aggregator's minimum update delay
--varianceThreshold=<value> [default: 0] 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an aptos aggregator for a given queue
ALIASES
$ sbv2 aptos create aggregator
sbv2 aptos aggregator job add AGGREGATORHEXSTRING
add a job to an aggregator
USAGE
$ sbv2 aptos aggregator job add AGGREGATORHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [-a <value>] [--name <value> | --jobKey <value>]
[--metadata <value> | ] [--jobDefinition <value> | ] [--jobWeight <value>]
ARGUMENTS
AGGREGATORHEXSTRING HexString address of the aggregator
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--jobDefinition=<value> filesystem path of job json definition file
--jobKey=<value> public key of an existing job account to add to an aggregator
--jobWeight=<value> [default: 1] job weight
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the job account
--name=<value> name of the job account
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
DESCRIPTION
add a job to an aggregator
ALIASES
$ sbv2 aptos aggregator job add
sbv2 aptos aggregator update AGGREGATORHEXSTRING
request a new value on-chain for an aggregator
USAGE
$ sbv2 aptos aggregator update AGGREGATORHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>]
ARGUMENTS
AGGREGATORHEXSTRING HexString address of the aggregator
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
DESCRIPTION
request a new value on-chain for an aggregator
ALIASES
$ sbv2 aptos update aggregator
sbv2 aptos crank create QUEUEHEXSTRING
create a new crank
USAGE
$ sbv2 aptos crank create QUEUEHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [--json] [--name <value>] [--metadata <value>] [--maxRows
<value>] [--new]
ARGUMENTS
QUEUEHEXSTRING HexString of the oracle queue to create a crank for
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--maxRows=<value> [default: 100] maximum number of rows on the crank
--metadata=<value> metadata of the queue for easier identification
--name=<value> name of the queue for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new crank
ALIASES
$ sbv2 aptos create crank
sbv2 aptos crank list CRANKHEXSTRING
sort the crank
USAGE
$ sbv2 aptos crank list CRANKHEXSTRING [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId <value>] [-u
<value>] [--json]
ARGUMENTS
CRANKHEXSTRING HexString address of the crank
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
sort the crank
ALIASES
$ sbv2 aptos list crank
sbv2 aptos crank pop CRANKHEXSTRING
pop the crank
USAGE
$ sbv2 aptos crank pop CRANKHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [--json]
ARGUMENTS
CRANKHEXSTRING HexString address of the crank
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
pop the crank
ALIASES
$ sbv2 aptos pop crank
sbv2 aptos crank push CRANKHEXSTRING
push an aggregator onto the crank
USAGE
$ sbv2 aptos crank push CRANKHEXSTRING --keypair <value> -a <value> [-h] [-v] [-s] [--networkId
devnet|testnet|mainnet] [--programId <value>] [-u <value>] [--profileName <value>] [--json]
ARGUMENTS
CRANKHEXSTRING HexString address of the crank
FLAGS
-a, --aggregatorHexString=<value> (required) HexString address of the aggregator
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional
profile to load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
push an aggregator onto the crank
ALIASES
$ sbv2 aptos push crank
sbv2 aptos create aggregator QUEUEHEXSTRING
create an aptos aggregator for a given queue
USAGE
$ sbv2 aptos create aggregator QUEUEHEXSTRING --keypair <value> --updateInterval <value> [-h] [-v] [-s] [--networkId
devnet|testnet|mainnet] [--programId <value>] [-u <value>] [--profileName <value>] [--json] [-a <value>]
[--crankAddress <value>] [--name <value>] [--metadata <value>] [--forceReportPeriod <value>] [--batchSize <value>]
[--minJobs <value>] [--minOracles <value>] [--varianceThreshold <value>] [-j <value>] [--new]
ARGUMENTS
QUEUEHEXSTRING HexString address of the queue
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-j, --job=<value>... filesystem path to job definition file
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--batchSize=<value> number of oracles requested for each open round call
--crankAddress=<value> optional, address of the crank to add the aggregator to
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept new
responses from oracles.
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the aggregator for easier identification
--minJobs=<value> number of jobs that must respond before an oracle responds
--minOracles=<value> number of oracles that must respond before a value is accepted on-chain
--name=<value> name of the aggregator for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile
to load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
--updateInterval=<value> (required) set an aggregator's minimum update delay
--varianceThreshold=<value> [default: 0] 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an aptos aggregator for a given queue
ALIASES
$ sbv2 aptos create aggregator
sbv2 aptos create crank QUEUEHEXSTRING
create a new crank
USAGE
$ sbv2 aptos create crank QUEUEHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [--json] [--name <value>] [--metadata <value>] [--maxRows
<value>] [--new]
ARGUMENTS
QUEUEHEXSTRING HexString of the oracle queue to create a crank for
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--maxRows=<value> [default: 100] maximum number of rows on the crank
--metadata=<value> metadata of the queue for easier identification
--name=<value> name of the queue for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new crank
ALIASES
$ sbv2 aptos create crank
sbv2 aptos create job QUEUEHEXSTRING JOBDEFINITION
create a new job
USAGE
$ sbv2 aptos create job QUEUEHEXSTRING JOBDEFINITION --keypair <value> [-h] [-v] [-s] [--networkId
devnet|testnet|mainnet] [--programId <value>] [-u <value>] [--profileName <value>] [--json] [-a <value>] [--name
<value>] [--metadata <value>] [--new] [--weight <value>]
ARGUMENTS
QUEUEHEXSTRING HexString address of the queue
JOBDEFINITION filesystem path to job definition
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the job account
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the job for easier identification
--name=<value> name of the job for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
--weight=<value> [default: 1] job weight to assign
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new job
ALIASES
$ sbv2 aptos create job
sbv2 aptos create oracle QUEUEHEXSTRING
create a oracle for a given queue
USAGE
$ sbv2 aptos create oracle QUEUEHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [--json] [-a <value>] [--name <value>] [--metadata
<value>] [--new]
ARGUMENTS
QUEUEHEXSTRING HexString address of the queue
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the oracle for easier identification
--name=<value> name of the oracle for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a oracle for a given queue
ALIASES
$ sbv2 aptos create oracle
sbv2 aptos create queue
create a new oracle queue
USAGE
$ sbv2 aptos create queue --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId <value>]
[-u <value>] [--profileName <value>] [--json] [-a <value>] [--name <value>] [--metadata <value>] [--minStake
<value>] [-r <value>] [--oracleTimeout <value>] [--queueSize <value>] [--slashingEnabled] [--unpermissionedFeeds]
[--unpermissionedVrf] [--enableBufferRelayers] [--lockLeaseFunding] [--new]
FLAGS
-a, --authority=<value> alternate account HexString that will be the authority for the queue
-h, --help Show CLI help.
-r, --reward=<value> oracle rewards for successfully responding to an update request
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--enableBufferRelayers enable oracles to fulfill buffer relayer requests
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--lockLeaseFunding lock lease funding
--metadata=<value> metadata of the queue for easier identification
--minStake=<value> minimum stake required by an oracle to join the queue
--name=<value> name of the queue for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--oracleTimeout=<value> [default: 180] number of oracles to add to the queue
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
--queueSize=<value> [default: 100] maximum number of oracles the queue can support
--slashingEnabled permit slashing malicous oracles
--unpermissionedFeeds permit unpermissioned feeds
--unpermissionedVrf permit unpermissioned VRF accounts
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new oracle queue
ALIASES
$ sbv2 aptos create queue
sbv2 aptos job create QUEUEHEXSTRING JOBDEFINITION
create a new job
USAGE
$ sbv2 aptos job create QUEUEHEXSTRING JOBDEFINITION --keypair <value> [-h] [-v] [-s] [--networkId
devnet|testnet|mainnet] [--programId <value>] [-u <value>] [--profileName <value>] [--json] [-a <value>] [--name
<value>] [--metadata <value>] [--new] [--weight <value>]
ARGUMENTS
QUEUEHEXSTRING HexString address of the queue
JOBDEFINITION filesystem path to job definition
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the job account
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the job for easier identification
--name=<value> name of the job for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
--weight=<value> [default: 1] job weight to assign
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new job
ALIASES
$ sbv2 aptos create job
sbv2 aptos list crank CRANKHEXSTRING
sort the crank
USAGE
$ sbv2 aptos list crank CRANKHEXSTRING [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId <value>] [-u
<value>] [--json]
ARGUMENTS
CRANKHEXSTRING HexString address of the crank
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
sort the crank
ALIASES
$ sbv2 aptos list crank
sbv2 aptos oracle create QUEUEHEXSTRING
create a oracle for a given queue
USAGE
$ sbv2 aptos oracle create QUEUEHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [--json] [-a <value>] [--name <value>] [--metadata
<value>] [--new]
ARGUMENTS
QUEUEHEXSTRING HexString address of the queue
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--metadata=<value> metadata of the oracle for easier identification
--name=<value> name of the oracle for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a oracle for a given queue
ALIASES
$ sbv2 aptos create oracle
sbv2 aptos oracle metrics ORACLEHEXSTRING
list oracle metrics
USAGE
$ sbv2 aptos oracle metrics ORACLEHEXSTRING [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId <value>]
[-u <value>] [--json]
ARGUMENTS
ORACLEHEXSTRING HexString address of the oracle
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
list oracle metrics
sbv2 aptos oracle up ORACLEHEXSTRING
start an aptos docker oracle
USAGE
$ sbv2 aptos oracle up ORACLEHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [-d <value>] [--nodeImage <value>] [--arm]
ARGUMENTS
ORACLEHEXSTRING HexString address of the oracle
FLAGS
-d, --switchboardDir=<value> directory with switchboard.env to load a switchboard environment
-h, --help Show CLI help.
-s, --silent suppress docker logging
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--arm apple silicon needs to use a docker image for linux/arm64
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--nodeImage=<value> [default: dev-v2-RC_02_24_23_18_43] public key of the oracle to start-up
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile
to load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
DESCRIPTION
start an aptos docker oracle
sbv2 aptos permission create GRANTER
create a new permission
USAGE
$ sbv2 aptos permission create GRANTER --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId
<value>] [-u <value>] [--profileName <value>] [--json] [--aggregator <value> | --oracle <value>] [--enable]
ARGUMENTS
GRANTER HexString of the oracle queue to create a permission for
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--aggregator=<value> HexString of the aggregator address to create a permission for
--enable whether to enable the permissions after creation
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--oracle=<value> HexString of the aggregator address to create a permission for
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new permission
sbv2 aptos permission set GRANTER
create a new permission
USAGE
$ sbv2 aptos permission set GRANTER --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId
<value>] [-u <value>] [--profileName <value>] [--json] [--aggregator <value> | --oracle <value>] [--enable]
ARGUMENTS
GRANTER HexString of the oracle queue to create a permission for
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--aggregator=<value> HexString of the aggregator address to create a permission for
--enable whether to enable the permissions after creation
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--oracle=<value> HexString of the aggregator address to create a permission for
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new permission
sbv2 aptos pop crank CRANKHEXSTRING
pop the crank
USAGE
$ sbv2 aptos pop crank CRANKHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>] [--json]
ARGUMENTS
CRANKHEXSTRING HexString address of the crank
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
pop the crank
ALIASES
$ sbv2 aptos pop crank
sbv2 aptos print ACCOUNTTYPE ADDRESS
print an aptos account
USAGE
$ sbv2 aptos print ACCOUNTTYPE ADDRESS [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId
<value>] [-u <value>] [--json]
ARGUMENTS
ACCOUNTTYPE (queue|aggregator|crank|oracle|permission|lease|job|state) account type to print
ADDRESS HexString address of the account to print
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an aptos account
ALIASES
$ sbv2 aptos print
sbv2 aptos push crank CRANKHEXSTRING
push an aggregator onto the crank
USAGE
$ sbv2 aptos push crank CRANKHEXSTRING --keypair <value> -a <value> [-h] [-v] [-s] [--networkId
devnet|testnet|mainnet] [--programId <value>] [-u <value>] [--profileName <value>] [--json]
ARGUMENTS
CRANKHEXSTRING HexString address of the crank
FLAGS
-a, --aggregatorHexString=<value> (required) HexString address of the aggregator
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional
profile to load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
push an aggregator onto the crank
ALIASES
$ sbv2 aptos push crank
sbv2 aptos queue create
create a new oracle queue
USAGE
$ sbv2 aptos queue create --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet] [--programId <value>]
[-u <value>] [--profileName <value>] [--json] [-a <value>] [--name <value>] [--metadata <value>] [--minStake
<value>] [-r <value>] [--oracleTimeout <value>] [--queueSize <value>] [--slashingEnabled] [--unpermissionedFeeds]
[--unpermissionedVrf] [--enableBufferRelayers] [--lockLeaseFunding] [--new]
FLAGS
-a, --authority=<value> alternate account HexString that will be the authority for the queue
-h, --help Show CLI help.
-r, --reward=<value> oracle rewards for successfully responding to an update request
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--enableBufferRelayers enable oracles to fulfill buffer relayer requests
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--lockLeaseFunding lock lease funding
--metadata=<value> metadata of the queue for easier identification
--minStake=<value> minimum stake required by an oracle to join the queue
--name=<value> name of the queue for easier identification
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--new create account at new AptosAccount with authority set to --account
--oracleTimeout=<value> [default: 180] number of oracles to add to the queue
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
--queueSize=<value> [default: 100] maximum number of oracles the queue can support
--slashingEnabled permit slashing malicous oracles
--unpermissionedFeeds permit unpermissioned feeds
--unpermissionedVrf permit unpermissioned VRF accounts
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new oracle queue
ALIASES
$ sbv2 aptos create queue
sbv2 aptos update aggregator AGGREGATORHEXSTRING
request a new value on-chain for an aggregator
USAGE
$ sbv2 aptos update aggregator AGGREGATORHEXSTRING --keypair <value> [-h] [-v] [-s] [--networkId devnet|testnet|mainnet]
[--programId <value>] [-u <value>] [--profileName <value>]
ARGUMENTS
AGGREGATORHEXSTRING HexString address of the aggregator
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--keypair=<value> (required) Path to AptosAccount keypair or config.yaml file
--networkId=<option> [default: testnet] Aptos network to connect to
<options: devnet|testnet|mainnet>
--profileName=<value> [default: default] If --keypair is pointing to a yaml file, provide an optional profile to
load. If none provided, default will be used
--programId=<value> Switchboard programId on the selected Aptos network
DESCRIPTION
request a new value on-chain for an aggregator
ALIASES
$ sbv2 aptos update aggregator
Near
Config
# Testnet
sbv2 config set near testnet rpc https://rpc.testnet.near.org
sbv2 config set near testnet default-account my-named-account.testnet
# Mainnet
sbv2 config set near mainnet rpc https://rpc.mainnet.near.org
sbv2 config set near mainnet default-account my-named-account.near
Commands
sbv2 near
interact with switchboard on Near
sbv2 near aggregator add history AGGREGATORADDRESSsbv2 near aggregator add job AGGREGATORADDRESSsbv2 near aggregator create QUEUEADDRESSsbv2 near aggregator escrow AGGREGATORADDRESSsbv2 near aggregator fetchsbv2 near aggregator fund AGGREGATORADDRESSsbv2 near aggregator history add AGGREGATORADDRESSsbv2 near aggregator job add AGGREGATORADDRESSsbv2 near aggregator job remove AGGREGATORADDRESSsbv2 near aggregator permission create AGGREGATORADDRESSsbv2 near aggregator remove job AGGREGATORADDRESSsbv2 near aggregator set AGGREGATORADDRESSsbv2 near aggregator update AGGREGATORADDRESSsbv2 near crank create QUEUEADDRESSsbv2 near crank list CRANKADDRESSsbv2 near crank pop CRANKADDRESSsbv2 near crank push CRANKADDRESSsbv2 near create aggregator QUEUEADDRESSsbv2 near create aggregator permission AGGREGATORADDRESSsbv2 near create crank QUEUEADDRESSsbv2 near create escrowsbv2 near create job JOBDEFINITIONsbv2 near create oracle QUEUEADDRESSsbv2 near create oracle permissionsbv2 near create queuesbv2 near escrow createsbv2 near escrow printsbv2 near fetch aggregatorssbv2 near fund aggregator AGGREGATORADDRESSsbv2 near job create JOBDEFINITIONsbv2 near list queue QUEUEADDRESSsbv2 near oracle create QUEUEADDRESSsbv2 near oracle escrow ORACLEADDRESSsbv2 near oracle stake ORACLEADDRESSsbv2 near oracle unstake ORACLEADDRESSsbv2 near oracle up ORACLEADDRESSsbv2 near permission createsbv2 near pop crank CRANKADDRESSsbv2 near print ACCOUNTTYPE ADDRESSsbv2 near print escrowsbv2 near push crank CRANKADDRESSsbv2 near queue aggregators QUEUEADDRESSsbv2 near queue createsbv2 near queue feeds QUEUEADDRESSsbv2 near queue list QUEUEADDRESSsbv2 near queue set QUEUEADDRESSsbv2 near set aggregator AGGREGATORADDRESSsbv2 near update aggregator AGGREGATORADDRESS
sbv2 near aggregator add history AGGREGATORADDRESS
add rows to a history vector
USAGE
$ sbv2 near aggregator add history AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [--numRows
<value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--numRows=<value> [default: 1000] number of rows to add to the aggregator
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
add rows to a history vector
ALIASES
$ sbv2 near aggregator history add
sbv2 near aggregator add job AGGREGATORADDRESS
add a job to an aggregator
USAGE
$ sbv2 near aggregator add job AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--name <value> | --jobKey <value>] [--metadata <value> | ] [--jobDefinition <value> | ] [--jobWeight <value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--jobDefinition=<value> filesystem path of job json definition file
--jobKey=<value> public key of an existing job account to add to an aggregator
--jobWeight=<value> [default: 1] job weight
--metadata=<value> metadata of the job account
--name=<value> name of the job account
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
add a job to an aggregator
ALIASES
$ sbv2 near aggregator job add
sbv2 near aggregator create QUEUEADDRESS
create a near aggregator for a given queue
USAGE
$ sbv2 near aggregator create QUEUEADDRESS --accountName <value> --updateInterval <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--crankAddress <value>] [--name <value>] [--metadata <value>] [--forceReportPeriod <value>] [--batchSize <value>]
[--minJobs <value>] [--minOracles <value>] [--varianceThreshold <value>] [--rewardEscrow <value>] [--enable]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--batchSize=<value> number of oracles requested for each open round call
--crankAddress=<value> optional, address of the crank to add the aggregator to
--enable if required and queue authority is provided, enable permissions
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept new
responses from oracles.
--metadata=<value> metadata of the crank for easier identification
--minJobs=<value> number of jobs that must respond before an oracle responds
--minOracles=<value> number of oracles that must respond before a value is accepted on-chain
--name=<value> name of the crank for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
--rewardEscrow=<value> where to send rewards. defaults to user's escrow account
--updateInterval=<value> (required) set an aggregator's minimum update delay
--varianceThreshold=<value> [default: 0] 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a near aggregator for a given queue
ALIASES
$ sbv2 near create aggregator
sbv2 near aggregator escrow AGGREGATORADDRESS
view an aggregators escrow state
USAGE
$ sbv2 near aggregator escrow AGGREGATORADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
DESCRIPTION
view an aggregators escrow state
sbv2 near aggregator fetch
fetch all aggregators for a given near account
USAGE
$ sbv2 near aggregator fetch --accountId <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountId=<value> (required) optional, authority to fetch aggregators for
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
fetch all aggregators for a given near account
ALIASES
$ sbv2 near fetch aggregators
sbv2 near aggregator fund AGGREGATORADDRESS
USAGE
$ sbv2 near aggregator fund AGGREGATORADDRESS --accountName <value> -a <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --amount=<value> (required) amount to deposit into the aggregator's lease
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
ALIASES
$ sbv2 near fund aggregator
sbv2 near aggregator history add AGGREGATORADDRESS
add rows to a history vector
USAGE
$ sbv2 near aggregator history add AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [--numRows
<value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--numRows=<value> [default: 1000] number of rows to add to the aggregator
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
add rows to a history vector
ALIASES
$ sbv2 near aggregator history add
sbv2 near aggregator job add AGGREGATORADDRESS
add a job to an aggregator
USAGE
$ sbv2 near aggregator job add AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--name <value> | --jobKey <value>] [--metadata <value> | ] [--jobDefinition <value> | ] [--jobWeight <value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--jobDefinition=<value> filesystem path of job json definition file
--jobKey=<value> public key of an existing job account to add to an aggregator
--jobWeight=<value> [default: 1] job weight
--metadata=<value> metadata of the job account
--name=<value> name of the job account
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
add a job to an aggregator
ALIASES
$ sbv2 near aggregator job add
sbv2 near aggregator job remove AGGREGATORADDRESS
remove a job to an aggregator
USAGE
$ sbv2 near aggregator job remove AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[-j <value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-h, --help Show CLI help.
-j, --jobAddress=<value>... public key of an existing job account to remove from an aggregator
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
remove a job to an aggregator
ALIASES
$ sbv2 near aggregator job remove
sbv2 near aggregator permission create AGGREGATORADDRESS
create a permission account for a near aggregator
USAGE
$ sbv2 near aggregator permission create AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a permission account for a near aggregator
ALIASES
$ sbv2 near create aggregator permission
sbv2 near aggregator remove job AGGREGATORADDRESS
remove a job to an aggregator
USAGE
$ sbv2 near aggregator remove job AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[-j <value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-h, --help Show CLI help.
-j, --jobAddress=<value>... public key of an existing job account to remove from an aggregator
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
remove a job to an aggregator
ALIASES
$ sbv2 near aggregator job remove
sbv2 near aggregator set AGGREGATORADDRESS
set a near aggregator's config
USAGE
$ sbv2 near aggregator set AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--crankAddress <value>] [--queueAddress <value>] [--name <value>] [--metadata <value>] [--forceReportPeriod
<value>] [--batchSize <value>] [--minJobs <value>] [--minOracles <value>] [--updateInterval <value>]
[--varianceThreshold <value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--batchSize=<value> number of oracles requested for each open round call
--crankAddress=<value> optional, address of the crank to add the aggregator to
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept new
responses from oracles.
--metadata=<value> metadata of the crank for easier identification
--minJobs=<value> number of jobs that must respond before an oracle responds
--minOracles=<value> number of oracles that must respond before a value is accepted on-chain
--name=<value> name of the crank for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
--queueAddress=<value> optional, address of the new queue to add the aggregator to
--updateInterval=<value> set an aggregator's minimum update delay
--varianceThreshold=<value> 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
set a near aggregator's config
ALIASES
$ sbv2 near set aggregator
sbv2 near aggregator update AGGREGATORADDRESS
request a new value on-chain for an aggregator
USAGE
$ sbv2 near aggregator update AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
request a new value on-chain for an aggregator
ALIASES
$ sbv2 near update aggregator
sbv2 near crank create QUEUEADDRESS
create a new crank
USAGE
$ sbv2 near crank create QUEUEADDRESS --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [--name <value>] [--metadata <value>]
[--maxRows <value>]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--maxRows=<value> [default: 100] maximum number of rows on the crank
--metadata=<value> metadata of the crank for easier identification
--name=<value> name of the crank for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new crank
ALIASES
$ sbv2 near create crank
sbv2 near crank list CRANKADDRESS
pop the crank
USAGE
$ sbv2 near crank list CRANKADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId <value>] [-u
<value>] [--nearCredentialsDir <value>]
ARGUMENTS
CRANKADDRESS address of the crank in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
DESCRIPTION
pop the crank
ALIASES
$ sbv2 near pop crank
sbv2 near crank pop CRANKADDRESS
pop the crank
USAGE
$ sbv2 near crank pop CRANKADDRESS --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
CRANKADDRESS address of the crank in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
pop the crank
ALIASES
$ sbv2 near pop crank
sbv2 near crank push CRANKADDRESS
push an aggregator onto the crank
USAGE
$ sbv2 near crank push CRANKADDRESS --accountName <value> -a <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
CRANKADDRESS address of the crank in Uint8 or Base58 encoding
FLAGS
-a, --aggregatorAddress=<value> (required) address of the aggregator in Uint8 or Base58 encoding
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
push an aggregator onto the crank
ALIASES
$ sbv2 near push crank
sbv2 near create aggregator QUEUEADDRESS
create a near aggregator for a given queue
USAGE
$ sbv2 near create aggregator QUEUEADDRESS --accountName <value> --updateInterval <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--crankAddress <value>] [--name <value>] [--metadata <value>] [--forceReportPeriod <value>] [--batchSize <value>]
[--minJobs <value>] [--minOracles <value>] [--varianceThreshold <value>] [--rewardEscrow <value>] [--enable]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--batchSize=<value> number of oracles requested for each open round call
--crankAddress=<value> optional, address of the crank to add the aggregator to
--enable if required and queue authority is provided, enable permissions
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept new
responses from oracles.
--metadata=<value> metadata of the crank for easier identification
--minJobs=<value> number of jobs that must respond before an oracle responds
--minOracles=<value> number of oracles that must respond before a value is accepted on-chain
--name=<value> name of the crank for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
--rewardEscrow=<value> where to send rewards. defaults to user's escrow account
--updateInterval=<value> (required) set an aggregator's minimum update delay
--varianceThreshold=<value> [default: 0] 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a near aggregator for a given queue
ALIASES
$ sbv2 near create aggregator
sbv2 near create aggregator permission AGGREGATORADDRESS
create a permission account for a near aggregator
USAGE
$ sbv2 near create aggregator permission AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a permission account for a near aggregator
ALIASES
$ sbv2 near create aggregator permission
sbv2 near create crank QUEUEADDRESS
create a new crank
USAGE
$ sbv2 near create crank QUEUEADDRESS --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [--name <value>] [--metadata <value>]
[--maxRows <value>]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--maxRows=<value> [default: 100] maximum number of rows on the crank
--metadata=<value> metadata of the crank for easier identification
--name=<value> name of the crank for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new crank
ALIASES
$ sbv2 near create crank
sbv2 near create escrow
create an escrow token account
USAGE
$ sbv2 near create escrow --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--mint <value>]
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--mint=<value> [default: wrap.test] token mint to create escrow account for
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an escrow token account
ALIASES
$ sbv2 near create escrow
sbv2 near create job JOBDEFINITION
create a job on near
USAGE
$ sbv2 near create job JOBDEFINITION --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--name <value>] [--metadata
<value>]
ARGUMENTS
JOBDEFINITION filesystem path to job definition
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the job account
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--metadata=<value> metadata of the job for easier identification
--name=<value> name of the job for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a job on near
ALIASES
$ sbv2 near create job
sbv2 near create oracle QUEUEADDRESS
create a near oracle for a given queue
USAGE
$ sbv2 near create oracle QUEUEADDRESS --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--name <value>] [--metadata
<value>]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--metadata=<value> metadata of the oracle for easier identification
--name=<value> name of the oracle for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a near oracle for a given queue
ALIASES
$ sbv2 near create oracle
sbv2 near create oracle permission
create a permission account
USAGE
$ sbv2 near create oracle permission --accountName <value> --granter <value> --grantee <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--enable]
FLAGS
-a, --authority=<value> alternate account that is the granters authority
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--enable enable permissions
--grantee=<value> (required) account that will be granted permissions, typically an Oracle or Aggregator
--granter=<value> (required) account that will grant permissions, typically the OracleQueue
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a permission account
ALIASES
$ sbv2 near create oracle permission
sbv2 near create queue
create a new oracle queue
USAGE
$ sbv2 near create queue --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--name <value>] [--metadata <value>]
[--minStake <value>] [-r <value>] [--oracleTimeout <value>] [--queueSize <value>] [--slashingEnabled]
[--unpermissionedFeeds] [--unpermissionedVrf] [--enableBufferRelayers]
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the queue
-h, --help Show CLI help.
-r, --reward=<value> [default: 0] oracle rewards for successfully responding to an update request
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--enableBufferRelayers enable oracles to fulfill buffer relayer requests
--metadata=<value> metadata of the queue for easier identification
--minStake=<value> [default: 0] minimum stake required by an oracle to join the queue
--name=<value> name of the queue for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--oracleTimeout=<value> [default: 180] number of oracles to add to the queue
--programId=<value> Switchboard programId on the selected Near networkId
--queueSize=<value> [default: 100] maximum number of oracles the queue can support
--slashingEnabled permit slashing malicous oracles
--unpermissionedFeeds permit unpermissioned feeds
--unpermissionedVrf permit unpermissioned VRF accounts
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new oracle queue
ALIASES
$ sbv2 near create queue
sbv2 near escrow create
create an escrow token account
USAGE
$ sbv2 near escrow create --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--mint <value>]
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--mint=<value> [default: wrap.test] token mint to create escrow account for
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an escrow token account
ALIASES
$ sbv2 near create escrow
sbv2 near escrow print
print an escrow token account
USAGE
$ sbv2 near escrow print --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an escrow token account
ALIASES
$ sbv2 near print escrow
sbv2 near fetch aggregators
fetch all aggregators for a given near account
USAGE
$ sbv2 near fetch aggregators --accountId <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountId=<value> (required) optional, authority to fetch aggregators for
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
fetch all aggregators for a given near account
ALIASES
$ sbv2 near fetch aggregators
sbv2 near fund aggregator AGGREGATORADDRESS
USAGE
$ sbv2 near fund aggregator AGGREGATORADDRESS --accountName <value> -a <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --amount=<value> (required) amount to deposit into the aggregator's lease
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
ALIASES
$ sbv2 near fund aggregator
sbv2 near job create JOBDEFINITION
create a job on near
USAGE
$ sbv2 near job create JOBDEFINITION --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--name <value>] [--metadata
<value>]
ARGUMENTS
JOBDEFINITION filesystem path to job definition
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the job account
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--metadata=<value> metadata of the job for easier identification
--name=<value> name of the job for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a job on near
ALIASES
$ sbv2 near create job
sbv2 near list queue QUEUEADDRESS
list aggregators for a given queue
USAGE
$ sbv2 near list queue QUEUEADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId <value>] [-u
<value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
list aggregators for a given queue
ALIASES
$ sbv2 near list queue
sbv2 near oracle create QUEUEADDRESS
create a near oracle for a given queue
USAGE
$ sbv2 near oracle create QUEUEADDRESS --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--name <value>] [--metadata
<value>]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--metadata=<value> metadata of the oracle for easier identification
--name=<value> name of the oracle for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a near oracle for a given queue
ALIASES
$ sbv2 near create oracle
sbv2 near oracle escrow ORACLEADDRESS
view an aggregators escrow state
USAGE
$ sbv2 near oracle escrow ORACLEADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId <value>]
[-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
ORACLEADDRESS address of the oracle in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
view an aggregators escrow state
sbv2 near oracle stake ORACLEADDRESS
deposit funds to an oracle's staking wallet
USAGE
$ sbv2 near oracle stake ORACLEADDRESS --accountName <value> --amount <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
ORACLEADDRESS address of the oracle in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--amount=<value> (required) amount of Near to deposit into oracle staking wallet
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
deposit funds to an oracle's staking wallet
sbv2 near oracle unstake ORACLEADDRESS
deposit funds to an oracle's staking wallet
USAGE
$ sbv2 near oracle unstake ORACLEADDRESS --accountName <value> --amount <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
ORACLEADDRESS address of the oracle in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--amount=<value> (required) amount of Near to unstake from oracle staking wallet
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
deposit funds to an oracle's staking wallet
sbv2 near oracle up ORACLEADDRESS
start a near docker oracle
USAGE
$ sbv2 near oracle up ORACLEADDRESS --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-d <value>] [--nodeImage <value>]
[--arm]
ARGUMENTS
ORACLEADDRESS address of the oracle in Uint8 or Base58 encoding
FLAGS
-d, --switchboardDir=<value> directory with switchboard.env to load a switchboard environment
-h, --help Show CLI help.
-s, --silent suppress docker logging
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--arm apple silicon needs to use a docker image for linux/arm64
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--nodeImage=<value> [default: dev-v2-RC_02_24_23_18_43] public key of the oracle to start-up
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
start a near docker oracle
sbv2 near permission create
create a permission account
USAGE
$ sbv2 near permission create --accountName <value> --granter <value> --grantee <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--enable]
FLAGS
-a, --authority=<value> alternate account that is the granters authority
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--enable enable permissions
--grantee=<value> (required) account that will be granted permissions, typically an Oracle or Aggregator
--granter=<value> (required) account that will grant permissions, typically the OracleQueue
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a permission account
ALIASES
$ sbv2 near create oracle permission
sbv2 near pop crank CRANKADDRESS
pop the crank
USAGE
$ sbv2 near pop crank CRANKADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId <value>] [-u
<value>] [--nearCredentialsDir <value>]
ARGUMENTS
CRANKADDRESS address of the crank in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
DESCRIPTION
pop the crank
ALIASES
$ sbv2 near pop crank
sbv2 near print ACCOUNTTYPE ADDRESS
print a near switchboard account
USAGE
$ sbv2 near print ACCOUNTTYPE ADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [--all]
ARGUMENTS
ACCOUNTTYPE (queue|aggregator|crank|oracle|permission|lease|job) account type to print
ADDRESS address of the account to print in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--all print all account attributes including jobs, permissions, and leases
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print a near switchboard account
ALIASES
$ sbv2 near print
sbv2 near print escrow
print an escrow token account
USAGE
$ sbv2 near print escrow --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an escrow token account
ALIASES
$ sbv2 near print escrow
sbv2 near push crank CRANKADDRESS
push an aggregator onto the crank
USAGE
$ sbv2 near push crank CRANKADDRESS --accountName <value> -a <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
CRANKADDRESS address of the crank in Uint8 or Base58 encoding
FLAGS
-a, --aggregatorAddress=<value> (required) address of the aggregator in Uint8 or Base58 encoding
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
push an aggregator onto the crank
ALIASES
$ sbv2 near push crank
sbv2 near queue aggregators QUEUEADDRESS
fetch all aggregators for a given queue account
USAGE
$ sbv2 near queue aggregators QUEUEADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId <value>] [-u
<value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
fetch all aggregators for a given queue account
ALIASES
$ sbv2 near queue feeds
sbv2 near queue create
create a new oracle queue
USAGE
$ sbv2 near queue create --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId
<value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--name <value>] [--metadata <value>]
[--minStake <value>] [-r <value>] [--oracleTimeout <value>] [--queueSize <value>] [--slashingEnabled]
[--unpermissionedFeeds] [--unpermissionedVrf] [--enableBufferRelayers]
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the queue
-h, --help Show CLI help.
-r, --reward=<value> [default: 0] oracle rewards for successfully responding to an update request
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--enableBufferRelayers enable oracles to fulfill buffer relayer requests
--metadata=<value> metadata of the queue for easier identification
--minStake=<value> [default: 0] minimum stake required by an oracle to join the queue
--name=<value> name of the queue for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--oracleTimeout=<value> [default: 180] number of oracles to add to the queue
--programId=<value> Switchboard programId on the selected Near networkId
--queueSize=<value> [default: 100] maximum number of oracles the queue can support
--slashingEnabled permit slashing malicous oracles
--unpermissionedFeeds permit unpermissioned feeds
--unpermissionedVrf permit unpermissioned VRF accounts
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new oracle queue
ALIASES
$ sbv2 near create queue
sbv2 near queue feeds QUEUEADDRESS
fetch all aggregators for a given queue account
USAGE
$ sbv2 near queue feeds QUEUEADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId <value>] [-u
<value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
fetch all aggregators for a given queue account
ALIASES
$ sbv2 near queue feeds
sbv2 near queue list QUEUEADDRESS
list aggregators for a given queue
USAGE
$ sbv2 near queue list QUEUEADDRESS [-h] [-v] [-s] [--networkId testnet|mainnet|localnet] [--programId <value>] [-u
<value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
list aggregators for a given queue
ALIASES
$ sbv2 near list queue
sbv2 near queue set QUEUEADDRESS
create a new oracle queue
USAGE
$ sbv2 near queue set QUEUEADDRESS --accountName <value> [-h] [-v] [-s] [--networkId testnet|mainnet|localnet]
[--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>] [--name <value>] [--metadata
<value>] [--minStake <value>] [-r <value>] [--oracleTimeout <value>] [--slashingEnabled] [--unpermissionedFeeds]
[--unpermissionedVrf] [--enableBufferRelayers]
ARGUMENTS
QUEUEADDRESS address of the queue in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the queue
-h, --help Show CLI help.
-r, --reward=<value> oracle rewards for successfully responding to an update request
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--enableBufferRelayers enable oracles to fulfill buffer relayer requests
--metadata=<value> metadata of the queue for easier identification
--minStake=<value> minimum stake required by an oracle to join the queue
--name=<value> name of the queue for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--oracleTimeout=<value> number of oracles to add to the queue
--programId=<value> Switchboard programId on the selected Near networkId
--slashingEnabled permit slashing malicous oracles
--unpermissionedFeeds permit unpermissioned feeds
--unpermissionedVrf permit unpermissioned VRF accounts
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new oracle queue
ALIASES
$ sbv2 near create queue
sbv2 near set aggregator AGGREGATORADDRESS
set a near aggregator's config
USAGE
$ sbv2 near set aggregator AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json] [-a <value>]
[--crankAddress <value>] [--queueAddress <value>] [--name <value>] [--metadata <value>] [--forceReportPeriod
<value>] [--batchSize <value>] [--minJobs <value>] [--minOracles <value>] [--updateInterval <value>]
[--varianceThreshold <value>]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-a, --authority=<value> alternate named account that will be the authority for the oracle
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--batchSize=<value> number of oracles requested for each open round call
--crankAddress=<value> optional, address of the crank to add the aggregator to
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept new
responses from oracles.
--metadata=<value> metadata of the crank for easier identification
--minJobs=<value> number of jobs that must respond before an oracle responds
--minOracles=<value> number of oracles that must respond before a value is accepted on-chain
--name=<value> name of the crank for easier identification
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
--queueAddress=<value> optional, address of the new queue to add the aggregator to
--updateInterval=<value> set an aggregator's minimum update delay
--varianceThreshold=<value> 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
set a near aggregator's config
ALIASES
$ sbv2 near set aggregator
sbv2 near update aggregator AGGREGATORADDRESS
request a new value on-chain for an aggregator
USAGE
$ sbv2 near update aggregator AGGREGATORADDRESS --accountName <value> [-h] [-v] [-s] [--networkId
testnet|mainnet|localnet] [--programId <value>] [-u <value>] [--nearCredentialsDir <value>] [--json]
ARGUMENTS
AGGREGATORADDRESS address of the aggregator in Uint8 or Base58 encoding
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--accountName=<value> (required) Named account to load from your nearCredentialsDir
--nearCredentialsDir=<value> [default: /home/runner/.near-credentials] Alternative directory for near credentials.
Defaults to ~/.near-credentials
--networkId=<option> [default: testnet] Near network ID to connect to
<options: testnet|mainnet|localnet>
--programId=<value> Switchboard programId on the selected Near networkId
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
request a new value on-chain for an aggregator
ALIASES
$ sbv2 near update aggregator
Solana
Config
# Devnet
sbv2 config set solana devnet rpc https://api.devnet.solana.com
sbv2 config set solana devnet default-account "~/.config/solana/id.json"
# Mainnet
sbv2 config set solana mainnet-beta rpc https://api.mainnet-beta.solana.com
sbv2 config set solana mainnet-beta default-account "~/.config/solana/id.json"
Commands
sbv2 solana
interact with switchboard on Solana
sbv2 solana aggregator add history AGGREGATORKEYsbv2 solana aggregator add job AGGREGATORKEYsbv2 solana aggregator authority AGGREGATORKEYsbv2 solana aggregator close AGGREGATORKEYsbv2 solana aggregator create QUEUEKEYsbv2 solana aggregator create json DEFINITIONFILEsbv2 solana aggregator deposit AGGREGATORKEYsbv2 solana aggregator extend AGGREGATORKEYsbv2 solana aggregator fund AGGREGATORKEYsbv2 solana aggregator history AGGREGATORKEYsbv2 solana aggregator lease set AGGREGATORKEYsbv2 solana aggregator list AUTHORITYKEYsbv2 solana aggregator lock AGGREGATORKEYsbv2 solana aggregator metrics AGGREGATORKEYsbv2 solana aggregator open-round AGGREGATORKEYsbv2 solana aggregator permission create AGGREGATORKEYsbv2 solana aggregator print AGGREGATORKEYsbv2 solana aggregator remove job AGGREGATORKEY JOBKEYsbv2 solana aggregator set AGGREGATORKEYsbv2 solana aggregator transfer AGGREGATORKEYsbv2 solana aggregator update AGGREGATORKEYsbv2 solana aggregator watch AGGREGATORKEYsbv2 solana aggregator withdraw AGGREGATORKEYsbv2 solana anchor testsbv2 solana buffer create QUEUEKEYsbv2 solana buffer open-round BUFFERRELAYERKEYsbv2 solana buffer update BUFFERRELAYERKEYsbv2 solana crank create QUEUEKEYsbv2 solana crank events AGGREGATORKEYsbv2 solana crank pop CRANKKEYsbv2 solana crank print CRANKKEYsbv2 solana crank push AGGREGATORKEYsbv2 solana job createsbv2 solana job print JOBKEYsbv2 solana json create aggregator DEFINITIONFILEsbv2 solana lease create AGGREGATORKEYsbv2 solana lease extend AGGREGATORKEYsbv2 solana lease print LEASEKEYsbv2 solana lease set AGGREGATORKEYsbv2 solana lease withdraw AGGREGATORKEYsbv2 solana localnet envsbv2 solana localnet upsbv2 solana network createsbv2 solana network savesbv2 solana network startsbv2 solana oracle create QUEUEKEYsbv2 solana oracle print ORACLEKEYsbv2 solana oracle upsbv2 solana oracle withdraw ORACLEKEYsbv2 solana permission createsbv2 solana permission grant PERMISSIONKEYsbv2 solana permission print PERMISSIONKEYsbv2 solana permission revoke PERMISSIONKEYsbv2 solana print PUBKEYsbv2 solana queue createsbv2 solana queue print QUEUEKEYsbv2 solana queue set QUEUEKEYsbv2 solana vrf open-round VRFKEYsbv2 solana vrf print VRFKEYsbv2 solana vrf request VRFKEYsbv2 solana vrf update VRFKEY
sbv2 solana aggregator add history AGGREGATORKEY
add a history buffer to an aggregator
USAGE
$ sbv2 solana aggregator add history AGGREGATORKEY --historyLimit <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--force] [-a <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--force overwrite an existing history buffer if one already exists
--historyLimit=<value> (required) the number of samples to store before overwriting old samples
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
add a history buffer to an aggregator
EXAMPLES
$ sbv2 solana:aggregator:add:history
sbv2 solana aggregator add job AGGREGATORKEY
add jobs to an aggregator
USAGE
$ sbv2 solana aggregator add job AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--jobDefinition <value>] [--jobKey
<value>] [-a <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--jobDefinition=<value>... filesystem path of job json definition file
--jobKey=<value>... public key of an existing job account to add to an aggregator
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
add jobs to an aggregator
EXAMPLES
$ sbv2 solana aggregator add job
sbv2 solana aggregator authority AGGREGATORKEY
USAGE
$ sbv2 solana aggregator authority AGGREGATORKEY --newAuthority <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator and required to make config
changes
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--newAuthority=<value> (required)
--programId=<value> alternative Switchboard program ID to interact with
sbv2 solana aggregator close AGGREGATORKEY
close an aggregator and associated PDA accounts on devnet
USAGE
$ sbv2 solana aggregator close AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator and required to make config
changes
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
close an aggregator and associated PDA accounts on devnet
EXAMPLES
$ sbv2 solana aggregator close J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa --keypair ../payer-keypair.json
sbv2 solana aggregator create QUEUEKEY
create an aggregator account
USAGE
$ sbv2 solana aggregator create QUEUEKEY --updateInterval <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [-a <value>]
[--aggregatorKeypair <value>] [--name <value>] [--metadata <value>] [--batchSize <value>] [--minJobs <value>]
[--minOracles <value>] [--forceReportPeriod <value>] [--varianceThreshold <value>] [--historyLimit <value>]
[--crankKey <value> | --disableCrank] [--queueAuthority <value>] [--enable] [--leaseAmount <value>] [-j <value>]
[--jobKey <value>] [--slidingWindow] [--basePriorityFee <value>] [--priorityFeeBump <value>]
[--priorityFeeBumpPeriod <value>] [--maxPriorityFeeMultiplier <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue to create an aggregator on
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-h, --help Show CLI help.
-j, --job=<value>... filesystem path to job definition file
-k, --keypair=<value> keypair that will pay for onchain transactions. defaults to new account authority
if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--aggregatorKeypair=<value> keypair to use for aggregator account. This will be the account's publicKey
--basePriorityFee=<value>
--batchSize=<value> [default: 1] number of oracles requested for each open round call
--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>
--crankKey=<value> public key of the crank to join
--disableCrank whether the newly created feed can be pushed onto a crank. irreversible
--enable set permissions to PERMIT_ORACLE_QUEUE_USAGE
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept
new responses from oracles.
--historyLimit=<value> number of historical samples to store
--jobKey=<value>... public key of existing job account
--leaseAmount=<value> [default: 0] amount of funds to deposit into the lease, ex: 1.5 would deposit 1.5
wSOL
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--maxPriorityFeeMultiplier=<value>
--metadata=<value> metadata of the aggregator
--minJobs=<value> [default: 1] number of jobs that must respond before an oracle responds
--minOracles=<value> [default: 1] number of oracles that must respond before a value is accepted
on-chain
--name=<value> name of the aggregator
--priorityFeeBump=<value>
--priorityFeeBumpPeriod=<value>
--programId=<value> alternative Switchboard program ID to interact with
--queueAuthority=<value> alternative keypair to use for queue authority
--slidingWindow enable sliding window resolution mode
--updateInterval=<value> (required) set an aggregator's minimum update delay
--varianceThreshold=<value> [default: 0] 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an aggregator account
sbv2 solana aggregator create json DEFINITIONFILE
create an aggregator from a json file
USAGE
$ sbv2 solana aggregator create json DEFINITIONFILE [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [-q <value>] [-a <value>]
[--leaseAmount <value>]
ARGUMENTS
DEFINITIONFILE filesystem path of queue definition json file
FLAGS
-a, --authority=<value> alternate keypair that will be the authority for the aggregator
-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
-q, --queueKey=<value> public key of the oracle queue to create aggregator for
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--leaseAmount=<value> [default: 0] amount of funds to deposit into the lease, ex: 1.5 would deposit 1.5 wSOL
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an aggregator from a json file
ALIASES
$ sbv2 solana json create aggregator
EXAMPLES
$ sbv2 solana aggregator create json examples/aggregator.json --keypair ../payer-keypair.json --queueKey GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --outputFile aggregator.schema.json
sbv2 solana aggregator deposit AGGREGATORKEY
fund and re-enable an aggregator lease
USAGE
$ sbv2 solana aggregator deposit AGGREGATORKEY --amount <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> (required) amount to deposit into the lease escrow
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
fund and re-enable an aggregator lease
ALIASES
$ sbv2 solana aggregator fund
$ sbv2 solana aggregator deposit
$ sbv2 solana aggregator extend
EXAMPLES
$ sbv2 solana:aggregator:fund GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
sbv2 solana aggregator extend AGGREGATORKEY
fund and re-enable an aggregator lease
USAGE
$ sbv2 solana aggregator extend AGGREGATORKEY --amount <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> (required) amount to deposit into the lease escrow
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
fund and re-enable an aggregator lease
ALIASES
$ sbv2 solana aggregator fund
$ sbv2 solana aggregator deposit
$ sbv2 solana aggregator extend
EXAMPLES
$ sbv2 solana:aggregator:fund GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
sbv2 solana aggregator fund AGGREGATORKEY
fund and re-enable an aggregator lease
USAGE
$ sbv2 solana aggregator fund AGGREGATORKEY --amount <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> (required) amount to deposit into the lease escrow
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
fund and re-enable an aggregator lease
ALIASES
$ sbv2 solana aggregator fund
$ sbv2 solana aggregator deposit
$ sbv2 solana aggregator extend
EXAMPLES
$ sbv2 solana:aggregator:fund GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
sbv2 solana aggregator history AGGREGATORKEY
print an aggregator's history'
USAGE
$ sbv2 solana aggregator history AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [--json] [--metrics]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--metrics print metrics on an aggregators history like average update interval
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an aggregator's history'
sbv2 solana aggregator lease set AGGREGATORKEY
set a lease's withdraw authority
USAGE
$ sbv2 solana aggregator lease set AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>] [--queuePubkey <value>]
[--newAuthority <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair delegated as the authority for managing the lease 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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--newAuthority=<value> new lease withdraw authority. if not set, defaults to the aggregator authority
--programId=<value> alternative Switchboard program ID to interact with
--queuePubkey=<value> override the aggregators current queue. useful for withdrawing from a lease after moving to a
new queue
DESCRIPTION
set a lease's withdraw authority
ALIASES
$ sbv2 solana aggregator lease set
EXAMPLES
$ sbv2 solana:lease:set GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --keypair ../payer-keypair.json
sbv2 solana aggregator list AUTHORITYKEY
get a list of aggregators from a provided authority pubkey
USAGE
$ sbv2 solana aggregator list AUTHORITYKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet]
[-u <value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json]
ARGUMENTS
AUTHORITYKEY public key of the aggregator authority
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
get a list of aggregators from a provided authority pubkey
sbv2 solana aggregator lock AGGREGATORKEY
lock an aggregator's configuration and prevent further changes
USAGE
$ sbv2 solana aggregator lock AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
lock an aggregator's configuration and prevent further changes
sbv2 solana aggregator metrics AGGREGATORKEY
print an aggregator's metrics'
USAGE
$ sbv2 solana aggregator metrics AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [--json] [--period <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--period=<value>... the period to collect metrics for. Ex. 3600 will collect update metrics for the last 1hr
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an aggregator's metrics'
sbv2 solana aggregator open-round AGGREGATORKEY
request a new aggregator result from a set of oracles
USAGE
$ sbv2 solana aggregator open-round AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
request a new aggregator result from a set of oracles
ALIASES
$ sbv2 solana aggregator open-round
EXAMPLES
$ sbv2 solana aggregator update J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa --keypair ../payer-keypair.json
sbv2 solana aggregator permission create AGGREGATORKEY
create a permission account for an aggregator
USAGE
$ sbv2 solana aggregator permission create AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
create a permission account for an aggregator
sbv2 solana aggregator print AGGREGATORKEY
print an aggregator and it's associated accounts
USAGE
$ sbv2 solana aggregator print AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [--json] [--queuePubkey <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--queuePubkey=<value> override the aggregators current queue. useful for viewing permission lease accounts if an
aggregator has moved queues
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an aggregator and it's associated accounts
sbv2 solana aggregator remove job AGGREGATORKEY JOBKEY
remove a switchboard job account from an aggregator
USAGE
$ sbv2 solana aggregator remove job AGGREGATORKEY JOBKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
JOBKEY public key of an existing job account to remove from an aggregator
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
remove a switchboard job account from an aggregator
sbv2 solana aggregator set AGGREGATORKEY
set an aggregators config
USAGE
$ sbv2 solana aggregator set AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [-a <value>] [--name <value>]
[--metadata <value>] [--batchSize <value>] [--minJobs <value>] [--minOracles <value>] [--updateInterval <value>]
[--varianceThreshold <value>] [--forceReportPeriod <value>] [--basePriorityFee <value>] [--priorityFeeBump <value>]
[--priorityFeeBumpPeriod <value>] [--maxPriorityFeeMultiplier <value>] [--enableSlidingWindow]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator and required to make
config changes
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--basePriorityFee=<value>
--batchSize=<value> number of oracles requested for each open round call
--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>
--enableSlidingWindow set the aggregator resolution mode
--forceReportPeriod=<value> Number of seconds for which, even if the variance threshold is not passed, accept
new responses from oracles.
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--maxPriorityFeeMultiplier=<value>
--metadata=<value> metadata of the aggregator
--minJobs=<value> number of jobs that must respond before an oracle responds
--minOracles=<value> number of oracles that must respond before a value is accepted on-chain
--name=<value> name of the aggregator
--priorityFeeBump=<value>
--priorityFeeBumpPeriod=<value>
--programId=<value> alternative Switchboard program ID to interact with
--updateInterval=<value> set an aggregator's minimum update delay
--varianceThreshold=<value> 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
set an aggregators config
sbv2 solana aggregator transfer AGGREGATORKEY
transfer an aggregator to a new queue
USAGE
$ sbv2 solana aggregator transfer AGGREGATORKEY --newQueue <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>] [--newCrank <value>]
[--loadAmount <value>] [--enable] [--queueAuthority <value>] [--force]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the aggregator
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--enable enable permissions on the new queue
--force skip permission checks
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--loadAmount=<value> [default: 0.0] amount of funds to load into the new lease, in addition to the funds
remaining in the old lease account
--mainnetBeta WARNING: use mainnet-beta solana cluster
--newCrank=<value> publicKey of the crank to transfer to
--newQueue=<value> (required) publicKey of the new queue to transfer to
--programId=<value> alternative Switchboard program ID to interact with
--queueAuthority=<value> alternate keypair that is the authority for the queue. only used if enabling permissions in
one transaction
DESCRIPTION
transfer an aggregator to a new queue
EXAMPLES
$ sbv2 solana aggregator transfer GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --mainnetBeta --loadAmount 0.1 --newQueue 3HBb2DQqDfuMdzWxNk1Eo9RTMkFYmuEAd32RiLKn9pAn --newCrank GdNVLWzcE6h9SPuSbmu69YzxAj8enim9t6mjzuqTXgLd --keypair ~/.config/solana/id.json
sbv2 solana aggregator update AGGREGATORKEY
request a new aggregator result from a set of oracles
USAGE
$ sbv2 solana aggregator update AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
request a new aggregator result from a set of oracles
ALIASES
$ sbv2 solana aggregator open-round
EXAMPLES
$ sbv2 solana aggregator update J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa --keypair ../payer-keypair.json
sbv2 solana aggregator watch AGGREGATORKEY
watch an aggregator account and stream the results
USAGE
$ sbv2 solana aggregator watch AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-t <value>] [-f <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-f, --outfile=<value> save results to a file
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-t, --timeout=<value> time to watch feed for updates
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
watch an aggregator account and stream the results
sbv2 solana aggregator withdraw AGGREGATORKEY
withdraw funds from an aggregator lease
USAGE
$ sbv2 solana aggregator withdraw AGGREGATORKEY --amount <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>] [--queuePubkey <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> keypair delegated as the authority for managing the lease 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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> (required) token amount to withdraw from lease account
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--queuePubkey=<value> override the aggregators current queue. useful for withdrawing from a lease after moving to a
new queue
DESCRIPTION
withdraw funds from an aggregator lease
ALIASES
$ sbv2 solana aggregator withdraw
EXAMPLES
$ sbv2 solana:aggregator:withdraw GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
sbv2 solana anchor test
run anchor test and a switchboard oracle in parallel
USAGE
$ sbv2 solana anchor test [-h] [-v] [-s] [--mainnetBeta | --cluster localnet|devnet] [-u <value>] [--mainnetRpcUrl
<value>] [--programId <value>] [-d <value>] [--oracleKey <value>] [-k <value>] [--nodeImage <value>] [--arm] [-t
<value>] [--detach] [--testValidatorArgs <value>]
FLAGS
-d, --switchboardDir=<value> directory with switchboard.env to load a switchboard environment
-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
-s, --silent suppress docker logging
-t, --timeout=<value> [default: 120] number of seconds before ending the docker process
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--arm apple silicon needs to use a docker image for linux/arm64
--cluster=<option> [default: localnet] cluster
<options: localnet|devnet>
--detach keep the localnet rpc running
--mainnetBeta WARNING: use mainnet-beta solana cluster
--mainnetRpcUrl=<value> [default: https://api.mainnet-beta.solana.com/] Solana mainnet RPC URL to use for the
oracle task runner
--nodeImage=<value> [default: dev-v2-RC_02_24_23_18_43] public key of the oracle to start-up
--oracleKey=<value> public key of the oracle to start-up
--programId=<value> alternative Switchboard program ID to interact with
--testValidatorArgs=<value> additional args passed to the local solana validator
DESCRIPTION
run anchor test and a switchboard oracle in parallel
ALIASES
$ sbv2 anchor test
sbv2 solana buffer create QUEUEKEY
create a buffer relayer account
USAGE
$ sbv2 solana buffer create QUEUEKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value>
--ledger] [--json] [--bufferKeypair <value>] [-a <value>] [-n <value>] [--minUpdateDelaySeconds <value>]
[--jobDefinition <value> | --jobKey <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue account
FLAGS
-a, --authority=<value> alternate keypair that will be the buffer relayer authority
-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 buffer account
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--bufferKeypair=<value> keypair to use for the buffer relayer account. This will be the account's publicKey
--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>
--jobDefinition=<value> filesystem path to job definition
--jobKey=<value> public key of existing job account
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--minUpdateDelaySeconds=<value> [default: 30] minimum number of seconds between update calls
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a buffer relayer account
sbv2 solana buffer open-round BUFFERRELAYERKEY
request a new buffer relayer result
USAGE
$ sbv2 solana buffer open-round BUFFERRELAYERKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
BUFFERRELAYERKEY public key of the buffer relayer account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
request a new buffer relayer result
ALIASES
$ sbv2 solana buffer open-round
EXAMPLES
$ sbv2 solana buffer update J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa --keypair ../payer-keypair.json
sbv2 solana buffer update BUFFERRELAYERKEY
request a new buffer relayer result
USAGE
$ sbv2 solana buffer update BUFFERRELAYERKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
BUFFERRELAYERKEY public key of the buffer relayer account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
request a new buffer relayer result
ALIASES
$ sbv2 solana buffer open-round
EXAMPLES
$ sbv2 solana buffer update J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa --keypair ../payer-keypair.json
sbv2 solana crank create QUEUEKEY
create a new crank account
USAGE
$ sbv2 solana crank create QUEUEKEY -s <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [-n <value>] [--metadata
<value>] [--crankKeypair <value>] [--dataBufferKeypair <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue to create a crank on
FLAGS
-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 crank for easier identification
-s, --silent suppress cli prompts
-s, --size=<value> (required) maximum number of rows a crank can support
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--crankKeypair=<value> keypair to use for the crank account. This will be the account's publicKey
--dataBufferKeypair=<value> keypair to use for the crank data buffer account.
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--metadata=<value> metadata of the crank for easier identification
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new crank account
sbv2 solana crank events AGGREGATORKEY
watch an aggregator account and stream the on-chain events
USAGE
$ sbv2 solana crank events AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-t <value>] [-f <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-f, --outfile=<value> save results to a file
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-t, --timeout=<value> time to watch feed for updates
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
watch an aggregator account and stream the on-chain events
sbv2 solana crank pop CRANKKEY
pop the crank
USAGE
$ sbv2 solana crank pop CRANKKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value>
--ledger]
ARGUMENTS
CRANKKEY public key of the crank account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
pop the crank
sbv2 solana crank print CRANKKEY
print a crank
USAGE
$ sbv2 solana crank print CRANKKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json] [--rows]
ARGUMENTS
CRANKKEY public key of the crank account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--rows print the crank rows in order
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print a crank
sbv2 solana crank push AGGREGATORKEY
push the crank
USAGE
$ sbv2 solana crank push AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--crankKey <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--crankKey=<value> push onto a new crank, if provided
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
push the crank
sbv2 solana job create
create a job account
USAGE
$ sbv2 solana job create --jobDefinition <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [--jobKeypair <value>] [-a
<value>] [-n <value>]
FLAGS
-a, --authority=<value> alternate keypair that will be the buffer relayer authority
-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 buffer account
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--jobDefinition=<value> (required) filesystem path to job definition
--jobKeypair=<value> keypair to use for the job account. This will be the account's publicKey
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a job account
sbv2 solana job print JOBKEY
print an job and it's associated accounts
USAGE
$ sbv2 solana job print JOBKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json]
ARGUMENTS
JOBKEY public key of the job account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an job and it's associated accounts
sbv2 solana json create aggregator DEFINITIONFILE
create an aggregator from a json file
USAGE
$ sbv2 solana json create aggregator DEFINITIONFILE [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [-q <value>] [-a <value>]
[--leaseAmount <value>]
ARGUMENTS
DEFINITIONFILE filesystem path of queue definition json file
FLAGS
-a, --authority=<value> alternate keypair that will be the authority for the aggregator
-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
-q, --queueKey=<value> public key of the oracle queue to create aggregator for
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--leaseAmount=<value> [default: 0] amount of funds to deposit into the lease, ex: 1.5 would deposit 1.5 wSOL
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an aggregator from a json file
ALIASES
$ sbv2 solana json create aggregator
EXAMPLES
$ sbv2 solana aggregator create json examples/aggregator.json --keypair ../payer-keypair.json --queueKey GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --outputFile aggregator.schema.json
sbv2 solana lease create AGGREGATORKEY
fund and re-enable an aggregator lease
USAGE
$ sbv2 solana lease create AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--amount <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> token amount to load into the lease escrow. If decimals provided, amount will be normalized to
raw tokenAmount
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
fund and re-enable an aggregator lease
EXAMPLES
$ sbv2 solana lease create GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.5 --keypair ../payer-keypair.json
sbv2 solana lease extend AGGREGATORKEY
fund and re-enable an aggregator lease
USAGE
$ sbv2 solana lease extend AGGREGATORKEY --amount <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> (required) amount to deposit into the lease escrow
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
fund and re-enable an aggregator lease
ALIASES
$ sbv2 solana aggregator fund
$ sbv2 solana aggregator deposit
$ sbv2 solana aggregator extend
EXAMPLES
$ sbv2 solana:aggregator:fund GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
sbv2 solana lease print LEASEKEY
print a lease account
USAGE
$ sbv2 solana lease print LEASEKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json]
ARGUMENTS
LEASEKEY public key of the lease account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print a lease account
sbv2 solana lease set AGGREGATORKEY
set a lease's withdraw authority
USAGE
$ sbv2 solana lease set AGGREGATORKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>] [--queuePubkey <value>]
[--newAuthority <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> alternate keypair delegated as the authority for managing the lease 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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--newAuthority=<value> new lease withdraw authority. if not set, defaults to the aggregator authority
--programId=<value> alternative Switchboard program ID to interact with
--queuePubkey=<value> override the aggregators current queue. useful for withdrawing from a lease after moving to a
new queue
DESCRIPTION
set a lease's withdraw authority
ALIASES
$ sbv2 solana aggregator lease set
EXAMPLES
$ sbv2 solana:lease:set GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --keypair ../payer-keypair.json
sbv2 solana lease withdraw AGGREGATORKEY
withdraw funds from an aggregator lease
USAGE
$ sbv2 solana lease withdraw AGGREGATORKEY --amount <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>] [--queuePubkey <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
FLAGS
-a, --authority=<value> keypair delegated as the authority for managing the lease 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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> (required) token amount to withdraw from lease account
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--queuePubkey=<value> override the aggregators current queue. useful for withdrawing from a lease after moving to a
new queue
DESCRIPTION
withdraw funds from an aggregator lease
ALIASES
$ sbv2 solana aggregator withdraw
EXAMPLES
$ sbv2 solana:aggregator:withdraw GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
sbv2 solana localnet env
create a localnet switchboard environment
USAGE
$ sbv2 solana localnet env [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u <value>]
[--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
[--force] [-o <value>]
FLAGS
-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
-o, --outputDir=<value> [default: ./.switchboard] output directory for scripts
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--force overwrite output file if existing
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
create a localnet switchboard environment
sbv2 solana localnet up
start a local solana validator with a switchboard environment and oracle running alongside it
USAGE
$ sbv2 solana localnet up [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u <value>]
[--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
[--oracleStakingWalletKeypair <value> --queueKeypair <value>] [--nodeImage <value>] [--arm] [-t <value>] [--reward
<value>] [--minStake <value>] [--oracleTimeout <value>] [--slashingEnabled] [--permissionedFeeds]
[--unpermissionedVrf] [--enableBufferRelayers]
FLAGS
-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
-s, --silent suppress docker logging
-t, --timeout=<value> [default: 120] number of seconds before ending the docker process
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--arm apple silicon needs to use a docker image for linux/arm64
--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>
--enableBufferRelayers enabling this setting will allow buffer relayer accounts to call openRound.
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--minStake=<value> [default: 0] the reward payed out to oracles for responding to an update request
on-chain, Ex: 2 requires oracles to have 2 wSOL in their staking wallet before
heartbeating
--nodeImage=<value> [default: dev-v2-RC_02_24_23_18_43] public key of the oracle to start-up
--oracleStakingWalletKeypair=<value> keypair to use for the oracle staking wallet. Using a static staking wallet with
the same queue will produce the same oracle pubkey each time.
--oracleTimeout=<value> [default: 180] time period (in seconds) we should remove an oracle after if no
response
--permissionedFeeds enabling this setting means data feeds need explicit permission to join the
queue.
--programId=<value> alternative Switchboard program ID to interact with
--queueKeypair=<value> keypair to use for the oracle queue account. This will be the account's
publicKey
--reward=<value> [default: 0] the reward payed out to oracles for responding to an update request
on-chain, Ex: A reward of 0.0000075 with a feed with a batchSize of 4 would
deduct (4 * 0.0000075) wSOL from an aggregators lease each round.
--slashingEnabled whether slashing is enabled on this queue.
--unpermissionedVrf enabling this setting means data feeds do not need explicit permission to
request VRF proofs and verifications from this queue.
DESCRIPTION
start a local solana validator with a switchboard environment and oracle running alongside it
sbv2 solana network create
create an oracle queue
USAGE
$ sbv2 solana network create --configFile <value> --schemaFile <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [--force]
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--configFile=<value> (required)
--force
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--schemaFile=<value> (required)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an oracle queue
sbv2 solana network save
save an existing switchboard network
USAGE
$ sbv2 solana network save --queueKey <value> --outputFile <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [--json] [--force]
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--force
--mainnetBeta WARNING: use mainnet-beta solana cluster
--outputFile=<value> (required) outputFile to save accounts in JSON format
--programId=<value> alternative Switchboard program ID to interact with
--queueKey=<value> (required) queue account to load
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
save an existing switchboard network
sbv2 solana network start
start a switchboard network from a JSON file
USAGE
$ sbv2 solana network start [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u <value>]
[--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
[--json] [--configFile <value>] [--schemaFile <value>] [--nodeImage <value>] [--arm] [-t <value>] [--mainnetRpcUrl
<value>]
FLAGS
-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
-s, --silent suppress docker logging
-t, --timeout=<value> [default: 300] number of seconds before ending the docker process
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--arm apple silicon needs to use a docker image for linux/arm64
--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>
--configFile=<value>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--mainnetRpcUrl=<value> [default: https://api.mainnet-beta.solana.com/] Solana mainnet RPC URL to use for the oracle
task runner
--nodeImage=<value> [default: dev-v2-RC_02_24_23_18_43] public key of the oracle to start-up
--programId=<value> alternative Switchboard program ID to interact with
--schemaFile=<value>
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
start a switchboard network from a JSON file
sbv2 solana oracle create QUEUEKEY
create a new oracle account for a given queue
USAGE
$ sbv2 solana oracle create QUEUEKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value>
--ledger] [--json] [-n <value>] [--metadata <value>] [-a <value>] [--enable] [--queueAuthority <value>]
[--stakeAmount <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue account
FLAGS
-a, --authority=<value> keypair to delegate authority to for managing the oracle 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 oracle for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--enable enable oracle heartbeat permissions
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--metadata=<value> metadata of the oracle for easier identification
--programId=<value> alternative Switchboard program ID to interact with
--queueAuthority=<value> alternative keypair to use for queue authority
--stakeAmount=<value> token amount to load into the oracle's staking wallet.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a new oracle account for a given queue
EXAMPLES
$ sbv2 solana:oracle:create F8ce7MsckeZAbAGmxjJNetxYXQa9mKr9nnrC3qKubyYy --name oracle-1 --stakeAmount 1
sbv2 solana oracle print ORACLEKEY
print an oracle account
USAGE
$ sbv2 solana oracle print ORACLEKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet]
[-u <value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json]
ARGUMENTS
ORACLEKEY public key of the oracle account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print an oracle account
sbv2 solana oracle up
start a solana docker oracle
USAGE
$ sbv2 solana oracle up --oracleKey <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--nodeImage <value>] [--arm] [-t
<value>]
FLAGS
-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
-s, --silent suppress docker logging
-t, --timeout=<value> [default: 120] number of seconds before ending the docker process
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--arm apple silicon needs to use a docker image for linux/arm64
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--nodeImage=<value> [default: dev-v2-RC_02_24_23_18_43] public key of the oracle to start-up
--oracleKey=<value> (required) public key of the oracle to start-up
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
start a solana docker oracle
sbv2 solana oracle withdraw ORACLEKEY
withdraw from an oracle's staking wallet
USAGE
$ sbv2 solana oracle withdraw ORACLEKEY --amount <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>]
ARGUMENTS
ORACLEKEY public key of the oracle account
FLAGS
-a, --authority=<value> alternate keypair for the oracle authority
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=<value> (required) amount to withdraw
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
withdraw from an oracle's staking wallet
sbv2 solana permission create
create a permission account
USAGE
$ sbv2 solana permission create --granter <value> --grantee <value> [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [--json] [--enable] [-a <value>]
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the granter
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--enable whether to enable permissions on the resource. --keypair or --authority must be provided
--grantee=<value> (required) publicKey of the resource that is being granted permissions. This is typically an
AggregatorAccount, BufferRelayerAccount, OracleAccount, or VrfAccount.
--granter=<value> (required) publicKey of the resource that is granting permissions. This is typically the
QueueAccount.
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create a permission account
sbv2 solana permission grant PERMISSIONKEY
enable a resources permissions
USAGE
$ sbv2 solana permission grant PERMISSIONKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>]
ARGUMENTS
PERMISSIONKEY public key of the permission account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the permission 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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
enable a resources permissions
sbv2 solana permission print PERMISSIONKEY
print a permission account
USAGE
$ sbv2 solana permission print PERMISSIONKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [--json]
ARGUMENTS
PERMISSIONKEY public key of the permission account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print a permission account
sbv2 solana permission revoke PERMISSIONKEY
disable a resources permissions
USAGE
$ sbv2 solana permission revoke PERMISSIONKEY [-h] [-v] [-s] [--mainnetBeta | --cluster
devnet|mainnet-beta|mainnet|localnet] [-u <value>] [--programId <value>] [--commitment
confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger] [-a <value>]
ARGUMENTS
PERMISSIONKEY public key of the permission account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the permission 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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
disable a resources permissions
sbv2 solana print PUBKEY
print a Switchboard account
USAGE
$ sbv2 solana print PUBKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json]
ARGUMENTS
PUBKEY publicKey of the Switchboard account to search for
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print a Switchboard account
sbv2 solana queue create
create an oracle queue
USAGE
$ sbv2 solana queue create [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u <value>]
[--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value> --ledger]
[--json] [-a <value>] [--queueKeypair <value>] [--dataBufferKeypair <value>] [--size <value>] [--name <value>]
[--metadata <value>] [--reward <value>] [--minStake <value>] [--oracleTimeout <value>] [--slashingEnabled]
[--permissionedFeeds] [--unpermissionedVrf] [--enableBufferRelayers] [--feedProbationPeriod <value>]
[--consecutiveFeedFailureLimit <value>] [--consecutiveOracleFailureLimit <value>]
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the queue and is required to
approve permissions
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--consecutiveFeedFailureLimit=<value> [default: 1000] consecutive failure limit for a feed before feed permission
is revoked.
--consecutiveOracleFailureLimit=<value> [default: 1000] consecutive failure limit for an oracle before oracle
permission is revoked.
--dataBufferKeypair=<value> keypair to use for the oracle queue data buffer account.
--enableBufferRelayers enabling this setting will allow buffer relayer accounts to call openRound.
--feedProbationPeriod=<value> [default: 1000] 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.
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--metadata=<value> metadata of the aggregator
--minStake=<value> [default: 0] the reward payed out to oracles for responding to an update
request on-chain, Ex: 2 requires oracles to have 2 wSOL in their staking
wallet before heartbeating
--name=<value> name of the aggregator
--oracleTimeout=<value> [default: 180] time period (in seconds) we should remove an oracle after if
no response
--permissionedFeeds enabling this setting means data feeds need explicit permission to join the
queue.
--programId=<value> alternative Switchboard program ID to interact with
--queueKeypair=<value> keypair to use for the oracle queue account. This will be the account's
publicKey
--reward=<value> [default: 0] the reward payed out to oracles for responding to an update
request on-chain, Ex: A reward of 0.0000075 with a feed with a batchSize of 4
would deduct (4 * 0.0000075) wSOL from an aggregators lease each round.
--size=<value> [default: 100] set the size of the queue
--slashingEnabled whether slashing is enabled on this queue.
--unpermissionedVrf enabling this setting means data feeds do not need explicit permission to
request VRF proofs and verifications from this queue.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
create an oracle queue
sbv2 solana queue print QUEUEKEY
print a queue account
USAGE
$ sbv2 solana queue print QUEUEKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json]
ARGUMENTS
QUEUEKEY public key of the queue account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print a queue account
sbv2 solana queue set QUEUEKEY
set an oracle queue's config
USAGE
$ sbv2 solana queue set QUEUEKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value>
--ledger] [--json] [-a <value>] [--name <value>] [--metadata <value>] [--reward <value>] [--minStake <value>]
[--oracleTimeout <value>] [--slashingEnabled] [--unpermissionedFeeds | --permissionedFeeds] [--unpermissionedVrf]
[--enableBufferRelayers] [--consecutiveFeedFailureLimit <value>] [--consecutiveOracleFailureLimit <value>]
ARGUMENTS
QUEUEKEY public key of the queue account
FLAGS
-a, --authority=<value> alternate keypair that is the authority for the queue and is required to
approve permissions
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--consecutiveFeedFailureLimit=<value> consecutive failure limit for a feed before feed permission is revoked.
--consecutiveOracleFailureLimit=<value> consecutive failure limit for an oracle before oracle permission is revoked.
--enableBufferRelayers enabling this setting will allow buffer relayer accounts to call openRound.
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--metadata=<value> metadata of the aggregator
--minStake=<value> the reward payed out to oracles for responding to an update request on-chain,
Ex: 2 requires oracles to have 2 wSOL in their staking wallet before
heartbeating
--name=<value> name of the aggregator
--oracleTimeout=<value> time period (in seconds) we should remove an oracle after if no response
--permissionedFeeds enabling this setting means data feeds need explicit permission to join the
queue.
--programId=<value> alternative Switchboard program ID to interact with
--reward=<value> the reward payed out to oracles for responding to an update request on-chain,
Ex: A reward of 0.0000075 with a feed with a batchSize of 4 would deduct (4 *
0.0000075) wSOL from an aggregators lease each round.
--slashingEnabled whether slashing is enabled on this queue.
--unpermissionedFeeds enabling this setting means data feeds do not need explicit permission to
join the queue.
--unpermissionedVrf enabling this setting means data feeds do not need explicit permission to
request VRF proofs and verifications from this queue.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
set an oracle queue's config
sbv2 solana vrf open-round VRFKEY
request a new vrf result from a set of oracles
USAGE
$ sbv2 solana vrf open-round VRFKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value>
--ledger] [--authority <value>]
ARGUMENTS
VRFKEY public key of the VRF account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--authority=<value> alternative keypair that is the VRF authority
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
request a new vrf result from a set of oracles
ALIASES
$ sbv2 solana vrf update
$ sbv2 solana vrf open-round
EXAMPLES
$ sbv2 solana vrf request
sbv2 solana vrf print VRFKEY
print a VRF and it's associated accounts
USAGE
$ sbv2 solana vrf print VRFKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [--json]
ARGUMENTS
VRFKEY public key of the VRF account
FLAGS
-h, --help Show CLI help.
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--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>
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
print a VRF and it's associated accounts
sbv2 solana vrf request VRFKEY
request a new vrf result from a set of oracles
USAGE
$ sbv2 solana vrf request VRFKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value>
--ledger] [--authority <value>]
ARGUMENTS
VRFKEY public key of the VRF account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--authority=<value> alternative keypair that is the VRF authority
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
request a new vrf result from a set of oracles
ALIASES
$ sbv2 solana vrf update
$ sbv2 solana vrf open-round
EXAMPLES
$ sbv2 solana vrf request
sbv2 solana vrf update VRFKEY
request a new vrf result from a set of oracles
USAGE
$ sbv2 solana vrf update VRFKEY [-h] [-v] [-s] [--mainnetBeta | --cluster devnet|mainnet-beta|mainnet|localnet] [-u
<value>] [--programId <value>] [--commitment confirmed|finalized|processed] [-k <value>] [--ledgerPath <value>
--ledger] [--authority <value>]
ARGUMENTS
VRFKEY public key of the VRF account
FLAGS
-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
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--authority=<value> alternative keypair that is the VRF authority
--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>
--ledger enable ledger support
--ledgerPath=<value> HID path to the ledger
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
request a new vrf result from a set of oracles
ALIASES
$ sbv2 solana vrf update
$ sbv2 solana vrf open-round
EXAMPLES
$ sbv2 solana vrf request