svm venue: orca-whirlpool

Solana venue integration orca-whirlpool, exported from @eco-incorp/sauce/svm. Generated from the type declarations of @eco-incorp/sauce.

`whirlpoolSqrtPriceAtTick`

Function · @eco-incorp/sauce/svm sqrt_price_from_tick_index (Q64.64) over the UNBIASED tick.

export declare function whirlpoolSqrtPriceAtTick(tick: number): bigint;

`windowStartTicks`

Function · @eco-incorp/sauce/svm The program’s expected window start indexes for a direction (sparse_swap.rs get_start_tick_indexes), unfiltered: exactly three, including any outside the initializable range (those PDAs never exist and stay beyond readable).

export declare function windowStartTicks(tickCurrentIndex: number, tickSpacing: number, aToB: boolean): [
    number,
    number,
    number
];

`fetchOrcaWhirlpoolConfig`

Function · @eco-incorp/sauce/svm Fetch + gate one whirlpool (see the header for the gate list) and freeze both directions’ boundary windows. Read-only against the loader.

export declare function fetchOrcaWhirlpoolConfig(owned: OwnedAccountLoader, pool: Address): Promise<OrcaWhirlpoolPoolConfig>;

`ORCA_WHIRLPOOL_PROGRAM_ID`

Variable · @eco-incorp/sauce/svm

ORCA_WHIRLPOOL_PROGRAM_ID: Address<"whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc">

`WHIRLPOOL_ACCOUNT_SIZE`

Variable · @eco-incorp/sauce/svm

WHIRLPOOL_ACCOUNT_SIZE = 653

`TICK_ARRAY_ACCOUNT_SIZE`

Variable · @eco-incorp/sauce/svm

TICK_ARRAY_ACCOUNT_SIZE = 9988

`WHIRLPOOL_DISCRIMINATOR`

Variable · @eco-incorp/sauce/svm sha256(‘account:Whirlpool’)[0..8].

WHIRLPOOL_DISCRIMINATOR: number[]

`TICK_ARRAY_DISCRIMINATOR`

Variable · @eco-incorp/sauce/svm sha256(‘account:TickArray’)[0..8] - the FIXED tick array (the only readable kind).

TICK_ARRAY_DISCRIMINATOR: number[]

`TICK_ARRAY_SIZE`

Variable · @eco-incorp/sauce/svm

TICK_ARRAY_SIZE = 88

`MAX_TICK_INDEX`

Variable · @eco-incorp/sauce/svm

MAX_TICK_INDEX = 443636

`MIN_TICK_INDEX`

Variable · @eco-incorp/sauce/svm Orca Whirlpools tick math - exact transcription of programs/whirlpool/src/math/tick_math.rs sqrt_price_from_tick_index in orca-so/whirlpools (https://github.com/orca-so/whirlpools) at commit 8ab2e923138badb2fcb1069cc9947f44df3e48eb, Copyright (c) 2022 Orca Foundation, licensed under the Apache License, Version 2.0 (see THIRD_PARTY_NOTICES.md): positive ticks accumulate in Q96 with (r * C) >> 96 steps and a final >> 32, negative ticks accumulate in Q64 with (r * C) >> 64 steps. Verified against the source’s own pinned bit-value test table (see the unit suite). Shared by fetchPoolConfig (deriving the shipped boundary sqrt prices), the ladder mirror and the test fixtures. sqrt_price_from_tick_index is a pure function of the tick, which is why a prepare-shipped sqrt price is exact by construction - the engine-side fragment never recomputes it (an in-VM bit ladder costs ~54k CU per call on the interpreter).

MIN_TICK_INDEX = -443636

`WHIRLPOOL_MAX_BOUNDARIES`

Variable · @eco-incorp/sauce/svm Shipped initialized-tick boundaries per direction.

WHIRLPOOL_MAX_BOUNDARIES = 4

`OFF_TICK_SPACING`

Variable · @eco-incorp/sauce/svm

OFF_TICK_SPACING = 41

`OFF_FEE_TIER_INDEX`

Variable · @eco-incorp/sauce/svm

OFF_FEE_TIER_INDEX = 43

`OFF_FEE_RATE`

Variable · @eco-incorp/sauce/svm

OFF_FEE_RATE = 45

`OFF_LIQUIDITY`

Variable · @eco-incorp/sauce/svm

OFF_LIQUIDITY = 49

`OFF_SQRT_PRICE`

Variable · @eco-incorp/sauce/svm

OFF_SQRT_PRICE = 65

`OFF_TICK_CURRENT`

Variable · @eco-incorp/sauce/svm

OFF_TICK_CURRENT = 81

`OFF_TA_START`

Variable · @eco-incorp/sauce/svm

OFF_TA_START = 8

`OFF_TA_TICKS`

Variable · @eco-incorp/sauce/svm

OFF_TA_TICKS = 12

`TICK_LEN`

Variable · @eco-incorp/sauce/svm

TICK_LEN = 113

`OFF_TA_WHIRLPOOL`

Variable · @eco-incorp/sauce/svm

OFF_TA_WHIRLPOOL = 9956

`WhirlpoolBoundary`

Interface · @eco-incorp/sauce/svm

export interface WhirlpoolBoundary {
    arrayIndex: number;
    offset: number;
    tick: number;
    sqrtPrice: bigint;
}

`WhirlpoolWindow`

Interface · @eco-incorp/sauce/svm

export interface WhirlpoolWindow {
    tickArrays: [
        Address,
        Address,
        Address
    ];
    startTicks: [
        number,
        number,
        number
    ];
    boundaries: WhirlpoolBoundary[];
    edge: {
        tick: number;
        sqrtPrice: bigint;
    } | null;
    readable: number;
}

`OrcaWhirlpoolPoolConfig`

Interface · @eco-incorp/sauce/svm

export interface OrcaWhirlpoolPoolConfig extends PoolConfig {
    venue: typeof SLUG;
    direction: "aToB" | "bToA";
    tokenMintA: Address;
    tokenMintB: Address;
    tokenVaultA: Address;
    tokenVaultB: Address;
    oracle: Address;
    tickSpacing: number;
    feeRate: number;
    liquidity: bigint;
    sqrtPrice: bigint;
    tickCurrentIndex: number;
    windows: {
        aToB: WhirlpoolWindow;
        bToA: WhirlpoolWindow;
    };
}

`orcaWhirlpool`

Variable · @eco-incorp/sauce/svm The Orca Whirlpools venue: a concentrated-liquidity AMM.

orcaWhirlpool: {
    slug: string;
    programId: Address<"whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc">;
    tokenProgram: Address<"TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA">;
    fetchPoolConfig: typeof fetchOrcaWhirlpoolConfig;
}

Start here

Integration guides

Language reference

SauceScript libraries

Runtime and security

Troubleshooting and production

Chains and protocols

@eco-incorp/sauce

@eco-incorp/sauce-compiler

svm venue: orca-whirlpool

`whirlpoolSqrtPriceAtTick`

`windowStartTicks`

`fetchOrcaWhirlpoolConfig`

`ORCA_WHIRLPOOL_PROGRAM_ID`

`WHIRLPOOL_ACCOUNT_SIZE`

`TICK_ARRAY_ACCOUNT_SIZE`

`WHIRLPOOL_DISCRIMINATOR`

`TICK_ARRAY_DISCRIMINATOR`

`TICK_ARRAY_SIZE`

`MAX_TICK_INDEX`

`MIN_TICK_INDEX`

`WHIRLPOOL_MAX_BOUNDARIES`

`OFF_TICK_SPACING`

`OFF_FEE_TIER_INDEX`

`OFF_FEE_RATE`

`OFF_LIQUIDITY`

`OFF_SQRT_PRICE`

`OFF_TICK_CURRENT`

`OFF_TA_START`

`OFF_TA_TICKS`

`TICK_LEN`

`OFF_TA_WHIRLPOOL`

`WhirlpoolBoundary`

`WhirlpoolWindow`

`OrcaWhirlpoolPoolConfig`

`orcaWhirlpool`

​whirlpoolSqrtPriceAtTick

​windowStartTicks

​fetchOrcaWhirlpoolConfig

​ORCA_WHIRLPOOL_PROGRAM_ID

​WHIRLPOOL_ACCOUNT_SIZE

​TICK_ARRAY_ACCOUNT_SIZE

​WHIRLPOOL_DISCRIMINATOR

​TICK_ARRAY_DISCRIMINATOR

​TICK_ARRAY_SIZE

​MAX_TICK_INDEX

​MIN_TICK_INDEX

​WHIRLPOOL_MAX_BOUNDARIES

​OFF_TICK_SPACING

​OFF_FEE_TIER_INDEX

​OFF_FEE_RATE

​OFF_LIQUIDITY

​OFF_SQRT_PRICE

​OFF_TICK_CURRENT

​OFF_TA_START

​OFF_TA_TICKS

​TICK_LEN

​OFF_TA_WHIRLPOOL

​WhirlpoolBoundary

​WhirlpoolWindow

​OrcaWhirlpoolPoolConfig

​orcaWhirlpool

`whirlpoolSqrtPriceAtTick`

`windowStartTicks`

`fetchOrcaWhirlpoolConfig`

`ORCA_WHIRLPOOL_PROGRAM_ID`

`WHIRLPOOL_ACCOUNT_SIZE`

`TICK_ARRAY_ACCOUNT_SIZE`

`WHIRLPOOL_DISCRIMINATOR`

`TICK_ARRAY_DISCRIMINATOR`

`TICK_ARRAY_SIZE`

`MAX_TICK_INDEX`

`MIN_TICK_INDEX`

`WHIRLPOOL_MAX_BOUNDARIES`

`OFF_TICK_SPACING`

`OFF_FEE_TIER_INDEX`

`OFF_FEE_RATE`

`OFF_LIQUIDITY`

`OFF_SQRT_PRICE`

`OFF_TICK_CURRENT`

`OFF_TA_START`

`OFF_TA_TICKS`

`TICK_LEN`

`OFF_TA_WHIRLPOOL`

`WhirlpoolBoundary`

`WhirlpoolWindow`

`OrcaWhirlpoolPoolConfig`

`orcaWhirlpool`