docs
This commit is contained in:
parent
cd7658992c
commit
53f52f38b9
|
@ -41,3 +41,4 @@ public
|
||||||
# Auto generated
|
# Auto generated
|
||||||
website/static/api/ts
|
website/static/api/ts
|
||||||
website/static/api/ts-lite
|
website/static/api/ts-lite
|
||||||
|
website/static/api/sbv2-utils
|
2641
cli/README.md
2641
cli/README.md
File diff suppressed because it is too large
Load Diff
|
@ -2,7 +2,6 @@
|
||||||
interact with a switchboard aggregator account
|
interact with a switchboard aggregator account
|
||||||
|
|
||||||
* [`sbv2 aggregator:add:job AGGREGATORKEY`](#sbv2-aggregatoraddjob-aggregatorkey)
|
* [`sbv2 aggregator:add:job AGGREGATORKEY`](#sbv2-aggregatoraddjob-aggregatorkey)
|
||||||
* [`sbv2 aggregator:create QUEUEKEY`](#sbv2-aggregatorcreate-queuekey)
|
|
||||||
* [`sbv2 aggregator:create:copy AGGREGATORSOURCE`](#sbv2-aggregatorcreatecopy-aggregatorsource)
|
* [`sbv2 aggregator:create:copy AGGREGATORSOURCE`](#sbv2-aggregatorcreatecopy-aggregatorsource)
|
||||||
* [`sbv2 aggregator:create:json DEFINITIONFILE`](#sbv2-aggregatorcreatejson-definitionfile)
|
* [`sbv2 aggregator:create:json DEFINITIONFILE`](#sbv2-aggregatorcreatejson-definitionfile)
|
||||||
* [`sbv2 aggregator:lock AGGREGATORKEY`](#sbv2-aggregatorlock-aggregatorkey)
|
* [`sbv2 aggregator:lock AGGREGATORKEY`](#sbv2-aggregatorlock-aggregatorkey)
|
||||||
|
@ -61,57 +60,6 @@ EXAMPLE
|
||||||
|
|
||||||
_See code: [src/commands/aggregator/add/job.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/aggregator/add/job.ts)_
|
_See code: [src/commands/aggregator/add/job.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/aggregator/add/job.ts)_
|
||||||
|
|
||||||
## `sbv2 aggregator:create QUEUEKEY`
|
|
||||||
|
|
||||||
create an aggregator account
|
|
||||||
|
|
||||||
```
|
|
||||||
USAGE
|
|
||||||
$ sbv2 aggregator:create QUEUEKEY
|
|
||||||
|
|
||||||
ARGUMENTS
|
|
||||||
QUEUEKEY public key of the oracle queue account to create aggregator for
|
|
||||||
|
|
||||||
OPTIONS
|
|
||||||
-a, --authority=authority alternate keypair that is the authority for the aggregator
|
|
||||||
-h, --help show CLI help
|
|
||||||
-j, --job=job filesystem path to job definition file
|
|
||||||
|
|
||||||
-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
|
|
||||||
|
|
||||||
--batchSize=batchSize number of oracles requested for each open round call
|
|
||||||
|
|
||||||
--force skip job confirmation
|
|
||||||
|
|
||||||
--forceReportPeriod=forceReportPeriod Number of seconds for which, even if the variance threshold is not passed,
|
|
||||||
accept new responses from oracles.
|
|
||||||
|
|
||||||
--mainnetBeta WARNING: use mainnet-beta solana cluster
|
|
||||||
|
|
||||||
--minJobs=minJobs number of jobs that must respond before an oracle responds
|
|
||||||
|
|
||||||
--minOracles=minOracles number of oracles that must respond before a value is accepted on-chain
|
|
||||||
|
|
||||||
--newQueue=newQueue public key of the new oracle queue
|
|
||||||
|
|
||||||
--programId=programId alternative Switchboard program ID to interact with
|
|
||||||
|
|
||||||
--updateInterval=updateInterval set an aggregator's minimum update delay
|
|
||||||
|
|
||||||
--varianceThreshold=varianceThreshold percentage change between a previous accepted result and the next round before
|
|
||||||
an oracle reports a value on-chain. Used to conserve lease cost during low
|
|
||||||
volatility
|
|
||||||
```
|
|
||||||
|
|
||||||
_See code: [src/commands/aggregator/create/index.ts](https://github.com/switchboard-xyz/switchboard-v2/tree/main/cli/src/commands/aggregator/create/index.ts)_
|
|
||||||
|
|
||||||
## `sbv2 aggregator:create:copy AGGREGATORSOURCE`
|
## `sbv2 aggregator:create:copy AGGREGATORSOURCE`
|
||||||
|
|
||||||
copy an aggregator account to a new oracle queue
|
copy an aggregator account to a new oracle queue
|
||||||
|
@ -139,8 +87,12 @@ OPTIONS
|
||||||
|
|
||||||
--batchSize=batchSize override source aggregator's oracleRequestBatchSize
|
--batchSize=batchSize override source aggregator's oracleRequestBatchSize
|
||||||
|
|
||||||
|
--copyJobs create copy of job accounts instead of referincing existing job account
|
||||||
|
|
||||||
--crankKey=crankKey public key of the crank to push aggregator to
|
--crankKey=crankKey public key of the crank to push aggregator to
|
||||||
|
|
||||||
|
--enable set permissions to PERMIT_ORACLE_QUEUE_USAGE
|
||||||
|
|
||||||
--force skip job confirmation
|
--force skip job confirmation
|
||||||
|
|
||||||
--forceReportPeriod=forceReportPeriod override source aggregator's forceReportPeriod
|
--forceReportPeriod=forceReportPeriod override source aggregator's forceReportPeriod
|
||||||
|
@ -155,9 +107,9 @@ OPTIONS
|
||||||
|
|
||||||
--programId=programId alternative Switchboard program ID to interact with
|
--programId=programId alternative Switchboard program ID to interact with
|
||||||
|
|
||||||
--queueKey=queueKey (required) public key of the queue to create aggregator for
|
--queueAuthority=queueAuthority alternative keypair to use for queue authority
|
||||||
|
|
||||||
--sourceCluster=devnet|mainnet-beta alternative solana cluster to copy source aggregator from
|
--queueKey=queueKey (required) public key of the queue to create aggregator for
|
||||||
|
|
||||||
--varianceThreshold=varianceThreshold override source aggregator's varianceThreshold
|
--varianceThreshold=varianceThreshold override source aggregator's varianceThreshold
|
||||||
|
|
||||||
|
|
|
@ -1,10 +1,44 @@
|
||||||
|
|
||||||
interact with a switchboard job account
|
interact with a switchboard job account
|
||||||
|
|
||||||
|
* [`sbv2 job:create JOBDEFINITION`](#sbv2-jobcreate-jobdefinition)
|
||||||
* [`sbv2 job:create:copy JOBSOURCE`](#sbv2-jobcreatecopy-jobsource)
|
* [`sbv2 job:create:copy JOBSOURCE`](#sbv2-jobcreatecopy-jobsource)
|
||||||
* [`sbv2 job:create:json DEFINITIONFILE`](#sbv2-jobcreatejson-definitionfile)
|
* [`sbv2 job:create:json DEFINITIONFILE`](#sbv2-jobcreatejson-definitionfile)
|
||||||
* [`sbv2 job:create:template TEMPLATE ID`](#sbv2-jobcreatetemplate-template-id)
|
* [`sbv2 job:create:template TEMPLATE ID`](#sbv2-jobcreatetemplate-template-id)
|
||||||
|
|
||||||
|
## `sbv2 job:create JOBDEFINITION`
|
||||||
|
|
||||||
|
create a buffer relayer account
|
||||||
|
|
||||||
|
```
|
||||||
|
USAGE
|
||||||
|
$ sbv2 job:create JOBDEFINITION
|
||||||
|
|
||||||
|
ARGUMENTS
|
||||||
|
JOBDEFINITION filesystem path to job definition
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
-a, --authority=authority alternate keypair that will be the aggregator authority
|
||||||
|
-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 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
|
||||||
|
```
|
||||||
|
|
||||||
|
_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:create:copy JOBSOURCE`
|
## `sbv2 job:create:copy JOBSOURCE`
|
||||||
|
|
||||||
copy a job account
|
copy a job account
|
||||||
|
|
|
@ -22,8 +22,8 @@ ARGUMENTS
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-h, --help show CLI help
|
-h, --help show CLI help
|
||||||
|
|
||||||
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
|
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if
|
||||||
alternate authority provided
|
no alternate authority provided
|
||||||
|
|
||||||
-n, --name=name name of the crank for easier identification
|
-n, --name=name name of the crank for easier identification
|
||||||
|
|
||||||
|
@ -39,6 +39,8 @@ OPTIONS
|
||||||
|
|
||||||
--programId=programId alternative Switchboard program ID to interact with
|
--programId=programId alternative Switchboard program ID to interact with
|
||||||
|
|
||||||
|
--queueAuthority=queueAuthority alternative keypair to use for queue authority
|
||||||
|
|
||||||
EXAMPLE
|
EXAMPLE
|
||||||
$ sbv2 queue:add:crank 5aYuxRdcB9GpWrEXVMBQp2R5uf94uoBiFdMEBwcmHuU4 -k ../authority-keypair.json -n crank-1
|
$ sbv2 queue:add:crank 5aYuxRdcB9GpWrEXVMBQp2R5uf94uoBiFdMEBwcmHuU4 -k ../authority-keypair.json -n crank-1
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in New Issue