@symmetry-hq/baskets-sdk
TypeScript icon, indicating that this package has built-in type declarations

0.0.28 • Public • Published

Baskets Sdk

Software Development Kit for interacting with Symmetry Baskets Program

Init

import { BasketsSDK } from "@symmetry-hq/baskets-sdk";

let basketsSdk: BasketsSDK = await BasketsSDK.init(
    // rpc connection
    connection: Connection,
    // wallet (optional, can be provided later, using setWallet()
    wallet: Wallet,
);

// load list of supported tokens(returns TokenSettings array)
let tokens: TokenSettings[] = basketsSdk.getTokenListData();

// get tokenId(tokenId in symmetry supported tokens) from mint
let tokenId = basketsSdk.tokenIdFromMint(
  "So11111111111111111111111111111111111111112"
);

// set wallet
basketsSdk.setWallet(wallet: Wallet);

Create/Edit/Close Basket

Create Basket with specific settings and rules

Checkout Types and Full Example for more information on how settings should be provided.

let basket: Basket = await basketsSdk.createBasket(params: CreateBasketParams);

Edit Basket (Only for Mutable & Permissioned baskets)

// Option 1 - (Simple) Directly set desired composition
await basketsSdk
  .simpleEditBasket(basket: Basket, params: SimpleEditParams);

// Option 2 - (Advanced) Provide full settings with rules
await basketsSdk
  .editBasket(basket: Basket, params: CreateBasketParams);

Close Basket (Basket TVL == 0 & no active BuyStates is required)

await basketsSdk.closeBasket(basket: Basket);

Create/Update Metadata for Baskets token mint:

let tx: TransactionSignature[] = await basketsSdk.setMetadata(
  basket: Basket,
  symbol: string,
  name: string,
  uri: string,
);

Load Basket(s)

Load specific basket from pubkey

let basket: Basket = await basketsSdk.loadFromPubkey(pubkey: PublicKey);

Load baskets array based on filters (manager/host platform pubkey)

let baskets: Basket[] = await basketsSdk.findBaskets(filters: FilterOption[]);
let baskets: Basket[] = await basketsSdk.findBaskets([{
  filterType: "manager"|"host",
  filterPubkey: PublicKey
}]);

You can also load baskets' current compositions

let currentCompositions: CurrentComposition[] =
  await basketsSdk.getCurrentCompositions(baskets: Basket[]);

Buy Basket Tokens

There are three ways to buy a basket token.

Option 1 (Simple):

Buy basket with a single token (token should be in the basket composition)

// Fetch expected amount of Basket tokens after contribution
let expectedAmount = await basketsSdk.computeMintAmountWithSingleToken(
  basket: Basket, 
  token: PublicKey, 
  amount: number
);

// Contribute single token and mint Basket tokens
let tx: TransactionSignature = await basketsSdk.buyWithSingleToken(
  basket: Basket, 
  token: PublicKey, 
  amount: number
);

Option 2 (Simple): Contribute all tokens from baskets composition

Works for baskets with no more than 5 tokens Amounts for tokens should be provided in the same order tokens are present in baskets composition. Baskets composition can be found in Basket object of a basket, or using getCurrentCompositions()

// Fetch expected amount of Basket tokens after contribution
let expectedAmount: number = await basketsSdk.computeMintAmount(
  basket: Basket,
  amounts: number[]
);

// Contribute tokens and mint Basket tokens
let tx: TransactionSignature = await basketsSdk.buyBasketInstant(
  basket: Basket,
  amounts: number[]
);

Option 3 (Advanced):

Users also have option to contribute USDC to the basket. Symmetry Engine will use that USDC to buy underlying tokens (rebalance usdc to baskets current composition based on their target weights) After rebalancing, basket tokens will be minted for user.

Step 1: Contribute USDC to Basket and create BuyState (Temporary on-chain account)
Initially BuyState will have the information about users contribution.

let buyState: BuyState = await basketsSdk.buyBasket(
  basket: Basket,
  amountUsdc: number
);

Step 2: Rebalance BuyState: Buy underlying assets in the basket using contributed USDC.
During rebalancing process, BuyState will store the information about already purchased
assets, as well as remaining amount of USDC.
Users can always force-rebalance their BuyState, but it is also done by
Symmetry engine (BuyState will automatically rebalance within 3 minutes)

let txs: TransactionSignature[] = await basketsSdk
  .rebalanceBuyState(buyState: BuyState);

Step 3: Mint Basket Tokens & Close Buy State
During this stage, all the assets acquired during rebalancing process will be added
to the basket. Corresponding basket tokens will be minted for user, and circulating supply
of the basket tokens will increase by same amount. After, it will safely close BuyState.
Users can call force-mint function after 3 minutes, but Symmetry engine will also
automatically handle this step. Rent for creating temporary account goes back to user.

let tx: TransactionSignature = await basketsSdk
  .mintBasket(buyState: BuyState);

Helpers:

// Find active BuyStates for user that have been created after Step 1
let buyStates: BuyState[] = await basketsSdk
  .findActiveBuyStates(user: PublicKey);

// Fetch specific BuyState using its PublicKey
let buyState: BuyState[] = await basketsSdk
  .fetchBuyStateFromPubkey(pubkey: PublicKey);

// Claim Tokens from halted BuyState
// In a case where BuyState has been created more than 30 minutes ago,
// and mint was unsuccessful for some reason
// (no liquidity for token / oracle feed not live / chain congestion)
// contributed token(s) can be claimed back by user.
let tx = await basketsSdk.claimTokensFromBuyState(pubkey: PublicKey)

Sell Basket

There are two ways to sell basket tokens.

Option 1 (Simple): Sell to a specific token (token should be in baskets composition)

// Fetch expected amount of received tokens.
let amount: number = await basketsSdk.computeOutputAmountWithInstantBurn(
  basket: Basket,
  amount: number,
  withdrawToken: PublicKey
);


// Burn/Sell Basket tokens.
let tx: TransactionSignature = await basketsSdk.instantBurn(
  basket: Basket,
  amount: number,
  withdrawToken: PublicKey
);

Option 2 (Advanced):

Users can directly claim their portion of the tokens from Baskets composition. They also have an option to rebalance those tokens to USDC before claiming.

Step 1: Burn Basket Tokens and create SellState (Temporary on-chain account)
SellState is an on-chain account which has exactly same structure as Basket.
Initially SellState will store baskets composition with amounts corresponding to users holdings.
Circulating supply will decrease by burn amount and users Basket tokens will be burned.
From here, this SellState is already independent from the original Basket.
User can specify if they want to rebalance their to-be-claimed tokens to USDC

let sellState: Basket = await basketsSdk
  .sellBasket(basket: Basket, amount: number, rebalance: boolean);

Step 2: Rebalance SellState(Basket): Rebalance underlying assets to USDC
This step is optional, user can skip this step and directly claim underlying tokens.
SellState-s have exact structure as Baskets so rebalance function is same for them.
(Optional, only when rebalance == true)

let txs: TransactionSignature[] = await basketsSdk
  .rebalanceBasket(sellState: Basket);

Step 3: Claim underlying tokens (or USDC) from SellState.
After this step, SellState is closed and rent is collected by user.

let txs: TransactionSignature[] = await basketsSdk
  .claimTokens(sellState: Basket);

Helpers:

// Find active SellStates for user that have been created after Step 1
let sellStates: Basket[] = await basketsSdk
  .findActiveSellStates(user: PublicKey);

Automation

Automation on all baskets (Refilter/Reweight/Rebalance), as well as monitoring active
Buy/Sell states and rebalancing them is done by Symmetry Engine, based on RefilterInterval,
ReweightInterval, RebalanceInterval settings provided in basket rules.
Platforms and Developers can run their own automation for their baskets using examples bellow.
Managers can Force-(Refilter/Reweight/Rebalance) anytime.

Refilter Basket

Automatically selects assets based on provided rules in basket settings.

let txs: TransactionSignature = await basketsSdk.refilterBasket(basket: Basket);

Reweight Basket

Automatically updates target weights for assets based on provided rules.

let txs: TransactionSignature = await basketsSdk.reweightBasket(basket: Basket);

Rebalance Basket

Swap basket tokens using DEX aggregators to bring all tokens back to target weights.

let txs: TransactionSignature[] = await basketsSdk.rebalanceBasket(basket: Basket);

Other Helper Functions

Set priority fee:

await basketsSdk.setPriorityFee(lamports: number);

Fetch User's Holdings:

let allHoldings = await basketsSdk.fetchAllHoldings(user: PublicKey);

Get Oracle Prices

let txs: number[] = await basketsSdk.getOraclePrices();

Retrieve TransactionInstruction Objects that can be called on baskets.

import { BasketInstructions } from "@symmetry-hq/baskets-sdk";
let ix: TransactionInstruction = await BasketInstructions.closeBasketIx(...);
let ix: TransactionInstruction = await BasketInstructions.refilterBasketIx(...);
let ix: TransactionInstruction = await BasketInstructions.reweightBasketIx(...);
let ix: TransactionInstruction = await BasketInstructions.buyBasketWithSingleTokenIx(...);
let ix: TransactionInstruction = await BasketInstructions.instantBurnIx(...);
// and many more

Swap using Symmetry Baskets Liquidity

Users can swap and check available swap liquidity for a specific basket

Find out more at @symmetry-hq/liquidity-sdk

Full Example

Example shows how to create/buy/sell/rebalance/refilter/reweight a basket

Creating basket with following settings:

  • Manager fee : 0.1% - Users pay 0.1% to basket manager when buying
  • Is Mutable - Manager can edit basket settings and rules
  • Asset Pool consists of 4 tokens - [USDC, SOL, BTC, ETH]
  • Basket refilters underlying assets every week
  • Basket reweights underlying assets every day
  • Basket rebalances every 2 hours
  • Basket rebalances when target and current weights differ by at least 5%
  • Maximum allowed slippage on rebalance is 3% (compared to oracle price)
  • Basket provides swap liquidity for a token if current weight is within
    5% (rebalance) 50%(lpOffset) = 2.5% of target weight
  • Basket has 1 rule:
  • Select TOP 3 assets by 1 week average MarketCap,
  • Weight chosen assets by square root of 1 day performance
  • Automation is on (Symmetry Engine will Refilter/Reweight/Rebalance based on rules)
  • Liquidity Provision is enabled.
import {
  BasketsSDK,
  Basket,
  BuyState,
  FilterType,
  FilterTime,
  SortBy,
  WeightType,
  WeightTime
} from "@symmetry-hq/baskets-sdk";

/*  init baskets sdk */
let basketsSdk: BasketsSDK = await BasketsSDK.init(
   connection,
   wallet
);

/*  Create a basket (CreateBasket + SetRules + Refilter&Reweight) */
let basket: Basket = await basketsSdk.createBasket({
  name: "Solana Bitcoin Ethereum",
  symbol: "SOLBTCETH",
  uri: "",
  hostPlatform: wallet.publicKey,     // platform hosting UI 
  hostPlatformFee: 0,                 // fees on deposits for host 
  manager: wallet.publicKey,          // basket manager
  managerFee: 10,                     // deposit fee in bps: 10 = 0.1%
  activelyManaged: 1,                 // actively managed
  assetPool: [0, 1, 2, 3],            // USDC, SOL, BTC, ETH
  refilterInterval: 7 * 24 * 3600,    // 1 week
  reweightInterval: 24 * 3600,        // 1 day
  rebalanceInterval: 2 * 3600,        // 2 hours
  rebalanceThreshold: 500,            // 5%
  rebalanceSlippage: 300,             // 3%
  lpOffsetThreshold: 5000,            // 50% of rebalance threshold
  disableRebalance: 0,                // Auto Rebalance is on
  disableLp: 0,                       // Liquidity provision is on
  rules: [{
    filterBy: FilterType.MarketCap,   // filter assets by marketcap
    filterDays: FilterTime.Week,      // by 1 week average of marketcap
    sortBy: SortBy.DescendingOrder,   // select top coins by marketcap
    totalWeight: 100,                 // total weight of this rule
    fixedAsset: 0,                    // (provide if filterBy is Fixed)
    numAssets: 3,                     // select 3 assets
    weightBy: WeightType.Performance, // weight by performance
    weightDays: WeightTime.Day,       // 1 day performance
    weightExpo: 0.5,                  // square root of performance
    excludeAssets: [0],               // Exclude USDC when filtering
   }],
});

/*  1. buy a basket with 50 USDC
    2. rebalance buyState (buy underlying assets)
    3. mint basket tokens */
let buyState1: BuyState = await basketsSdk.buyBasket(basket, 50);
let txsRebalanceBuyState1 = await basketsSdk.rebalanceBuyState(buyState1);
let txMintBasket1 = await basketsSdk.mintBasket(buyState1);


/*  1. buy a basket with 50 USDC without rebalancing
      unspent amount will have *penalty* and counted as if rebalance
      happend with maximum slippage (rebalanceSlippage = 3%)
    2. mint basket tokens */
let buyState2: BuyState = await basketsSdk.buyBasket(basket, 50);
let txMintBasket2 = await basketsSdk.mintBasket(buyState2);


/*  1. sell a basket
    2. rebalance basket (to USDC)
    3. claim tokens (USDC + tokens for which rebalance failed) */
let sellState1: Basket = await basketsSdk.sellBasket(basket, 0.4, true);
let txsRebalanceSellState = await basketsSdk.rebalanceBasket(sellState1);
let txsClaimTokens1 = await basketsSdk.claimTokens(sellState);

/*  1. sell a basket without rebalancing
    2. claim tokens (all tokens in a SellState) */
let sellState2: Basket = await basketsSdk.sellBasket(basket, 0.4, false);
let txsClaimTokens2 = await basketsSdk.claimTokens(sellState2);


/*  1. Refilter basket (RefilterInterval seconds since last refilter)
    2. Reweight basket (ReweightInterval seconds since last reweight)
    3. Rebalance basket (RebalanceInterval seconds since last rebalanace) */
let txRefilter: TransactionSignature = await basketsSdk.refilterBasket(basket);
let txReweight: TransactionSignature = await basketsSdk.reweightBasket(basket);
let txsRebalance = await basketsSdk.rebalanceBasket(basket);


/* In some cases, when basket decides to remove token after refiltering,
   and rebalance function sells it to USDC, basket might end up with 
   small amount of that token, for which it is unable to rebalance and
   sell the full amount. Although it's possible to remove the "dust"
   if user swaps equivalent amount of usdc (based on oracle price) for 
   the token, which is stuck in a basket. Meaning that basket will receive
   USDC and user will receive token. RemoveDust will be triggered for
   tokens with equivalent USD value < 0.005.
   Amount of usdc to be swapped is computed in a following way:
   max(tokenAmount * tokenPrice * 1.1 (for slippage purposes), 0.000001) */
let txsRemoveDust = await basket.removeDust();

Types

// Information about Token and its settings
type TokenSettings = {
    id: number,
    symbol: string,
    name: string,
    tokenMint: string,
    decimals: number,
    coingeckoId: string,
    pdaTokenAccount: string,
    oracleType: string,
    oracleAccount: string,
    oracleIndex: number,
    oracleConfidencePct: number,
    fixedConfidenceBps: number,
    tokenSwapFeeBeforeTwBps: number,
    tokenSwapFeeAfterTwBps: number,
    isLive: boolean,
    lpOn: boolean,
    useCurveData: boolean,
    additionalData: number[],
}
// Create/Edit Basket settings
type SimpleEditParams = {
    managerFee: number,         // manager fee in bps 100 = 1%
    rebalanceInterval: number,  // rebalance interval in seconds
    rebalanceThreshold: number, // rebalance threshold in bps 100 = 1%
    rebalanceSlippage: number,  // rebalance slippage in bps 100 = 1%
    lpOffsetThreshold: number,  // liquidity provsion ... in bps
    disableRebalance: boolean,  // true for turning of automation
    disableLp: boolean,         // true for turining of lp
    composition: {token: PublicKey, weight: number}[],
}
type CreateBasketParams = {
    name: string,
    symbol: string,
    uri: string,                // metadata URI which stores name, symbol, logo.
    hostPlatform: PublicKey,    // platofrm hosting symmetry UI
    hostPlatformFee: number,    // deposit fee for host platform in bps
    manager: PublicKey,         // basket manager
    managerFee: number,         // deposit fee for manager in bps 
    activelyManaged: number,    // 0 - Immutable, 1 - Mutable, 2 - Permissioned
    assetPool: number[],        // Asset pool with tokenIds (check getTokenListData())
    refilterInterval: number,   // refilter interval in seconds
    reweightInterval: number,   // reweight interval in seconds
    rebalanceInterval: number,  // rebalance interval in seconds
    rebalanceThreshold: number, // rebalance threshold in bps 
    rebalanceSlippage: number,  // rebalance slippage in bps
    lpOffsetThreshold: number,  // liquidity provision .. in bps
    disableRebalance: boolean,  // true for disabling automaion
    disableLp: boolean,         // true for disabling liquidity provision
    rules: Rule[],
}

type Rule = {
  totalWeight: number,     // (integer) - total weight of this rule (relative to other rules)
  filterBy: FilterType,    // FilterType.Fixed if you want this rule to have 1 specific asset
  filterDays: FilterTime,
  sortBy: SortBy,
  fixedAsset: number,      // id of token if you want this rule to have 1 specific asset
  numAssets: number,       // number of tokens for this rule (1 for specific asset)
  weightBy: WeightType,
  weightDays: WeightTime,
  weightExpo: number,      // (integer) expo multiplied by 100x. for ^0.5 use 500
  excludeAssets: number[], // token ids to be excluded when filtering
}

export enum FilterType {
    Fixed,       // 0
    MarketCap,   // 1
    Volume,      // 2
    Performance, // 3
}
export enum WeightType {
    Fixed,       // 0
    MarketCap,   // 1
    Volume,      // 2
    Performance, // 3
}
export enum FilterTime {
    Day,         // 0
    Week,        // 1
    Month,       // 2
    Quarter,     // 3
    HalfYear,    // 4
    Year,        // 5
}
export enum WeightTime {
    Day,         // 0
    Week,        // 1
    Month,       // 2
    Quarter,     // 3
    HalfYear,    // 4
    Year,        // 5
}
export enum SortBy {
    DescendingOrder,  // 0
    AscendingOrder,   // 1
}
// Current Composition 
type CurrentComposition = {
  currentSupply: number,
  basketTokenMint: PublicKey,
  basketWorth: number,
  rawPrice: number,
  manager: PublicKey,
  managerFee: number,
  activelyManaged: boolean,
  host: PublicKey,
  hstFee: number,
  currentComposition: CurrComp[],
  rules: Rule[]
}
type CurrComp = {
  coingeckoId: string,
  currentWeight: number,
  lockedAmount: number,
  mintAddress: string,
  oraclePrice: number,
  symbol: string,
  symmetryTokenId: number,
  targetWeight: number
  usdValue: number,
  tokenData: TokenSettings
}
// Filter options for finding baskets:
type BasketFilter = "manager" | "host";

type FilterOption = {
    filterType: BasketFilter,
    filterPubkey: PublicKey,
}
// On-chain state account structure for Baskets and SellStates
type BasketStateChainData = {
  version: BN,
  manager: PublicKey,
  fundToken: PublicKey,
  managerFee: BN,
  supplyOutstanding: BN,
  activelyManaged: BN,
  activeBuyStates: BN,

  sellState: BN,
  rebalanceSellState: BN,

  hostPubkey: PublicKey,
  hostFee: BN,

  numOfTokens: BN,     
  currentCompToken: BN[],
  currentCompAmount: BN[],
  lastRebalanceTime: BN[],
  targetWeight: BN[],
  weightSum: BN,

  currentWeight: BN[],
  fundWorth: BN,
  lastUpdateTime: BN,

  refilterInterval: BN,
  reweightInterval: BN,
  rebalanceInterval: BN,
  rebalanceThreshold: BN,
  rebalanceSlippage: BN,
  lpOffsetThreshold: BN,
  lastRefilterTime: BN,
  lastReweightTime: BN,

  rulesReady: BN,
  assetPool: BN[],
  numOfRules: BN,      
  rules: {
    filterBy: BN,
    filterDays: BN,
    sortBy: BN,
    totalWeight: BN,
    fixedAsset: BN,
    numAssets: BN,
    weightBy: BN,  
    weightDays: BN,
    weightExpo: BN,
    excludeNum: BN,
    excludeAssets: BN[],
    ruleAssets: BN[],
  }[],

  numRuleTokens: BN,   
  ruleTokens: BN[],
  ruleTokenWeights: BN[],

  messageDigestFive: number[],

  disableRebalance: BN,
  disableLp: BN,

  allowMultiAssetContribution: number,
  symbolLength: number,
  symbol: number[],
  nameLength: number,
  name: number[],
  uriLength: number,
  uri: number[],

  extraBytes: number[],
}

// On-chain state account structure for BuyStates
type BuyStateChainData = {
  fund: PublicKey,
  buyer: PublicKey,
  fundManager: PublicKey,
  hostPlatform: PublicKey,
  buyerFundTokenAccount: PublicKey,
  usdcContributed: BN,
  usdcLeft: BN,
  token: BN[],
  amountToSpend: BN[],
  amountBought: BN[],
  creationTimestamp: BN,
  contributedValue: BN
}

Package Sidebar

Install

npm i @symmetry-hq/baskets-sdk

Weekly Downloads

137

Version

0.0.28

License

ISC

Unpacked Size

855 kB

Total Files

28

Last publish

Collaborators

  • effarigesrever
  • prism-ag
  • ubermenschsym
  • symmetry_fi