@symmetry-hq/temp-v3-sdk 0.0.1

package/src/layouts/basket.ts

@@ -0,0 +1,82 @@
+
+import { BN } from "@coral-xyz/anchor";
+import { PublicKey } from "@solana/web3.js";
+import { array, publicKey, str, struct, u128, u16, u64, u8 } from '@coral-xyz/borsh';
+import { OracleAggregator, OracleAggregatorLayout } from "./oracle";
+import { Fraction, FractionLayout } from "./fraction";
+import { BasketSettings, BasketSettingsLayout } from "./config";
+
+export const MAX_SUPPORTED_TOKENS_PER_BASKET: number = 100;
+
+export interface BasketFees {
+    symmetryFees: BN; // u64
+    creatorFees: BN; // u64
+    hostFees: BN; // u64
+    managersFees: BN; // u64
+};
+
+export const BasketFeesLayout = struct<BasketFees>([
+    u64("symmetryFees"),
+    u64("creatorFees"),
+    u64("hostFees"),
+    u64("managersFees"),
+]);
+
+export interface LookupTables {
+    active: PublicKey[]; // length 2
+    temp: PublicKey[]; // length 2
+};
+
+export const LookupTablesLayout = struct<LookupTables>([
+    array(publicKey(), 2, "active"),
+    array(publicKey(), 2, "temp"),
+]);
+
+export interface Asset {
+    mint: PublicKey;
+    amount: BN; // u64
+    weight: number; // u16
+    oracleAggregator: OracleAggregator;
+};
+
+export const AssetLayout = struct<Asset>([
+    publicKey('mint'),
+    u64('amount'),
+    u16('weight'),
+    OracleAggregatorLayout.replicate('oracleAggregator'),
+]);
+
+export interface Basket {
+    version: number; // u8
+    seedArray: number[]; // length 16
+    ownAddress: PublicKey;
+    mint: PublicKey;
+    supplyOutstanding: BN; // u64
+
+    highWaterMark: Fraction;
+    bountyBalance: BN; // u64
+
+    settings: BasketSettings;
+    accumulatedFees: BasketFees;
+    lookupTables: LookupTables;
+
+    writeVersion: BN; // u64
+    numTokens: number; // u8
+    composition: Asset[]; // length MAX_SUPPORTED_TOKENS_PER_BASKET
+};
+
+export const BasketLayout = struct<Basket>([
+    u8('version'),
+    array(u8(), 16, 'seedArray'),
+    publicKey('ownAddress'),
+    publicKey('mint'),
+    u64('supplyOutstanding'),
+    FractionLayout.replicate('highWaterMark'),
+    u64('bountyBalance'),
+    BasketSettingsLayout.replicate('settings'),
+    BasketFeesLayout.replicate('accumulatedFees'),
+    LookupTablesLayout.replicate('lookupTables'),
+    u64('writeVersion'),
+    u8('numTokens'),
+    array(AssetLayout, MAX_SUPPORTED_TOKENS_PER_BASKET, 'composition'),
+]);

package/src/layouts/config.ts

@@ -0,0 +1,301 @@
+import { PublicKey } from "@solana/web3.js";
+import { array, publicKey, str, struct, u128, u16, u64, u8 } from '@coral-xyz/borsh';
+import { Fraction, FractionLayout } from "./fraction";
+import { BN } from "@coral-xyz/anchor";
+import { BountySchedule, BountyScheduleLayout } from "./intents/bounty";
+
+export const MAX_MANAGERS_PER_BASKET = 10;
+export const MAX_SYMBOL_LENGTH = 10;
+export const MAX_NAME_LENGTH = 32;
+export const MAX_URI_LENGTH = 200;
+
+export enum BasketType {
+    Private = 0,
+    Public = 1,
+};
+
+export const BasketTypeLayout = struct<BasketType>([
+    u8('basketType'),
+]);
+
+export interface ScheduleSettings {
+    cycleDuration: BN; // u64 
+    depositsStart: BN; // u64
+    depositsEnd: BN; // u64
+    automationStart: BN; // u64
+    automationEnd: BN; // u64
+    managementStart: BN; // u64
+    managementEnd: BN; // u64
+    modificationDelay: BN; // u64
+};
+
+export const ScheduleSettingsLayout = struct<ScheduleSettings>([
+    u64('cycleDuration'),
+    u64('depositsStart'),
+    u64('depositsEnd'),
+    u64('automationStart'),
+    u64('automationEnd'),
+    u64('managementStart'),
+    u64('managementEnd'),
+    u64('modificationDelay'),
+]);
+
+export interface FeeSettings {
+    hostDepositFeeBps: number;
+    hostManagementFeeBps: number;
+    hostPerformanceFeeBps: number;
+    creatorDepositFeeBps: number;
+    creatorManagementFeeBps: number;
+    creatorPerformanceFeeBps: number;
+    managersDepositFeeBps: number;
+    managersManagementFeeBps: number;
+    managersPerformanceFeeBps: number;
+    basketDepositFeeBps: number;
+    basketWithdrawFeeBps: number;
+    modificationDelay: BN; // u64 -> BN
+};
+
+export const FeeSettingsLayout = struct<FeeSettings>([
+    u16('hostDepositFeeBps'),
+    u16('hostManagementFeeBps'),
+    u16('hostPerformanceFeeBps'),
+    u16('creatorDepositFeeBps'),
+    u16('creatorManagementFeeBps'),
+    u16('creatorPerformanceFeeBps'),
+    u16('managersDepositFeeBps'),
+    u16('managersManagementFeeBps'),
+    u16('managersPerformanceFeeBps'),
+    u16('basketDepositFeeBps'),
+    u16('basketWithdrawFeeBps'),
+    u64('modificationDelay'),
+]);
+
+export interface ManagerSettings {
+    managers: PublicKey[]; // [Pubkey; 10]
+    managersWeightBps: number[]; //[u16; 10]
+    modificationDelay: BN; // u64
+}
+
+export const ManagerSettingsLayout = struct<ManagerSettings>([
+    array(publicKey(), MAX_MANAGERS_PER_BASKET, 'managers'),
+    array(u16(), MAX_MANAGERS_PER_BASKET, 'managersWeightBps'),
+    u64('modificationDelay'),
+])
+
+export interface AutomationSettings {
+    allowAutomation: number;          // u8
+    rebalanceSlippageBps: number;    // u16
+    rebalanceThresholdBps: number;   // u16
+    rebalanceIntervalSeconds: BN;    // u64 -> BN
+    modificationDelay: BN;            // u64 -> BN
+};
+
+export const AutomationSettingsLayout = struct<AutomationSettings>([
+    u8('allowAutomation'),
+    u16('rebalanceSlippageBps'),
+    u16('rebalanceThresholdBps'),
+    u64('rebalanceIntervalSeconds'),
+    u64('modificationDelay'),
+]);
+  
+export interface LpSettings {
+    lpThresholdBps: number; // u16
+    allowLp: number;          // u8
+    modificationDelay: BN;    // u64 -> BN
+};
+
+export const LpSettingsLayout = struct<LpSettings>([
+    u16('lpThresholdBps'),
+    u8('allowLp'),
+    u64('modificationDelay'),
+]);
+  
+export interface MetadataSettings {
+    symbolLength: number;          // u8
+    symbol: number[];               // [u8; MAX_SYMBOL_LENGTH]
+    nameLength: number;            // u8
+    name: number[];                 // [u8; MAX_NAME_LENGTH]
+    uriLength: number;             // u8
+    uri: number[];                  // [u8; MAX_URI_LENGTH]
+    modificationDelay: BN;         // u64
+};
+
+export const MetadataSettingsLayout = struct<MetadataSettings>([
+    u8('symbolLength'),
+    array(u8(), MAX_SYMBOL_LENGTH, 'symbol'),
+    u8('nameLength'),
+    array(u8(), MAX_NAME_LENGTH, 'name'),
+    u8('uriLength'),
+    array(u8(), MAX_URI_LENGTH, 'uri'),
+    u64('modificationDelay'),
+]);
+
+export interface BasketSettings {
+    creator: PublicKey;
+    host: PublicKey;
+  
+    basketType: BasketType;
+    startPrice: Fraction;
+  
+    activeRebalance: BN;
+    activeDeposits: BN;
+    activeManagements: BN;
+  
+    schedule: ScheduleSettings;
+    scheduleAuthorityBitmask: number; // u16
+  
+    feeSettings: FeeSettings;
+    feeSettingsAuthorityBitmask: number; // u16
+  
+    managerSettings: ManagerSettings;
+    managerSettingsAuthorityBitmask: number; // u16
+  
+    automationSettings: AutomationSettings;
+    automationSettingsAuthorityBitmask: number; // u16
+  
+    lpSettings: LpSettings;
+    lpSettingsAuthorityBitmask: number; // u16
+  
+    metadataSettings: MetadataSettings;
+    metadataSettingsAuthorityBitmask: number; // u16
+  
+    addTokenDelay: BN; // u64
+    addTokenIntentAuthorityBitmask: number; // u16
+  
+    updateWeightsDelay: BN; // u64
+    updateWeightsIntentAuthorityBitmask: number; // u16
+  
+    makeDirectSwapDelay: BN; // u64
+    makeDirectSwapIntentAuthorityBitmask: number; // u16
+  
+    extraData: BN[]; // [u64; 32]
+};
+
+export const BasketSettingsLayout = struct<BasketSettings>([
+    publicKey('creator'),
+    publicKey('host'),
+  
+    BasketTypeLayout.replicate('basketType'),
+    FractionLayout.replicate('startPrice'),
+  
+    u64('activeRebalance'),
+    u64('activeDeposits'),
+    u64('activeManagements'),
+  
+    ScheduleSettingsLayout.replicate('schedule'),
+    u16('scheduleAuthorityBitmask'),
+  
+    FeeSettingsLayout.replicate('feeSettings'),
+    u16('feeSettingsAuthorityBitmask'),
+  
+    ManagerSettingsLayout.replicate('managerSettings'),
+    u16('managerSettingsAuthorityBitmask'),
+  
+    AutomationSettingsLayout.replicate('automationSettings'),
+    u16('automationSettingsAuthorityBitmask'),
+  
+    LpSettingsLayout.replicate('lpSettings'),
+    u16('lpSettingsAuthorityBitmask'),
+  
+    MetadataSettingsLayout.replicate('metadataSettings'),
+    u16('metadataSettingsAuthorityBitmask'),
+  
+    u64('addTokenDelay'),
+    u16('addTokenIntentAuthorityBitmask'),
+  
+    u64('updateWeightsDelay'),
+    u16('updateWeightsIntentAuthorityBitmask'),
+  
+    u64('makeDirectSwapDelay'),
+    u16('makeDirectSwapIntentAuthorityBitmask'),
+  
+    array(u64(), 32, 'extraData'),
+]);
+
+
+
+
+export interface GlobalConfig {
+    admin: PublicKey;
+    owners: PublicKey[]; // [Pubkey; 3]
+  
+    allowCreation: number;     // u8
+    allowManagement: number;   // u8
+    allowAutomation: number;   // u8
+    allowDeposits: number;     // u8
+    allowWithdraws: number;    // u8
+  
+    maxDepositFeeBps: number;     // u16
+    maxWithdrawFeeBps: number;    // u16
+    maxManagementFeeBps: number;  // u16
+    maxPerformanceFeeBps: number; // u16
+  
+    symmetryFeeCollector: PublicKey;
+    symmetryDepositFeeBps: number;     // u16
+    symmetryWithdrawFeeBps: number;    // u16
+    symmetryRebalanceFeeBps: number;   // u16
+    symmetryManagementFeeBps: number;  // u16
+    symmetryPerformanceFeeBps: number; // u16
+  
+    bountyMint: PublicKey;
+    minBountyForBasketAutomation: BN; // u64
+    bountyBondAmount: BN;               // u64
+    bountyPerPriceUpdateTask: BountySchedule;
+    bountyPerTask: BountySchedule;
+  
+    aprBpsPerYear: number;      // u16
+    rebalanceIntentLifetime: BN; // u64
+  
+    depositTimeframe: BN;                 // u64
+    priceUpdateTimeframe: BN;            // u64
+    rebalanceAuction1Timeframe: BN;    // u64
+    rebalanceAuction2Timeframe: BN;    // u64
+    rebalanceAuction3Timeframe: BN;    // u64
+  
+    priceUpdateDelayAfterCreation: BN; // u64
+    priceUpdateLifetime: BN;             // u64
+    priceUpdateReexecutionDelay: BN;    // u64
+}
+  
+
+export const GlobalConfigLayout = struct<GlobalConfig>([
+    publicKey('admin'),
+    array(publicKey(), 3, 'owners'),
+  
+    u8('allowCreation'),
+    u8('allowManagement'),
+    u8('allowAutomation'),
+    u8('allowDeposits'),
+    u8('allowWithdraws'),
+  
+    u16('maxDepositFeeBps'),
+    u16('maxWithdrawFeeBps'),
+    u16('maxManagementFeeBps'),
+    u16('maxPerformanceFeeBps'),
+  
+    publicKey('symmetryFeeCollector'),
+    u16('symmetryDepositFeeBps'),
+    u16('symmetryWithdrawFeeBps'),
+    u16('symmetryRebalanceFeeBps'),
+    u16('symmetryManagementFeeBps'),
+    u16('symmetryPerformanceFeeBps'),
+  
+    publicKey('bountyMint'),
+    u64('minBountyForBasketAutomation'),
+    u64('bountyBondAmount'),
+    BountyScheduleLayout.replicate('bountyPerPriceUpdateTask'),
+    BountyScheduleLayout.replicate('bountyPerTask'),
+  
+    u16('aprBpsPerYear'),
+    u64('rebalanceIntentLifetime'),
+  
+    u64('depositTimeframe'),
+    u64('priceUpdateTimeframe'),
+    u64('rebalanceAuction1Timeframe'),
+    u64('rebalanceAuction2Timeframe'),
+    u64('rebalanceAuction3Timeframe'),
+  
+    u64('priceUpdateDelayAfterCreation'),
+    u64('priceUpdateLifetime'),
+    u64('priceUpdateReexecutionDelay'),
+]);

package/src/layouts/fraction.ts

@@ -0,0 +1,12 @@
+import { BN } from "@coral-xyz/anchor";
+import { array, publicKey, str, struct, u128, u16, u64, u8 } from '@coral-xyz/borsh';
+
+export interface Fraction {
+    numerator: BN; // u64 -> BN
+    exponent: BN; // u64 -> BN
+};
+
+export const FractionLayout = struct<Fraction>([
+    u64('numerator'),
+    u64('exponent'),
+]);

package/src/layouts/intents/bounty.ts

@@ -0,0 +1,35 @@
+import { BN } from "@coral-xyz/anchor";
+import { PublicKey } from "@solana/web3.js";
+import { array, publicKey, str, struct, u128, u16, u64, u8 } from '@coral-xyz/borsh';
+
+export interface BountySchedule {
+    minBounty: BN;        // u64
+    maxBounty: BN;        // u64
+    minBountyUntil: BN;  // u64
+    maxBountyAfter: BN;  // u64
+};
+
+export const BountyScheduleLayout = struct<BountySchedule>([
+    u64('minBounty'),
+    u64('maxBounty'),
+    u64('minBountyUntil'),
+    u64('maxBountyAfter'),
+]);
+
+export interface Bounty {
+    bountyDepositor: PublicKey;
+    bountyMint: PublicKey;
+    bountyTotal: BN; // u64
+    bountyLeft: BN; // u64
+    bountyPerPriceUpdateTask: BountySchedule;
+    bountyPerTask: BountySchedule;
+}
+  
+  export const BountyLayout = struct<Bounty>([
+    publicKey('bountyDepositor'),
+    publicKey('bountyMint'),
+    u64('bountyTotal'),
+    u64('bountyLeft'),
+    BountyScheduleLayout.replicate('bountyPerPriceUpdateTask'),
+    BountyScheduleLayout.replicate('bountyPerTask')
+]);

package/src/layouts/intents/intent.ts

@@ -0,0 +1,204 @@
+import { BN } from "@coral-xyz/anchor";
+import { PublicKey } from "@solana/web3.js";
+import { array, publicKey, str, struct, u128, u16, u64, u8 } from '@coral-xyz/borsh';
+import { Bounty, BountyLayout } from "./bounty";
+import { AutomationSettings, FeeSettings, LpSettings, ManagerSettings, ManagerSettingsLayout, MetadataSettings, ScheduleSettings } from "../config";
+import { OracleAggregator } from "../../states/oracles/oracle";
+import { OracleAggregatorLayout } from "../oracle";
+
+export const INTENT_TASK_DATA_SIZE = 600;
+
+export enum IntentStatus {
+    NotActive,
+    Active,
+    Reverted,
+    Completed,
+};
+
+export interface ParsedIntent {
+    manager: PublicKey;
+    status : IntentStatus;
+    activationTimestamp: BN; // u64
+    basket: PublicKey;
+    bounty: Bounty;
+    taskType: TaskType;
+    taskData: EditData;
+};
+
+export interface Intent {
+    manager: PublicKey;
+    status : IntentStatus;
+    activationTimestamp: BN; // u64
+    basket: PublicKey;
+    bounty: Bounty;
+    taskType: TaskType;
+    taskData: number[]; // length of 600
+};
+
+export const IntentLayout = struct<Intent>([
+    publicKey('manager'),
+    u8('status'),
+    u64('activationTimestamp'),
+    publicKey('basket'),
+    BountyLayout.replicate('bounty'),
+    u8('taskType'),
+    array(u8(), INTENT_TASK_DATA_SIZE, 'taskData'),
+]);
+
+export interface HostFees {
+    hostDepositFeeBps: number;
+    hostManagementFeeBps: number;
+    hostPerformanceFeeBps: number;
+}
+
+export const HostFeesLayout = struct<HostFees>([
+    u16('hostDepositFeeBps'),
+    u16('hostManagementFeeBps'),
+    u16('hostPerformanceFeeBps'),
+]);
+  
+  
+export interface MetadataParams {
+    name: string;
+    symbol: string;
+    uri: string;
+};
+
+export const MetadataParamsLayout = struct([
+    str("name"),
+    str("symbol"),
+    str("uri"),
+]);
+  
+
+export enum TaskType {
+    Unknown = 0,
+  
+    EditSchedule = 1,
+    EditFeeSettings = 2,
+    EditManagerSettings = 3,
+    EditAutomationSettings = 4,
+    EditLpSettings = 5,
+    EditMetadataSettings = 6,
+  
+    EditAddTokenDelay = 7,
+    EditUpdateWeightsDelay = 8,
+  
+    AddToken = 9,
+    UpdateWeights = 10,
+    Swap = 11,
+  }
+  
+  export function taskTypeFromU8(value: number): TaskType {
+    switch (value) {
+      case 1: return TaskType.EditSchedule;
+      case 2: return TaskType.EditFeeSettings;
+      case 3: return TaskType.EditManagerSettings;
+      case 4: return TaskType.EditAutomationSettings;
+      case 5: return TaskType.EditLpSettings;
+      case 6: return TaskType.EditMetadataSettings;
+      case 7: return TaskType.EditAddTokenDelay;
+      case 8: return TaskType.EditUpdateWeightsDelay;
+      case 9: return TaskType.AddToken;
+      case 10: return TaskType.UpdateWeights;
+      case 11: return TaskType.Swap;
+      default: return TaskType.Unknown;
+    }
+};
+
+export interface AuthorityBitmasks{
+    scheduleAuthorityBitmask: number; // u16
+    feeSettingsAuthorityBitmask: number; // u16
+    managerSettingsAuthorityBitmask: number; // u16
+    automationSettingsAuthorityBitmask: number; // u16
+    lpSettingsAuthorityBitmask: number; // u16
+    metadataSettingsAuthorityBitmask: number; // u16
+    addTokenIntentAuthorityBitmask: number; // u16
+    updateWeightsIntentAuthorityBitmask: number; // u16
+    makeDirectSwapIntentAuthorityBitmask: number; // u16
+};
+
+export const AuthorityBitmasksLayout = struct<AuthorityBitmasks>([
+    u16('scheduleAuthorityBitmask'),
+    u16('feeSettingsAuthorityBitmask'),
+    u16('managerSettingsAuthorityBitmask'),
+    u16('automationSettingsAuthorityBitmask'),
+    u16('lpSettingsAuthorityBitmask'),
+    u16('metadataSettingsAuthorityBitmask'),
+    u16('addTokenIntentAuthorityBitmask'),
+    u16('updateWeightsIntentAuthorityBitmask'),
+    u16('makeDirectSwapIntentAuthorityBitmask'),
+]);
+
+export interface ManagerSettingsWithAuthorityBitmasks{
+    managerSettings: ManagerSettings;
+    authorityBitmasks: AuthorityBitmasks;
+};
+
+export const ManagerSettingsWithAuthorityBitmasksLayout = struct<ManagerSettingsWithAuthorityBitmasks>([
+    ManagerSettingsLayout.replicate('managerSettings'),
+    AuthorityBitmasksLayout.replicate('authorityBitmasks'),
+]);
+
+export interface AddTokenDelay{
+    delay: BN; // u64
+};
+
+export const AddTokenDelayLayout = struct<AddTokenDelay>([
+    u64('delay'),
+]);
+  
+export interface UpdateWeightsDelay{
+    delay: BN; // u64
+};
+
+export const UpdateWeightsDelayLayout = struct<UpdateWeightsDelay>([
+    u64('delay'),
+]);
+
+export interface AddToken{
+    oracleAggregator: OracleAggregator;
+    tokenMint: PublicKey;
+    oracleAccounts: PublicKey[];
+};
+
+export const AddTokenLayout = struct<AddToken>([
+    OracleAggregatorLayout.replicate('oracleAggregator'),
+    publicKey('tokenMint'),
+    array(publicKey(), 4, 'oracleAccounts'),
+]);
+
+export interface UpdateWeights{
+    tokenWeights: number[]; // [u16; 100]
+    writeVersion: BN; // u64
+};
+
+export const UpdateWeightsLayout = struct<UpdateWeights>([
+    array(u16(), 100, 'tokenWeights'),
+    u64('writeVersion'),
+]);
+  
+export interface Swap {
+    fromTokenMint: PublicKey;
+    toTokenMint: PublicKey;
+    amountFrom: BN; // u64
+};
+export const SwapLayout = struct<Swap>([
+    publicKey('fromTokenMint'),
+    publicKey('toTokenMint'),
+    u64('amountFrom'),
+]);
+
+export type EditData =
+    ScheduleSettings |
+    FeeSettings |
+    ManagerSettingsWithAuthorityBitmasks |
+    AutomationSettings |
+    LpSettings |
+    MetadataSettings |
+    AddTokenDelay |
+    UpdateWeightsDelay |
+    AddToken |
+    UpdateWeights |
+    Swap;
+