@overcast-xyz/solana-program 0.1.1

package/dist/overcast_settlement_physical.json

@@ -0,0 +1,393 @@
+{
+  "address": "2Nd6fQknNSfrDApARY8km19qp41yS8yk59RRPrnHHKnB",
+  "metadata": {
+    "name": "overcast_settlement_physical",
+    "version": "0.1.0",
+    "spec": "0.1.0",
+    "description": "Physical-settlement layer for Overcast options"
+  },
+  "instructions": [
+    {
+      "name": "can_borrow",
+      "discriminator": [23, 180, 16, 136, 86, 168, 84, 152],
+      "accounts": [
+        {
+          "name": "config"
+        }
+      ],
+      "args": [
+        {
+          "name": "option",
+          "type": {
+            "defined": {
+              "name": "MarketOption"
+            }
+          }
+        },
+        {
+          "name": "borrower",
+          "type": "pubkey"
+        },
+        {
+          "name": "borrow_amount",
+          "type": "u64"
+        },
+        {
+          "name": "collateral_receiver",
+          "type": "pubkey"
+        },
+        {
+          "name": "metadata",
+          "type": "bytes"
+        }
+      ]
+    },
+    {
+      "name": "can_exercise",
+      "discriminator": [114, 239, 61, 62, 83, 204, 139, 83],
+      "accounts": [
+        {
+          "name": "config"
+        }
+      ],
+      "args": [
+        {
+          "name": "option",
+          "type": {
+            "defined": {
+              "name": "MarketOption"
+            }
+          }
+        },
+        {
+          "name": "exercise_amount",
+          "type": "u64"
+        },
+        {
+          "name": "metadata",
+          "type": "bytes"
+        }
+      ],
+      "returns": {
+        "defined": {
+          "name": "ExerciseResolution"
+        }
+      }
+    },
+    {
+      "name": "can_match",
+      "discriminator": [223, 238, 7, 233, 72, 137, 146, 135],
+      "accounts": [
+        {
+          "name": "config"
+        }
+      ],
+      "args": [
+        {
+          "name": "option",
+          "type": {
+            "defined": {
+              "name": "MarketOption"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "can_redeem",
+      "docs": [
+        "Physical-settlement redeem resolution — the payout math (pro-rata against",
+        "the live claim supply and escrow balances) lives in the [`SettlementLayer`]",
+        "impl in `crate::layer` and is shared, settlement-agnostic logic."
+      ],
+      "discriminator": [88, 241, 152, 58, 50, 172, 234, 99],
+      "accounts": [
+        {
+          "name": "config"
+        }
+      ],
+      "args": [
+        {
+          "name": "option",
+          "type": {
+            "defined": {
+              "name": "MarketOption"
+            }
+          }
+        },
+        {
+          "name": "redeem_amount",
+          "type": "u64"
+        },
+        {
+          "name": "claim_supply",
+          "type": "u64"
+        },
+        {
+          "name": "collateral_balance",
+          "type": "u64"
+        },
+        {
+          "name": "settlement_balance",
+          "type": "u64"
+        },
+        {
+          "name": "metadata",
+          "type": "bytes"
+        }
+      ],
+      "returns": {
+        "defined": {
+          "name": "RedeemResolution"
+        }
+      }
+    },
+    {
+      "name": "initialize_config",
+      "discriminator": [208, 127, 21, 1, 194, 190, 196, 70],
+      "accounts": [
+        {
+          "name": "authority",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "config",
+          "writable": true,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  115, 101, 116, 116, 108, 101, 109, 101, 110, 116, 45, 99, 111,
+                  110, 102, 105, 103
+                ]
+              }
+            ]
+          }
+        },
+        {
+          "name": "system_program",
+          "address": "11111111111111111111111111111111"
+        }
+      ],
+      "args": []
+    }
+  ],
+  "accounts": [
+    {
+      "name": "SettlementConfig",
+      "discriminator": [205, 26, 40, 112, 76, 134, 3, 14]
+    }
+  ],
+  "errors": [
+    {
+      "code": 6000,
+      "name": "InvalidCollateralAmount",
+      "msg": "Collateral amount must be non-zero"
+    },
+    {
+      "code": 6001,
+      "name": "ExerciseAmountTooLarge",
+      "msg": "Exercise amount exceeds available collateral"
+    },
+    {
+      "code": 6002,
+      "name": "ArithmeticOverflow",
+      "msg": "Arithmetic overflow computing settlement"
+    },
+    {
+      "code": 6003,
+      "name": "BorrowNotSupported",
+      "msg": "This settlement layer does not permit borrowing collateral"
+    }
+  ],
+  "types": [
+    {
+      "name": "ExerciseResolution",
+      "docs": [
+        "A settlement layer returns this from `can_exercise` to instruct core how to",
+        "move escrowed funds. Core owns custody of all option assets; layers are pure",
+        "decision modules."
+      ],
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "collateral_to_taker",
+            "docs": [
+              "Collateral asset moved from option escrow to maker escrow (e.g. cashless leftover)."
+            ],
+            "type": "u64"
+          },
+          {
+            "name": "settlement_from_taker",
+            "docs": [
+              "Settlement asset pulled from taker to maker. Zero for cashless settlement."
+            ],
+            "type": "u64"
+          }
+        ]
+      }
+    },
+    {
+      "name": "MarketOption",
+      "docs": [
+        "A live option, as passed to a settlement layer / hook. Mirrors",
+        "`overcast_core::state::MarketOption` byte-for-byte."
+      ],
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "details",
+            "type": {
+              "defined": {
+                "name": "OptionDetails"
+              }
+            }
+          },
+          {
+            "name": "taker",
+            "type": "pubkey"
+          },
+          {
+            "name": "maker",
+            "type": "pubkey"
+          },
+          {
+            "name": "settlement_offer",
+            "type": "pubkey"
+          },
+          {
+            "name": "collateral_offer",
+            "type": "pubkey"
+          },
+          {
+            "name": "borrowed_collateral",
+            "docs": [
+              "Collateral currently out on loan via `borrow_collateral` and not yet",
+              "returned via `repay_collateral`."
+            ],
+            "type": "u64"
+          }
+        ]
+      }
+    },
+    {
+      "name": "OptionDetails",
+      "docs": [
+        "The economic terms of an option, as seen by a settlement layer / hook.",
+        "",
+        "Mirrors `overcast_core::state::OptionDetails` byte-for-byte — core owns the",
+        "on-chain account representation, this is the shared interface view."
+      ],
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "domain",
+            "type": "u32"
+          },
+          {
+            "name": "start_timestamp",
+            "type": "i64"
+          },
+          {
+            "name": "end_timestamp",
+            "type": "i64"
+          },
+          {
+            "name": "premium_asset",
+            "type": "pubkey"
+          },
+          {
+            "name": "premium_amount",
+            "type": "u64"
+          },
+          {
+            "name": "collateral_asset",
+            "type": "pubkey"
+          },
+          {
+            "name": "collateral_amount",
+            "type": "u64"
+          },
+          {
+            "name": "settlement_asset",
+            "type": "pubkey"
+          },
+          {
+            "name": "settlement_amount",
+            "type": "u64"
+          },
+          {
+            "name": "settlement_layer",
+            "type": "pubkey"
+          },
+          {
+            "name": "borrow_allowed",
+            "docs": [
+              "Opt-in flag: if false, `borrow_collateral` is hard-rejected by core",
+              "regardless of what the settlement layer says. If true, the layer is",
+              "CPI'd and can still refuse."
+            ],
+            "type": "bool"
+          }
+        ]
+      }
+    },
+    {
+      "name": "RedeemResolution",
+      "docs": [
+        "A settlement layer returns this from `can_redeem` to instruct core how much",
+        "of each escrow to release to the maker. The redemption analogue of",
+        "[`ExerciseResolution`]: redemption only ever unwinds the two escrows back to",
+        "the maker, so the taker-facing fields are dropped."
+      ],
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "collateral_to_maker",
+            "docs": [
+              "Collateral asset released from the option escrow to the maker."
+            ],
+            "type": "u64"
+          },
+          {
+            "name": "settlement_to_maker",
+            "docs": [
+              "Settlement asset released from the option escrow to the maker."
+            ],
+            "type": "u64"
+          }
+        ]
+      }
+    },
+    {
+      "name": "SettlementConfig",
+      "docs": [
+        "Per-instance config for the physical-settlement layer. Stub layout — the",
+        "physical layer is parameter-free, but the PDA must exist so options can bind",
+        "to a specific config (and, transitively, to this program as the owner)."
+      ],
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "bump",
+            "type": "u8"
+          }
+        ]
+      }
+    }
+  ],
+  "constants": [
+    {
+      "name": "SETTLEMENT_CONFIG_SEED",
+      "type": "bytes",
+      "value": "[115, 101, 116, 116, 108, 101, 109, 101, 110, 116, 45, 99, 111, 110, 102, 105, 103]"
+    }
+  ]
+}

package/dist/pda.d.ts

@@ -0,0 +1,129 @@
+import { Program } from "@anchor-lang/core";
+import { PublicKey } from "@solana/web3.js";
+import type { OvercastCore } from "./overcast_core";
+/**
+ * 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. */
+export declare const PROTOCOL_STATE_SEED: Buffer<ArrayBuffer>;
+export declare const PROTOCOL_ESCROW_SEED: Buffer<ArrayBuffer>;
+/**
+ * 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.
+ */
+export declare const OFFER_SEED: Buffer<ArrayBuffer>;
+/** Per-offer escrow seed — holds the locked collateral (maker) or premium (taker). */
+export declare const OFFER_ESCROW_SEED: Buffer<ArrayBuffer>;
+/**
+ * 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`.
+ */
+export declare const SETTLEMENT_CONFIG_SEED: Buffer<ArrayBuffer>;
+/**
+ * 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`.
+ */
+export declare const STATIC_PROTOCOL_FEE_SEED: Buffer<ArrayBuffer>;
+export declare const OPTION_SEED: Buffer<ArrayBuffer>;
+export declare const OPTION_COLLATERAL_ESCROW_SEED: Buffer<ArrayBuffer>;
+/** Seed for the option's escrow that collects settlement paid on exercise. */
+export declare const OPTION_SETTLEMENT_ESCROW_SEED: Buffer<ArrayBuffer>;
+export declare const MINT_EXERCISE_SEED: Buffer<ArrayBuffer>;
+export declare const MINT_COLLATERAL_RETURN_SEED: Buffer<ArrayBuffer>;
+/** Seed for the record binding a delegated signing key to its owner. */
+export declare const SIGNING_KEY_SEED: Buffer<ArrayBuffer>;
+/** Seed for the replay guard consumed when a signed operation executes. */
+export declare const USED_OPERATION_SEED: Buffer<ArrayBuffer>;
+/** Singleton protocol state PDA. Mirrors `seeds = [PROTOCOL_STATE_SEED]`. */
+export declare function getProtocolStatePda(programId: PublicKey): [PublicKey, number];
+/**
+ * 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]`.
+ */
+export declare function getProtocolEscrowAccountPda(programId: PublicKey, user: PublicKey, mint: PublicKey): [PublicKey, number];
+/**
+ * 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`.
+ */
+export declare function getSettlementConfigPda(physicalProgramId: PublicKey): [PublicKey, number];
+/**
+ * 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`.
+ */
+export declare function getProtocolFeePda(feeHookProgramId: PublicKey, salt: PublicKey): [PublicKey, number];
+/** Mirrors: `seeds = [OFFER_SEED, offer_id]` */
+export declare function getOfferPda(programId: PublicKey, id: Buffer): [PublicKey, number];
+/** Mirrors: `seeds = [OFFER_ESCROW_SEED, offer_id]` */
+export declare function getOfferEscrowPda(programId: PublicKey, id: Buffer): [PublicKey, number];
+/** Mirrors: `seeds = [OPTION_SEED, collateral_offer_id, settlement_offer_id]` */
+export declare function getOptionPda(programId: PublicKey, collateralOfferId: Buffer, settlementOfferId: Buffer): [PublicKey, number];
+/** Mirrors: `seeds = [OPTION_COLLATERAL_ESCROW_SEED, collateral_offer_id, settlement_offer_id]` */
+export declare function getOptionCollateralEscrowPda(programId: PublicKey, collateralOfferId: Buffer, settlementOfferId: Buffer): [PublicKey, number];
+/** Mirrors: `seeds = [OPTION_SETTLEMENT_ESCROW_SEED, collateral_offer_id, settlement_offer_id]` */
+export declare function getOptionSettlementEscrowPda(programId: PublicKey, collateralOfferId: Buffer, settlementOfferId: Buffer): [PublicKey, number];
+/** Mirrors: `seeds = [MINT_EXERCISE_SEED, collateral_offer_id, settlement_offer_id]` */
+export declare function getMintExercisePda(programId: PublicKey, collateralOfferId: Buffer, settlementOfferId: Buffer): [PublicKey, number];
+/** Mirrors: `seeds = [MINT_COLLATERAL_RETURN_SEED, collateral_offer_id, settlement_offer_id]` */
+export declare function getMintCollateralReturnPda(programId: PublicKey, collateralOfferId: Buffer, settlementOfferId: Buffer): [PublicKey, number];
+/**
+ * Record proving `owner` authorized `key` to sign operations on its behalf.
+ *
+ * Mirrors: `seeds = [SIGNING_KEY_SEED, owner, key]` in `add_signing_key.rs`.
+ */
+export declare function getSigningKeyDelegationPda(programId: PublicKey, owner: PublicKey, key: PublicKey): [PublicKey, number];
+/**
+ * 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.
+ */
+export declare function getUsedOperationPda(programId: PublicKey, signer: PublicKey, nonce: Buffer | Uint8Array): [PublicKey, number];
+/** The `Offer` value passed to `make_offer` (fields: salt, creator, optionDetails, expiry, side). */
+export type OfferInput = Parameters<Program<OvercastCore>["methods"]["makeOffer"]>[0];
+/**
+ * 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`.
+ */
+export declare function deriveOfferPdas(program: Program<OvercastCore>, id: Buffer): {
+    offer: PublicKey;
+    escrow: PublicKey;
+};
+/** Mirrors `OracleKind` in the oracle-gated layer's `state.rs`. */
+export declare const ORACLE_KIND: {
+    readonly Pyth: 0;
+};
+export type OracleKindByte = (typeof ORACLE_KIND)[keyof typeof ORACLE_KIND];
+/**
+ * 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.
+ */
+export declare function getOracleSettlementConfigPda(oracleGatedProgramId: PublicKey, collMint: PublicKey, settMint: PublicKey, collOracleKind: OracleKindByte, collOracleId: Uint8Array, settOracleKind: OracleKindByte, settOracleId: Uint8Array): [PublicKey, number];