@wuwei-labs/srsly 2.0.0-beta.37 → 2.0.0-beta.41

package/target/idl/srsly.json

@@ -10,7 +10,7 @@
     {
       "name": "accept_rental",
       "docs": [
-        "Allows a borrower to accept a rental by providing funds and specifying duration."
+        "Accept a rental contract by providing payment and specifying duration."
       ],
       "discriminator": [
         192,
@@ -348,37 +348,7 @@
         },
         {
           "name": "rental_thread",
-          "writable": true,
-          "pda": {
-            "seeds": [
-              {
-                "kind": "const",
-                "value": [
-                  116,
-                  104,
-                  114,
-                  101,
-                  97,
-                  100
-                ]
-              },
-              {
-                "kind": "account",
-                "path": "rental_authority"
-              },
-              {
-                "kind": "account",
-                "path": "rental_state"
-              }
-            ]
-          }
-        },
-        {
-          "name": "referral_token_account",
-          "docs": [
-            "Referral token account - defaults to system program if no referral"
-          ],
-          "optional": true
+          "writable": true
         },
         {
           "name": "sage_program"
@@ -414,7 +384,7 @@
     {
       "name": "cancel_rental",
       "docs": [
-        "Cancels an ongoing rental before its scheduled end, marking it as canceled for repayment logic."
+        "Cancel an active rental early with prorated refunds."
       ],
       "discriminator": [
         97,
@@ -430,10 +400,7 @@
         {
           "name": "borrower",
           "writable": true,
-          "signer": true,
-          "relations": [
-            "rental_state"
-          ]
+          "signer": true
         },
         {
           "name": "config",
@@ -744,7 +711,7 @@
     {
       "name": "close_contract",
       "docs": [
-        "Closes an existing rental contract, preventing further rentals."
+        "Closes a rental contract. Contract must have no active rentals."
       ],
       "discriminator": [
         37,
@@ -849,7 +816,7 @@
     {
       "name": "close_rental",
       "docs": [
-        "Closes a rental after its duration has ended, removes it from the contract."
+        "Close a completed or expired rental and clean up state."
       ],
       "discriminator": [
         179,
@@ -993,7 +960,8 @@
           }
         },
         {
-          "name": "contract"
+          "name": "contract",
+          "writable": true
         },
         {
           "name": "rental_state",
@@ -1238,30 +1206,24 @@
         },
         {
           "name": "rental_thread",
-          "writable": true,
-          "pda": {
-            "seeds": [
-              {
-                "kind": "const",
-                "value": [
-                  116,
-                  104,
-                  114,
-                  101,
-                  97,
-                  100
-                ]
-              },
-              {
-                "kind": "account",
-                "path": "rental_authority"
-              },
-              {
-                "kind": "account",
-                "path": "rental_state"
-              }
-            ]
-          }
+          "writable": true
+        },
+        {
+          "name": "fleet",
+          "writable": true
+        },
+        {
+          "name": "game_id"
+        },
+        {
+          "name": "starbase"
+        },
+        {
+          "name": "starbase_player",
+          "writable": true
+        },
+        {
+          "name": "sage_program"
         },
         {
           "name": "antegen_program",
@@ -1285,7 +1247,7 @@
     {
       "name": "create_contract",
       "docs": [
-        "Creates a new rental contract, defining the rental terms such as rate, duration, and payment frequency."
+        "Creates a new rental contract for a fleet with specified terms."
       ],
       "discriminator": [
         244,
@@ -1526,7 +1488,7 @@
     {
       "name": "initialize_config",
       "docs": [
-        "Initializes the SRSLY program configuration account"
+        "Initialize global program configuration. Called once during deployment."
       ],
       "discriminator": [
         208,
@@ -1582,7 +1544,7 @@
     {
       "name": "pay_rental",
       "docs": [
-        "Handles recurring rental payments via an automated thread."
+        "Process recurring rental payments via automated Clockwork thread."
       ],
       "discriminator": [
         114,
@@ -1874,13 +1836,6 @@
             }
           }
         },
-        {
-          "name": "referral_token_account",
-          "docs": [
-            "Referral token account - optional, can be any valid token account"
-          ],
-          "optional": true
-        },
         {
           "name": "config",
           "pda": {
@@ -1918,10 +1873,83 @@
         }
       }
     },
+    {
+      "name": "reset_contract_temp",
+      "docs": [
+        "Temporary instruction to reset current_rental_state for devnet testing."
+      ],
+      "discriminator": [
+        185,
+        172,
+        167,
+        183,
+        225,
+        177,
+        238,
+        68
+      ],
+      "accounts": [
+        {
+          "name": "signer",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "contract",
+          "writable": true
+        },
+        {
+          "name": "rental_authority",
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  114,
+                  101,
+                  110,
+                  116,
+                  97,
+                  108,
+                  95,
+                  97,
+                  117,
+                  116,
+                  104,
+                  111,
+                  114,
+                  105,
+                  116,
+                  121
+                ]
+              }
+            ]
+          }
+        },
+        {
+          "name": "fleet",
+          "writable": true
+        },
+        {
+          "name": "game_id"
+        },
+        {
+          "name": "starbase"
+        },
+        {
+          "name": "starbase_player",
+          "writable": true
+        },
+        {
+          "name": "sage_program"
+        }
+      ],
+      "args": []
+    },
     {
       "name": "reset_rental",
       "docs": [
-        "Resets a rental in the event of an early cancellation or contract ending."
+        "Reset a cancelled rental and process refunds."
       ],
       "discriminator": [
         139,
@@ -1934,6 +1962,11 @@
         183
       ],
       "accounts": [
+        {
+          "name": "signer",
+          "writable": true,
+          "signer": true
+        },
         {
           "name": "fleet",
           "writable": true
@@ -1996,7 +2029,7 @@
     {
       "name": "update_config",
       "docs": [
-        "Updates the SRSLY program configuration"
+        "Update program configuration. Only callable by config authority."
       ],
       "discriminator": [
         29,
@@ -2222,6 +2255,26 @@
       "code": 6023,
       "name": "RentalNotExpired",
       "msg": "Rental has not expired yet. Cannot close contract with active rental."
+    },
+    {
+      "code": 6024,
+      "name": "InvalidAccountOwner",
+      "msg": "Account is owned by the wrong program."
+    },
+    {
+      "code": 6025,
+      "name": "InvalidAccountData",
+      "msg": "Account data is invalid or corrupted."
+    },
+    {
+      "code": 6026,
+      "name": "UnauthorizedAccess",
+      "msg": "Unauthorized access to this resource."
+    },
+    {
+      "code": 6027,
+      "name": "ArithmeticOverflow",
+      "msg": "Arithmetic overflow occurred in calculation."
     }
   ],
   "types": [
@@ -2260,57 +2313,89 @@
     {
       "name": "Config",
       "docs": [
-        "Admin-configurable settings for the SRSLY program"
+        "Global configuration for the SRSLY rental program.",
+        "",
+        "PDA derived from `CONFIG_SEED`. Contains system-wide settings including fees,",
+        "duration limits, and payment frequencies. Only config authority can update."
       ],
       "type": {
         "kind": "struct",
         "fields": [
           {
             "name": "version",
+            "docs": [
+              "Account version for migrations"
+            ],
             "type": "u8"
           },
           {
             "name": "bump",
+            "docs": [
+              "PDA bump seed"
+            ],
             "type": "u8"
           },
           {
             "name": "authority",
+            "docs": [
+              "Authority that can update configuration"
+            ],
             "type": "pubkey"
           },
           {
             "name": "stardust_to_atlas",
+            "docs": [
+              "Stardust to ATLAS conversion rate (default: 100M = 1 ATLAS)"
+            ],
             "type": "u64"
           },
           {
             "name": "service_fee_bps",
-            "type": "u64"
-          },
-          {
-            "name": "referral_fee_bps",
+            "docs": [
+              "Service fee in basis points (default: 1000 = 10%, max: 10%)"
+            ],
             "type": "u64"
           },
           {
             "name": "base_bps",
+            "docs": [
+              "Basis points denominator (default: 10,000)"
+            ],
             "type": "u64"
           },
           {
             "name": "rental_duration_min_seconds",
+            "docs": [
+              "Minimum rental duration (default: 3600s = 1 hour)"
+            ],
             "type": "u64"
           },
           {
             "name": "rental_duration_max_seconds",
+            "docs": [
+              "Maximum rental duration (default: 8,035,200s ≈ 3 months)"
+            ],
             "type": "u64"
           },
           {
             "name": "fees_account",
+            "docs": [
+              "Address that receives collected fees"
+            ],
             "type": "pubkey"
           },
           {
             "name": "atlas_mint",
+            "docs": [
+              "ATLAS token mint for payments"
+            ],
             "type": "pubkey"
           },
           {
             "name": "default_payment_frequency",
+            "docs": [
+              "Default payment frequency (default: Daily)"
+            ],
             "type": {
               "defined": {
                 "name": "PaymentFrequency"
@@ -2319,6 +2404,9 @@
           },
           {
             "name": "allowed_frequencies",
+            "docs": [
+              "Allowed payment frequencies (max 10)"
+            ],
             "type": {
               "vec": {
                 "defined": {
@@ -2332,65 +2420,90 @@
     },
     {
       "name": "ConfigUpdateParams",
+      "docs": [
+        "Parameters for updating global configuration. All fields are optional",
+        "for partial updates."
+      ],
       "type": {
         "kind": "struct",
         "fields": [
           {
             "name": "authority",
+            "docs": [
+              "New authority address"
+            ],
             "type": {
               "option": "pubkey"
             }
           },
           {
             "name": "stardust_to_atlas",
+            "docs": [
+              "Stardust to ATLAS conversion rate"
+            ],
             "type": {
               "option": "u64"
             }
           },
           {
             "name": "service_fee_bps",
-            "type": {
-              "option": "u64"
-            }
-          },
-          {
-            "name": "referral_fee_bps",
+            "docs": [
+              "Service fee in basis points (1000 = 10%)"
+            ],
             "type": {
               "option": "u64"
             }
           },
           {
             "name": "base_bps",
+            "docs": [
+              "Basis points denominator"
+            ],
             "type": {
               "option": "u64"
             }
           },
           {
             "name": "rental_duration_min_seconds",
+            "docs": [
+              "Minimum rental duration in seconds"
+            ],
             "type": {
               "option": "u64"
             }
           },
           {
             "name": "rental_duration_max_seconds",
+            "docs": [
+              "Maximum rental duration in seconds"
+            ],
             "type": {
               "option": "u64"
             }
           },
           {
             "name": "fees_account",
+            "docs": [
+              "Fee collection address"
+            ],
             "type": {
               "option": "pubkey"
             }
           },
           {
             "name": "atlas_mint",
+            "docs": [
+              "ATLAS token mint address"
+            ],
             "type": {
               "option": "pubkey"
             }
           },
           {
             "name": "default_payment_frequency",
+            "docs": [
+              "Default payment frequency"
+            ],
             "type": {
               "option": {
                 "defined": {
@@ -2401,6 +2514,9 @@
           },
           {
             "name": "allowed_frequencies",
+            "docs": [
+              "Allowed payment frequencies"
+            ],
             "type": {
               "option": {
                 "vec": {
@@ -2417,61 +2533,103 @@
     {
       "name": "ContractState",
       "docs": [
-        "* **Rental Contract State**\n *\n * This account stores the details of a fleet rental contract, which includes:\n * - Rental price (`rate`)\n * - Duration constraints (`duration_min`, `duration_max`)\n * - Payment frequency (`payments_feq`)\n * - Ownership details (`owner`, `owner_token_account`)\n * - Current rental status (`current_rental_state`)\n * - Fleet and game identifiers"
+        "Rental contract defining terms for a specific fleet.",
+        "",
+        "PDA derived from `RENTAL_CONTRACT_SEED` and fleet public key. Integrates with SAGE",
+        "for fleet ownership and rental permissions."
       ],
       "type": {
         "kind": "struct",
         "fields": [
           {
             "name": "version",
+            "docs": [
+              "Version number for account migrations"
+            ],
             "type": "u8"
           },
           {
             "name": "to_close",
+            "docs": [
+              "Whether contract is scheduled for closure"
+            ],
             "type": "bool"
           },
           {
             "name": "rate",
+            "docs": [
+              "Rental rate per payment period in ATLAS tokens"
+            ],
             "type": "u64"
           },
           {
             "name": "duration_min",
+            "docs": [
+              "Minimum rental duration in seconds"
+            ],
             "type": "u64"
           },
           {
             "name": "duration_max",
+            "docs": [
+              "Maximum rental duration in seconds"
+            ],
             "type": "u64"
           },
           {
             "name": "payments_feq",
+            "docs": [
+              "Payment frequency string (@hourly, @daily, etc.)"
+            ],
             "type": "string"
           },
           {
             "name": "fleet",
+            "docs": [
+              "Fleet associated with this contract"
+            ],
             "type": "pubkey"
           },
           {
             "name": "game_id",
+            "docs": [
+              "Game ID for SAGE integration"
+            ],
             "type": "pubkey"
           },
           {
             "name": "current_rental_state",
+            "docs": [
+              "Currently active rental state (system_program::ID if none)"
+            ],
             "type": "pubkey"
           },
           {
             "name": "owner",
+            "docs": [
+              "Fleet owner who receives payments"
+            ],
             "type": "pubkey"
           },
           {
             "name": "owner_token_account",
+            "docs": [
+              "Owner's token account for receiving payments"
+            ],
             "type": "pubkey"
           },
           {
             "name": "owner_profile",
+            "docs": [
+              "Owner's Star Atlas game profile"
+            ],
             "type": "pubkey"
           },
           {
             "name": "bump",
+            "docs": [
+              "PDA bump seed"
+            ],
             "type": "u8"
           }
         ]
@@ -2557,6 +2715,37 @@
     },
     {
       "name": "PaymentFrequency",
+      "docs": [
+        "Represents the different payment frequencies supported by the rental system.",
+        "",
+        "Payment frequencies determine how often rental payments are processed automatically.",
+        "Each frequency corresponds to a specific time interval and is used to calculate",
+        "payment amounts and schedule automated payment threads.",
+        "",
+        "# Variants",
+        "",
+        "* `Hourly` - Payments processed every hour (3,600 seconds)",
+        "* `Daily` - Payments processed every day (86,400 seconds) - **Default**",
+        "* `DailyOld` - Legacy daily variant maintained for backwards compatibility",
+        "* `Weekly` - Payments processed every week (604,800 seconds)",
+        "* `Monthly` - Payments processed every month (2,678,400 seconds)",
+        "* `Decasecond` - Payments processed every 10 seconds (development/testing only)",
+        "* `Minute` - Payments processed every minute (development/testing only)",
+        "",
+        "# Examples",
+        "",
+        "```rust,ignore",
+        "use PaymentFrequency;",
+        "",
+        "// Create a daily payment frequency (default)",
+        "let frequency = PaymentFrequency::default();",
+        "assert_eq!(frequency.to_seconds(), 86400);",
+        "",
+        "// Parse from string representation",
+        "let weekly = PaymentFrequency::from_str(\"@weekly\")?;",
+        "assert_eq!(weekly.to_seconds(), 604800);",
+        "```"
+      ],
       "type": {
         "kind": "enum",
         "variants": [
@@ -2587,53 +2776,82 @@
     {
       "name": "RentalState",
       "docs": [
-        "* **Rental State Account**\n     *\n     * This account stores data for an **active** rental session, including:\n     * - The renter's (`borrower`) public key\n     * - Payment details, including rate and total duration\n     * - Start and end timestamps\n     * - Whether the rental was cancelled early"
+        "Active rental session between a fleet owner and borrower.",
+        "",
+        "Handles automated payments via Clockwork threads and tracks rental lifecycle.",
+        "PDA derived from contract address and borrower public key."
       ],
       "type": {
         "kind": "struct",
         "fields": [
           {
             "name": "version",
+            "docs": [
+              "Version number for account migrations"
+            ],
             "type": "u8"
           },
           {
             "name": "borrower",
+            "docs": [
+              "Borrower public key (receives refunds if cancelled)"
+            ],
             "type": "pubkey"
           },
           {
             "name": "thread",
+            "docs": [
+              "Clockwork thread for automated payments"
+            ],
             "type": "pubkey"
           },
           {
             "name": "contract",
+            "docs": [
+              "Reference to the rental contract"
+            ],
             "type": "pubkey"
           },
           {
             "name": "owner_token_account",
-            "type": "pubkey"
-          },
-          {
-            "name": "referral_token_account",
+            "docs": [
+              "Owner's token account for receiving payments"
+            ],
             "type": "pubkey"
           },
           {
             "name": "rate",
+            "docs": [
+              "Effective rental rate per payment cycle"
+            ],
             "type": "f64"
           },
           {
             "name": "start_time",
+            "docs": [
+              "Rental start timestamp"
+            ],
             "type": "i64"
           },
           {
             "name": "end_time",
+            "docs": [
+              "Rental end timestamp"
+            ],
             "type": "i64"
           },
           {
             "name": "cancelled",
+            "docs": [
+              "Whether rental was cancelled early"
+            ],
             "type": "bool"
           },
           {
             "name": "bump",
+            "docs": [
+              "PDA bump seed"
+            ],
             "type": "u8"
           }
         ]
@@ -3083,7 +3301,13 @@
     {
       "name": "THREAD_SEED",
       "docs": [
-        "Global seed prefix for PDAs in the program."
+        "Seed for automated payment thread PDAs managed by Clockwork.",
+        "",
+        "Used to create deterministic addresses for Clockwork threads that handle",
+        "recurring rental payments. Each rental gets its own thread for automated",
+        "payment processing at the specified frequency.",
+        "",
+        "**Usage**: Combined with rental state account address to create unique thread PDAs."
       ],
       "type": "bytes",
       "value": "[116, 104, 114, 101, 97, 100]"