blockworks-foundation
/
sbv2-solana
mirror of https://github.com/blockworks-foundation/sbv2-solana.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cli docs

This commit is contained in:
Conner Gallagher 2022-06-07 21:32:17 -05:00
parent ec11e26b05
commit 49f6096934
20 changed files with 1901 additions and 4600 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2820
cli/README.md
View File

File diff suppressed because it is too large Load Diff

14
tools/scripts/generate-cli-docs.js
View File

@ -18,23 +18,15 @@ const projectRoot = path.join(__dirname, "..", "..");
const cliPath = path.join(projectRoot, "cli");
const cliOutPath = path.join(projectRoot, "website", "api", "cli");
const cliOutRelPath = path.relative(cliPath, cliOutPath);
const oclifBin = path.join(
projectRoot,
"cli",
"node_modules",
".bin",
"oclif-dev"
);
const oclifBin = path.join(projectRoot, "cli", "node_modules", ".bin", "oclif");
// Generate Oclif documentation
shell.cd(cliPath);
if (shell.exec(`npx oclif-dev readme`).code !== 0) {
if (shell.exec(`npx oclif readme`).code !== 0) {
shell.echo(`Error: Oclif failed to generate documentation`);
shell.exit(1);
}
if (
shell.exec(`npx oclif-dev readme --multi --dir ${cliOutRelPath}`).code !== 0
) {
if (shell.exec(`npx oclif readme --multi --dir ${cliOutRelPath}`).code !== 0) {
shell.echo(`Error: Oclif failed to generate documentation`);
shell.exit(1);
}

1464
website/api/cli/_aggregator.md
View File

File diff suppressed because it is too large Load Diff

52
website/api/cli/_config.md
View File

@ -1,68 +1,56 @@
print cli config
* [`sbv2 config:print`](#sbv2-configprint)
* [`sbv2 config:set PARAM [VALUE]`](#sbv2-configset-param-value)
* [`sbv2 config print`](#sbv2-config-print)
* [`sbv2 config set [PARAM] [VALUE]`](#sbv2-config-set-param-value)
## `sbv2 config:print`
## `sbv2 config print`
print cli config
```
USAGE
$ sbv2 config:print
$ sbv2 config print [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
print cli config
EXAMPLE
EXAMPLES
$ sbv2 config:print
```
_See code: [src/commands/config/print.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/config/print.ts)_
## `sbv2 config:set PARAM [VALUE]`
## `sbv2 config set [PARAM] [VALUE]`
set a configuration option
```
USAGE
$ sbv2 config:set PARAM [VALUE]
$ sbv2 config set [PARAM] [VALUE] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[-r]
ARGUMENTS
PARAM (devnet-rpc|mainnet-rpc) configuration parameter to set
VALUE value of the param to set
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-k, --keypair=<value> keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-r, --reset remove value or set to default rpc
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
set a configuration option
```
_See code: [src/commands/config/set.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/config/set.ts)_

209
website/api/cli/_crank.md
View File

@ -1,107 +1,184 @@
interact with a switchboard crank account
* [`sbv2 crank:list CRANKKEY`](#sbv2-cranklist-crankkey)
* [`sbv2 crank:push CRANKKEY AGGREGATORKEY`](#sbv2-crankpush-crankkey-aggregatorkey)
* [`sbv2 crank:turn CRANKKEY`](#sbv2-crankturn-crankkey)
* [`sbv2 crank add aggregator [CRANKKEY] [AGGREGATORKEY]`](#sbv2-crank-add-aggregator-crankkey-aggregatorkey)
* [`sbv2 crank create [QUEUEKEY]`](#sbv2-crank-create-queuekey)
* [`sbv2 crank list [CRANKKEY]`](#sbv2-crank-list-crankkey)
* [`sbv2 crank print [CRANKKEY]`](#sbv2-crank-print-crankkey)
* [`sbv2 crank push [CRANKKEY] [AGGREGATORKEY]`](#sbv2-crank-push-crankkey-aggregatorkey)
* [`sbv2 crank turn [CRANKKEY]`](#sbv2-crank-turn-crankkey)
## `sbv2 crank:list CRANKKEY`
list the pubkeys currently on the crank
```
USAGE
$ sbv2 crank:list CRANKKEY
ARGUMENTS
CRANKKEY public key of the crank
OPTIONS
-f, --outputFile=outputFile output file to save aggregator pubkeys to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite output file if exists
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
```
_See code: [src/commands/crank/list.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/crank/list.ts)_
## `sbv2 crank:push CRANKKEY AGGREGATORKEY`
## `sbv2 crank add aggregator [CRANKKEY] [AGGREGATORKEY]`
push an aggregator onto a crank
```
USAGE
$ sbv2 crank:push CRANKKEY AGGREGATORKEY
$ sbv2 crank add aggregator [CRANKKEY] [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k
<value>]
ARGUMENTS
CRANKKEY public key of the crank
AGGREGATORKEY public key of the aggregator
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
push an aggregator onto a crank
ALIASES
$ sbv2 aggregator:add:crank
$ sbv2 crank:add:aggregator
$ sbv2 aggregator add crank
$ sbv2 crank add aggregator
```
_See code: [src/commands/crank/push.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/crank/push.ts)_
## `sbv2 crank create [QUEUEKEY]`
## `sbv2 crank:turn CRANKKEY`
add a crank to an existing oracle queue
```
USAGE
$ sbv2 crank create [QUEUEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>] [-n
<value>] [-r <value>] [--queueAuthority <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue to create a crank on
FLAGS
-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
-r, --maxRows=<value> maximum number of rows a crank can support
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--queueAuthority=<value> alternative keypair to use for queue authority
DESCRIPTION
add a crank to an existing oracle queue
EXAMPLES
$ sbv2 queue:add:crank 5aYuxRdcB9GpWrEXVMBQp2R5uf94uoBiFdMEBwcmHuU4 -k ../authority-keypair.json -n crank-1
```
## `sbv2 crank list [CRANKKEY]`
list the pubkeys currently on the crank
```
USAGE
$ sbv2 crank list [CRANKKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[--force] [-f <value>]
ARGUMENTS
CRANKKEY public key of the crank
FLAGS
-f, --outputFile=<value> output file to save aggregator pubkeys to
-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
--force overwrite output file if exists
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
list the pubkeys currently on the crank
```
## `sbv2 crank print [CRANKKEY]`
print deserialized switchboard crank account
```
USAGE
$ sbv2 crank print [CRANKKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
CRANKKEY public key of the crank account to deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
print deserialized switchboard crank account
ALIASES
$ sbv2 crank print
EXAMPLES
$ sbv2 crank:print 85L2cFUvXaeGQ4HrzP8RJEVCL7WvRrXM2msvEmQ82AVr
```
## `sbv2 crank push [CRANKKEY] [AGGREGATORKEY]`
push an aggregator onto a crank
```
USAGE
$ sbv2 crank push [CRANKKEY] [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k
<value>]
ARGUMENTS
CRANKKEY public key of the crank
AGGREGATORKEY public key of the aggregator
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
push an aggregator onto a crank
ALIASES
$ sbv2 aggregator add crank
$ sbv2 crank add aggregator
```
## `sbv2 crank turn [CRANKKEY]`
turn the crank and get rewarded if aggregator updates available
```
USAGE
$ sbv2 crank:turn CRANKKEY
$ sbv2 crank turn [CRANKKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
CRANKKEY public key of the crank to turn
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
turn the crank and get rewarded if aggregator updates available
EXAMPLE
EXAMPLES
$ sbv2 crank:turn 85L2cFUvXaeGQ4HrzP8RJEVCL7WvRrXM2msvEmQ82AVr --keypair ../payer-keypair.json
```
_See code: [src/commands/crank/turn.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/crank/turn.ts)_

7
website/api/cli/_help.md
View File

@ -9,13 +9,16 @@ Display help for sbv2.
```
USAGE
$ sbv2 help [COMMAND]
$ sbv2 help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
OPTIONS
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for sbv2.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_

171
website/api/cli/_job.md
View File

@ -1,167 +1,62 @@
interact with a switchboard job account
* [`sbv2 job:create JOBDEFINITION`](#sbv2-jobcreate-jobdefinition)
* [`sbv2 job:create:copy JOBSOURCE`](#sbv2-jobcreatecopy-jobsource)
* [`sbv2 job:create:json DEFINITIONFILE`](#sbv2-jobcreatejson-definitionfile)
* [`sbv2 job:create:template TEMPLATE ID`](#sbv2-jobcreatetemplate-template-id)
* [`sbv2 job create JOBDEFINITION`](#sbv2-job-create-jobdefinition)
* [`sbv2 job print [JOBKEY]`](#sbv2-job-print-jobkey)
## `sbv2 job:create JOBDEFINITION`
## `sbv2 job create JOBDEFINITION`
create a buffer relayer account
```
USAGE
$ sbv2 job:create JOBDEFINITION
$ sbv2 job create [JOBDEFINITION] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[-a <value>] [-n <value>]
ARGUMENTS
JOBDEFINITION filesystem path to job definition
OPTIONS
-a, --authority=authority alternate keypair that will be the aggregator authority
-h, --help show CLI help
FLAGS
-a, --authority=<value> alternate keypair that will be the aggregator authority
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the buffer account
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
create a buffer relayer account
```
_See code: [src/commands/job/create/index.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/job/create/index.ts)_
## `sbv2 job print [JOBKEY]`
## `sbv2 job:create:copy JOBSOURCE`
copy a job account
Print the deserialized Switchboard job account
```
USAGE
$ sbv2 job:create:copy JOBSOURCE
$ sbv2 job print [JOBKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
JOBSOURCE public key of the aggregator account to copy
JOBKEY public key of the job account to deserialize
OPTIONS
-f, --outputFile=outputFile output file to save job definition to
-h, --help show CLI help
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force skip job confirmation
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
EXAMPLE
$ sbv2 job:create:copy 7pdb5RVM6cVBU8XDfpGqakb1S4wX2i5QsZxT117tK4HS --keypair ../payer-keypair.json
```
_See code: [src/commands/job/create/copy.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/job/create/copy.ts)_
## `sbv2 job:create:json DEFINITIONFILE`
create a job from a json file
```
USAGE
$ sbv2 job:create:json DEFINITIONFILE
ARGUMENTS
DEFINITIONFILE filesystem path of job definition json file
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account
authority if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--aggregatorAuthority=aggregatorAuthority filesystem path of aggregator authority keypair to add job account to
--aggregatorKey=aggregatorKey public key of aggregator to add job to
--force overwrite output file
--mainnetBeta WARNING: use mainnet-beta solana cluster
--outputFile=outputFile output job schema to a json file
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard job account
ALIASES
$ sbv2 json:create:job
EXAMPLE
$ sbv2 job:create:json examples/job.json --keypair ../payer-keypair.json
--aggregatorAuthority=../aggregator-keypair.json --outputFile=job.schema.json
```
_See code: [src/commands/job/create/json.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/job/create/json.ts)_
## `sbv2 job:create:template TEMPLATE ID`
create a new on-chain job account from an existing template
```
USAGE
$ sbv2 job:create:template TEMPLATE ID
ARGUMENTS
TEMPLATE the template type (ftxUs/coinbase/etc) or the filesystem path to the json file containing the task
definitions
ID api endpoint id for a given source
OPTIONS
-f, --outputFile=outputFile output file to save job definition to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-k, --outKeypair=outKeypair existing keypair file to store new account. useful for using the same public key on
different clusters
-n, --name=name name of the job account for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force skip job confirmation
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
$ sbv2 job print
EXAMPLES
$ sbv2 job:create:template ftxUs BTC_USD --keypair ../payer-keypair.json
$ sbv2 job:create:template ftxUs BTC_USD --keypair ../payer-keypair.json --name=ftxUs_Btc
$ sbv2 job:create:template ftxUs BTC_USD -k ../payer-keypair.json -n ftxUs_Btc -f ftx_us_btc_job.json
$ sbv2 job:print SzTvFZLz3hwjZFMwVWzuEnr1oUF6qyvXwXCvsqf7qeA
```
_See code: [src/commands/job/create/template.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/job/create/template.ts)_

149
website/api/cli/_json.md
View File

@ -1,149 +0,0 @@
create and manage an oracle queue from a json file
* [`sbv2 json:add:aggregator`](#sbv2-jsonaddaggregator)
* [`sbv2 json:add:crank SCHEMAFILE`](#sbv2-jsonaddcrank-schemafile)
* [`sbv2 json:add:oracle SCHEMAFILE`](#sbv2-jsonaddoracle-schemafile)
* [`sbv2 json:create:queue INPUTFILE OUTPUTFILE`](#sbv2-jsoncreatequeue-inputfile-outputfile)
## `sbv2 json:add:aggregator`
add an aggregator to a schema file
```
USAGE
$ sbv2 json:add:aggregator
OPTIONS
-a, --authority=authority alternate keypair that is the authority for the oracle queue
-a, --schema=schema filesystem path for an oracle queue schema
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority
if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--aggregatorFile=aggregatorFile filesystem path of job json definition file
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
--sourceAggregator=sourceAggregator public key of an existing aggregator account to copy
```
_See code: [src/commands/json/add/aggregator.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/json/add/aggregator.ts)_
## `sbv2 json:add:crank SCHEMAFILE`
add a crank to a schema file
```
USAGE
$ sbv2 json:add:crank SCHEMAFILE
ARGUMENTS
SCHEMAFILE filesystem path for an oracle queue schema
OPTIONS
-a, --authority=authority alternate keypair that is the authority for the oracle queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the crank for easier identification
-r, --maxRows=maxRows maximum number of rows a crank can support
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
```
_See code: [src/commands/json/add/crank.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/json/add/crank.ts)_
## `sbv2 json:add:oracle SCHEMAFILE`
add an oracle to a schema file
```
USAGE
$ sbv2 json:add:oracle SCHEMAFILE
ARGUMENTS
SCHEMAFILE filesystem path for an oracle queue schema
OPTIONS
-a, --authority=authority alternate keypair that is the authority for the oracle queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the crank for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
```
_See code: [src/commands/json/add/oracle.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/json/add/oracle.ts)_
## `sbv2 json:create:queue INPUTFILE OUTPUTFILE`
create an oracle queue from a json file
```
USAGE
$ sbv2 json:create:queue INPUTFILE OUTPUTFILE
ARGUMENTS
INPUTFILE filesystem path of queue definition json file
OUTPUTFILE filesystem path of output file to quickly load the queue
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--authority=authority alternate keypair that will be the authority for any created accounts
--force overwrite output file
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
ALIASES
$ sbv2 queue:create:json
EXAMPLE
$ sbv2 json:create:queue examples/queue.json queue-1.json -k ../authority-keypair.json
```
_See code: [src/commands/json/create/queue.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/json/create/queue.ts)_

118
website/api/cli/_lease.md
View File

@ -1,129 +1,107 @@
interact with a switchboard lease account
* [`sbv2 lease:create AGGREGATORKEY`](#sbv2-leasecreate-aggregatorkey)
* [`sbv2 lease:extend AGGREGATORKEY`](#sbv2-leaseextend-aggregatorkey)
* [`sbv2 lease:withdraw AGGREGATORKEY`](#sbv2-leasewithdraw-aggregatorkey)
* [`sbv2 lease create [AGGREGATORKEY]`](#sbv2-lease-create-aggregatorkey)
* [`sbv2 lease extend [AGGREGATORKEY]`](#sbv2-lease-extend-aggregatorkey)
* [`sbv2 lease withdraw [AGGREGATORKEY]`](#sbv2-lease-withdraw-aggregatorkey)
## `sbv2 lease:create AGGREGATORKEY`
## `sbv2 lease create [AGGREGATORKEY]`
fund and re-enable an aggregator lease
```
USAGE
$ sbv2 lease:create AGGREGATORKEY
$ sbv2 lease create [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[--amount <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator to extend a lease for
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=amount token amount to load into the lease escrow. If decimals provided, amount will be normalized to
--amount=<value> token amount to load into the lease escrow. If decimals provided, amount will be normalized to
raw tokenAmount
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
fund and re-enable an aggregator lease
ALIASES
$ sbv2 aggregator:lease:create
$ sbv2 aggregator lease create
EXAMPLE
EXAMPLES
$ sbv2 lease:create GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.5 --keypair ../payer-keypair.json
```
_See code: [src/commands/lease/create.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/lease/create.ts)_
## `sbv2 lease:extend AGGREGATORKEY`
## `sbv2 lease extend [AGGREGATORKEY]`
fund and re-enable an aggregator lease
```
USAGE
$ sbv2 lease:extend AGGREGATORKEY
$ sbv2 lease extend [AGGREGATORKEY] --amount <value> [-v] [-s] [--mainnetBeta] [-u <value>] [--programId
<value>] [-k <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator to extend a lease for
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=amount (required) token amount to load into the lease escrow. If decimals provided, amount will be
--amount=<value> (required) token amount to load into the lease escrow. If decimals provided, amount will be
normalized to raw tokenAmount
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
fund and re-enable an aggregator lease
ALIASES
$ sbv2 aggregator:lease:extend
$ sbv2 aggregator lease extend
EXAMPLE
$ sbv2 aggregator:lease:extend GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair
../payer-keypair.json
EXAMPLES
$ sbv2 aggregator:lease:extend GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
```
_See code: [src/commands/lease/extend.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/lease/extend.ts)_
## `sbv2 lease:withdraw AGGREGATORKEY`
## `sbv2 lease withdraw [AGGREGATORKEY]`
withdraw funds from an aggregator lease
```
USAGE
$ sbv2 lease:withdraw AGGREGATORKEY
$ sbv2 lease withdraw [AGGREGATORKEY] --amount <value> [-v] [-s] [--mainnetBeta] [-u <value>] [--programId
<value>] [-k <value>] [--withdrawAddress <value>] [-a <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator to extend a lease for
OPTIONS
-a, --authority=authority keypair delegated as the authority for managing the oracle account
-h, --help show CLI help
FLAGS
-a, --authority=<value> keypair delegated as the authority for managing the oracle account
-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. If decimals provided, amount will
be normalized to raw tokenAmount
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--withdrawAddress=<value> tokenAccount to withdraw to. If not provided, payer associated token account will be used
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority
if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--amount=amount (required) token amount to withdraw from lease account. If decimals provided,
amount will be normalized to raw tokenAmount
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
--withdrawAddress=withdrawAddress tokenAccount to withdraw to. If not provided, payer associated token account will
be used
DESCRIPTION
withdraw funds from an aggregator lease
ALIASES
$ sbv2 aggregator:lease:withdraw
$ sbv2 aggregator lease withdraw
EXAMPLE
$ sbv2 aggregator:lease:withdraw GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair
../payer-keypair.json
EXAMPLES
$ sbv2 aggregator:lease:withdraw GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR --amount 1.1 --keypair ../payer-keypair.json
```
_See code: [src/commands/lease/withdraw.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/lease/withdraw.ts)_

39
website/api/cli/_localnet.md
View File

@ -1,35 +1,28 @@
create a localnet switchboard environment
* [`sbv2 localnet:env`](#sbv2-localnetenv)
* [`sbv2 localnet env`](#sbv2-localnet-env)
## `sbv2 localnet:env`
## `sbv2 localnet env`
create a localnet switchboard environment
```
USAGE
$ sbv2 localnet:env
$ sbv2 localnet env [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>] [--force] [-o
<value>]
OPTIONS
-h, --help show CLI help
FLAGS
-k, --keypair=<value> keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-o, --outputDir=<value> output directory for scripts
-s, --silent suppress cli prompts
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--force overwrite output file if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-o, --outputDir=outputDir output directory for scripts
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite output file if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
create a localnet switchboard environment
```
_See code: [src/commands/localnet/env.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/localnet/env.ts)_

300
website/api/cli/_oracle.md
View File

@ -1,225 +1,281 @@
interact with a switchboard oracle account
* [`sbv2 oracle:balance ORACLEKEY`](#sbv2-oraclebalance-oraclekey)
* [`sbv2 oracle:create QUEUEKEY`](#sbv2-oraclecreate-queuekey)
* [`sbv2 oracle:deposit ORACLEKEY`](#sbv2-oracledeposit-oraclekey)
* [`sbv2 oracle:nonce ORACLEKEY`](#sbv2-oraclenonce-oraclekey)
* [`sbv2 oracle:permission:create ORACLEKEY`](#sbv2-oraclepermissioncreate-oraclekey)
* [`sbv2 oracle:withdraw ORACLEKEY`](#sbv2-oraclewithdraw-oraclekey)
* [`sbv2 oracle balance [ORACLEKEY]`](#sbv2-oracle-balance-oraclekey)
* [`sbv2 oracle create [QUEUEKEY]`](#sbv2-oracle-create-queuekey)
* [`sbv2 oracle deposit [ORACLEKEY]`](#sbv2-oracle-deposit-oraclekey)
* [`sbv2 oracle nonce [ORACLEKEY]`](#sbv2-oracle-nonce-oraclekey)
* [`sbv2 oracle permission create [ORACLEKEY]`](#sbv2-oracle-permission-create-oraclekey)
* [`sbv2 oracle permission print [ORACLEKEY]`](#sbv2-oracle-permission-print-oraclekey)
* [`sbv2 oracle print [ORACLEKEY]`](#sbv2-oracle-print-oraclekey)
* [`sbv2 oracle print permission [ORACLEKEY]`](#sbv2-oracle-print-permission-oraclekey)
* [`sbv2 oracle withdraw [ORACLEKEY]`](#sbv2-oracle-withdraw-oraclekey)
## `sbv2 oracle:balance ORACLEKEY`
## `sbv2 oracle balance [ORACLEKEY]`
check an oracles token balance
```
USAGE
$ sbv2 oracle:balance ORACLEKEY
$ sbv2 oracle balance [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle to check token balance
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
check an oracles token balance
EXAMPLE
EXAMPLES
$ sbv2 oracle:balance 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
_See code: [src/commands/oracle/balance.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/oracle/balance.ts)_
## `sbv2 oracle:create QUEUEKEY`
## `sbv2 oracle create [QUEUEKEY]`
create a new oracle account for a given queue
```
USAGE
$ sbv2 oracle:create QUEUEKEY
$ sbv2 oracle create [QUEUEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>] [-n
<value>] [-a <value>] [--enable] [--queueAuthority <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue to join
OPTIONS
-a, --authority=authority keypair to delegate authority to for managing the oracle account
-h, --help show CLI help
FLAGS
-a, --authority=<value> keypair to delegate authority to for managing the oracle account
-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
--enable enable oracle heartbeat permissions
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--queueAuthority=<value> alternative keypair to use for queue authority
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if
no alternate authority provided
-n, --name=name name of the oracle for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--enable enable oracle heartbeat permissions
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
--queueAuthority=queueAuthority alternative keypair to use for queue authority
DESCRIPTION
create a new oracle account for a given queue
EXAMPLES
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --keypair ../payer-and-authority-keypair.json
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --name=oracle-1 --keypair
../payer-and-authority-keypair.json
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --keypair ../payer-keypair.json --authority
../oracle-keypair.json
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --name=oracle-1 --keypair ../payer-and-authority-keypair.json
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --keypair ../payer-keypair.json --authority ../oracle-keypair.json
```
_See code: [src/commands/oracle/create.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/oracle/create.ts)_
## `sbv2 oracle:deposit ORACLEKEY`
## `sbv2 oracle deposit [ORACLEKEY]`
deposit tokens into an oracle's token wallet
```
USAGE
$ sbv2 oracle:deposit ORACLEKEY
$ sbv2 oracle deposit [ORACLEKEY] --amount <value> [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>]
[-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle to deposit funds into
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--amount=amount (required) token amount to load into the oracle escrow. If decimals provided, amount will be
--amount=<value> (required) token amount to load into the oracle escrow. If decimals provided, amount will be
normalized to raw tokenAmount
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
deposit tokens into an oracle's token wallet
EXAMPLE
EXAMPLES
$ sbv2 oracle:deposit 6kPsQoufdugtHLjM4fH7Z2fNv7jLt5pgvwKHt5JvRhQ6 2500 --keypair ../payer-keypair.json
```
_See code: [src/commands/oracle/deposit.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/oracle/deposit.ts)_
## `sbv2 oracle:nonce ORACLEKEY`
## `sbv2 oracle nonce [ORACLEKEY]`
view an oracles nonce accounts
```
USAGE
$ sbv2 oracle:nonce ORACLEKEY
$ sbv2 oracle nonce [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle to check token balance
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
view an oracles nonce accounts
```
_See code: [src/commands/oracle/nonce/index.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/oracle/nonce/index.ts)_
## `sbv2 oracle:permission:create ORACLEKEY`
## `sbv2 oracle permission create [ORACLEKEY]`
create a permission account for an oracle
```
USAGE
$ sbv2 oracle:permission:create ORACLEKEY
$ sbv2 oracle permission create [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle account
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
create a permission account for an oracle
```
_See code: [src/commands/oracle/permission/create.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/oracle/permission/create.ts)_
## `sbv2 oracle permission print [ORACLEKEY]`
## `sbv2 oracle:withdraw ORACLEKEY`
Print the permission account associated with a Switchboard oracle account
```
USAGE
$ sbv2 oracle permission print [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle account to fetch permission account and deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
Print the permission account associated with a Switchboard oracle account
ALIASES
$ sbv2 oracle permission print
$ sbv2 oracle print permission
EXAMPLES
$ sbv2 oracle:permission:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
## `sbv2 oracle print [ORACLEKEY]`
Print the deserialized Switchboard oracle account
```
USAGE
$ sbv2 oracle print [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle account to deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard oracle account
ALIASES
$ sbv2 oracle print
EXAMPLES
$ sbv2 oracle:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
## `sbv2 oracle print permission [ORACLEKEY]`
Print the permission account associated with a Switchboard oracle account
```
USAGE
$ sbv2 oracle print permission [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle account to fetch permission account and deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
Print the permission account associated with a Switchboard oracle account
ALIASES
$ sbv2 oracle permission print
$ sbv2 oracle print permission
EXAMPLES
$ sbv2 oracle:permission:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
## `sbv2 oracle withdraw [ORACLEKEY]`
withdraw tokens from an oracle's token wallet
```
USAGE
$ sbv2 oracle:withdraw ORACLEKEY
$ sbv2 oracle withdraw [ORACLEKEY] --amount <value> [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>]
[-k <value>] [-f] [-w <value>] [-a <value>]
ARGUMENTS
ORACLEKEY public key of the oracle to withdraw from
OPTIONS
-a, --authority=authority keypair delegated as the authority for managing the oracle account
-f, --force skip minStake balance check. your oracle may be removed from the queue
-h, --help show CLI help
FLAGS
-a, --authority=<value> keypair delegated as the authority for managing the oracle account
-f, --force skip minStake balance check. your oracle may be removed from the queue
-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
-w, --withdrawAccount=<value> optional solana pubkey or keypair filesystem path to withdraw funds to. default
destination is oracle authority's token wallet
--amount=<value> (required) token amount to withdraw from oracle escrow. If decimals provided, amount
will be normalized to raw tokenAmount
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account
authority if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
-w, --withdrawAccount=withdrawAccount optional solana pubkey or keypair filesystem path to withdraw funds to. default
destination is oracle authority's token wallet
--amount=amount (required) token amount to withdraw from oracle escrow. If decimals provided,
amount will be normalized to raw tokenAmount
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
withdraw tokens from an oracle's token wallet
EXAMPLES
$ sbv2 oracle:withdraw 6kPsQoufdugtHLjM4fH7Z2fNv7jLt5pgvwKHt5JvRhQ6 2500 --keypair ../oracle-keypair.json
$ sbv2 oracle:withdraw 6kPsQoufdugtHLjM4fH7Z2fNv7jLt5pgvwKHt5JvRhQ6 2500 --keypair ../payer-keypair.json --authority
../oracle-keypair.json -w ByJs8E29jxvqf2KFLwfyiE2gUh5fivaS7aShcRMAsnzg
```
_See code: [src/commands/oracle/withdraw.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/oracle/withdraw.ts)_
$ sbv2 oracle:withdraw 6kPsQoufdugtHLjM4fH7Z2fNv7jLt5pgvwKHt5JvRhQ6 2500 --keypair ../payer-keypair.json --authority ../oracle-keypair.json -w ByJs8E29jxvqf2KFLwfyiE2gUh5fivaS7aShcRMAsnzg
```

91
website/api/cli/_permission.md
View File

@ -1,69 +1,88 @@
create a permission account
* [`sbv2 permission:create GRANTER GRANTEE`](#sbv2-permissioncreate-granter-grantee)
* [`sbv2 permission:set PERMISSIONKEY`](#sbv2-permissionset-permissionkey)
* [`sbv2 permission create [GRANTER] [GRANTEE]`](#sbv2-permission-create-granter-grantee)
* [`sbv2 permission print [PERMISSIONKEY]`](#sbv2-permission-print-permissionkey)
* [`sbv2 permission set [PERMISSIONKEY]`](#sbv2-permission-set-permissionkey)
## `sbv2 permission:create GRANTER GRANTEE`
## `sbv2 permission create [GRANTER] [GRANTEE]`
create a permission account
```
USAGE
$ sbv2 permission:create GRANTER GRANTEE
$ sbv2 permission create [GRANTER] [GRANTEE] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
GRANTER public key of the account granting permission
GRANTEE public key of the account getting permissions
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
create a permission account
```
_See code: [src/commands/permission/create.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/permission/create.ts)_
## `sbv2 permission print [PERMISSIONKEY]`
## `sbv2 permission:set PERMISSIONKEY`
Print the deserialized Switchboard permission account
```
USAGE
$ sbv2 permission print [PERMISSIONKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
PERMISSIONKEY public key of the permission account to deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard permission account
ALIASES
$ sbv2 permission print
EXAMPLES
$ sbv2 permission:print 94XXM72K2aKu2wcuJaawV8njuGaFZvhy8iKgPxoa1tJk
```
## `sbv2 permission set [PERMISSIONKEY]`
permit a grantee to use a granters resources
```
USAGE
$ sbv2 permission:set PERMISSIONKEY
$ sbv2 permission set [PERMISSIONKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[-a <value>] [--disable]
ARGUMENTS
PERMISSIONKEY public key of the permission account
OPTIONS
-a, --authority=authority alternate keypair that is the granters authority
-h, --help show CLI help
FLAGS
-a, --authority=<value> alternate keypair that is the granters authority
-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
--disable disable permissions
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--disable disable permissions
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
permit a grantee to use a granters resources
```
_See code: [src/commands/permission/set.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/permission/set.ts)_

427
website/api/cli/_print.md
View File

@ -1,494 +1,409 @@
find and print a switchboard account by public key for a given cluster
* [`sbv2 print PUBLICKEY`](#sbv2-print-publickey)
* [`sbv2 print:aggregator AGGREGATORKEY`](#sbv2-printaggregator-aggregatorkey)
* [`sbv2 print:aggregator:history AGGREGATORKEY`](#sbv2-printaggregatorhistory-aggregatorkey)
* [`sbv2 print:aggregator:lease AGGREGATORKEY`](#sbv2-printaggregatorlease-aggregatorkey)
* [`sbv2 print:aggregator:permission AGGREGATORKEY`](#sbv2-printaggregatorpermission-aggregatorkey)
* [`sbv2 print:crank CRANKKEY`](#sbv2-printcrank-crankkey)
* [`sbv2 print:job JOBKEY`](#sbv2-printjob-jobkey)
* [`sbv2 print:job:templates`](#sbv2-printjobtemplates)
* [`sbv2 print:json:samples OUTPUTDIRECTORY`](#sbv2-printjsonsamples-outputdirectory)
* [`sbv2 print:oracle ORACLEKEY`](#sbv2-printoracle-oraclekey)
* [`sbv2 print:oracle:permission ORACLEKEY`](#sbv2-printoraclepermission-oraclekey)
* [`sbv2 print:program`](#sbv2-printprogram)
* [`sbv2 print:queue QUEUEKEY`](#sbv2-printqueue-queuekey)
* [`sbv2 print:vrf VRFKEY`](#sbv2-printvrf-vrfkey)
* [`sbv2 print [PUBLICKEY]`](#sbv2-print-publickey)
* [`sbv2 print aggregator [AGGREGATORKEY]`](#sbv2-print-aggregator-aggregatorkey)
* [`sbv2 print aggregator history [AGGREGATORKEY]`](#sbv2-print-aggregator-history-aggregatorkey)
* [`sbv2 print aggregator lease [AGGREGATORKEY]`](#sbv2-print-aggregator-lease-aggregatorkey)
* [`sbv2 print aggregator permission [AGGREGATORKEY]`](#sbv2-print-aggregator-permission-aggregatorkey)
* [`sbv2 print crank [CRANKKEY]`](#sbv2-print-crank-crankkey)
* [`sbv2 print job [JOBKEY]`](#sbv2-print-job-jobkey)
* [`sbv2 print oracle [ORACLEKEY]`](#sbv2-print-oracle-oraclekey)
* [`sbv2 print oracle permission [ORACLEKEY]`](#sbv2-print-oracle-permission-oraclekey)
* [`sbv2 print permission [PERMISSIONKEY]`](#sbv2-print-permission-permissionkey)
* [`sbv2 print program`](#sbv2-print-program)
* [`sbv2 print queue [QUEUEKEY]`](#sbv2-print-queue-queuekey)
* [`sbv2 print vrf [VRFKEY]`](#sbv2-print-vrf-vrfkey)
## `sbv2 print PUBLICKEY`
## `sbv2 print [PUBLICKEY]`
find a switchboard account by public key for a given cluster
```
USAGE
$ sbv2 print PUBLICKEY
$ sbv2 print [PUBLICKEY] [-h] [-v]
ARGUMENTS
PUBLICKEY public key of a switchboard account to lookup
OPTIONS
-h, --help show CLI help
FLAGS
-h, --help Show CLI help.
-v, --verbose log everything
EXAMPLE
DESCRIPTION
find a switchboard account by public key for a given cluster
EXAMPLES
$ sbv2 print GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U
```
_See code: [src/commands/print/index.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/index.ts)_
_See code: [dist/commands/print/index.ts](https://github.com/switchboard-xyz/switchboard-v2/blob/v0.2.0/dist/commands/print/index.ts)_
## `sbv2 print:aggregator AGGREGATORKEY`
## `sbv2 print aggregator [AGGREGATORKEY]`
Print the deserialized Switchboard aggregator account
```
USAGE
$ sbv2 print:aggregator AGGREGATORKEY
$ sbv2 print aggregator [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[--jobs] [-o]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-k, --keypair=<value> keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-o, --oraclePubkeysData print the assigned oracles for the current round
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--jobs output job definitions
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard aggregator account
ALIASES
$ sbv2 aggregator:print
$ sbv2 aggregator print
EXAMPLE
EXAMPLES
$ sbv2 aggregator:print GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR
```
_See code: [src/commands/print/aggregator.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/aggregator.ts)_
## `sbv2 print:aggregator:history AGGREGATORKEY`
## `sbv2 print aggregator history [AGGREGATORKEY]`
Print the history buffer associated with an aggregator account
```
USAGE
$ sbv2 print:aggregator:history AGGREGATORKEY
$ sbv2 print aggregator history [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k
<value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to fetch permission account and deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the history buffer associated with an aggregator account
ALIASES
$ sbv2 aggregator:history:print
$ sbv2 aggregator:print:history
$ sbv2 aggregator history print
$ sbv2 aggregator print history
EXAMPLE
EXAMPLES
$ sbv2 aggregator:print:history 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
_See code: [src/commands/print/aggregator/history.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/aggregator/history.ts)_
## `sbv2 print:aggregator:lease AGGREGATORKEY`
## `sbv2 print aggregator lease [AGGREGATORKEY]`
Print the lease account associated with a Switchboard aggregator account
```
USAGE
$ sbv2 print:aggregator:lease AGGREGATORKEY
$ sbv2 print aggregator lease [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k
<value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to fetch permission account and deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the lease account associated with a Switchboard aggregator account
ALIASES
$ sbv2 aggregator:lease:print
$ sbv2 aggregator:print:lease
$ sbv2 aggregator lease print
$ sbv2 aggregator print lease
EXAMPLE
EXAMPLES
$ sbv2 aggregator:lease:print 8SXvChNYFhRq4EZuZvnhjrB3jJRQCv4k3P4W6hesH3Ee
```
_See code: [src/commands/print/aggregator/lease.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/aggregator/lease.ts)_
## `sbv2 print:aggregator:permission AGGREGATORKEY`
## `sbv2 print aggregator permission [AGGREGATORKEY]`
Print the permission account associated with a Switchboard aggregator account
```
USAGE
$ sbv2 print:aggregator:permission AGGREGATORKEY
$ sbv2 print aggregator permission [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k
<value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to fetch permission account and deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the permission account associated with a Switchboard aggregator account
ALIASES
$ sbv2 aggregator:permission:print
$ sbv2 aggregator:print:permission
$ sbv2 aggregator permission print
$ sbv2 aggregator print permission
EXAMPLE
EXAMPLES
$ sbv2 aggregator:permission:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
_See code: [src/commands/print/aggregator/permission.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/aggregator/permission.ts)_
## `sbv2 print:crank CRANKKEY`
## `sbv2 print crank [CRANKKEY]`
print deserialized switchboard crank account
```
USAGE
$ sbv2 print:crank CRANKKEY
$ sbv2 print crank [CRANKKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
CRANKKEY public key of the crank account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
print deserialized switchboard crank account
ALIASES
$ sbv2 crank:print
$ sbv2 crank print
EXAMPLE
EXAMPLES
$ sbv2 crank:print 85L2cFUvXaeGQ4HrzP8RJEVCL7WvRrXM2msvEmQ82AVr
```
_See code: [src/commands/print/crank.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/crank.ts)_
## `sbv2 print:job JOBKEY`
## `sbv2 print job [JOBKEY]`
Print the deserialized Switchboard job account
```
USAGE
$ sbv2 print:job JOBKEY
$ sbv2 print job [JOBKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
JOBKEY public key of the job account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard job account
ALIASES
$ sbv2 job:print
$ sbv2 job print
EXAMPLE
EXAMPLES
$ sbv2 job:print SzTvFZLz3hwjZFMwVWzuEnr1oUF6qyvXwXCvsqf7qeA
```
_See code: [src/commands/print/job.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/job.ts)_
## `sbv2 print:job:templates`
list available templates to build a job from
```
USAGE
$ sbv2 print:job:templates
ALIASES
$ sbv2 job:print:templates
```
_See code: [src/commands/print/job/templates.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/job/templates.ts)_
## `sbv2 print:json:samples OUTPUTDIRECTORY`
write sample definition files to a directory
```
USAGE
$ sbv2 print:json:samples OUTPUTDIRECTORY
ARGUMENTS
OUTPUTDIRECTORY filesystem path to output sample definition files
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
ALIASES
$ sbv2 json:samples
$ sbv2 write:json:samples
EXAMPLES
$ sbv2 print:json:samples ~/switchboard_json_samples
$ sbv2 json:samples ~/switchboard_json_samples
$ sbv2 write:json:samples ~/switchboard_json_samples
```
_See code: [src/commands/print/json/samples.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/json/samples.ts)_
## `sbv2 print:oracle ORACLEKEY`
## `sbv2 print oracle [ORACLEKEY]`
Print the deserialized Switchboard oracle account
```
USAGE
$ sbv2 print:oracle ORACLEKEY
$ sbv2 print oracle [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard oracle account
ALIASES
$ sbv2 oracle:print
$ sbv2 oracle print
EXAMPLE
EXAMPLES
$ sbv2 oracle:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
_See code: [src/commands/print/oracle.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/oracle.ts)_
## `sbv2 print:oracle:permission ORACLEKEY`
## `sbv2 print oracle permission [ORACLEKEY]`
Print the permission account associated with a Switchboard oracle account
```
USAGE
$ sbv2 print:oracle:permission ORACLEKEY
$ sbv2 print oracle permission [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle account to fetch permission account and deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the permission account associated with a Switchboard oracle account
ALIASES
$ sbv2 oracle:permission:print
$ sbv2 oracle:print:permission
$ sbv2 oracle permission print
$ sbv2 oracle print permission
EXAMPLE
EXAMPLES
$ sbv2 oracle:permission:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
```
_See code: [src/commands/print/oracle/permission.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/oracle/permission.ts)_
## `sbv2 print permission [PERMISSIONKEY]`
## `sbv2 print:program`
Print the deserialized Switchboard permission account
```
USAGE
$ sbv2 print permission [PERMISSIONKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
PERMISSIONKEY public key of the permission account to deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard permission account
ALIASES
$ sbv2 permission print
EXAMPLES
$ sbv2 permission:print 94XXM72K2aKu2wcuJaawV8njuGaFZvhy8iKgPxoa1tJk
```
## `sbv2 print program`
print the deserialized switchboard program state account
```
USAGE
$ sbv2 print:program
$ sbv2 print program [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
print the deserialized switchboard program state account
ALIASES
$ sbv2 program:print
$ sbv2 program print
EXAMPLE
EXAMPLES
$ sbv2 program:print
```
_See code: [src/commands/print/program.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/program.ts)_
## `sbv2 print:queue QUEUEKEY`
## `sbv2 print queue [QUEUEKEY]`
Print the deserialized Switchboard oraclequeue account
```
USAGE
$ sbv2 print:queue QUEUEKEY
$ sbv2 print queue [QUEUEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[--oracles]
ARGUMENTS
QUEUEKEY public key of the oracle queue account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--oracles output oracles that are heartbeating on the queue
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard oraclequeue account
ALIASES
$ sbv2 queue:print
$ sbv2 queue print
EXAMPLE
EXAMPLES
$ sbv2 queue:print GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U
```
_See code: [src/commands/print/queue.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/queue.ts)_
## `sbv2 print:vrf VRFKEY`
## `sbv2 print vrf [VRFKEY]`
Print the deserialized Switchboard VRF account
```
USAGE
$ sbv2 print:vrf VRFKEY
$ sbv2 print vrf [VRFKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
VRFKEY public key of the vrf account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard VRF account
ALIASES
$ sbv2 vrf print
EXAMPLES
$ sbv2 vrf:print
EXAMPLE
$ sbv2 vrf:print SzTvFZLz3hwjZFMwVWzuEnr1oUF6qyvXwXCvsqf7qeA
```
_See code: [src/commands/print/vrf.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/print/vrf.ts)_

266
website/api/cli/_queue.md
View File

@ -1,234 +1,132 @@
interact with a switchboard oracle queue account
* [`sbv2 queue:add:crank QUEUEKEY`](#sbv2-queueaddcrank-queuekey)
* [`sbv2 queue:create`](#sbv2-queuecreate)
* [`sbv2 queue:permit:aggregator AGGREGATORKEY`](#sbv2-queuepermitaggregator-aggregatorkey)
* [`sbv2 queue:permit:oracle ORACLEKEY`](#sbv2-queuepermitoracle-oraclekey)
* [`sbv2 queue:set:rewards QUEUEKEY REWARDS`](#sbv2-queuesetrewards-queuekey-rewards)
* [`sbv2 queue:set:vrf QUEUEKEY`](#sbv2-queuesetvrf-queuekey)
* [`sbv2 queue create`](#sbv2-queue-create)
* [`sbv2 queue print [QUEUEKEY]`](#sbv2-queue-print-queuekey)
* [`sbv2 queue set rewards [QUEUEKEY] [REWARDS]`](#sbv2-queue-set-rewards-queuekey-rewards)
* [`sbv2 queue set vrf [QUEUEKEY]`](#sbv2-queue-set-vrf-queuekey)
## `sbv2 queue:add:crank QUEUEKEY`
add a crank to an existing oracle queue
```
USAGE
$ sbv2 queue:add:crank QUEUEKEY
ARGUMENTS
QUEUEKEY public key of the oracle queue to create a crank on
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if
no alternate authority provided
-n, --name=name name of the crank for easier identification
-r, --maxRows=maxRows maximum number of rows a crank can support
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
--queueAuthority=queueAuthority alternative keypair to use for queue authority
EXAMPLE
$ sbv2 queue:add:crank 5aYuxRdcB9GpWrEXVMBQp2R5uf94uoBiFdMEBwcmHuU4 -k ../authority-keypair.json -n crank-1
```
_See code: [src/commands/queue/add/crank.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/queue/add/crank.ts)_
## `sbv2 queue:create`
## `sbv2 queue create`
create a custom queue
```
USAGE
$ sbv2 queue:create
$ sbv2 queue create [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>] [--force] [-a
<value>] [-n <value>] [--minStake <value>] [-r <value>] [-c <value>] [-o <value>] [-o <value>] [--queueSize <value>]
[--unpermissionedFeeds] [--unpermissionedVrf] [--enableBufferRelayers] [-f <value>]
OPTIONS
-a, --authority=authority keypair to delegate authority to for creating permissions targeted at the queue
-c, --crankSize=crankSize [default: 100] size of the crank
-f, --outputFile=outputFile output queue schema to a json file
-h, --help show CLI help
FLAGS
-a, --authority=<value> keypair to delegate authority to for creating permissions targeted at the queue
-c, --crankSize=<value> [default: 100] size of the crank
-f, --outputFile=<value> output queue schema to a json file
-k, --keypair=<value> keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=<value> [default: Custom Queue] name of the queue for easier identification
-o, --numOracles=<value> number of oracles to add to the queue
-o, --oracleTimeout=<value> [default: 180] number of oracles to add to the queue
-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
--enableBufferRelayers enable oracles to fulfill buffer relayer requests
--force overwrite output file if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
--minStake=<value> [default: 0] minimum stake required by an oracle to join the queue
--programId=<value> alternative Switchboard program ID to interact with
--queueSize=<value> [default: 100] maximum number of oracles the queue can support
--unpermissionedFeeds permit unpermissioned feeds
--unpermissionedVrf permit unpermissioned VRF accounts
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority
if no alternate authority provided
-n, --name=name [default: Custom Queue] name of the queue for easier identification
-o, --numOracles=numOracles number of oracles to add to the queue
-o, --oracleTimeout=oracleTimeout [default: 180] number of oracles to add to the queue
-r, --reward=reward [default: 0] oracle rewards for successfully responding to an update request
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--enableBufferRelayers enable oracles to fulfill buffer relayer requests
--force overwrite output file if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
--minStake=minStake [default: 0] minimum stake required by an oracle to join the queue
--programId=programId alternative Switchboard program ID to interact with
--queueSize=queueSize [default: 100] maximum number of oracles the queue can support
--unpermissionedFeeds permit unpermissioned feeds
--unpermissionedVrf permit unpermissioned VRF accounts
DESCRIPTION
create a custom queue
ALIASES
$ sbv2 custom:queue
$ sbv2 custom queue
```
_See code: [src/commands/queue/create.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/queue/create.ts)_
## `sbv2 queue print [QUEUEKEY]`
## `sbv2 queue:permit:aggregator AGGREGATORKEY`
permit an aggregator to use an oracle queue's resources
Print the deserialized Switchboard oraclequeue account
```
USAGE
$ sbv2 queue:permit:aggregator AGGREGATORKEY
$ sbv2 queue print [QUEUEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[--oracles]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to authorize oracle queue usage
QUEUEKEY public key of the oracle queue account to deserialize
OPTIONS
-a, --authority=authority alternate keypair that is the authority for oracle queue
-h, --help show CLI help
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--oracles output oracles that are heartbeating on the queue
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
DESCRIPTION
Print the deserialized Switchboard oraclequeue account
-s, --silent suppress cli prompts
ALIASES
$ sbv2 queue print
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
EXAMPLE
$ sbv2 queue:permit:aggregator 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4 --keypair ../queue-authority.json
EXAMPLES
$ sbv2 queue:print GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U
```
_See code: [src/commands/queue/permit/aggregator.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/queue/permit/aggregator.ts)_
## `sbv2 queue:permit:oracle ORACLEKEY`
permit an oracle to heartbeat on a queue
```
USAGE
$ sbv2 queue:permit:oracle ORACLEKEY
ARGUMENTS
ORACLEKEY public key of the oracle account to authorize oracle queue usage
OPTIONS
-a, --authority=authority alternate keypair that is the authority for oracle queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
EXAMPLE
$ sbv2 queue:permit:oracle 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4 --keypair ../queue-authority.json
```
_See code: [src/commands/queue/permit/oracle.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/queue/permit/oracle.ts)_
## `sbv2 queue:set:rewards QUEUEKEY REWARDS`
## `sbv2 queue set rewards [QUEUEKEY] [REWARDS]`
set an oracle queue's rewards
```
USAGE
$ sbv2 queue:set:rewards QUEUEKEY REWARDS
$ sbv2 queue set rewards [QUEUEKEY] [REWARDS] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k
<value>] [-a <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue
REWARDS token rewards for each assigned oracle per open round call
OPTIONS
-a, --authority=authority alternate keypair that is the authority for oracle queue
-h, --help show CLI help
FLAGS
-a, --authority=<value> alternate keypair that is the authority for oracle queue
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
set an oracle queue's rewards
```
_See code: [src/commands/queue/set/rewards.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/queue/set/rewards.ts)_
## `sbv2 queue set vrf [QUEUEKEY]`
## `sbv2 queue:set:vrf QUEUEKEY`
add a crank to an existing oracle queue
set unpermissionedVrfEnabled
```
USAGE
$ sbv2 queue:set:vrf QUEUEKEY
$ sbv2 queue set vrf [QUEUEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>] [-a
<value>] [--disable]
ARGUMENTS
QUEUEKEY public key of the oracle queue to create a crank on
OPTIONS
-a, --authority=authority alternate keypair that is the authority for oracle queue
-h, --help show CLI help
FLAGS
-a, --authority=<value> alternate keypair that is the authority for oracle queue
-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
--disable disable unpermissionedVrfEnabled
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--disable disable unpermissionedVrfEnabled
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
set unpermissionedVrfEnabled
```
_See code: [src/commands/queue/set/vrf.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/queue/set/vrf.ts)_

24
website/api/cli/_sandbox.md
View File

@ -9,25 +9,21 @@ sandbox
```
USAGE
$ sbv2 sandbox [PLACEHOLDER]
$ sbv2 sandbox [PLACEHOLDER] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>] [-n
<value>]
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-k, --keypair=<value> keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the job account for easier identification
-n, --name=<value> name of the job account for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
sandbox
```
_See code: [src/commands/sandbox.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/sandbox.ts)_
_See code: [dist/commands/sandbox.ts](https://github.com/switchboard-xyz/switchboard-v2/blob/v0.2.0/dist/commands/sandbox.ts)_

24
website/api/cli/_test.md
View File

@ -1,34 +1,30 @@
sandbox
* [`sbv2 test ORACLEKEY`](#sbv2-test-oraclekey)
* [`sbv2 test [ORACLEKEY]`](#sbv2-test-oraclekey)
## `sbv2 test ORACLEKEY`
## `sbv2 test [ORACLEKEY]`
sandbox
```
USAGE
$ sbv2 test ORACLEKEY
$ sbv2 test [ORACLEKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
ORACLEKEY public key of the oracle to deposit funds into
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
sandbox
```
_See code: [src/commands/test.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/test.ts)_
_See code: [dist/commands/test.ts](https://github.com/switchboard-xyz/switchboard-v2/blob/v0.2.0/dist/commands/test.ts)_

31
website/api/cli/_update.md
View File

@ -9,10 +9,33 @@ update the sbv2 CLI
```
USAGE
$ sbv2 update [CHANNEL]
$ sbv2 update [CHANNEL] [-a] [-v <value> | -i] [--force]
OPTIONS
--from-local interactively choose an already installed version
FLAGS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the sbv2 CLI
EXAMPLES
Update to the stable channel:
$ sbv2 update stable
Update to a specific version:
$ sbv2 update --version 1.0.0
Interactively select version:
$ sbv2 update --interactive
See available versions:
$ sbv2 update --available
```
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.5.0/src/commands/update.ts)_
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.0.0/src/commands/update.ts)_

13
website/api/cli/_version.md Normal file
View File

@ -0,0 +1,13 @@
* [`sbv2 version`](#sbv2-version)
## `sbv2 version`
```
USAGE
$ sbv2 version
```
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.0.4/src/commands/version.ts)_

226
website/api/cli/_vrf.md
View File

@ -1,147 +1,169 @@
create a Switchboard VRF Account
* [`sbv2 vrf:create QUEUEKEY`](#sbv2-vrfcreate-queuekey)
* [`sbv2 vrf:create:example QUEUEKEY`](#sbv2-vrfcreateexample-queuekey)
* [`sbv2 vrf:request VRFKEY`](#sbv2-vrfrequest-vrfkey)
* [`sbv2 vrf create [QUEUEKEY]`](#sbv2-vrf-create-queuekey)
* [`sbv2 vrf create example [QUEUEKEY]`](#sbv2-vrf-create-example-queuekey)
* [`sbv2 vrf print [VRFKEY]`](#sbv2-vrf-print-vrfkey)
* [`sbv2 vrf request [VRFKEY]`](#sbv2-vrf-request-vrfkey)
* [`sbv2 vrf watch [VRFKEY]`](#sbv2-vrf-watch-vrfkey)
## `sbv2 vrf:create QUEUEKEY`
## `sbv2 vrf create [QUEUEKEY]`
create a Switchboard VRF Account
```
USAGE
$ sbv2 vrf:create QUEUEKEY
$ sbv2 vrf create [QUEUEKEY] -a <value> --callbackPid <value> --ixData <value> [-v] [-s] [--mainnetBeta] [-u
<value>] [--programId <value>] [-k <value>] [--vrfKeypair <value>] [--enable] [--authority <value>]
[--queueAuthority <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue to create VRF account for
OPTIONS
-a, --accountMeta=accountMeta (required) account metas for VRF callback
-h, --help show CLI help
FLAGS
-a, --accountMeta=<value>... (required) account metas for VRF callback
-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 to use for VRF authority
--callbackPid=<value> (required) callback program ID
--enable enable vrf permissions
--ixData=<value> (required) instruction data
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--queueAuthority=<value> alternative keypair to use for queue authority
--vrfKeypair=<value> filesystem path of existing keypair to use for VRF Account
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if
no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--authority=authority alternative keypair to use for VRF authority
--callbackPid=callbackPid (required) callback program ID
--enable enable vrf permissions
--ixData=ixData (required) instruction data
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
--queueAuthority=queueAuthority alternative keypair to use for queue authority
--vrfKeypair=vrfKeypair filesystem path of existing keypair to use for VRF Account
DESCRIPTION
create a Switchboard VRF Account
EXAMPLES
sbv2 vrf:create 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --keypair ../payer-keypair.json -v --enable
--queueAuthority queue-authority-keypair.json --callbackPid 6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --ixData
"[145,72,9,94,61,97,126,106]" -a "{"pubkey": "HpQoFL5kxPp2JCFvjsVTvBd7navx4THLefUU68SXAyd6","isSigner":
false,"isWritable": true}" -a "{"pubkey": "8VdBtS8ufkXMCa6Yr9E4KVCfX2inVZVwU4KGg2CL1q7P","isSigner":
false,"isWritable": false}"
sbv2 vrf:create 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --keypair ../payer-keypair.json -v --enable
--queueAuthority oracle-keypair.json --callbackPid 6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --ixData
"[145,72,9,94,61,97,126,106]" -a "{"pubkey": "HYKi1grticLXPe5vqapUHhm976brwqRob8vqRnWMKWL5","isSigner":
false,"isWritable": true}" -a "{"pubkey": "6vG9QLMgSvsfjvSpDxWfZ2MGPYGzEYoBxviLG7cr4go","isSigner":
false,"isWritable": false}"
$ sbv2 vrf:create 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --keypair ../payer-keypair.json -v --enable --queueAuthority queue-authority-keypair.json --callbackPid 6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --ixData "[145,72,9,94,61,97,126,106]" -a "{"pubkey": "HpQoFL5kxPp2JCFvjsVTvBd7navx4THLefUU68SXAyd6","isSigner": false,"isWritable": true}" -a "{"pubkey": "8VdBtS8ufkXMCa6Yr9E4KVCfX2inVZVwU4KGg2CL1q7P","isSigner": false,"isWritable": false}"
$ sbv2 vrf:create 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --keypair ../payer-keypair.json -v --enable --queueAuthority oracle-keypair.json --callbackPid 6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --ixData "[145,72,9,94,61,97,126,106]" -a "{"pubkey": "HYKi1grticLXPe5vqapUHhm976brwqRob8vqRnWMKWL5","isSigner": false,"isWritable": true}" -a "{"pubkey": "6vG9QLMgSvsfjvSpDxWfZ2MGPYGzEYoBxviLG7cr4go","isSigner": false,"isWritable": false}"
```
_See code: [src/commands/vrf/create/index.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/vrf/create/index.ts)_
## `sbv2 vrf:create:example QUEUEKEY`
## `sbv2 vrf create example [QUEUEKEY]`
create a VRF account for the client example program
```
USAGE
$ sbv2 vrf:create:example QUEUEKEY
$ sbv2 vrf create example [QUEUEKEY] --vrfPid <value> [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k
<value>] [--vrfKeypair <value>] [--enable] [--queueAuthority <value>] [--maxResult <value>]
ARGUMENTS
QUEUEKEY public key of the oracle queue to create VRF account for
OPTIONS
-h, --help show CLI help
FLAGS
-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
--enable enable vrf permissions
--mainnetBeta WARNING: use mainnet-beta solana cluster
--maxResult=<value> [default: 256000] the maximum VRF result
--programId=<value> alternative Switchboard program ID to interact with
--queueAuthority=<value> alternative keypair to use for queue authority
--vrfKeypair=<value> filesystem path of existing keypair to use for VRF Account
--vrfPid=<value> (required) program ID for the VRF example program
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if
no alternate authority provided
DESCRIPTION
create a VRF account for the client example program
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--enable enable vrf permissions
--mainnetBeta WARNING: use mainnet-beta solana cluster
--maxResult=maxResult [default: 256000] the maximum VRF result
--programId=programId alternative Switchboard program ID to interact with
--queueAuthority=queueAuthority alternative keypair to use for queue authority
--vrfKeypair=vrfKeypair filesystem path of existing keypair to use for VRF Account
--vrfPid=vrfPid (required) program ID for the VRF example program
EXAMPLE
sbv2 vrf:create:example 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --vrfPid
6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --keypair ../payer-keypair.json -v --enable --queueAuthority
queue-authority-keypair.json
EXAMPLES
$ sbv2 vrf:create:example 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --vrfPid 6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --keypair ../payer-keypair.json -v --enable --queueAuthority queue-authority-keypair.json
```
_See code: [src/commands/vrf/create/example.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/vrf/create/example.ts)_
## `sbv2 vrf print [VRFKEY]`
## `sbv2 vrf:request VRFKEY`
Print the deserialized Switchboard VRF account
```
USAGE
$ sbv2 vrf print [VRFKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
VRFKEY public key of the vrf account to deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
Print the deserialized Switchboard VRF account
ALIASES
$ sbv2 vrf print
EXAMPLES
$ sbv2 vrf:print
```
## `sbv2 vrf request [VRFKEY]`
request a new value for a VRF
```
USAGE
$ sbv2 vrf:request VRFKEY
$ sbv2 vrf request [VRFKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
[--funderAuthority <value>] [--authority <value>]
ARGUMENTS
VRFKEY public key of the VRF account to request randomness for
OPTIONS
-h, --help show CLI help
FLAGS
-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
--funderAuthority=<value> alternative keypair to pay for VRF request
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority
if no alternate authority provided
DESCRIPTION
request a new value for a VRF
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--authority=authority alternative keypair that is the VRF authority
--funderAuthority=funderAuthority alternative keypair to pay for VRF request
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=programId alternative Switchboard program ID to interact with
EXAMPLE
sbv2 vrf:create 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --keypair ../payer-keypair.json -v --enable
--queueAuthority queue-authority-keypair.json --callbackPid 6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --ixData
"[145,72,9,94,61,97,126,106]" -a "{"pubkey": "HpQoFL5kxPp2JCFvjsVTvBd7navx4THLefUU68SXAyd6","isSigner":
false,"isWritable": true}" -a "{"pubkey": "8VdBtS8ufkXMCa6Yr9E4KVCfX2inVZVwU4KGg2CL1q7P","isSigner":
false,"isWritable": false}"
EXAMPLES
$ sbv2 vrf:create 9WZ59yz95bd3XwJxDPVE2PjvVWmSy9WM1NgGD2Hqsohw --keypair ../payer-keypair.json -v --enable --queueAuthority queue-authority-keypair.json --callbackPid 6MLk7G54uHZ7JuzNxpBAVENANrgM9BZ51pKkzGwPYBCE --ixData "[145,72,9,94,61,97,126,106]" -a "{"pubkey": "HpQoFL5kxPp2JCFvjsVTvBd7navx4THLefUU68SXAyd6","isSigner": false,"isWritable": true}" -a "{"pubkey": "8VdBtS8ufkXMCa6Yr9E4KVCfX2inVZVwU4KGg2CL1q7P","isSigner": false,"isWritable": false}"
```
_See code: [src/commands/vrf/request.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/vrf/request.ts)_
## `sbv2 vrf watch [VRFKEY]`
watch a vrf for a new value
```
USAGE
$ sbv2 vrf watch [VRFKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
VRFKEY public key of the vrf account to deserialize
FLAGS
-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
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
DESCRIPTION
watch a vrf for a new value
ALIASES
$ sbv2 vrf watch
EXAMPLES
$ sbv2 vrf:aggregator J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa
```

56
website/api/cli/_watch.md
View File

@ -1,77 +1,65 @@
watch an aggregator for a new value
* [`sbv2 watch:aggregator AGGREGATORKEY`](#sbv2-watchaggregator-aggregatorkey)
* [`sbv2 watch:vrf VRFKEY`](#sbv2-watchvrf-vrfkey)
* [`sbv2 watch aggregator [AGGREGATORKEY]`](#sbv2-watch-aggregator-aggregatorkey)
* [`sbv2 watch vrf [VRFKEY]`](#sbv2-watch-vrf-vrfkey)
## `sbv2 watch:aggregator AGGREGATORKEY`
## `sbv2 watch aggregator [AGGREGATORKEY]`
watch an aggregator for a new value
```
USAGE
$ sbv2 watch:aggregator AGGREGATORKEY
$ sbv2 watch aggregator [AGGREGATORKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
watch an aggregator for a new value
ALIASES
$ sbv2 aggregator:watch
$ sbv2 aggregator watch
EXAMPLE
EXAMPLES
$ sbv2 watch:aggregator J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa
```
_See code: [src/commands/watch/aggregator.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/watch/aggregator.ts)_
## `sbv2 watch:vrf VRFKEY`
## `sbv2 watch vrf [VRFKEY]`
watch a vrf for a new value
```
USAGE
$ sbv2 watch:vrf VRFKEY
$ sbv2 watch vrf [VRFKEY] [-v] [-s] [--mainnetBeta] [-u <value>] [--programId <value>] [-k <value>]
ARGUMENTS
VRFKEY public key of the vrf account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
FLAGS
-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=rpcUrl alternate RPC url
-u, --rpcUrl=<value> alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
--programId=<value> alternative Switchboard program ID to interact with
--programId=programId alternative Switchboard program ID to interact with
DESCRIPTION
watch a vrf for a new value
ALIASES
$ sbv2 vrf:watch
$ sbv2 vrf watch
EXAMPLE
EXAMPLES
$ sbv2 vrf:aggregator J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa
```
_See code: [src/commands/watch/vrf.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/watch/vrf.ts)_