@glamsystems/glam-sdk 1.1.0-alpha.5 → 1.1.0

package/src/client.d.ts

@@ -0,0 +1,82 @@
+import { GlamClientConfig } from "./clientConfig";
+import { BaseClient } from "./client/base";
+import { JupiterSwapClient } from "./client/jupiter";
+import { MarinadeClient } from "./client/marinade";
+import { VaultClient } from "./client/vault";
+import { StateClient } from "./client/state";
+import { KaminoLendingClient, KaminoFarmClient, KaminoVaultsClient } from "./client/kamino";
+import { InvestClient } from "./client/invest";
+import { PriceClient } from "./client/price";
+import { FeesClient } from "./client/fees";
+import { MintClient } from "./client/mint";
+import { AccessClient } from "./client/access";
+import { TimelockClient } from "./client/timelock";
+import { StakeClient } from "./client/stake";
+import { StakePoolClient } from "./client/stake-pool";
+import { CctpClient } from "./client/cctp";
+import { BridgeClient } from "./client/bridge";
+import { EpiClient } from "./client/epi";
+import { LoopscaleBorrowClient, LoopscaleLendClient, LoopscaleVaultClient } from "./client/loopscale";
+import { PhoenixClient } from "./client/phoenix";
+import { JupiterBorrowClient, JupiterEarnClient } from "./client/jupiter-lend";
+import { OrcaWhirlpoolsClient } from "./client/orca";
+/**
+ * Main entrypoint for the GLAM SDK
+ *
+ * Lazy loads each client/module at first use
+ */
+export declare class GlamClient extends BaseClient {
+    private _invest?;
+    private _jupiterSwap?;
+    private _marinade?;
+    private _vault?;
+    private _price?;
+    private _stake?;
+    private _stakePool?;
+    private _state?;
+    private _mint?;
+    private _access?;
+    private _kaminoLending?;
+    private _kaminoFarm?;
+    private _kaminoVaults?;
+    private _fees?;
+    private _timelock?;
+    private _cctp?;
+    private _bridge?;
+    private _epi?;
+    private _loopscaleCore?;
+    private _loopscaleBorrow?;
+    private _loopscaleLend?;
+    private _loopscaleVault?;
+    private _phoenix?;
+    private _jupiterEarn?;
+    private _jupiterBorrow?;
+    private _orca?;
+    constructor(config?: GlamClientConfig);
+    get invest(): InvestClient;
+    get fees(): FeesClient;
+    get jupiterSwap(): JupiterSwapClient;
+    get marinade(): MarinadeClient;
+    get vault(): VaultClient;
+    get stake(): StakeClient;
+    get stakePool(): StakePoolClient;
+    get price(): PriceClient;
+    get state(): StateClient;
+    get access(): AccessClient;
+    get mint(): MintClient;
+    get kaminoLending(): KaminoLendingClient;
+    get kaminoFarm(): KaminoFarmClient;
+    get kaminoVaults(): KaminoVaultsClient;
+    get timelock(): TimelockClient;
+    get cctp(): CctpClient;
+    get bridge(): BridgeClient;
+    get epi(): EpiClient;
+    private get loopscaleCore();
+    get loopscaleBorrow(): LoopscaleBorrowClient;
+    get loopscaleLend(): LoopscaleLendClient;
+    get loopscaleVault(): LoopscaleVaultClient;
+    get phoenix(): PhoenixClient;
+    get jupiterEarn(): JupiterEarnClient;
+    get jupiterBorrow(): JupiterBorrowClient;
+    get orca(): OrcaWhirlpoolsClient;
+}

package/src/clientConfig.d.ts

@@ -0,0 +1,32 @@
+import { Provider, Wallet } from "@coral-xyz/anchor";
+import { PublicKey } from "@solana/web3.js";
+import { JupiterApiClient } from "./utils";
+import { PhoenixApiClient } from "./utils/phoenixApi";
+export declare enum ClusterNetwork {
+    Mainnet = "mainnet-beta",
+    Testnet = "testnet",
+    Devnet = "devnet",
+    Localnet = "localnet",
+    Custom = "custom"
+}
+export declare namespace ClusterNetwork {
+    function fromStr(cluster: string): ClusterNetwork;
+    /**
+     * Detects the Solana cluster network from an RPC endpoint URL
+     *
+     * @param rpcUrl The RPC endpoint URL
+     * @returns The detected cluster network
+     */
+    function fromUrl(rpcUrl: string): ClusterNetwork;
+}
+export type GlamClientConfig = {
+    provider?: Provider;
+    wallet?: Wallet;
+    cluster?: ClusterNetwork;
+    statePda?: PublicKey;
+    jupiterApiKey?: string;
+    jupiterApiClient?: JupiterApiClient;
+    phoenixApiUrl?: string;
+    phoenixApiClient?: PhoenixApiClient;
+    useStaging?: boolean;
+};

package/src/constants.d.ts

@@ -0,0 +1,111 @@
+import { PublicKey } from "@solana/web3.js";
+export declare const SEED_STATE = "state";
+export declare const SEED_VAULT = "vault";
+export declare const SEED_METADATA = "metadata";
+export declare const SEED_MINT = "mint";
+export declare const SEED_ESCROW = "escrow";
+export declare const SEED_REQUEST_QUEUE = "request-queue";
+export declare const SEED_ACCOUNT_POLICY = "account-policy";
+export declare const SEED_EXTRA_ACCOUNT_METAS = "extra-account-metas";
+export declare const SEED_GLOBAL_CONFIG = "global-config";
+export declare const SEED_INTEGRATION_AUTHORITY = "integration-authority";
+export declare const SEED_OBSERVATION_STATE = "observation-state";
+export declare const SEED_WORMHOLE_OBSERVATION_CONFIG = "wormhole-observation-config";
+export declare const SEED_WORMHOLE_HYPERLIQUID_OBSERVATION_CONFIG = "wormhole-hl-observation-config";
+export declare const SEED_BRIDGE_REGISTRY = "bridge-registry";
+export declare const SEED_BRIDGE_SESSION = "bridge-session";
+export declare const SEED_BRIDGE_TRANSFER_RECORD = "bridge-transfer-record";
+export declare const STAKE_ACCOUNT_SIZE = 200;
+export declare const METEORA_POSITION_SIZE = 8120;
+export declare const KAMINO_OBTRIGATION_SIZE = 3344;
+export declare const KAMINO_RESERVE_SIZE = 8624;
+export declare const KAMINO_VAULT_STATE_SIZE = 62552;
+export declare const JITO_TIP_DEFAULT: PublicKey;
+export declare const MARINADE_NATIVE_STAKE_AUTHORITY: PublicKey;
+/**
+ * Token mints. If no devnet version is defined, assume mainnet and devnet addresses are the same.
+ *
+ * Unless otherwise noted, all mints have 9 decimals.
+ */
+export declare const WSOL: PublicKey;
+export declare const MSOL: PublicKey;
+export declare const USDC: PublicKey;
+export declare const USDC_DEVNET: PublicKey;
+export declare const USDT: PublicKey;
+export declare const JUP: PublicKey;
+/**
+ * Program IDs
+ */
+export declare const MARINADE_PROGRAM_ID: PublicKey;
+export declare const JUPITER_PROGRAM_ID: PublicKey;
+export declare const SANCTUM_STAKE_POOL_PROGRAM_ID: PublicKey;
+export declare const KAMINO_LENDING_PROGRAM: PublicKey;
+export declare const KAMINO_VAULTS_PROGRAM: PublicKey;
+export declare const KAMINO_FARM_PROGRAM: PublicKey;
+export declare const MEMO_PROGRAM: PublicKey;
+export declare const ALT_PROGRAM_ID: PublicKey;
+export declare const TOKEN_MESSENGER_MINTER_V2: PublicKey;
+export declare const MESSAGE_TRANSMITTER_V2: PublicKey;
+export declare const LOOPSCALE_PROGRAM_ID: PublicKey;
+export declare const WORMHOLE_CORE_BRIDGE_PROGRAM: PublicKey;
+export declare const WORMHOLE_VERIFY_VAA_SHIM_PROGRAM: PublicKey;
+export declare const HYPEREVM_NAV_ADAPTER_V2 = "0x8e3d311e3f5814d2b4c1a9fc56d28d379abd1a86";
+export declare const HYPEREVM_NAV_ADAPTER_V2_EMITTER = "0x0000000000000000000000008e3d311e3f5814d2b4c1a9fc56d28d379abd1a86";
+export declare const LOOPSCALE_PROTOCOL_ADMIN_STATE: PublicKey;
+export declare const PHOENIX_PROGRAM_ID: PublicKey;
+export declare const PHOENIX_LOG_AUTHORITY: PublicKey;
+export declare const PHOENIX_GLOBAL_CONFIG: PublicKey;
+export declare const PHOENIX_WITHDRAW_QUEUE: PublicKey;
+export declare const EMBER_PROGRAM_ID: PublicKey;
+/**
+ * Phoenix OrderPacketKind discriminants.
+ * Mirror `OrderPacketKind` variant order in anchor/deps/phoenix/phoenix.json.
+ */
+export declare const PHOENIX_ORDER_PACKET_KIND_POST_ONLY = 0;
+export declare const PHOENIX_ORDER_PACKET_KIND_LIMIT = 1;
+export declare const PHOENIX_ORDER_PACKET_KIND_IMMEDIATE_OR_CANCEL = 2;
+export declare const JUPITER_LENDING_PROGRAM_ID: PublicKey;
+export declare const JUPITER_VAULTS_PROGRAM_ID: PublicKey;
+export declare const JUPITER_LIQUIDITY_PROGRAM_ID: PublicKey;
+export declare const JUPITER_ORACLE_PROGRAM_ID: PublicKey;
+export declare const TOKEN_METADATA_PROGRAM_ID: PublicKey;
+export declare const ORCA_WHIRLPOOLS_PROGRAM_ID: PublicKey;
+export declare const ORCA_POSITION_DISCRIMINATOR: readonly [170, 188, 143, 228, 122, 64, 247, 208];
+export declare const ORCA_WHIRLPOOL_DISCRIMINATOR: readonly [63, 149, 209, 12, 225, 128, 99, 9];
+export declare const ORCA_TICK_ARRAY_DISCRIMINATOR: readonly [69, 97, 189, 190, 110, 7, 66, 187];
+/**
+ * Token ACL (sRFC-37)
+ */
+export declare const TOKEN_ACL_PROGRAM: PublicKey;
+export declare const TOKEN_ACL_GATE_PROGRAM: PublicKey;
+/**
+ * GLAM programs
+ */
+export declare const TRANSFER_HOOK_PROGRAM: PublicKey;
+export declare const GLAM_CONFIG_PROGRAM: PublicKey;
+/**
+ * Referrers
+ */
+export declare const GLAM_REFERRER: PublicKey;
+/**
+ * CCTP domain to chain name mapping
+ */
+export declare const CCTP_DOMAIN_MAPPING: Record<number, string>;
+/**
+ * Get protocol and permission mappings at runtime to ensure correct program IDs based on environment.
+ *
+ * This method provides the source of truth for protocol and permission mappings and staging status in SDK.
+ */
+export declare const getProtocolsAndPermissions: (staging: boolean) => Record<string, Record<string, {
+    name: string;
+    staging: boolean;
+    permissions: Record<number, string>;
+}>>;
+/**
+ * (Program ID, Bitflag) -> Protocol Name
+ */
+export declare const getProtocolNameByProgramAndBitflag: (staging: boolean) => Record<string, Record<string, string>>;
+/**
+ * Protocol Name -> (Program ID, Bitflag)
+ */
+export declare const getProgramAndBitflagByProtocolName: (staging: boolean) => Record<string, [string, string]>;

package/src/deser/base.d.ts

@@ -0,0 +1,18 @@
+import { struct } from "@coral-xyz/borsh";
+import { PublicKey } from "@solana/web3.js";
+/**
+ * Base class for decodable on-chain account structures.
+ *
+ * This class provides a generic decode method that can be inherited by all
+ * account deserializer classes, eliminating the need to implement the same
+ * decode logic in each class.
+ */
+export declare abstract class Decodable {
+    readonly _address: PublicKey;
+    static _layout: ReturnType<typeof struct>;
+    static decode<T extends Decodable>(this: {
+        new (): T;
+        _layout: ReturnType<typeof struct>;
+    }, address: PublicKey, buffer: Buffer): T;
+    getAddress(): PublicKey;
+}

package/src/deser/index.d.ts

@@ -0,0 +1,4 @@
+export { Decodable } from "./base";
+export * from "./kaminoLayouts";
+export * from "./loopscaleLayouts";
+export * from "./tokenAclLayouts";

package/src/deser/integrationPolicies.d.ts

@@ -0,0 +1,195 @@
+import { BN } from "@coral-xyz/anchor";
+import { PublicKey } from "@solana/web3.js";
+export declare class MintPolicy {
+    lockupPeriod: number;
+    maxCap: BN;
+    minSubscription: BN;
+    minRedemption: BN;
+    reserved: BN;
+    allowlist: PublicKey[] | null;
+    blocklist: PublicKey[] | null;
+    static _layout: any;
+    constructor(lockupPeriod: number, maxCap: BN, minSubscription: BN, minRedemption: BN, reserved: BN, allowlist: PublicKey[] | null, blocklist: PublicKey[] | null);
+    static decode(buffer: Buffer): MintPolicy;
+    encode(): Buffer;
+}
+export declare class JupiterSwapPolicy {
+    maxSlippageBps: number;
+    swapAllowlist: PublicKey[] | null;
+    maxDeviationBps: number;
+    constructor(maxSlippageBps: number, swapAllowlist: PublicKey[] | null, maxDeviationBps?: number);
+    static decode(buffer: Buffer<ArrayBufferLike>): JupiterSwapPolicy;
+    encode(): Buffer;
+}
+export declare class TransferPolicy {
+    allowlist: PublicKey[];
+    static _layout: any;
+    constructor(allowlist: PublicKey[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): TransferPolicy;
+    encode(): Buffer;
+}
+export declare class KaminoLendingPolicy {
+    marketsAllowlist: PublicKey[];
+    borrowAllowlist: PublicKey[];
+    static _layout: any;
+    constructor(marketsAllowlist: PublicKey[], borrowAllowlist: PublicKey[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): KaminoLendingPolicy;
+    encode(): Buffer;
+}
+export declare class KaminoVaultsPolicy {
+    vaultsAllowlist: PublicKey[];
+    static _layout: any;
+    constructor(vaultsAllowlist: PublicKey[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): KaminoVaultsPolicy;
+    encode(): Buffer;
+}
+export declare class JupiterEarnPolicy {
+    mintsAllowlist: PublicKey[];
+    static _layout: any;
+    constructor(mintsAllowlist: PublicKey[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): JupiterEarnPolicy;
+    encode(): Buffer;
+}
+export declare class JupiterBorrowPolicy {
+    vaultsAllowlist: PublicKey[];
+    collateralMintsAllowlist: PublicKey[];
+    borrowMintsAllowlist: PublicKey[];
+    static _layout: any;
+    constructor(vaultsAllowlist: PublicKey[], collateralMintsAllowlist: PublicKey[], borrowMintsAllowlist: PublicKey[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): JupiterBorrowPolicy;
+    encode(): Buffer;
+}
+export declare class LoopscaleBorrowMarketPolicy {
+    market: PublicKey;
+    maxBorrowAmount: BN;
+    maxTotalBorrowAmount: BN;
+    maxLtvBps: number;
+    durationIndexesAllowlist: number[];
+    static _layout: any;
+    constructor(market: PublicKey, maxBorrowAmount: BN, maxTotalBorrowAmount: BN, maxLtvBps: number, durationIndexesAllowlist?: number[]);
+    static encodedSize(policy: LoopscaleBorrowMarketPolicy): number;
+}
+export declare class LoopscaleLendingMarketPolicy {
+    market: PublicKey;
+    maxDepositAmount: BN;
+    maxTotalDepositAmount: BN;
+    minLoanApyCbps: number;
+    maxLtvBps: number;
+    durationIndexesAllowlist: number[];
+    collateralAssetAllowlist: PublicKey[];
+    static _layout: any;
+    constructor(market: PublicKey, maxDepositAmount: BN, maxTotalDepositAmount: BN, minLoanApyCbps: number, maxLtvBps: number, durationIndexesAllowlist?: number[], collateralAssetAllowlist?: PublicKey[]);
+    static encodedSize(policy: LoopscaleLendingMarketPolicy): number;
+}
+export declare class LoopscaleSellLedgerPolicy {
+    maxDiscountBps: number;
+    maxSlippageBps: number;
+    static _layout: any;
+    constructor(maxDiscountBps?: number, maxSlippageBps?: number);
+}
+export declare class LoopscaleBorrowPolicy {
+    collateralAllowlist: PublicKey[];
+    principalAllowlist: PublicKey[];
+    marketPolicies: LoopscaleBorrowMarketPolicy[];
+    static _layout: any;
+    constructor(collateralAllowlist?: PublicKey[], principalAllowlist?: PublicKey[], marketPolicies?: LoopscaleBorrowMarketPolicy[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): LoopscaleBorrowPolicy;
+    encode(): Buffer;
+}
+export declare class LoopscaleVaultPolicy {
+    vaultAllowlist: PublicKey[];
+    static _layout: any;
+    constructor(vaultAllowlist?: PublicKey[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): LoopscaleVaultPolicy;
+    encode(): Buffer;
+}
+export declare class LoopscaleLendingPolicy {
+    principalAllowlist: PublicKey[];
+    collateralAllowlist: PublicKey[];
+    marketPolicies: LoopscaleLendingMarketPolicy[];
+    sellLedgerPolicy: LoopscaleSellLedgerPolicy;
+    static _layout: any;
+    constructor(principalAllowlist?: PublicKey[], collateralAllowlist?: PublicKey[], marketPolicies?: LoopscaleLendingMarketPolicy[], sellLedgerPolicy?: LoopscaleSellLedgerPolicy);
+    static decode(buffer: Buffer<ArrayBufferLike>): LoopscaleLendingPolicy;
+    encode(): Buffer;
+}
+export declare class PhoenixPolicy {
+    marketsAllowlist: PublicKey[];
+    allowedOrderTypes: number[];
+    requireReduceOnlyOrders: boolean;
+    maxPriceDeviationBps: number;
+    maxReferencePriceAgeSecs: number;
+    constructor(marketsAllowlist: PublicKey[], allowedOrderTypes: number[], requireReduceOnlyOrders: boolean, maxPriceDeviationBps: number, maxReferencePriceAgeSecs?: number);
+    static decode(buffer: Buffer<ArrayBufferLike>): PhoenixPolicy;
+    encode(): Buffer;
+}
+export declare class WhirlpoolsPolicy {
+    whirlpoolsAllowlist: PublicKey[];
+    tokenMintsAllowlist: PublicKey[];
+    maxDeviationBps: number;
+    static _layout: any;
+    constructor(whirlpoolsAllowlist: PublicKey[], tokenMintsAllowlist: PublicKey[], maxDeviationBps?: number);
+    static decode(buffer: Buffer<ArrayBufferLike>): WhirlpoolsPolicy;
+    encode(): Buffer;
+}
+export declare class CctpPolicy {
+    allowedDestinations: {
+        domain: number;
+        address: PublicKey;
+    }[];
+    static _layout: any;
+    constructor(allowedDestinations: {
+        domain: number;
+        address: PublicKey;
+    }[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): CctpPolicy;
+    encode(): Buffer;
+    get domainToAddressesMap(): Map<number, PublicKey[]>;
+}
+export declare enum RouteManagementMode {
+    UnmanagedOnly = 0,
+    ManagedOnly = 1,
+    Either = 2
+}
+export type LayerzeroOftRoute = {
+    sourceMint: PublicKey;
+    destinationChain: number;
+    destinationRecipient: PublicKey;
+    providerProgram: PublicKey;
+    managementMode: RouteManagementMode;
+    minAmount: BN;
+    maxAmount: BN;
+};
+export declare class LayerzeroOftPolicy {
+    routes: LayerzeroOftRoute[];
+    static _layout: any;
+    constructor(routes: LayerzeroOftRoute[]);
+    static decode(buffer: Buffer<ArrayBufferLike>, _staging?: boolean): LayerzeroOftPolicy;
+    encode(): Buffer;
+}
+export declare enum PeriodType {
+    Day = 0,
+    Week = 1,
+    Month = 2
+}
+export interface AssetRateLimit {
+    mint: PublicKey;
+    periodType: number;
+    amount: BN;
+}
+export interface DelegateRateLimit {
+    delegate: PublicKey;
+    limits: AssetRateLimit[];
+}
+export declare class TransferRateLimitPolicy {
+    vaultDefaults: AssetRateLimit[];
+    delegateOverrides: DelegateRateLimit[];
+    static _layout: any;
+    constructor(vaultDefaults: AssetRateLimit[], delegateOverrides: DelegateRateLimit[]);
+    static decode(buffer: Buffer<ArrayBufferLike>): TransferRateLimitPolicy;
+    encode(): Buffer;
+    /**
+     * Derive the TransferTracker PDA address for a given vault state, signer, and mint.
+     */
+    static getTransferTrackerPda(glamState: PublicKey, signer: PublicKey, mint: PublicKey, programId: PublicKey): [PublicKey, number];
+}