@overcast-xyz/solana-program 0.1.1

package/dist/pda.js

@@ -0,0 +1,191 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ORACLE_KIND = exports.USED_OPERATION_SEED = exports.SIGNING_KEY_SEED = exports.MINT_COLLATERAL_RETURN_SEED = exports.MINT_EXERCISE_SEED = exports.OPTION_SETTLEMENT_ESCROW_SEED = exports.OPTION_COLLATERAL_ESCROW_SEED = exports.OPTION_SEED = exports.STATIC_PROTOCOL_FEE_SEED = exports.SETTLEMENT_CONFIG_SEED = exports.OFFER_ESCROW_SEED = exports.OFFER_SEED = exports.PROTOCOL_ESCROW_SEED = exports.PROTOCOL_STATE_SEED = void 0;
+exports.getProtocolStatePda = getProtocolStatePda;
+exports.getProtocolEscrowAccountPda = getProtocolEscrowAccountPda;
+exports.getSettlementConfigPda = getSettlementConfigPda;
+exports.getProtocolFeePda = getProtocolFeePda;
+exports.getOfferPda = getOfferPda;
+exports.getOfferEscrowPda = getOfferEscrowPda;
+exports.getOptionPda = getOptionPda;
+exports.getOptionCollateralEscrowPda = getOptionCollateralEscrowPda;
+exports.getOptionSettlementEscrowPda = getOptionSettlementEscrowPda;
+exports.getMintExercisePda = getMintExercisePda;
+exports.getMintCollateralReturnPda = getMintCollateralReturnPda;
+exports.getSigningKeyDelegationPda = getSigningKeyDelegationPda;
+exports.getUsedOperationPda = getUsedOperationPda;
+exports.deriveOfferPdas = deriveOfferPdas;
+exports.getOracleSettlementConfigPda = getOracleSettlementConfigPda;
+const web3_js_1 = require("@solana/web3.js");
+/**
+ * Program Derived Address (PDA) helpers.
+ *
+ * Seeds are kept in one place so that callers stay in sync with the on-chain
+ * program (see `programs/overcast-core/src/constants.rs`). When a new PDA is
+ * added to the program, add its seed and a matching derivation helper here so
+ * every consumer derives addresses the same way.
+ */
+/** Seed for the singleton protocol state account. */
+exports.PROTOCOL_STATE_SEED = Buffer.from("protocol-state");
+exports.PROTOCOL_ESCROW_SEED = Buffer.from("protocol-escrow");
+/**
+ * Single offer PDA seed. Collateral (maker) and settlement (taker) offers were
+ * merged into one content-addressed `Offer`, so both now share this seed; the
+ * offer's `id` (which folds in its `side`) is what keeps the two disjoint.
+ */
+exports.OFFER_SEED = Buffer.from("offer");
+/** Per-offer escrow seed — holds the locked collateral (maker) or premium (taker). */
+exports.OFFER_ESCROW_SEED = Buffer.from("offer-escrow");
+/**
+ * Seed for the physical-settlement layer's config PDA. Lives in the separate
+ * `overcast_settlement_physical` program, so its `get*Pda` helper below takes
+ * that layer's program id rather than the core program id.
+ * Mirrors `SETTLEMENT_CONFIG_SEED` in the layer's `constants.rs`.
+ */
+exports.SETTLEMENT_CONFIG_SEED = Buffer.from("settlement-config");
+/**
+ * Seed for the protocol-fee hook's config PDA. Lives in the separate
+ * `overcast_fee_hook` program, so its `get*Pda` helper below takes that
+ * program's id rather than the core program id. Mirrors `STATIC_PROTOCOL_FEE`
+ * in the hook's `constants.rs`.
+ */
+exports.STATIC_PROTOCOL_FEE_SEED = Buffer.from("static-protocol-fee");
+exports.OPTION_SEED = Buffer.from("option");
+exports.OPTION_COLLATERAL_ESCROW_SEED = Buffer.from("option-collateral-escrow");
+/** Seed for the option's escrow that collects settlement paid on exercise. */
+exports.OPTION_SETTLEMENT_ESCROW_SEED = Buffer.from("option-settlement-escrow");
+exports.MINT_EXERCISE_SEED = Buffer.from("mint-exercise");
+exports.MINT_COLLATERAL_RETURN_SEED = Buffer.from("mint-collateral-return");
+/** Seed for the record binding a delegated signing key to its owner. */
+exports.SIGNING_KEY_SEED = Buffer.from("signing-key");
+/** Seed for the replay guard consumed when a signed operation executes. */
+exports.USED_OPERATION_SEED = Buffer.from("used-operation");
+/** Singleton protocol state PDA. Mirrors `seeds = [PROTOCOL_STATE_SEED]`. */
+function getProtocolStatePda(programId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.PROTOCOL_STATE_SEED], programId);
+}
+/**
+ * Per-user, per-mint vault token account owned by the protocol — the
+ * `user_token_account` in deposit / withdraw.
+ *
+ * Mirrors: `seeds = [PROTOCOL_ESCROW_SEED, user, mint]`.
+ */
+function getProtocolEscrowAccountPda(programId, user, mint) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.PROTOCOL_ESCROW_SEED, user.toBuffer(), mint.toBuffer()], programId);
+}
+/**
+ * Physical-settlement layer config PDA.
+ *
+ * Mirrors: `seeds = [SETTLEMENT_CONFIG_SEED, authority, salt]` in the layer.
+ * The derived address is what callers put into
+ * `option_details.settlement_layer`; the `physicalProgramId` is what they pass
+ * as `settlement_program` to `accept_offer` / `exercise_option`.
+ */
+function getSettlementConfigPda(physicalProgramId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.SETTLEMENT_CONFIG_SEED], physicalProgramId);
+}
+/**
+ * Protocol-fee hook config PDA.
+ *
+ * Mirrors: `seeds = [STATIC_PROTOCOL_FEE, config.salt]` in the hook. The
+ * derived address is the `ProtocolFee` account callers point
+ * `ProtocolState.option_creation_hook` at (and pass as `hook_config` to
+ * `accept_offer`); `feeHookProgramId` is what they pass as `hook_program`.
+ */
+function getProtocolFeePda(feeHookProgramId, salt) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.STATIC_PROTOCOL_FEE_SEED, salt.toBuffer()], feeHookProgramId);
+}
+/* -------------------------------------------------------------------------- */
+/*  Content-addressed offer / option PDAs                                      */
+/*                                                                            */
+/*  Offers are content-addressed: their PDA seed is a 32-byte `id` derived by  */
+/*  hashing the offer's raw-byte serialization (the on-chain `HashId::id()` in  */
+/*  `programs/overcast-core/src/utils/serialization.rs`). The helpers below     */
+/*  take that pre-computed `id` so derivation stays a pure, synchronous mirror  */
+/*  of the on-chain `seeds = [..]` clauses.                                     */
+/* -------------------------------------------------------------------------- */
+/** Mirrors: `seeds = [OFFER_SEED, offer_id]` */
+function getOfferPda(programId, id) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.OFFER_SEED, id], programId);
+}
+/** Mirrors: `seeds = [OFFER_ESCROW_SEED, offer_id]` */
+function getOfferEscrowPda(programId, id) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.OFFER_ESCROW_SEED, id], programId);
+}
+/** Mirrors: `seeds = [OPTION_SEED, collateral_offer_id, settlement_offer_id]` */
+function getOptionPda(programId, collateralOfferId, settlementOfferId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.OPTION_SEED, collateralOfferId, settlementOfferId], programId);
+}
+/** Mirrors: `seeds = [OPTION_COLLATERAL_ESCROW_SEED, collateral_offer_id, settlement_offer_id]` */
+function getOptionCollateralEscrowPda(programId, collateralOfferId, settlementOfferId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.OPTION_COLLATERAL_ESCROW_SEED, collateralOfferId, settlementOfferId], programId);
+}
+/** Mirrors: `seeds = [OPTION_SETTLEMENT_ESCROW_SEED, collateral_offer_id, settlement_offer_id]` */
+function getOptionSettlementEscrowPda(programId, collateralOfferId, settlementOfferId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.OPTION_SETTLEMENT_ESCROW_SEED, collateralOfferId, settlementOfferId], programId);
+}
+/** Mirrors: `seeds = [MINT_EXERCISE_SEED, collateral_offer_id, settlement_offer_id]` */
+function getMintExercisePda(programId, collateralOfferId, settlementOfferId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.MINT_EXERCISE_SEED, collateralOfferId, settlementOfferId], programId);
+}
+/** Mirrors: `seeds = [MINT_COLLATERAL_RETURN_SEED, collateral_offer_id, settlement_offer_id]` */
+function getMintCollateralReturnPda(programId, collateralOfferId, settlementOfferId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.MINT_COLLATERAL_RETURN_SEED, collateralOfferId, settlementOfferId], programId);
+}
+/**
+ * Record proving `owner` authorized `key` to sign operations on its behalf.
+ *
+ * Mirrors: `seeds = [SIGNING_KEY_SEED, owner, key]` in `add_signing_key.rs`.
+ */
+function getSigningKeyDelegationPda(programId, owner, key) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.SIGNING_KEY_SEED, owner.toBuffer(), key.toBuffer()], programId);
+}
+/**
+ * Replay guard for a signed operation: created when the operation is consumed,
+ * so the same (signer, nonce) pair can never execute twice.
+ *
+ * Mirrors: `seeds = [USED_OPERATION_SEED, signer, nonce]` in `operation.rs`,
+ * where `signer` is the account the operation acts for (offer maker / option
+ * taker), not the transaction submitter.
+ */
+function getUsedOperationPda(programId, signer, nonce) {
+    return web3_js_1.PublicKey.findProgramAddressSync([exports.USED_OPERATION_SEED, signer.toBuffer(), Buffer.from(nonce)], programId);
+}
+/**
+ * Derives an offer's account and escrow PDAs from its pre-computed 32-byte
+ * content-addressed `id` (see `HashId::id()` on-chain). Works for both sides —
+ * the `side` is already baked into `id`.
+ */
+function deriveOfferPdas(program, id) {
+    const [offer] = getOfferPda(program.programId, id);
+    const [escrow] = getOfferEscrowPda(program.programId, id);
+    return { offer, escrow };
+}
+/** Mirrors `OracleKind` in the oracle-gated layer's `state.rs`. */
+exports.ORACLE_KIND = {
+    Pyth: 0,
+};
+/**
+ * Oracle-gated settlement layer config PDA.
+ *
+ * Mirrors: `seeds = [SETTLEMENT_CONFIG_SEED, coll_mint, sett_mint,
+ *                    coll_oracle_kind_byte, coll_oracle_id,
+ *                    sett_oracle_kind_byte, sett_oracle_id]`.
+ *
+ * The full binding is baked into the address, so the pubkey alone is enough
+ * to verify what (mints, oracles) this config covers.
+ */
+function getOracleSettlementConfigPda(oracleGatedProgramId, collMint, settMint, collOracleKind, collOracleId, settOracleKind, settOracleId) {
+    if (collOracleId.length !== 32 || settOracleId.length !== 32) {
+        throw new Error("oracle ids must be 32 bytes");
+    }
+    return web3_js_1.PublicKey.findProgramAddressSync([
+        exports.SETTLEMENT_CONFIG_SEED,
+        collMint.toBuffer(),
+        settMint.toBuffer(),
+        Buffer.from([collOracleKind]),
+        Buffer.from(collOracleId),
+        Buffer.from([settOracleKind]),
+        Buffer.from(settOracleId),
+    ], oracleGatedProgramId);
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@overcast-xyz/solana-program",
+  "version": "0.1.1",
+  "description": "TypeScript mirror of the Overcast Solana program: IDL types, PDA derivation, and offer content-addressing.",
+  "keywords": [
+    "solana",
+    "overcast"
+  ],
+  "license": "Apache-2.0",
+  "author": "info@overcast.xyz",
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  },
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@anchor-lang/core": "1.0.2",
+    "@solana/web3.js": "^1.98.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "pnpm run build:idl && pnpm run build:ts",
+    "build:idl": "cd ../.. && anchor build && cp target/types/overcast_core.ts packages/solana-program/src/overcast_core.ts && cp target/idl/overcast_core.json packages/solana-program/src/overcast_core.json && cp target/types/overcast_settlement_physical.ts packages/solana-program/src/overcast_settlement_physical.ts && cp target/idl/overcast_settlement_physical.json packages/solana-program/src/overcast_settlement_physical.json && cp target/types/overcast_settlement_oracle_gated.ts packages/solana-program/src/overcast_settlement_oracle_gated.ts && cp target/idl/overcast_settlement_oracle_gated.json packages/solana-program/src/overcast_settlement_oracle_gated.json && cp target/types/overcast_fee_hook.ts packages/solana-program/src/overcast_fee_hook.ts && cp target/idl/overcast_fee_hook.json packages/solana-program/src/overcast_fee_hook.json && pnpm exec prettier --write packages/solana-program/src/overcast_core.ts packages/solana-program/src/overcast_core.json packages/solana-program/src/overcast_settlement_physical.ts packages/solana-program/src/overcast_settlement_physical.json packages/solana-program/src/overcast_settlement_oracle_gated.ts packages/solana-program/src/overcast_settlement_oracle_gated.json packages/solana-program/src/overcast_fee_hook.ts packages/solana-program/src/overcast_fee_hook.json",
+    "build:ts": "tsc -p tsconfig.json && cp src/overcast_core.json dist/overcast_core.json && cp src/overcast_settlement_physical.json dist/overcast_settlement_physical.json && cp src/overcast_settlement_oracle_gated.json dist/overcast_settlement_oracle_gated.json && cp src/overcast_fee_hook.json dist/overcast_fee_hook.json",
+    "clean": "rm -rf dist"
+  }
+}