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

docs: added new tasks and sbv2-utils links

This commit is contained in:
Conner Gallagher 2022-07-22 12:41:23 -06:00
parent 97853ed146
commit b3c198e779
6 changed files with 101 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
libraries/sbv2-utils/README.md Normal file
View File

@ -0,0 +1,13 @@
# Sbv2-Utils
[![GitHub](https://img.shields.io/badge/--181717?logo=github&logoColor=ffffff)](https://github.com/switchboard-xyz/switchboard-v2/tree/main/libraries/sbv2-utils)  
[![npm](https://img.shields.io/npm/v/@switchboard-xyz/switchboard-v2)](https://www.npmjs.com/package/@switchboard-xyz/sbv2-utils)  
[![twitter](https://badgen.net/twitter/follow/switchboardxyz)](https://twitter.com/switchboardxyz)  
A library of utility functions to interact with the Switchboardv2 program
## Install
```
npm i @switchboard-xyz/sbv2-utils
```

35
website/api/_tasks.md
View File

@ -11,6 +11,7 @@
- [OracleJob.CacheTask](#.OracleJob.CacheTask)
- [OracleJob.CacheTask.CacheItem](#.OracleJob.CacheTask.CacheItem)
- [OracleJob.ConditionalTask](#.OracleJob.ConditionalTask)
- [OracleJob.CronParseTask](#.OracleJob.CronParseTask)
- [OracleJob.DefiKingdomsTask](#.OracleJob.DefiKingdomsTask)
- [OracleJob.DefiKingdomsTask.Token](#.OracleJob.DefiKingdomsTask.Token)
- [OracleJob.DivideTask](#.OracleJob.DivideTask)
@ -49,6 +50,7 @@
- [OracleJob.BufferLayoutParseTask.BufferParseType](#.OracleJob.BufferLayoutParseTask.BufferParseType)
- [OracleJob.BufferLayoutParseTask.Endian](#.OracleJob.BufferLayoutParseTask.Endian)
- [OracleJob.CronParseTask.ClockType](#.OracleJob.CronParseTask.ClockType)
- [OracleJob.HttpTask.Method](#.OracleJob.HttpTask.Method)
- [OracleJob.JsonParseTask.AggregationMethod](#.OracleJob.JsonParseTask.AggregationMethod)
- [OracleJob.LendingRateTask.Field](#.OracleJob.LendingRateTask.Field)
@ -179,6 +181,23 @@ This task will run the `attempt` subtasks in an effort to produce a valid numeri
<a name=".OracleJob.CronParseTask"></a>
### OracleJob.CronParseTask
return a timestamp from a crontab instruction
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| cron_pattern | [string](#string) | optional | the cron pattern to parse |
| clock_offset | [int32](#int32) | optional | the timestamp offset to calculate the next run |
| clock | [OracleJob.CronParseTask.ClockType](#OracleJob.CronParseTask.ClockType) | optional | |
<a name=".OracleJob.DefiKingdomsTask"></a>
### OracleJob.DefiKingdomsTask
@ -695,6 +714,7 @@ Return the difference between an oracle&#39;s clock and the current timestamp at
| marinade_state_task | [OracleJob.MarinadeStateTask](#OracleJob.MarinadeStateTask) | optional | |
| solana_account_data_fetch_task | [OracleJob.SolanaAccountDataFetchTask](#OracleJob.SolanaAccountDataFetchTask) | optional | |
| buffer_layout_parse_task | [OracleJob.BufferLayoutParseTask](#OracleJob.BufferLayoutParseTask) | optional | |
| cron_parse_task | [OracleJob.CronParseTask](#OracleJob.CronParseTask) | optional | |
@ -724,6 +744,7 @@ Takes a twap over a set period for a certain aggregator.
| weight_by_propagation_time | [bool](#bool) | optional | Weight samples by their propagation time |
| min_samples | [uint32](#uint32) | optional | Minimum number of samples in the history to calculate a valid result |
| ending_unix_timestamp | [int32](#int32) | optional | Ending unix timestamp to collect values up to |
| ending_unix_timestamp_task | [OracleJob.CronParseTask](#OracleJob.CronParseTask) | optional | Execute the task to get the ending unix timestamp |
@ -838,6 +859,18 @@ Opens and maintains a websocket for light speed data retrieval.
<a name=".OracleJob.CronParseTask.ClockType"></a>
### OracleJob.CronParseTask.ClockType
which type of clock to use
| Name | Number | Description |
| ---- | ------ | ----------- |
| ORACLE | 0 | |
| SYSCLOCK | 1 | |
<a name=".OracleJob.HttpTask.Method"></a>
### OracleJob.HttpTask.Method
@ -862,6 +895,8 @@ The methods of combining a list of numerical results.
| MIN | 1 | Grab the minimum value of the results. |
| MAX | 2 | Grab the maximum value of the results. |
| SUM | 3 | Sum up all of the results. |
| MEAN | 4 | Average all of the results. |
| MEDIAN | 5 | Grab the median of the results. |

48
website/api/switchboard-tasks.md
View File

@ -266,12 +266,14 @@ response.
The methods of combining a list of numerical results.
| Name | Number | Description |
| ---- | ------ | -------------------------------------- |
| NONE | 0 | |
| MIN | 1 | Grab the minimum value of the results. |
| MAX | 2 | Grab the maximum value of the results. |
| SUM | 3 | Sum up all of the results. |
| Name | Number | Description |
| ------ | ------ | -------------------------------------- |
| NONE | 0 | |
| MIN | 1 | Grab the minimum value of the results. |
| MAX | 2 | Grab the maximum value of the results. |
| SUM | 3 | Sum up all of the results. |
| MEAN | 4 | Average all of the results. |
| MEDIAN | 5 | Grab the median of the results. |
### 🛠RegexExtractTask
@ -351,6 +353,25 @@ Execute a job and store the result in a variable to reference later.
Return the difference between an oracle&#39;s clock and the current timestamp at `SYSVAR_CLOCK_PUBKEY`.
### CronParseTask
Return a timestamp from a crontab instruction.
| Field | Type | Label | Description |
| ------------ | ----------------------- | -------- | ---------------------------------------------------------------- |
| cron_pattern | [string](#string) | optional | The cron pattern to parse |
| clock_offset | [int32](#int32) | optional | The timestamp offset to calculate the next run |
| clock | [ClockType](#ClockType) | optional | The type of clock to use, oracle or the solana cluster sysclock. |
#### ClockType
The type of clock.
| Name | Number | Description |
| -------- | ------ | ------------------------------ |
| ORACLE | 0 | The oracles current clock. |
| SYSCLOCK | 1 | The solana cluster's sysclock. |
### 🛠TpsTask
Fetch the current transactions per second.
@ -361,13 +382,14 @@ Fetch the current transactions per second.
Takes a twap over a set period for a certain aggregator.
| Field | Type | Label | Description |
| -------------------------- | ----------------- | -------- | -------------------------------------------------------------------- |
| aggregator_pubkey | [string](#string) | optional | The target aggregator for the TWAP. |
| period | [int32](#int32) | optional | Period, in seconds, the twap should account for |
| weight_by_propagation_time | [bool](#bool) | optional | Weight samples by their propagation time |
| min_samples | [uint32](#uint32) | optional | Minimum number of samples in the history to calculate a valid result |
| ending_unix_timestamp | [int32](#int32) | optional | Ending unix timestamp to collect values up to |
| Field | Type | Label | Description |
| -------------------------- | ------------------------------- | -------- | -------------------------------------------------------------------- |
| aggregator_pubkey | [string](#string) | optional | The target aggregator for the TWAP. |
| period | [int32](#int32) | optional | Period, in seconds, the twap should account for |
| weight_by_propagation_time | [bool](#bool) | optional | Weight samples by their propagation time |
| min_samples | [uint32](#uint32) | optional | Minimum number of samples in the history to calculate a valid result |
| ending_unix_timestamp | [int32](#int32) | optional | Ending unix timestamp to collect values up to |
| ending_unix_timestamp_task | [CronParseTask](#CronParseTask) | optional | Execute the task to get the ending unix timestamp |
### 🛠MaxTask

17
website/docs/developers/_library_table.mdx
View File

@ -17,11 +17,12 @@ import { SerumIcon } from "/src/components/icons/SerumIcon";
Switchboard V2 on-chain
</Typography>
| Library | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| <Link className="nowrap" to="/api/tasks"><VscJson className="devicons" fontSize="large" /> switchboard-tasks</Link> | Protobuf definitions for the various supported task definitions to build job definitions from. |
| <Link className="nowrap" to="/api/cli"><SiPowershell className="devicons" fontSize="large" /> switchboardv2-cli</Link> | A Command Line Interface (CLI) to interact with the Switchboardv2 program. |
| <Link className="nowrap" to="/api/ts" target="_blank"><SiTypescript className="devicons" fontSize="large" /> switchboardv2-api <GoLinkExternal className="devicons" /></Link> | A typescript library of utility functions to interact with the Switchboardv2 program. |
| <Link className="nowrap" to="/api/ts-lite" target="_blank"><SiTypescript className="devicons" fontSize="large" /> sbv2-lite <GoLinkExternal className="devicons" /></Link> | A typescript "Lite" client to deserialize aggregator accounts. |
| <Link className="nowrap" to="/api/py" target="_blank"><SiPython className="devicons" fontSize="large" /> switchboardpy <GoLinkExternal className="devicons" /></Link> | A python library of utility functions to interact with the Switchboardv2 program. |
| <Link className="nowrap" to="https://docs.rs/switchboard-v2"><SiRust className="devicons" /> switchboard-v2 <GoLinkExternal className="devicons" /></Link> | A rust library of utility functions to interact with the Switchboardv2 program on-chain. |
| Library | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |
| <Link className="nowrap" to="/api/tasks"><VscJson className="devicons" fontSize="large" /> switchboard-tasks</Link> | Protobuf definitions for the various supported task definitions to build job definitions from. |
| <Link className="nowrap" to="/api/cli"><SiPowershell className="devicons" fontSize="large" /> switchboardv2-cli</Link> | A Command Line Interface (CLI) to interact with the Switchboardv2 program. |
| <Link className="nowrap" to="/api/ts" target="_blank"><SiTypescript className="devicons" fontSize="large" /> switchboardv2-api <GoLinkExternal className="devicons" /></Link> | A typescript library of utility functions to interact with the Switchboardv2 program. |
| <Link className="nowrap" to="/api/ts-lite" target="_blank"><SiTypescript className="devicons" fontSize="large" /> sbv2-lite <GoLinkExternal className="devicons" /></Link> | A typescript "Lite" client to deserialize aggregator accounts. |
| <Link className="nowrap" to="/api/sbv2-utils" target="_blank"><SiTypescript className="devicons" fontSize="large" /> sbv2-utils <GoLinkExternal className="devicons" /></Link> | Some utility functions to interact with Switchboard V2. |
| <Link className="nowrap" to="/api/py" target="_blank"><SiPython className="devicons" fontSize="large" /> switchboardpy <GoLinkExternal className="devicons" /></Link> | A python library of utility functions to interact with the Switchboardv2 program. |
| <Link className="nowrap" to="https://docs.rs/switchboard-v2"><SiRust className="devicons" /> switchboard-v2 <GoLinkExternal className="devicons" /></Link> | A rust library of utility functions to interact with the Switchboardv2 program on-chain. |

4
website/docusaurus.config.js
View File

@ -157,6 +157,10 @@ const config = {
label: "Typescript Lite",
to: "https://docs.switchboard.xyz/api/ts-lite",
},
{
label: "Sbv2 Utils",
to: "https://docs.switchboard.xyz/api/sbv2-utils",
},
{
label: "Python",
to: "https://docs.switchboard.xyz/api/py",

5
website/sidebarsAPI.js
View File

@ -25,6 +25,11 @@ module.exports = {
label: "Typescript Lite",
href: "https://docs.switchboard.xyz/api/ts-lite/",
},
{
type: "link",
label: "Sbv2 Utils",
href: "https://docs.switchboard.xyz/api/sbv2-utils/",
},
{
type: "link",
label: "Python",