Skip to main content

@switchboard-xyz/aptos.js

NPM Badge

A library of utility functions to interact with Switchboard Modules on Aptos

Github

View the Github repo

Live Deployment:

We're currently deployed on Aptos Testnet and Aptos Devnet.

Mainnet

View the Mainnet deployment accounts

Install

npm install --save @switchboard-xyz/aptos.js

Creating Feeds

import { Buffer } from "buffer";
import { AptosClient, AptosAccount, FaucetClient, HexString } from "aptos";
import {
AptosEvent,
EventCallback,
OracleJob,
createFeed,
} from "@switchboard-xyz/aptos.js";
import Big from "big.js";

const NODE_URL = "https://fullnode.testnet.aptoslabs.com/v1";
const FAUCET_URL = "https://faucet.testnet.aptoslabs.com";

const SWITCHBOARD_TESTNET_ADDRESS =
"0xb27f7bbf7caf2368b08032d005e8beab151a885054cdca55c4cc644f0a308d2b";

const SWITCHBOARD_QUEUE_ADDRESS =
"0xb27f7bbf7caf2368b08032d005e8beab151a885054cdca55c4cc644f0a308d2b";

const SWITCHBOARD_CRANK_ADDRESS =
"0xb27f7bbf7caf2368b08032d005e8beab151a885054cdca55c4cc644f0a308d2b";

const client = new AptosClient(NODE_URL);
const faucetClient = new FaucetClient(NODE_URL, FAUCET_URL);

// create new user
let user = new AptosAccount();

await faucetClient.fundAccount(user.address(), 50000);
console.log(`User account ${user.address().hex()} created + funded.`);

// Make Job data for btc price
const serializedJob = Buffer.from(
OracleJob.encodeDelimited(
OracleJob.create({
tasks: [
{
httpTask: {
url: "https://www.binance.us/api/v3/ticker/price?symbol=BTCUSD",
},
},
{
jsonParseTask: {
path: "$.price",
},
},
],
})
).finish()
);

const [aggregator, createFeedTx] = await createFeed(
client,
user,
{
authority: user.address(),
queueAddress: SWITCHBOARD_QUEUE_ADDRESS, // account with OracleQueue resource
crankAddress: SWITCHBOARD_CRANK_ADDRESS, // account with Crank resource
batchSize: 1, // number of oracles to respond to each round
minJobResults: 1, // minimum # of jobs that need to return a result
minOracleResults: 1, // minumum # of oracles that need to respond for a result
minUpdateDelaySeconds: 5, // minimum delay between rounds
coinType: "0x1::aptos_coin::AptosCoin", // CoinType of the queue (now only AptosCoin)
initialLoadAmount: 1000, // load of the lease
jobs: [
{
name: "BTC/USD",
metadata: "binance",
authority: user.address().hex(),
data: serializedJob.toString("base64"), // jobs need to be base64 encoded strings
weight: 1,
},
],
},
SWITCHBOARD_TESTNET_ADDRESS
);

console.log(
`Created Aggregator and Lease resources at account address ${aggregator.address}. Tx hash ${createFeedTx}`
);

// Manually trigger an update
await aggregator.openRound(user);

Reading Feeds

import { AggregatorAccount } from "@switchboard-xyz/aptos.js";

const aggregatorAccount: AggregatorAccount = new AggregatorAccount(
client,
aggregator_address,
SWITCHBOARD_TESTNET_ADDRESS
);

console.log(await aggregatorAccount.loadData());

Listening to Updates

/**
* Listen to Aggregator Updates Off-Chain
*/

// create event listener
const onAggregatorUpdate = (
client: AptosClient,
cb: EventCallback,
pollIntervalMs: number = 1000
) => {
const event = new AptosEvent(
client,
HexString.ensure(SWITCHBOARD_TESTNET_ADDRESS),
`${SWITCHBOARD_TESTNET_ADDRESS}::switchboard::State`,
"aggregator_update_events",
pollIntervalMs
);
event.onTrigger(cb);
return event;
};

// initialize event listener
const updatePoller = onAggregatorUpdate(client, async (e) => {
if (aggregator.address == e.data.aggregator_address) {
console.log(`NEW RESULT:`, e.data);
}
});