@velocity-exchange/sdk 0.3.0 → 0.4.0

package/lib/node/constants/spotMarkets.d.ts

@@ -2,22 +2,35 @@ import { PublicKey } from '@solana/web3.js';
 import { OracleSource } from '../types';
 import { BN } from '../isomorphic/anchor';
 import { VelocityEnv } from '../config';
+/** Static off-chain metadata for one deployed spot market, keyed by `marketIndex`. Client-side registry (symbol/oracle/mint/decimals wiring) — not decoded from chain, so it must be kept in sync with deployments. */
 export type SpotMarketConfig = {
     symbol: string;
     marketIndex: number;
+    /** the LP-pool "pool" this market belongs to (distinct spot markets can wrap the same mint under different pool ids, e.g. `SOL` vs `SOL-2`) */
     poolId: number;
     oracle: PublicKey;
     mint: PublicKey;
     oracleSource: OracleSource;
+    /** `10^precisionExp`; the token mint's precision as a `BN`, i.e. one whole token */
     precision: BN;
+    /** the token mint's decimals */
     precisionExp: BN;
+    /** unix ms timestamp the market launched */
     launchTs?: number;
+    /** Pyth price-feed id (hex), for the legacy Pyth push/pull oracle path */
     pythFeedId?: string;
+    /** Pyth Lazer feed id, for `OracleSource.PYTH_LAZER*` markets */
     pythLazerId?: number;
 };
+/** The canonical wrapped-SOL mint address, shared across all `SOL`-symbol spot market configs. */
 export declare const WRAPPED_SOL_MINT: PublicKey;
+/**
+ * Reflects what is actually deployed on devnet (per on-chain enumeration of
+ * `StateAccount.numberOfSpotMarkets`). Update when devnet adds/changes a spot market.
+ */
 export declare const DevnetSpotMarkets: SpotMarketConfig[];
 export declare const MainnetSpotMarkets: SpotMarketConfig[];
+/** Spot market registries keyed by `VelocityEnv`, for looking up a deployment's markets without hardcoding the environment. */
 export declare const SpotMarkets: {
     [key in VelocityEnv]: SpotMarketConfig[];
 };

package/lib/node/constants/spotMarkets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"spotMarkets.d.ts","sourceRoot":"","sources":["../../../src/constants/spotMarkets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAW5C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,EAAE,EAAE,MAAM,sBAAsB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,MAAM,gBAAgB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,YAAY,EAAE,YAAY,CAAC;IAC3B,SAAS,EAAE,EAAE,CAAC;IACd,YAAY,EAAE,EAAE,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,gBAAgB,WAE5B,CAAC;AAIF,eAAO,MAAM,iBAAiB,EAAE,gBAAgB,EAuB/C,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,gBAAgB,EAwyBhD,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE;KAAG,GAAG,IAAI,WAAW,GAAG,gBAAgB,EAAE;CAGnE,CAAC"}
+{"version":3,"file":"spotMarkets.d.ts","sourceRoot":"","sources":["../../../src/constants/spotMarkets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAQ5C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,EAAE,EAAE,MAAM,sBAAsB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,uNAAuN;AACvN,MAAM,MAAM,gBAAgB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,+IAA+I;IAC/I,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,YAAY,EAAE,YAAY,CAAC;IAC3B,oFAAoF;IACpF,SAAS,EAAE,EAAE,CAAC;IACd,gCAAgC;IAChC,YAAY,EAAE,EAAE,CAAC;IACjB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,kGAAkG;AAClG,eAAO,MAAM,gBAAgB,WAE5B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,gBAAgB,EAuB/C,CAAC;AAKF,eAAO,MAAM,kBAAkB,EAAE,gBAAgB,EA2BhD,CAAC;AAEF,+HAA+H;AAC/H,eAAO,MAAM,WAAW,EAAE;KAAG,GAAG,IAAI,WAAW,GAAG,gBAAgB,EAAE;CAGnE,CAAC"}