@symmetry-hq/sdk 1.0.1

package/dist/src/layouts/basket.d.ts

@@ -0,0 +1,191 @@
+import BN from 'bn.js';
+import { AddressLookupTableAccount, PublicKey } from '@solana/web3.js';
+import { OracleAggregator } from './oracle';
+import { OraclePrice } from '../states/oracles/oracle';
+import Decimal from 'decimal.js';
+import { BasketSettings } from './config';
+import { EditAddTokenSettings, EditAutomationSettings, EditCreatorSettings, EditCustomRebalanceSettings, EditDepositsSettings, EditFeeSettings, EditForceRebalanceSettings, EditLpSettings, EditMakeDirectSwapSettings, EditManagerSettings, EditMetadataSettings, EditScheduleSettings, EditUpdateWeightsSettings, OracleInput } from './intents/intent';
+export type FormattedBasketType = "private" | "public";
+export declare const BASKET_TYPES_STRINGS: Map<number, FormattedBasketType>;
+export interface FormattedAccumulatedFees {
+    symmetry_fees: number;
+    creator_fees: number;
+    host_fees: number;
+    managers_fees: number;
+}
+export interface FormattedLookupTables {
+    active: {
+        pubkey: string;
+        contents: string[];
+    }[];
+    temp: {
+        pubkey: string;
+        contents: string[];
+    }[];
+}
+export interface FormattedOracleSettings extends OracleInput {
+    quote: string;
+    side: string;
+}
+export interface FormattedOracle {
+    oracle_settings: FormattedOracleSettings;
+    accounts_to_load_lut_ids: number[];
+    accounts_to_load_lut_indices: number[];
+}
+export interface FormattedOracleAggregator {
+    num_oracles: number;
+    min_oracles_thresh: number;
+    oracles: FormattedOracle[];
+    min_conf_bps: number;
+    conf_thresh_bps: number;
+    conf_multiplier: number;
+}
+export interface FormattedAsset {
+    mint: string;
+    amount: number;
+    weight: number;
+    active: boolean;
+    oracle_aggregator: FormattedOracleAggregator;
+}
+export interface FormattedCreatorSettings extends EditCreatorSettings {
+}
+export interface FormattedManagersSettings extends EditManagerSettings {
+    updated_at: number;
+}
+export interface FormattedFeeSettings extends EditFeeSettings {
+    host_deposit_fee_bps: number;
+    host_withdraw_fee_bps: number;
+    host_management_fee_bps: number;
+    host_performance_fee_bps: number;
+    updated_at: number;
+}
+export interface FormattedScheduleSettings extends EditScheduleSettings {
+    updated_at: number;
+}
+export interface FormattedAutomationSettings extends EditAutomationSettings {
+    updated_at: number;
+}
+export interface FormattedLpSettings extends EditLpSettings {
+    updated_at: number;
+}
+export interface FormattedMetadataSettings extends EditMetadataSettings {
+    updated_at: number;
+}
+export interface FormattedDepositsSettings extends EditDepositsSettings {
+}
+export interface FormattedForceRebalanceSettings extends EditForceRebalanceSettings {
+    updated_at: number;
+}
+export interface FormattedCustomRebalanceSettings extends EditCustomRebalanceSettings {
+    updated_at: number;
+}
+export interface FormattedAddTokenSettings extends EditAddTokenSettings {
+    updated_at: number;
+}
+export interface FormattedUpdateWeightsSettings extends EditUpdateWeightsSettings {
+    updated_at: number;
+}
+export interface FormattedMakeDirectSwapSettings extends EditMakeDirectSwapSettings {
+    updated_at: number;
+}
+export interface FormattedBasket {
+    pubkey: string;
+    name: string;
+    symbol: string;
+    uri: string;
+    version: number;
+    own_address: string;
+    mint: string;
+    supply_outstanding: number;
+    creator: string;
+    host: string;
+    basket_type: FormattedBasketType;
+    bounty_mint: string;
+    bounty_balance: number;
+    start_price: number;
+    high_watermark: number;
+    active_rebalance: number;
+    active_withdraws: number;
+    active_managements: number;
+    last_automation_execution_timestamp: number;
+    creator_settings: FormattedCreatorSettings;
+    manager_settings: FormattedManagersSettings;
+    fee_settings: FormattedFeeSettings;
+    schedule_settings: FormattedScheduleSettings;
+    automation_settings: FormattedAutomationSettings;
+    lp_settings: FormattedLpSettings;
+    metadata_settings: FormattedMetadataSettings;
+    deposits_settings: FormattedDepositsSettings;
+    force_rebalance_settings: FormattedForceRebalanceSettings;
+    custom_rebalance_settings: FormattedCustomRebalanceSettings;
+    add_token_settings: FormattedAddTokenSettings;
+    update_weights_settings: FormattedUpdateWeightsSettings;
+    make_direct_swap_settings: FormattedMakeDirectSwapSettings;
+    accumulated_fees: FormattedAccumulatedFees;
+    lookup_tables: FormattedLookupTables;
+    composition: FormattedAsset[];
+}
+export interface BasketFees {
+    symmetryFees: BN;
+    creatorFees: BN;
+    hostFees: BN;
+    managersFees: BN;
+}
+export declare const BasketFeesLayout: any;
+export interface FormattedWithdrawBasketFees {
+    pubkey: string;
+    basket: string;
+    rent_payer: string;
+    owners: string[];
+    owners_weights: number[];
+    accumulated_tokens: string[];
+    accumulated_fees: number[];
+}
+export interface WithdrawBasketFees {
+    basket: PublicKey;
+    rentPayer: PublicKey;
+    owners: PublicKey[];
+    ownersWeights: number[];
+    accumulatedTokens: PublicKey[];
+    accumulatedFees: BN[];
+    ownAddress?: PublicKey;
+    formatted?: FormattedWithdrawBasketFees;
+}
+export declare const WithdrawBasketFeesLayout: any;
+export interface LookupTables {
+    active: PublicKey[];
+    temp: PublicKey[];
+}
+export declare const LookupTablesLayout: any;
+export interface Asset {
+    mint: PublicKey;
+    amount: BN;
+    weight: number;
+    active: number;
+    oracleAggregator: OracleAggregator;
+    price?: OraclePrice;
+    value?: Decimal;
+}
+export declare const AssetLayout: any;
+export interface Metadata {
+    symbol: string;
+    name: string;
+    uri: string;
+}
+export interface Basket {
+    version: number;
+    ownAddress: PublicKey;
+    mint: PublicKey;
+    supplyOutstanding: BN;
+    settings: BasketSettings;
+    accumulatedFees: BasketFees;
+    lookupTables: LookupTables;
+    numTokens: number;
+    composition: Asset[];
+    lutPubkeys?: AddressLookupTableAccount[];
+    metadata?: Metadata;
+    tvl?: Decimal;
+    price?: Decimal;
+    formatted?: FormattedBasket;
+}
+export declare const BasketLayout: any;

package/dist/src/layouts/basket.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasketLayout = exports.AssetLayout = exports.LookupTablesLayout = exports.WithdrawBasketFeesLayout = exports.BasketFeesLayout = exports.BASKET_TYPES_STRINGS = void 0;
+const borsh_1 = require("@coral-xyz/borsh");
+const oracle_1 = require("./oracle");
+const config_1 = require("./config");
+const constants_1 = require("../constants");
+exports.BASKET_TYPES_STRINGS = new Map([
+    [0, "private"],
+    [1, "public"],
+]);
+;
+exports.BasketFeesLayout = (0, borsh_1.struct)([
+    (0, borsh_1.u64)("symmetryFees"),
+    (0, borsh_1.u64)("creatorFees"),
+    (0, borsh_1.u64)("hostFees"),
+    (0, borsh_1.u64)("managersFees"),
+]);
+exports.WithdrawBasketFeesLayout = (0, borsh_1.struct)([
+    (0, borsh_1.publicKey)('basket'),
+    (0, borsh_1.publicKey)('rentPayer'),
+    (0, borsh_1.array)((0, borsh_1.publicKey)(), constants_1.MAX_MANAGERS_PER_BASKET, 'owners'),
+    (0, borsh_1.array)((0, borsh_1.u16)(), constants_1.MAX_MANAGERS_PER_BASKET, 'ownersWeights'),
+    (0, borsh_1.array)((0, borsh_1.publicKey)(), constants_1.MAX_SUPPORTED_TOKENS_PER_BASKET, 'accumulatedTokens'),
+    (0, borsh_1.array)((0, borsh_1.u64)(), constants_1.MAX_SUPPORTED_TOKENS_PER_BASKET, 'accumulatedFees'),
+]);
+;
+exports.LookupTablesLayout = (0, borsh_1.struct)([
+    (0, borsh_1.array)((0, borsh_1.publicKey)(), 2, "active"),
+    (0, borsh_1.array)((0, borsh_1.publicKey)(), 2, "temp"),
+]);
+;
+exports.AssetLayout = (0, borsh_1.struct)([
+    (0, borsh_1.publicKey)('mint'),
+    (0, borsh_1.u64)('amount'),
+    (0, borsh_1.u16)('weight'),
+    (0, borsh_1.u8)('active'),
+    oracle_1.OracleAggregatorLayout.replicate('oracleAggregator'),
+]);
+;
+exports.BasketLayout = (0, borsh_1.struct)([
+    (0, borsh_1.u8)('version'),
+    (0, borsh_1.publicKey)('ownAddress'),
+    (0, borsh_1.publicKey)('mint'),
+    (0, borsh_1.u64)('supplyOutstanding'),
+    config_1.BasketSettingsLayout.replicate('settings'),
+    exports.BasketFeesLayout.replicate('accumulatedFees'),
+    exports.LookupTablesLayout.replicate('lookupTables'),
+    (0, borsh_1.u8)('numTokens'),
+    (0, borsh_1.array)(exports.AssetLayout, constants_1.MAX_SUPPORTED_TOKENS_PER_BASKET, 'composition'),
+]);

package/dist/src/layouts/config.d.ts

@@ -0,0 +1,281 @@
+import BN from 'bn.js';
+import { PublicKey } from '@solana/web3.js';
+import { Fraction } from './fraction';
+import { BountySchedule } from './intents/bounty';
+import { FormattedBountySchedule } from './intents/intent';
+export declare const MAX_MANAGERS_PER_BASKET = 10;
+export declare const MAX_SYMBOL_LENGTH = 10;
+export declare const MAX_NAME_LENGTH = 32;
+export declare const MAX_URI_LENGTH = 200;
+export declare enum BasketType {
+    Private = 0,
+    Public = 1
+}
+export interface EditCreator {
+    creator: PublicKey;
+}
+export declare const EditCreatorLayout: any;
+export interface AuthorityBitmasks {
+    scheduleAuthorityBitmask: number;
+    feesAuthorityBitmask: number;
+    managersAuthorityBitmask: number;
+    automationAuthorityBitmask: number;
+    lpAuthorityBitmask: number;
+    metadataAuthorityBitmask: number;
+    depositsAuthorityBitmask: number;
+    forceRebalanceAuthorityBitmask: number;
+    customRebalanceAuthorityBitmask: number;
+    addTokenIntentAuthorityBitmask: number;
+    updateWeightsIntentAuthorityBitmask: number;
+    makeDirectSwapIntentAuthorityBitmask: number;
+    extraData: number;
+    extraData1: number;
+    extraData2: number;
+}
+export declare const AuthorityBitmasksLayout: any;
+export interface ManagerSettings {
+    managers: PublicKey[];
+    managersWeightBps: number[];
+    modificationDelay: BN;
+}
+export declare const ManagerSettingsLayout: any;
+export interface ManagerSettingsWithAuthorityBitmasks {
+    managerSettings: ManagerSettings;
+    authorityBitmasks: AuthorityBitmasks;
+}
+export declare const ManagerSettingsWithAuthorityBitmasksLayout: any;
+export interface HostFees {
+    hostDepositFeeBps: number;
+    hostWithdrawalFeeBps: number;
+    hostManagementFeeBps: number;
+    hostPerformanceFeeBps: number;
+}
+export declare const HostFeesLayout: any;
+export interface FeeSettings {
+    hostDepositFeeBps: number;
+    hostWithdrawFeeBps: number;
+    hostManagementFeeBps: number;
+    hostPerformanceFeeBps: number;
+    creatorDepositFeeBps: number;
+    creatorWithdrawFeeBps: number;
+    creatorManagementFeeBps: number;
+    creatorPerformanceFeeBps: number;
+    managersDepositFeeBps: number;
+    managersWithdrawFeeBps: number;
+    managersManagementFeeBps: number;
+    managersPerformanceFeeBps: number;
+    basketDepositFeeBps: number;
+    basketWithdrawFeeBps: number;
+    extraData: number[];
+    modificationDelay: BN;
+}
+export declare const FeeSettingsLayout: any;
+export interface ScheduleSettings {
+    cycleStartTime: BN;
+    cycleDuration: BN;
+    depositsStart: BN;
+    depositsEnd: BN;
+    automationStart: BN;
+    automationEnd: BN;
+    managementStart: BN;
+    managementEnd: BN;
+    modificationDelay: BN;
+}
+export declare const ScheduleSettingsLayout: any;
+export interface AutomationSettings {
+    allowAutomation: number;
+    rebalanceSlippageThresholdBps: number;
+    perTradeRebalanceSlippageThresholdBps: number;
+    rebalanceActivationThresholdAbsBps: number;
+    rebalanceActivationThresholdRelBps: number;
+    rebalanceActivationCooldown: BN;
+    extraData: PublicKey[];
+    modificationDelay: BN;
+}
+export declare const AutomationSettingsLayout: any;
+export interface LpSettings {
+    allowLp: number;
+    lpThresholdBps: number;
+    extraData: number[];
+    modificationDelay: BN;
+}
+export declare const LpSettingsLayout: any;
+export interface MetadataParams {
+    name: string;
+    symbol: string;
+    uri: string;
+}
+export declare const MetadataParamsLayout: any;
+export interface MetadataSettings {
+    symbolLength: number;
+    symbol: number[];
+    nameLength: number;
+    name: number[];
+    uriLength: number;
+    uri: number[];
+    modificationDelay: BN;
+}
+export declare const MetadataSettingsLayout: any;
+export interface EditAddTokenDelay {
+    modificationDelay: BN;
+}
+export declare const EditAddTokenDelayLayout: any;
+export interface EditUpdateWeightsDelay {
+    modificationDelay: BN;
+}
+export declare const EditUpdateWeightsDelayLayout: any;
+export interface EditMakeDirectSwapDelay {
+    modificationDelay: BN;
+}
+export declare const EditMakeDirectSwapDelayLayout: any;
+export interface UpdateWeights {
+    tokenWeights: number[];
+    tokenMintsHash: number[];
+}
+export declare const UpdateWeightsLayout: any;
+export interface MakeDirectSwap {
+    fromTokenMint: PublicKey;
+    toTokenMint: PublicKey;
+    amountFrom: BN;
+    amountTo: BN;
+}
+export declare const MakeDirectSwapLayout: any;
+export interface BasketSettings {
+    creator: PublicKey;
+    host: PublicKey;
+    basketType: BasketType;
+    bountyMint: PublicKey;
+    bountyBalance: BN;
+    startPrice: Fraction;
+    highWaterMark: Fraction;
+    activeRebalance: BN;
+    activeWithdraws: BN;
+    activeManagements: BN;
+    lastAutomationExecutionTimestamp: BN;
+    managers: ManagerSettings;
+    managersLastUpdateTimestamp: BN;
+    managersAuthorityBitmask: number;
+    fees: FeeSettings;
+    feesLastUpdateTimestamp: BN;
+    feesAuthorityBitmask: number;
+    schedule: ScheduleSettings;
+    scheduleLastUpdateTimestamp: BN;
+    scheduleAuthorityBitmask: number;
+    automation: AutomationSettings;
+    automationLastUpdateTimestamp: BN;
+    automationAuthorityBitmask: number;
+    lp: LpSettings;
+    lpLastUpdateTimestamp: BN;
+    lpAuthorityBitmask: number;
+    metadata: MetadataSettings;
+    metadataLastUpdateTimestamp: BN;
+    metadataAuthorityBitmask: number;
+    depositsAreAllowed: number;
+    depositsAuthorityBitmask: number;
+    forceRebalanceIsAllowed: number;
+    forceRebalanceModificationDelay: BN;
+    forceRebalanceLastUpdateTimestamp: BN;
+    forceRebalanceAuthorityBitmask: number;
+    customRebalanceIsAllowed: number;
+    customRebalanceModificationDelay: BN;
+    customRebalanceLastUpdateTimestamp: BN;
+    customRebalanceAuthorityBitmask: number;
+    addTokenDelay: BN;
+    addTokenLastUpdateTimestamp: BN;
+    addTokenIntentAuthorityBitmask: number;
+    updateWeightsDelay: BN;
+    updateWeightsLastUpdateTimestamp: BN;
+    updateWeightsIntentAuthorityBitmask: number;
+    makeDirectSwapDelay: BN;
+    makeDirectSwapLastUpdateTimestamp: BN;
+    makeDirectSwapIntentAuthorityBitmask: number;
+    extraData: BN[];
+}
+export declare const BasketSettingsLayout: any;
+export interface FormattedGlobalConfig {
+    pubkey: string;
+    admin: string;
+    owners: string[];
+    total_number_of_baskets: number;
+    allow_interactions: boolean;
+    allow_creation: boolean;
+    allow_management: boolean;
+    allow_automation: boolean;
+    allow_deposits: boolean;
+    allow_withdraws: boolean;
+    max_deposit_fee_bps: number;
+    max_withdraw_fee_bps: number;
+    max_management_fee_bps: number;
+    max_performance_fee_bps: number;
+    symmetry_fee_collector: string;
+    symmetry_deposit_fee_bps: number;
+    symmetry_deposit_fee_share_bps: number;
+    symmetry_withdraw_fee_bps: number;
+    symmetry_withdraw_fee_share_bps: number;
+    symmetry_management_fee_bps: number;
+    symmetry_management_fee_share_bps: number;
+    symmetry_performance_fee_bps: number;
+    symmetry_performance_fee_share_bps: number;
+    symmetry_trade_fee_bps: number;
+    symmetry_limit_order_fee_bps: number;
+    bounty_mint: string;
+    min_bounty_for_basket_automation: number;
+    bounty_bond_amount: number;
+    bounty_per_task: FormattedBountySchedule;
+    bounty_per_price_update_task_divisor: number;
+    min_remaining_value: number;
+    min_mint_ratio: number;
+    apr_bps_per_year: number;
+    rebalance_intent_lifetime: number;
+    rebalance_auction_1_timeframe: number;
+    rebalance_auction_2_timeframe: number;
+    rebalance_auction_3_timeframe: number;
+    price_update_delay_after_creation: number;
+    price_update_lifetime: number;
+    price_update_reexecution_delay: number;
+}
+export interface GlobalConfig {
+    admin: PublicKey;
+    owners: PublicKey[];
+    totalNumberOfBaskets: BN;
+    allowInteractions: number;
+    allowCreation: number;
+    allowManagement: number;
+    allowAutomation: number;
+    allowDeposits: number;
+    allowWithdraws: number;
+    maxDepositFeeBps: number;
+    maxWithdrawFeeBps: number;
+    maxManagementFeeBps: number;
+    maxPerformanceFeeBps: number;
+    symmetryFeeCollector: PublicKey;
+    symmetryDepositFeeBps: number;
+    symmetryDepositFeeShareBps: number;
+    symmetryWithdrawFeeBps: number;
+    symmetryWithdrawFeeShareBps: number;
+    symmetryManagementFeeBps: number;
+    symmetryManagementFeeShareBps: number;
+    symmetryPerformanceFeeBps: number;
+    symmetryPerformanceFeeShareBps: number;
+    symmetryTradeFeeBps: number;
+    symmetryLimitOrderFeeBps: number;
+    symmetryFeesExtraData: number[];
+    bountyMint: PublicKey;
+    minBountyForBasketAutomation: BN;
+    bountyBondAmount: BN;
+    bountyPerTask: BountySchedule;
+    bountyPerPriceUpdateTaskDivisor: BN;
+    minRemainingValue: Fraction;
+    minMintRatio: Fraction;
+    aprBpsPerYear: number;
+    rebalanceIntentLifetime: BN;
+    rebalanceAuction1Timeframe: BN;
+    rebalanceAuction2Timeframe: BN;
+    rebalanceAuction3Timeframe: BN;
+    priceUpdateDelayAfterCreation: BN;
+    priceUpdateLifetime: BN;
+    priceUpdateReexecutionDelay: BN;
+    extraData: BN[];
+    formatted?: FormattedGlobalConfig;
+}
+export declare const GlobalConfigLayout: any;