@symmetry-hq/sdk 1.0.1

package/src/layouts/fraction.ts

@@ -0,0 +1,164 @@
+import BN from "bn.js";
+import { array, publicKey, str, struct, u128, u16, u64, u8 } from '@coral-xyz/borsh';
+import Decimal from "decimal.js";
+import { X64 } from "../constants";
+
+export interface Fraction {
+    high: BN; // u64 -> BN
+    low: BN; // u64 -> BN
+};
+
+export const FractionLayout = struct<Fraction>([
+    u64('high'),
+    u64('low'),
+]);
+
+export function fractionToDecimal(fraction: Fraction): Decimal {
+    let high = new Decimal(fraction.high.toString());
+    let low = new Decimal(fraction.low.toString());
+    let res = high.add(low.div(X64));
+    return res;
+}
+
+export function decimalToFraction(decimal: Decimal): Fraction {
+    let res = decimal.mul(X64).floor();
+    let high = res.div(X64).floor();
+    let low = res.sub(high.mul(X64));
+    return { high: new BN(high.toString()), low: new BN(low.toString()) };
+}
+
+// X64 = 2^64
+const X64_BN = new BN(2).pow(new BN(64));
+const U64_MAX = new BN(2).pow(new BN(64)).sub(new BN(1));
+
+// Fraction addition: (a + b)
+// a = high_a * 2^64 + low_a, b = high_b * 2^64 + low_b
+// result = (high_a + high_b) * 2^64 + (low_a + low_b)
+// Handle carry from low to high
+export function fractionAdd(a: Fraction, b: Fraction): Fraction {
+    const lowSum = a.low.add(b.low);
+    const carry = lowSum.gt(U64_MAX) ? new BN(1) : new BN(0);
+    const low = lowSum.mod(X64_BN);
+    const high = a.high.add(b.high).add(carry);
+    // Check overflow: high should fit in u64
+    if (high.gt(U64_MAX)) {
+        throw new Error("MathError");
+    }
+    return { high, low };
+}
+
+// Fraction subtraction: (a - b)
+// a = high_a * 2^64 + low_a, b = high_b * 2^64 + low_b
+// result = (high_a - high_b) * 2^64 + (low_a - low_b)
+// Handle borrow from high to low
+export function fractionSub(a: Fraction, b: Fraction): Fraction {
+    // Check if a < b
+    if (a.high.lt(b.high) || (a.high.eq(b.high) && a.low.lt(b.low))) {
+        throw new Error("MathError");
+    }
+    let low = a.low.sub(b.low);
+    let high = a.high.sub(b.high);
+    // Handle borrow if low < 0
+    if (low.isNeg()) {
+        low = low.add(X64_BN);
+        high = high.sub(new BN(1));
+    }
+    if (high.isNeg()) {
+        throw new Error("MathError");
+    }
+    return { high, low };
+}
+
+// Fraction multiplication: (a * b) / X64
+// (high_a * 2^64 + low_a) * (high_b * 2^64 + low_b) / 2^64
+// = high_a * high_b * 2^64 + high_a * low_b + low_a * high_b + (low_a * low_b) / 2^64
+export function fractionMul(a: Fraction, b: Fraction): Fraction {
+    // Calculate all components
+    const highHigh = a.high.mul(b.high).mul(X64_BN);
+    const highLow = a.high.mul(b.low);
+    const lowHigh = a.low.mul(b.high);
+    const lowLow = a.low.mul(b.low).div(X64_BN);
+    
+    // Sum: highHigh + highLow + lowHigh + lowLow
+    const sum = highHigh.add(highLow).add(lowHigh).add(lowLow);
+    
+    // Split into high and low
+    const high = sum.div(X64_BN);
+    const low = sum.mod(X64_BN);
+    
+    // Check overflow: high should fit in u64
+    if (high.gt(U64_MAX)) {
+        throw new Error("MathError");
+    }
+    return { high, low };
+}
+
+// Fraction division: (a * X64) / b
+// (high_a * 2^64 + low_a) * 2^64 / (high_b * 2^64 + low_b)
+export function fractionDiv(a: Fraction, b: Fraction): Fraction {
+    // Check division by zero
+    if (b.high.isZero() && b.low.isZero()) {
+        throw new Error("MathError");
+    }
+    
+    // numerator = a * X64 = (high_a * 2^64 + low_a) * 2^64
+    const numerator = a.high.mul(X64_BN).add(a.low).mul(X64_BN);
+    
+    // denominator = b = high_b * 2^64 + low_b
+    const denominator = b.high.mul(X64_BN).add(b.low);
+    
+    // result = numerator / denominator
+    const result = numerator.div(denominator);
+    
+    // Split into high and low
+    const high = result.div(X64_BN);
+    const low = result.mod(X64_BN);
+    
+    // Check overflow: high should fit in u64
+    if (high.gt(U64_MAX)) {
+        throw new Error("MathError");
+    }
+    return { high, low };
+}
+
+// Comparison functions
+export function fractionLt(a: Fraction, b: Fraction): boolean {
+    if (a.high.lt(b.high)) return true;
+    if (a.high.gt(b.high)) return false;
+    return a.low.lt(b.low);
+}
+
+export function fractionLte(a: Fraction, b: Fraction): boolean {
+    if (a.high.lt(b.high)) return true;
+    if (a.high.gt(b.high)) return false;
+    return a.low.lte(b.low);
+}
+
+export function fractionGt(a: Fraction, b: Fraction): boolean {
+    if (a.high.gt(b.high)) return true;
+    if (a.high.lt(b.high)) return false;
+    return a.low.gt(b.low);
+}
+
+export function fractionGte(a: Fraction, b: Fraction): boolean {
+    if (a.high.gt(b.high)) return true;
+    if (a.high.lt(b.high)) return false;
+    return a.low.gte(b.low);
+}
+
+export function fractionEq(a: Fraction, b: Fraction): boolean {
+    return a.high.eq(b.high) && a.low.eq(b.low);
+}
+
+// Round Fraction down to BN (floor)
+export function fractionRoundDown(fraction: Fraction): BN {
+    return fraction.high;
+}
+
+// Round Fraction up to BN (ceiling)
+export function fractionRoundUp(fraction: Fraction): BN {
+    if (fraction.low.isZero()) {
+        return fraction.high;
+    }
+    return fraction.high.add(new BN(1));
+}

package/src/layouts/intents/bounty.ts

@@ -0,0 +1,35 @@
+import BN from "bn.js";
+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;
+    bountyPerPriceUpdateTask: BountySchedule;
+    bountyPerTask: BountySchedule;
+    bountyTotal: BN; // u64
+    bountyLeft: BN; // u64
+}
+  
+  export const BountyLayout = struct<Bounty>([
+    publicKey('bountyDepositor'),
+    publicKey('bountyMint'),
+    BountyScheduleLayout.replicate('bountyPerPriceUpdateTask'),
+    BountyScheduleLayout.replicate('bountyPerTask'),
+    u64('bountyTotal'),
+    u64('bountyLeft'),
+]);

package/src/layouts/intents/intent.ts

@@ -0,0 +1,324 @@
+import BN from 'bn.js';
+import { array, publicKey, str, struct, u128, u16, u64, u8 } from '@coral-xyz/borsh';
+import { PublicKey } from '@solana/web3.js';
+
+import { Bounty, BountyLayout } from './bounty';
+import { FormattedOracleType } from '../oracle';
+
+export type FormattedIntentStatus = "not_active" | "active" | "reverted" | "completed";
+export const INTENT_STATUS_STRINGS: Map<number, FormattedIntentStatus> = new Map([
+    [0, "not_active"],
+    [1, "active"],
+    [2, "reverted"],
+    [3, "completed"],
+]);
+
+export type FormattedTaskType = "unknown" | "edit_creator" | "edit_manager_settings" | "edit_fee_settings" | "edit_schedule_settings" | "edit_automation_settings" | "edit_lp_settings" | "edit_metadata_settings" | "edit_deposits_settings" | "edit_force_rebalance_settings" | "edit_custom_rebalance_settings" | "edit_add_token_delay" | "edit_update_weights_delay" | "edit_make_direct_swap_delay" | "add_token" | "update_weights" | "make_direct_swap";
+export const TASK_TYPE_STRINGS: Map<number, FormattedTaskType> = new Map([
+    [0, "unknown"],
+    [1, "edit_creator"],
+    [2, "edit_manager_settings"],
+    [3, "edit_fee_settings"],
+    [4, "edit_schedule_settings"],
+    [5, "edit_automation_settings"],
+    [6, "edit_lp_settings"],
+    [7, "edit_metadata_settings"],
+    [8, "edit_deposits_settings"],
+    [9, "edit_force_rebalance_settings"],
+    [10, "edit_custom_rebalance_settings"],
+    [11, "edit_add_token_delay"],
+    [12, "edit_update_weights_delay"],
+    [13, "edit_make_direct_swap_delay"],
+    [14, "add_token"],
+    [15, "update_weights"],
+    [16, "make_direct_swap"],
+]);
+
+export interface FormattedBountySchedule {
+    min_bounty: number,
+    max_bounty: number,
+    min_bounty_until: number,
+    max_bounty_after: number,
+}
+export interface FormattedBounty {
+    bounty_depositor: string,
+    bounty_mint: string,
+    bounty_per_price_update_task: FormattedBountySchedule,
+    bounty_per_task: FormattedBountySchedule,
+    bounty_total: number,
+    bounty_left: number,
+}
+export interface FormattedIntent {
+    pubkey: string,
+    manager: string,
+    status: FormattedIntentStatus,
+    activation_timestamp: number,
+    expiration_timestamp: number,
+    basket: string,
+    bounty: FormattedBounty,
+    task_type: FormattedTaskType,
+    task_data: Settings,
+}
+
+export const INTENT_TASK_DATA_SIZE = 600;
+
+export enum IntentStatus {
+    NotActive,
+    Active,
+    Reverted,
+    Completed,
+};
+
+export interface Intent {
+    manager: PublicKey;
+    status : IntentStatus;
+    activationTimestamp: BN; // u64
+    expirationTimestamp: BN; // u64
+    basket: PublicKey;
+    bounty: Bounty;
+    taskType: TaskType;
+    taskData: number[]; // length of 600
+    ownAddress?: PublicKey;
+    formatted?: FormattedIntent;
+};
+
+export const IntentLayout = struct<Intent>([
+    publicKey('manager'),
+    u8('status'),
+    u64('activationTimestamp'),
+    u64('expirationTimestamp'),
+    publicKey('basket'),
+    BountyLayout.replicate('bounty'),
+    u8('taskType'),
+    array(u8(), INTENT_TASK_DATA_SIZE, 'taskData'),
+]);
+
+
+export enum TaskType {
+    Unknown = 0,
+  
+    EditCreator = 1,
+    EditManagerSettings = 2,
+    EditFeeSettings = 3,
+    EditScheduleSettings = 4,
+    EditAutomationSettings = 5,
+    EditLpSettings = 6,
+    EditMetadataSettings = 7,
+    EditDepositsSettings = 8,
+    EditForceRebalanceSettings = 9,
+    EditCustomRebalanceSettings = 10,
+  
+    EditAddTokenDelay = 11,
+    EditUpdateWeightsDelay = 12,
+    EditMakeDirectSwapDelay = 13,
+  
+    AddToken = 14,
+    UpdateWeights = 15,
+    MakeDirectSwap = 16,
+  }
+
+  // Maps raw u8 values from on-chain Borsh-serialized storage to TaskType enum.
+  // The on-chain program uses sequential Borsh discriminants (11-16) for storage,
+  // but the SDK enum uses non-sequential values (101-103, 201-203) for instruction input.
+  export function taskTypeFromU8(value: number): TaskType {
+    switch (value) {
+      case 1: return TaskType.EditCreator;
+      case 2: return TaskType.EditManagerSettings;
+      case 3: return TaskType.EditFeeSettings;
+      case 4: return TaskType.EditScheduleSettings;
+      case 5: return TaskType.EditAutomationSettings;
+      case 6: return TaskType.EditLpSettings;
+      case 7: return TaskType.EditMetadataSettings;
+      case 8: return TaskType.EditDepositsSettings;
+      case 9: return TaskType.EditForceRebalanceSettings;
+      case 10: return TaskType.EditCustomRebalanceSettings;
+
+      case 11: return TaskType.EditAddTokenDelay;
+      case 12: return TaskType.EditUpdateWeightsDelay;
+      case 13: return TaskType.EditMakeDirectSwapDelay;
+
+      case 14: return TaskType.AddToken;
+      case 15: return TaskType.UpdateWeights;
+      case 16: return TaskType.MakeDirectSwap;
+
+      default: return TaskType.Unknown;
+    }
+  };
+
+
+
+
+
+export interface TaskContext {
+    basket: string,
+    manager: string,
+    activation_timestamp?: number,
+    expiration_timestamp?: number,
+    min_bounty?: number,
+    max_bounty?: number,
+}
+
+export interface EditCreatorSettings {
+    creator: string,
+}
+
+export interface EditManagerSettings {
+    managers: {
+        pubkey: string;
+        fee_split_weight_bps: number;
+        authorities: {
+            managers: boolean;
+            fees: boolean;
+            schedule: boolean;
+            automation: boolean;
+            lp: boolean;
+            metadata: boolean;
+            deposits: boolean;
+            force_rebalance: boolean;
+            custom_rebalance: boolean;
+            add_token: boolean;
+            update_weights: boolean;
+            make_direct_swap: boolean;
+        },
+    }[],
+    modification_delay: number,
+}
+
+export interface EditFeeSettings {
+    creator_deposit_fee_bps: number,
+    creator_withdraw_fee_bps: number,
+    creator_management_fee_bps: number,
+    creator_performance_fee_bps: number,
+    managers_deposit_fee_bps: number,
+    managers_withdraw_fee_bps: number,
+    managers_management_fee_bps: number,
+    managers_performance_fee_bps: number,
+    basket_deposit_fee_bps: number,
+    basket_withdraw_fee_bps: number,
+    modification_delay: number,
+}
+
+export interface EditScheduleSettings {
+    cycle_start_time: number,
+    cycle_duration: number,
+    deposits_start: number,
+    deposits_end: number,
+    automation_start: number,
+    automation_end: number,
+    management_start: number,
+    management_end: number,
+    modification_delay: number,
+}
+
+export interface EditAutomationSettings {
+    enabled: boolean,
+    rebalance_slippage_threshold_bps: number,
+    per_trade_rebalance_slippage_threshold_bps: number,
+    rebalance_activation_threshold_abs_bps: number,
+    rebalance_activation_threshold_rel_bps: number,
+    rebalance_activation_cooldown: number,
+    modification_delay: number,
+}
+
+export interface EditLpSettings {
+    enabled: boolean,
+    lp_threshold_bps: number,
+    modification_delay: number,
+}
+
+export interface EditMetadataSettings {
+    symbol: string,
+    name: string,
+    uri: string,
+    modification_delay: number,
+}
+
+export interface EditDepositsSettings {
+    enabled: boolean,
+}
+
+export interface EditForceRebalanceSettings {
+    enabled: boolean,
+    modification_delay: number,
+}
+
+export interface EditCustomRebalanceSettings {
+    enabled: boolean,
+    modification_delay: number,
+}
+
+
+export interface EditAddTokenSettings {
+    modification_delay: number,
+}
+
+export interface EditUpdateWeightsSettings {
+    modification_delay: number,
+}
+
+export interface EditMakeDirectSwapSettings {
+    modification_delay: number,
+}
+
+export interface OracleInput {
+    oracle_type: FormattedOracleType,
+    account_lut_id: number,
+    account_lut_index: number,
+    account: string,
+    weight: number,
+    is_required: boolean,
+    conf_thresh_bps: number,
+    volatility_thresh_bps: number,
+    max_slippage_bps: number,
+    min_liquidity: number,
+    staleness_thresh: number,
+    staleness_conf_rate_bps: number,
+    token_decimals: number,
+    twap_seconds_ago: number,
+    twap_secondary_seconds_ago: number,
+}
+
+export interface AddOrEditTokenInput {
+    token_mint: string,
+    active: boolean,
+    min_oracles_thresh: number;
+    min_conf_bps: number;
+    conf_thresh_bps: number;
+    conf_multiplier: number;
+    oracles: OracleInput[];
+};
+
+export interface UpdateWeightsInput {
+    token_weights: {
+        mint: string,
+        weight_bps: number,
+    }[],
+    token_mints_hash?: number[],
+}
+
+export interface MakeDirectSwapInput {
+    from_token_mint: string,
+    to_token_mint: string,
+    amount_from: number,
+    amount_to: number,
+}
+
+export type Settings =
+    EditCreatorSettings |
+    EditManagerSettings |
+    EditFeeSettings |
+    EditScheduleSettings |
+    EditAutomationSettings |
+    EditLpSettings |
+    EditMetadataSettings |
+    EditDepositsSettings |
+    EditForceRebalanceSettings |
+    EditCustomRebalanceSettings |
+
+    EditAddTokenSettings |
+    EditUpdateWeightsSettings |
+    EditMakeDirectSwapSettings |
+
+    AddOrEditTokenInput |
+    UpdateWeightsInput |
+    MakeDirectSwapInput;