@cypher-zk/sdk 0.4.0 → 0.5.0

package/src/idl/cypher.ts

@@ -15,6 +15,9 @@ export type Cypher = {
   "instructions": [
     {
       "name": "adminClaimRemaining",
+      "docs": [
+        "Admin claims remaining unclaimed funds once the claim and refund deadlines have passed."
+      ],
       "discriminator": [
         226,
         176,
@@ -113,14 +116,92 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": []
     },
+    {
+      "name": "adminOverrideResolution",
+      "docs": [
+        "Admin override of a disputed resolution with a corrected outcome and recomputed payout ratio."
+      ],
+      "discriminator": [
+        47,
+        117,
+        40,
+        129,
+        108,
+        28,
+        219,
+        96
+      ],
+      "accounts": [
+        {
+          "name": "admin",
+          "signer": true
+        },
+        {
+          "name": "globalState",
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  103,
+                  108,
+                  111,
+                  98,
+                  97,
+                  108,
+                  95,
+                  115,
+                  116,
+                  97,
+                  116,
+                  101
+                ]
+              }
+            ]
+          }
+        },
+        {
+          "name": "market",
+          "writable": true,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  109,
+                  97,
+                  114,
+                  107,
+                  101,
+                  116
+                ]
+              },
+              {
+                "kind": "account",
+                "path": "market.market_id",
+                "account": "market"
+              }
+            ]
+          }
+        }
+      ],
+      "args": [
+        {
+          "name": "outcomeValue",
+          "type": "u8"
+        }
+      ]
+    },
     {
       "name": "cancelMarket",
+      "docs": [
+        "Cancel a market and return bond to creator (only if no bets placed)."
+      ],
       "discriminator": [
         205,
         121,
@@ -227,14 +308,16 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": []
     },
     {
       "name": "claimPayoutMulti",
+      "docs": [
+        "Queue MPC computation to verify and pay out a winning MultiOutcome position."
+      ],
       "discriminator": [
         183,
         30,
@@ -413,8 +496,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": [
@@ -426,6 +508,9 @@ export type Cypher = {
     },
     {
       "name": "claimPayoutYesno",
+      "docs": [
+        "Queue MPC computation to verify and pay out a winning YesNo position."
+      ],
       "discriminator": [
         224,
         84,
@@ -604,8 +689,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": [
@@ -617,6 +701,9 @@ export type Cypher = {
     },
     {
       "name": "claimRefundMulti",
+      "docs": [
+        "Queue MPC computation to refund a bet on an unresolved MultiOutcome market."
+      ],
       "discriminator": [
         186,
         255,
@@ -795,8 +882,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": [
@@ -808,6 +894,9 @@ export type Cypher = {
     },
     {
       "name": "claimRefundYesno",
+      "docs": [
+        "Queue MPC computation to refund a bet on an unresolved YesNo market."
+      ],
       "discriminator": [
         250,
         69,
@@ -986,8 +1075,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": [
@@ -999,6 +1087,9 @@ export type Cypher = {
     },
     {
       "name": "computeMultiPayoutCallback",
+      "docs": [
+        "Callback that transfers the computed payout to the winning bettor."
+      ],
       "discriminator": [
         242,
         12,
@@ -1050,8 +1141,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         },
         {
           "name": "systemProgram",
@@ -1081,6 +1171,9 @@ export type Cypher = {
     },
     {
       "name": "computeMultiRefundCallback",
+      "docs": [
+        "Callback that transfers the computed refund to the bettor."
+      ],
       "discriminator": [
         164,
         49,
@@ -1132,8 +1225,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         },
         {
           "name": "systemProgram",
@@ -1163,6 +1255,9 @@ export type Cypher = {
     },
     {
       "name": "computeYesnoPayoutCallback",
+      "docs": [
+        "Callback that transfers the computed payout to the winning bettor."
+      ],
       "discriminator": [
         154,
         174,
@@ -1214,8 +1309,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         },
         {
           "name": "systemProgram",
@@ -1245,6 +1339,9 @@ export type Cypher = {
     },
     {
       "name": "computeYesnoRefundCallback",
+      "docs": [
+        "Callback that transfers the computed refund to the bettor."
+      ],
       "discriminator": [
         87,
         6,
@@ -1296,8 +1393,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         },
         {
           "name": "systemProgram",
@@ -1327,6 +1423,9 @@ export type Cypher = {
     },
     {
       "name": "createMarket",
+      "docs": [
+        "Create a new YesNo prediction market (creator pays the bond, sets close time and challenge period)."
+      ],
       "discriminator": [
         103,
         226,
@@ -1461,8 +1560,7 @@ export type Cypher = {
           "name": "acceptedMint"
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         },
         {
           "name": "systemProgram",
@@ -1481,11 +1579,18 @@ export type Cypher = {
         {
           "name": "category",
           "type": "u8"
+        },
+        {
+          "name": "challengePeriod",
+          "type": "i64"
         }
       ]
     },
     {
       "name": "createMarketMulti",
+      "docs": [
+        "Create a new MultiOutcome prediction market with 2-4 outcomes."
+      ],
       "discriminator": [
         35,
         185,
@@ -1620,8 +1725,7 @@ export type Cypher = {
           "name": "acceptedMint"
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         },
         {
           "name": "systemProgram",
@@ -1644,11 +1748,112 @@ export type Cypher = {
         {
           "name": "numOutcomes",
           "type": "u8"
+        },
+        {
+          "name": "challengePeriod",
+          "type": "i64"
         }
       ]
     },
+    {
+      "name": "finalizeResolution",
+      "docs": [
+        "Finalize a pending resolution once the challenge window has passed undisputed."
+      ],
+      "discriminator": [
+        191,
+        74,
+        94,
+        214,
+        45,
+        150,
+        152,
+        125
+      ],
+      "accounts": [
+        {
+          "name": "caller",
+          "signer": true
+        },
+        {
+          "name": "market",
+          "writable": true,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  109,
+                  97,
+                  114,
+                  107,
+                  101,
+                  116
+                ]
+              },
+              {
+                "kind": "account",
+                "path": "market.market_id",
+                "account": "market"
+              }
+            ]
+          }
+        }
+      ],
+      "args": []
+    },
+    {
+      "name": "flagResolution",
+      "docs": [
+        "Flag a pending resolution as disputed during the challenge window."
+      ],
+      "discriminator": [
+        144,
+        21,
+        165,
+        219,
+        56,
+        125,
+        121,
+        138
+      ],
+      "accounts": [
+        {
+          "name": "flagger",
+          "signer": true
+        },
+        {
+          "name": "market",
+          "writable": true,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  109,
+                  97,
+                  114,
+                  107,
+                  101,
+                  116
+                ]
+              },
+              {
+                "kind": "account",
+                "path": "market.market_id",
+                "account": "market"
+              }
+            ]
+          }
+        }
+      ],
+      "args": []
+    },
     {
       "name": "initPayoutMultiCompDef",
+      "docs": [
+        "Register the compute_multi_payout Arcium computation definition."
+      ],
       "discriminator": [
         155,
         138,
@@ -1694,6 +1899,9 @@ export type Cypher = {
     },
     {
       "name": "initPayoutYesnoCompDef",
+      "docs": [
+        "Register the compute_yesno_payout Arcium computation definition."
+      ],
       "discriminator": [
         104,
         87,
@@ -1739,6 +1947,9 @@ export type Cypher = {
     },
     {
       "name": "initPlaceBetMultiCompDef",
+      "docs": [
+        "Register the place_private_bet_multi Arcium computation definition."
+      ],
       "discriminator": [
         2,
         251,
@@ -1784,6 +1995,9 @@ export type Cypher = {
     },
     {
       "name": "initPlaceBetYesnoCompDef",
+      "docs": [
+        "Register the place_private_bet_yesno Arcium computation definition."
+      ],
       "discriminator": [
         160,
         105,
@@ -1829,6 +2043,9 @@ export type Cypher = {
     },
     {
       "name": "initRefundMultiCompDef",
+      "docs": [
+        "Register the compute_multi_refund Arcium computation definition."
+      ],
       "discriminator": [
         166,
         248,
@@ -1874,6 +2091,9 @@ export type Cypher = {
     },
     {
       "name": "initRefundYesnoCompDef",
+      "docs": [
+        "Register the compute_yesno_refund Arcium computation definition."
+      ],
       "discriminator": [
         114,
         168,
@@ -1919,6 +2139,9 @@ export type Cypher = {
     },
     {
       "name": "initRevealMultiCompDef",
+      "docs": [
+        "Register the reveal_market_outcome_multi Arcium computation definition."
+      ],
       "discriminator": [
         174,
         143,
@@ -1964,6 +2187,9 @@ export type Cypher = {
     },
     {
       "name": "initRevealYesnoCompDef",
+      "docs": [
+        "Register the reveal_market_outcome_yesno Arcium computation definition."
+      ],
       "discriminator": [
         185,
         221,
@@ -2009,6 +2235,9 @@ export type Cypher = {
     },
     {
       "name": "initialize",
+      "docs": [
+        "Initialize the global protocol state: fee rates, treasury, accepted mint, and admin."
+      ],
       "discriminator": [
         175,
         175,
@@ -2075,6 +2304,9 @@ export type Cypher = {
     },
     {
       "name": "placePrivateBetMulti",
+      "docs": [
+        "Queue an encrypted multi-outcome bet for MPC processing."
+      ],
       "discriminator": [
         43,
         95,
@@ -2282,8 +2514,7 @@ export type Cypher = {
           }
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": [
@@ -2330,6 +2561,9 @@ export type Cypher = {
     },
     {
       "name": "placePrivateBetMultiCallback",
+      "docs": [
+        "Callback that applies the MPC-computed pool totals and entry odds for a MultiOutcome bet."
+      ],
       "discriminator": [
         81,
         0,
@@ -2393,6 +2627,9 @@ export type Cypher = {
     },
     {
       "name": "placePrivateBetYesno",
+      "docs": [
+        "Queue an encrypted YES/NO bet for MPC processing."
+      ],
       "discriminator": [
         14,
         226,
@@ -2600,8 +2837,7 @@ export type Cypher = {
           }
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": [
@@ -2648,6 +2884,9 @@ export type Cypher = {
     },
     {
       "name": "placePrivateBetYesnoCallback",
+      "docs": [
+        "Callback that applies the MPC-computed pool totals and entry odds for a YesNo bet."
+      ],
       "discriminator": [
         1,
         193,
@@ -2711,6 +2950,9 @@ export type Cypher = {
     },
     {
       "name": "resolveMarketMulti",
+      "docs": [
+        "Queue MPC computation to reveal the multi-outcome winner and pools."
+      ],
       "discriminator": [
         237,
         84,
@@ -2841,6 +3083,9 @@ export type Cypher = {
     },
     {
       "name": "resolveMarketYesno",
+      "docs": [
+        "Queue MPC computation to reveal the YES/NO outcome and pools."
+      ],
       "discriminator": [
         191,
         1,
@@ -2971,6 +3216,9 @@ export type Cypher = {
     },
     {
       "name": "revealMarketOutcomeMultiCallback",
+      "docs": [
+        "Callback that writes the revealed outcome, pools, and payout ratio; market enters the challenge window."
+      ],
       "discriminator": [
         114,
         103,
@@ -3030,6 +3278,9 @@ export type Cypher = {
     },
     {
       "name": "revealMarketOutcomeYesnoCallback",
+      "docs": [
+        "Callback that writes the revealed outcome, pools, and payout ratio; market enters the challenge window."
+      ],
       "discriminator": [
         92,
         112,
@@ -3089,6 +3340,9 @@ export type Cypher = {
     },
     {
       "name": "updateAcceptedMint",
+      "docs": [
+        "Update the protocol's accepted mint and treasury (admin only)."
+      ],
       "discriminator": [
         6,
         166,
@@ -3145,6 +3399,9 @@ export type Cypher = {
     },
     {
       "name": "withdrawCreatorFunds",
+      "docs": [
+        "Withdraw creator bond and accumulated LP fees after the market is resolved."
+      ],
       "discriminator": [
         135,
         166,
@@ -3251,8 +3508,7 @@ export type Cypher = {
           "writable": true
         },
         {
-          "name": "tokenProgram",
-          "address": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
+          "name": "tokenProgram"
         }
       ],
       "args": []
@@ -3378,6 +3634,19 @@ export type Cypher = {
         124
       ]
     },
+    {
+      "name": "marketFinalizedEvent",
+      "discriminator": [
+        141,
+        216,
+        158,
+        192,
+        60,
+        222,
+        155,
+        232
+      ]
+    },
     {
       "name": "marketResolvedEvent",
       "discriminator": [
@@ -3416,6 +3685,32 @@ export type Cypher = {
         154,
         233
       ]
+    },
+    {
+      "name": "resolutionFlaggedEvent",
+      "discriminator": [
+        159,
+        214,
+        98,
+        62,
+        158,
+        28,
+        21,
+        84
+      ]
+    },
+    {
+      "name": "resolutionOverriddenEvent",
+      "discriminator": [
+        133,
+        175,
+        170,
+        160,
+        47,
+        76,
+        128,
+        87
+      ]
     }
   ],
   "errors": [
@@ -3598,6 +3893,36 @@ export type Cypher = {
       "code": 6035,
       "name": "invalidCategory",
       "msg": "Invalid category — must be 0-6"
+    },
+    {
+      "code": 6036,
+      "name": "invalidChallengePeriod",
+      "msg": "Challenge period must be between 24 and 48 hours"
+    },
+    {
+      "code": 6037,
+      "name": "notPendingResolution",
+      "msg": "Market is not pending resolution"
+    },
+    {
+      "code": 6038,
+      "name": "challengePeriodNotElapsed",
+      "msg": "Challenge period has not elapsed yet"
+    },
+    {
+      "code": 6039,
+      "name": "challengePeriodElapsed",
+      "msg": "Challenge period has already elapsed"
+    },
+    {
+      "code": 6040,
+      "name": "marketDisputed",
+      "msg": "Market resolution is disputed — admin must override"
+    },
+    {
+      "code": 6041,
+      "name": "marketNotDisputed",
+      "msg": "Market resolution is not disputed"
     }
   ],
   "types": [
@@ -4600,6 +4925,27 @@ export type Cypher = {
             "name": "refundDeadline",
             "type": "i64"
           },
+          {
+            "name": "challengePeriod",
+            "docs": [
+              "Configurable dispute window (24-48h), set at creation"
+            ],
+            "type": "i64"
+          },
+          {
+            "name": "challengeDeadline",
+            "docs": [
+              "resolution_time + challenge_period — set by the reveal callback"
+            ],
+            "type": "i64"
+          },
+          {
+            "name": "disputed",
+            "docs": [
+              "Set true by flag_resolution; blocks finalize_resolution until admin overrides"
+            ],
+            "type": "bool"
+          },
           {
             "name": "bump",
             "type": "u8"
@@ -4663,6 +5009,26 @@ export type Cypher = {
         ]
       }
     },
+    {
+      "name": "marketFinalizedEvent",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "market",
+            "type": "pubkey"
+          },
+          {
+            "name": "outcome",
+            "type": "u8"
+          },
+          {
+            "name": "payoutRatio",
+            "type": "u64"
+          }
+        ]
+      }
+    },
     {
       "name": "marketResolvedEvent",
       "type": {
@@ -5061,6 +5427,50 @@ export type Cypher = {
         ]
       }
     },
+    {
+      "name": "resolutionFlaggedEvent",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "market",
+            "type": "pubkey"
+          },
+          {
+            "name": "flaggedBy",
+            "type": "pubkey"
+          }
+        ]
+      }
+    },
+    {
+      "name": "resolutionOverriddenEvent",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "market",
+            "type": "pubkey"
+          },
+          {
+            "name": "oldOutcome",
+            "type": "u8"
+          },
+          {
+            "name": "newOutcome",
+            "type": "u8"
+          },
+          {
+            "name": "newPayoutRatio",
+            "type": "u64"
+          },
+          {
+            "name": "admin",
+            "type": "pubkey"
+          }
+        ]
+      }
+    },
     {
       "name": "revealMarketOutcomeMultiOutput",
       "docs": [