sbv2-solana/website/api/_tasks.md

Protocol Documentation

Table of Contents

• job_schemas.proto

  • OracleJob

  • OracleJob.AddTask

  • OracleJob.AnchorFetchTask

  • OracleJob.BufferLayoutParseTask

  • OracleJob.CacheTask

  • OracleJob.CacheTask.CacheItem

  • OracleJob.ConditionalTask

  • OracleJob.DefiKingdomsTask

  • OracleJob.DefiKingdomsTask.Token

  • OracleJob.DivideTask

  • OracleJob.HttpTask

  • OracleJob.HttpTask.Header

  • OracleJob.JsonParseTask

  • OracleJob.JupiterSwapTask

  • OracleJob.LendingRateTask

  • OracleJob.LpExchangeRateTask

  • OracleJob.LpTokenPriceTask

  • OracleJob.MangoPerpMarketTask

  • OracleJob.MarinadeStateTask

  • OracleJob.MaxTask

  • OracleJob.MeanTask

  • OracleJob.MedianTask

  • OracleJob.MultiplyTask

  • OracleJob.OracleTask

  • OracleJob.PancakeswapExchangeRateTask

  • OracleJob.PerpMarketTask

  • OracleJob.PowTask

  • OracleJob.RegexExtractTask

  • OracleJob.SerumSwapTask

  • OracleJob.SolanaAccountDataFetchTask

  • OracleJob.SplStakePoolTask

  • OracleJob.SplTokenParseTask

  • OracleJob.SubtractTask

  • OracleJob.SushiswapExchangeRateTask

  • OracleJob.SysclockOffsetTask

  • OracleJob.Task

  • OracleJob.TpsTask

  • OracleJob.TwapTask

  • OracleJob.UniswapExchangeRateTask

  • OracleJob.ValueTask

  • OracleJob.WebsocketTask

  • OracleJob.XStepPriceTask

  • OracleJob.BufferLayoutParseTask.BufferParseType

  • OracleJob.BufferLayoutParseTask.Endian

  • OracleJob.HttpTask.Method

  • OracleJob.JsonParseTask.AggregationMethod

  • OracleJob.LendingRateTask.Field

• Scalar Value Types

Top

job_schemas.proto

OracleJob

Represnts a list of tasks to be performed by a switchboard oracle.

Field	Type	Label	Description
tasks	OracleJob.Task	repeated	The chain of tasks to perform for this OracleJob.

OracleJob.AddTask

This task will add a numerical input by a scalar value or by another aggregate.

Field	Type	Label	Description
scalar	double	optional	Specifies a scalar to add by.
aggregator_pubkey	string	optional	Specifies an aggregator to add by.
job	OracleJob	optional	A job whose result is computed before adding our numerical input by that result.
big	string	optional	A stringified big.js. Accepts variable expansion syntax.

OracleJob.AnchorFetchTask

Load a parse an Anchor based solana account.

Field	Type	Label	Description
program_id	string	optional	Owning program of the account to parse.
account_address	string	optional	The account to parse.

OracleJob.BufferLayoutParseTask

Return the deserialized value from a stringified buffer.

Field	Type	Label	Description
offset	uint32	optional	The buffer offset to start deserializing from.
endian	OracleJob.BufferLayoutParseTask.Endian	optional	The endianness of the stored value.
type	OracleJob.BufferLayoutParseTask.BufferParseType	optional	The type of value to deserialize.

OracleJob.CacheTask

Execute a job and store the result in a variable to reference later.

Field	Type	Label	Description
cache_items	OracleJob.CacheTask.CacheItem	repeated	A list of cached variables to reference in the job with ${VARIABLE_NAME}.

OracleJob.CacheTask.CacheItem

Field	Type	Label	Description
variable_name	string	optional	The name of the variable to store in cache to reference later with ${VARIABLE_NAME}.
job	OracleJob	optional	The OracleJob to execute to yield the value to store in cache.

OracleJob.ConditionalTask

This task will run the attempt subtasks in an effort to produce a valid numerical result. If attempt fails to produce an acceptable result, on_failure subtasks will be run instead.

Field	Type	Label	Description
attempt	OracleJob.Task	repeated	A list of subtasks to process in an attempt to produce a valid numerical result.
on_failure	OracleJob.Task	repeated	A list of subtasks that will be run if attempt subtasks are unable to produce an acceptable result.

OracleJob.DefiKingdomsTask

Fetch the swap price from DefiKingdoms.

Field	Type	Label	Description
provider	string	optional	The RPC provider to use for the swap.
in_token	OracleJob.DefiKingdomsTask.Token	optional	The input token of the swap.
out_token	OracleJob.DefiKingdomsTask.Token	optional	The output token of the swap.

OracleJob.DefiKingdomsTask.Token

Field	Type	Label	Description
address	string	optional	The address of the token.
decimals	int32	optional	The number of decimal places for a token.

OracleJob.DivideTask

This task will divide a numerical input by a scalar value or by another aggregate.

Field	Type	Label	Description
scalar	double	optional	Specifies a basic scalar denominator to divide by.
aggregator_pubkey	string	optional	Specifies another aggregator resut to divide by.
job	OracleJob	optional	A job whose result is computed before dividing our numerical input by that result.
big	string	optional	A stringified big.js. Accepts variable expansion syntax.

OracleJob.HttpTask

The adapter will report the text body of a successful HTTP request to the specified url, or return an error if the response status code is greater than or equal to 400. @return string representation of it's output.

Field	Type	Label	Description
url	string	optional	A string containing the URL to direct this HTTP request to.
method	OracleJob.HttpTask.Method	optional	The type of HTTP request to make.
headers	OracleJob.HttpTask.Header	repeated	A list of headers to add to this HttpTask.
body	string	optional	A stringified body (if any) to add to this HttpTask.

OracleJob.HttpTask.Header

An object that represents a header to add to an HTTP request.

Field	Type	Label	Description
key	string	optional
value	string	optional

OracleJob.JsonParseTask

The adapter walks the path specified and returns the value found at that result. If returning JSON data from the HttpGet or HttpPost adapters, you must use this adapter to parse the response.

Field	Type	Label	Description
path	string	optional	JSONPath formatted path to the element. https://t.ly/uLtw https://www.npmjs.com/package/jsonpath-plus
aggregation_method	OracleJob.JsonParseTask.AggregationMethod	optional	The technique that will be used to aggregate the results if walking the specified path returns multiple numerical results.

OracleJob.JupiterSwapTask

Fetch the simulated price for a swap on JupiterSwap.

Field	Type	Label	Description
in_token_address	string	optional	The input token address.
out_token_address	string	optional	The output token address.
base_amount	double	optional	The amount of tokens to swap.

OracleJob.LendingRateTask

Fetch the lending rates for various Solana protocols

Field	Type	Label	Description
protocol	string	optional	01, apricot, francium, jet, larix, mango, port, solend, tulip
asset_mint	string	optional	A token mint address supported by the chosen protocol
field	OracleJob.LendingRateTask.Field	optional

OracleJob.LpExchangeRateTask

Fetch the current swap price for a given liquidity pool

Field	Type	Label	Description
in_token_address	string	optional	Used alongside mercurial_pool_address to specify the input token for a swap.
out_token_address	string	optional	Used alongside mercurial_pool_address to specify the output token for a swap.
mercurial_pool_address	string	optional	Mercurial finance pool address. A full list can be found here: https://github.com/mercurial-finance/stable-swap-n-pool-js
saber_pool_address	string	optional	Saber pool address. A full list can be found here: https://github.com/saber-hq/saber-registry-dist
orca_pool_token_mint_address	string	optional	Deprecated. Orca pool address.
raydium_pool_address	string	optional	The Raydium liquidity pool ammId. A full list can be found here: https://sdk.raydium.io/liquidity/mainnet.json
orca_pool_address	string	optional	Pool address for an Orca LP pool or whirlpool. A full list of Orca LP pools can be found here: https://www.orca.so/pools

OracleJob.LpTokenPriceTask

Fetch LP token price info from a number of supported exchanges.

Field	Type	Label	Description
mercurial_pool_address	string	optional	Mercurial finance pool address. A full list can be found here: https://github.com/mercurial-finance/stable-swap-n-pool-js
saber_pool_address	string	optional	Saber pool address. A full list can be found here: https://github.com/saber-hq/saber-registry-dist
orca_pool_address	string	optional	Orca pool address. A full list can be found here: https://www.orca.so/pools
raydium_pool_address	string	optional	The Raydium liquidity pool ammId. A full list can be found here: https://sdk.raydium.io/liquidity/mainnet.json
price_feed_addresses	string	repeated	A list of Switchboard aggregator accounts used to calculate the fair LP price. This ensures the price is based on the previous round to mitigate flash loan price manipulation.
price_feed_jobs	OracleJob	repeated
use_fair_price	bool	optional	If enabled and price_feed_addresses provided, the oracle will calculate the fair LP price based on the liquidity pool reserves. See our blog post for more information: https://switchboardxyz.medium.com/fair-lp-token-oracles-94a457c50239

OracleJob.MangoPerpMarketTask

Fetch the current price for a Mango perpetual market

Field	Type	Label	Description
perp_market_address	string	optional	Mainnet address for a mango perpetual market. A full list can be found here: https://github.com/blockworks-foundation/mango-client-v3/blob/main/src/ids.json

OracleJob.MarinadeStateTask

OracleJob.MaxTask

Returns the maximum value of all the results returned by the provided subtasks and subjobs.

Field	Type	Label	Description
tasks	OracleJob.Task	repeated	A list of subtasks to process and produce a list of result values.
jobs	OracleJob	repeated	A list of subjobs to process and produce a list of result values.

OracleJob.MeanTask

Returns the mean of all the results returned by the provided subtasks and subjobs.

Field	Type	Label	Description
tasks	OracleJob.Task	repeated	A list of subtasks to process and produce a list of result values.
jobs	OracleJob	repeated	A list of subjobs to process and produce a list of result values.

OracleJob.MedianTask

Returns the median of all the results returned by the provided subtasks and subjobs. Nested tasks must return a Number.

Field	Type	Label	Description
tasks	OracleJob.Task	repeated	A list of subtasks to process and produce a list of result values.
jobs	OracleJob	repeated	A list of subjobs to process and produce a list of result values.
min_successful_required	int32	optional

OracleJob.MultiplyTask

This task will multiply a numerical input by a scalar value or by another aggregator.

Field	Type	Label	Description
scalar	double	optional	Specifies a scalar to multiply by.
aggregator_pubkey	string	optional	Specifies an aggregator to multiply by.
job	OracleJob	optional	A job whose result is computed before multiplying our numerical input by that result.
big	string	optional	A stringified big.js. Accepts variable expansion syntax.

OracleJob.OracleTask

Fetch the current price of a Solana oracle protocol.

Field	Type	Label	Description
switchboard_address	string	optional	Mainnet address of a Switchboard V2 feed. Switchboard is decentralized and allows anyone to build their own feed. A small subset of feeds is available here: https://switchboard.xyz/explorer
pyth_address	string	optional	Mainnet address for a Pyth feed. A full list can be found here: https://pyth.network/price-feeds/
chainlink_address	string	optional	Mainnet address for a Chainlink feed. A full list can be found here: https://docs.chain.link/docs/solana/data-feeds-solana
pyth_allowed_confidence_interval	double	optional	Value (as a percentage) that the lower bound confidence interval is of the actual value. Confidence intervals that are larger that this treshold are rejected.

OracleJob.PancakeswapExchangeRateTask

Fetch the swap price from PancakeSwap.

Field	Type	Label	Description
in_token_address	string	optional	The input token address.
out_token_address	string	optional	The output token address.
in_token_amount	double	optional	The amount of tokens to swap.
slippage	double	optional	The allowable slippage in percent for the swap.
provider	string	optional	The RPC provider to use for the swap.

OracleJob.PerpMarketTask

Fetch the current price of a perpetual market.

Field	Type	Label	Description
mango_market_address	string	optional	Market address for a mango perpetual market. A full list can be found here: https://github.com/blockworks-foundation/mango-client-v3/blob/main/src/ids.json
drift_market_address	string	optional	Market address for a drift perpetual market. A full list can be found here: https://github.com/drift-labs/protocol-v1/blob/master/sdk/src/constants/markets.ts
zeta_market_address	string	optional	Market address for a zeta perpetual market.
zo_market_address	string	optional	Market address for a 01 protocol perpetual market.

OracleJob.PowTask

Take the power of the working value.

Field	Type	Label	Description
scalar	double	optional	Take the working value to the exponent of value.
aggregator_pubkey	string	optional	Take the working value to the exponent of the aggregators value.
big	string	optional	A stringified big.js. Accepts variable expansion syntax.

OracleJob.RegexExtractTask

Find a pattern within a string of a previous task and extract a group number.

Field	Type	Label	Description
pattern	string	optional	Regex pattern to find.
group_number	int32	optional	Group number to extract.

OracleJob.SerumSwapTask

Fetch the latest swap price on Serum's orderbook

Field	Type	Label	Description
serum_pool_address	string	optional	The serum pool to fetch swap price for

OracleJob.SolanaAccountDataFetchTask

Fetch the account data in a stringified buffer format.

Field	Type	Label	Description
pubkey	string	optional	The on-chain account to fetch the account data from.

OracleJob.SplStakePoolTask

Fetch the JSON representation of an SPL Stake Pool account.

Field	Type	Label	Description
pubkey	string	optional	The pubkey of the SPL Stake Pool.

OracleJob.SplTokenParseTask

Fetch the JSON representation of an SPL token mint.

Field	Type	Label	Description
token_account_address	string	optional	The publicKey of a token account to fetch the mintInfo for.
mint_address	string	optional	The publicKey of the token mint address.

OracleJob.SubtractTask

This task will subtract a numerical input by a scalar value or by another aggregate.

Field	Type	Label	Description
scalar	double	optional	Specifies a scalar to subtract by.
aggregator_pubkey	string	optional	Specifies an aggregator to subtract by.
job	OracleJob	optional	A job whose result is computed before subtracting our numerical input by that result.
big	string	optional	A stringified big.js. Accepts variable expansion syntax.

OracleJob.SushiswapExchangeRateTask

Fetch the swap price from SushiSwap.

Field	Type	Label	Description
in_token_address	string	optional	The input token address.
out_token_address	string	optional	The output token address.
in_token_amount	double	optional	The amount of tokens to swap.
slippage	double	optional	The allowable slippage in percent for the swap.
provider	string	optional	The RPC provider to use for the swap.

OracleJob.SysclockOffsetTask

Return the difference between an oracle's clock and the current timestamp at SYSVAR_CLOCK_PUBKEY.

OracleJob.Task

Field	Type	Label	Description
http_task	OracleJob.HttpTask	optional
json_parse_task	OracleJob.JsonParseTask	optional
median_task	OracleJob.MedianTask	optional
mean_task	OracleJob.MeanTask	optional
websocket_task	OracleJob.WebsocketTask	optional
divide_task	OracleJob.DivideTask	optional
multiply_task	OracleJob.MultiplyTask	optional
lp_token_price_task	OracleJob.LpTokenPriceTask	optional
lp_exchange_rate_task	OracleJob.LpExchangeRateTask	optional
conditional_task	OracleJob.ConditionalTask	optional
value_task	OracleJob.ValueTask	optional
max_task	OracleJob.MaxTask	optional
regex_extract_task	OracleJob.RegexExtractTask	optional
xstep_price_task	OracleJob.XStepPriceTask	optional
add_task	OracleJob.AddTask	optional
subtract_task	OracleJob.SubtractTask	optional
twap_task	OracleJob.TwapTask	optional
serum_swap_task	OracleJob.SerumSwapTask	optional
pow_task	OracleJob.PowTask	optional
lending_rate_task	OracleJob.LendingRateTask	optional
mango_perp_market_task	OracleJob.MangoPerpMarketTask	optional
jupiter_swap_task	OracleJob.JupiterSwapTask	optional
perp_market_task	OracleJob.PerpMarketTask	optional
oracle_task	OracleJob.OracleTask	optional
anchor_fetch_task	OracleJob.AnchorFetchTask	optional
defi_kingdoms_task	OracleJob.DefiKingdomsTask	optional
tps_task	OracleJob.TpsTask	optional
spl_stake_pool_task	OracleJob.SplStakePoolTask	optional
spl_token_parse_task	OracleJob.SplTokenParseTask	optional
uniswap_exchange_rate_task	OracleJob.UniswapExchangeRateTask	optional
sushiswap_exchange_rate_task	OracleJob.SushiswapExchangeRateTask	optional
pancakeswap_exchange_rate_task	OracleJob.PancakeswapExchangeRateTask	optional
cache_task	OracleJob.CacheTask	optional
sysclock_offset_task	OracleJob.SysclockOffsetTask	optional
marinade_state_task	OracleJob.MarinadeStateTask	optional
solana_account_data_fetch_task	OracleJob.SolanaAccountDataFetchTask	optional
buffer_layout_parse_task	OracleJob.BufferLayoutParseTask	optional

OracleJob.TpsTask

Fetch the current transactions per second.

OracleJob.TwapTask

Takes a twap over a set period for a certain aggregator.

Field	Type	Label	Description
aggregator_pubkey	string	optional	The target aggregator for the TWAP.
period	int32	optional	Period, in seconds, the twap should account for
weight_by_propagation_time	bool	optional	Weight samples by their propagation time
min_samples	uint32	optional	Minimum number of samples in the history to calculate a valid result
ending_unix_timestamp	int32	optional	Ending unix timestamp to collect values up to

OracleJob.UniswapExchangeRateTask

Fetch the swap price from UniSwap.

Field	Type	Label	Description
in_token_address	string	optional	The input token address.
out_token_address	string	optional	The output token address.
in_token_amount	double	optional	The amount of tokens to swap.
slippage	double	optional	The allowable slippage in percent for the swap.
provider	string	optional	The RPC provider to use for the swap.

OracleJob.ValueTask

Returns a specified value.

Field	Type	Label	Description
value	double	optional	The value that will be returned from this task.
aggregator_pubkey	string	optional	Specifies an aggregatorr to pull the value of.
big	string	optional	A stringified big.js. Accepts variable expansion syntax.

OracleJob.WebsocketTask

Opens and maintains a websocket for light speed data retrieval.

Field	Type	Label	Description
url	string	optional	The websocket url.
subscription	string	optional	The websocket message to notify of a new subscription.
max_data_age_seconds	int32	optional	Minimum amount of time required between when the horses are taking out.
filter	string	optional	Incoming message JSONPath filter. Example: "$[?(@.channel == 'ticker' && @.market == 'BTC/USD')]"

OracleJob.XStepPriceTask

Field	Type	Label	Description
step_job	OracleJob.MedianTask	optional	median task containing the job definitions to fetch the STEP/USD price
step_aggregator_pubkey	string	optional	existing aggregator pubkey for STEP/USD

OracleJob.BufferLayoutParseTask.BufferParseType

Name	Number	Description
pubkey	1	A public key.
bool	2	A boolean.
u8	3	An 8-bit unsigned value.
i8	4	An 8-bit signed value.
u16	5	A 16-bit unsigned value.
i16	6	A 16-bit signed value.
u32	7	A 32-bit unsigned value.
i32	8	A 32-bit signed value.
f32	9	A 32-bit IEEE floating point value.
u64	10	A 64-bit unsigned value.
i64	11	A 64-bit signed value.
f64	12	A 64-bit IEEE floating point value.
u128	13	A 128-bit unsigned value.
i128	14	A 128-bit signed value.

OracleJob.BufferLayoutParseTask.Endian

Name	Number	Description
LITTLE_ENDIAN	0
BIG_ENDIAN	1

OracleJob.HttpTask.Method

An enumeration representing the types of HTTP requests available to make.

Name	Number	Description
METHOD_UNKOWN	0	Unset HTTP method will default to METHOD_GET
METHOD_GET	1	Perform an HTTP 'GET' request.
METHOD_POST	2	Perform an HTTP 'POST' request.

OracleJob.JsonParseTask.AggregationMethod

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.

OracleJob.LendingRateTask.Field

Name	Number	Description
FIELD_DEPOSIT_RATE	0	deposit lending rate
FIELD_BORROW_RATE	1	borrow lending rate

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)