@wuwei-labs/srsly 2.0.0-beta.9 → 2.3.3-canary.36.16828894446.0

package/dist/cjs/rental/accept.js

@@ -1,90 +1,263 @@
 "use strict";
+/**
+ * @purpose Rental contract acceptance with payment calculation and SAGE integration
+ * @reviewed 2025-07-29
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.acceptRentalDemo = void 0;
 exports.acceptRental = acceptRental;
 exports.getAcceptRentalInstructionAsync = getAcceptRentalInstructionAsync;
 const config_1 = require("../utils/config");
 const constants_1 = require("../utils/constants");
 const utils_1 = require("../utils");
+const instruction_converter_1 = require("../utils/instruction-converter");
+const fetch_accounts_1 = require("../utils/fetch-accounts");
+const cron_1 = require("../utils/cron");
+const derive_pda_1 = require("../utils/derive-pda");
+const signer_1 = require("../utils/signer");
+const param_converters_1 = require("../utils/param-converters");
 /**
- * Internal function to accept a rental instruction with configuration options
+ * Internal function to accept a rental instruction with configuration options.
+ *
+ * This function handles the core logic of creating a rental acceptance instruction,
+ * including contract state fetching, payment calculation, account derivation, and
+ * instruction generation. It automatically validates contract constraints and
+ * calculates the required payment amount.
+ *
+ * @internal
+ * @param params - The rental acceptance parameters
+ * @param config - Optional configuration for network and program settings
+ * @returns Promise resolving to a fluent instruction object
+ * @throws Error when contract is not found, duration constraints are violated, or account derivation fails
  */
 async function _acceptRental(params, config) {
-    const { borrower, borrowerProfile, borrowerFaction, fleet, contract, gameId, rate, duration, referralTokenAccount, } = params;
-    // Get the actual game ID to use (param override, config override, or network default)
-    const actualGameId = gameId || await (0, constants_1.getSageGameId)(config);
-    // Calculate the total amount from rate and duration
-    // Convert ATLAS to stardust (smallest unit): 1 ATLAS = 100,000,000 stardust
-    const amount = BigInt(rate) * BigInt(duration) * BigInt(constants_1.ATLAS_TO_STARDUST);
-    // Derive the three accounts we need
-    const { profileFaction, starbase, starbasePlayer } = await (0, utils_1.deriveGameAccounts)(borrowerProfile, borrowerFaction, actualGameId, 0, // starbaseSeqId
-    config);
-    // Let codama derive the rest (rentalThread, rentalState, rentalAuthority, etc.)
+    let { borrowerProfile, borrowerFaction, contract, duration } = params;
+    // Get the resolved addresses from config (including network-specific addresses)
+    const globalConfig = (0, config_1.getSdkConfig)();
+    const effectiveConfig = { ...globalConfig, ...config };
+    const resolvedAddresses = (0, config_1.resolveProgramAddresses)(effectiveConfig);
+    // Fetch contract state to get payment frequency and validate parameters
+    const contractState = await (0, fetch_accounts_1.fetchContractState)(contract);
+    const configState = await (0, fetch_accounts_1.fetchConfigState)();
+    // Extract data from contract state
+    const rate = contractState.rate; // Keep as bigint
+    const fleet = contractState.fleet;
+    // Resolve faction - use provided faction or fetch from fleet
+    if (!borrowerFaction) {
+        const fleetState = await (0, fetch_accounts_1.fetchFleetState)(fleet);
+        borrowerFaction = fleetState.faction;
+    }
+    // Convert duration to seconds using smart parameter converter
+    const durationSeconds = await (0, param_converters_1.convertDurationToSeconds)(duration);
+    // Get the actual period duration using prev/next method
+    const currentTime = Math.floor(Date.now() / 1000);
+    // Normalize the payment frequency for JavaScript cron-parser
+    const normalizedFreq = contractState.paymentsFeq.startsWith('@')
+        ? {
+            '@hourly': '0 * * * *',
+            '@daily': '0 0 * * *',
+            '@weekly': '0 0 * * 0',
+            '@monthly': '0 0 1 * *',
+            '@decasecond': '*/10 * * * * *',
+            '@minute': '0 * * * * *',
+        }[contractState.paymentsFeq] || contractState.paymentsFeq
+        : contractState.paymentsFeq;
+    // Get actual period duration (not time-to-first-payment)
+    const actualPeriodDuration = (0, cron_1.getActualPeriodDuration)(normalizedFreq, currentTime);
+    // Calculate proportional amount using integer math
+    // amount = rate * duration / period * stardust_to_atlas
+    const amount = rate
+        * BigInt(durationSeconds)
+        / BigInt(actualPeriodDuration)
+        * configState.stardustToAtlas;
+    // Derive the fee_token_account from config state
+    const feeTokenAccount = await (0, derive_pda_1.deriveFeeTokenAccount)(configState);
+    // Manually derive ALL game accounts - they all use different program addresses than main SAGE program
+    const { profileFaction, starbase, starbasePlayer } = await (0, utils_1.deriveGameAccounts)((0, constants_1.toAddress)(borrowerProfile), borrowerFaction, 0, // starbaseSeqId
+    contractState.gameId);
+    // Handle borrower using smart signer handler for universal compatibility
+    const borrower = (0, signer_1.createTransactionSigner)(params.borrower);
+    // Manually derive PDAs with correct program IDs
+    const rentalStatePda = await (0, derive_pda_1.deriveRental)((0, constants_1.toAddress)(contract), borrower.address, // Use TransactionSigner.address for PDA derivation
+    resolvedAddresses.srslyProgramAddress);
+    const rentalAuthorityPda = await (0, derive_pda_1.deriveRentalAuthority)(resolvedAddresses.srslyProgramAddress);
+    const rentalThreadPda = await (0, derive_pda_1.deriveRentalThread)(rentalAuthorityPda, rentalStatePda, resolvedAddresses.antegenProgramAddress);
     const input = {
-        borrower,
-        borrowerProfile,
-        borrowerProfileFaction: profileFaction,
-        fleet,
-        contract,
-        gameId: actualGameId,
-        starbase,
-        starbasePlayer,
+        borrower: borrower,
+        borrowerProfile: (0, constants_1.toAddress)(borrowerProfile),
+        borrowerProfileFaction: (0, constants_1.toAddress)(profileFaction),
+        fleet: (0, constants_1.toAddress)(fleet),
+        contract: (0, constants_1.toAddress)(contract),
+        gameId: contractState.gameId,
+        starbase: (0, constants_1.toAddress)(starbase),
+        starbasePlayer: (0, constants_1.toAddress)(starbasePlayer),
+        // Override PDAs with correctly derived addresses
+        rentalState: rentalStatePda,
+        rentalAuthority: rentalAuthorityPda,
+        rentalThread: rentalThreadPda,
         amount,
-        duration,
-        referralTokenAccount,
+        duration: durationSeconds,
+        feeTokenAccount,
+        mint: resolvedAddresses.atlasMint,
+        sageProgram: resolvedAddresses.sageProgramAddress,
+        antegenProgram: resolvedAddresses.antegenProgramAddress,
     };
-    // Dynamically import network-specific codama functions
-    const codamaModule = await (0, config_1.getCachedNetworkModule)('instructions', config?.network);
-    const { getAcceptRentalInstructionAsync, SRSLY_PROGRAM_ADDRESS } = codamaModule;
-    return getAcceptRentalInstructionAsync(input, { programAddress: SRSLY_PROGRAM_ADDRESS });
+    // Get network-specific codama functions from centralized config
+    const instructionsModule = (0, config_1.getModule)('instructions');
+    const { getAcceptRentalInstructionAsync } = instructionsModule;
+    const rawInstruction = await getAcceptRentalInstructionAsync(input, {
+        programAddress: resolvedAddresses.srslyProgramAddress,
+    });
+    return (0, instruction_converter_1.createFluentInstruction)(rawInstruction);
 }
 /**
- * Creates an instruction to accept a rental with fluent configuration.
+ * Creates an instruction to accept a rental contract with fluent configuration.
+ *
+ * This function allows a borrower to accept an existing rental contract, automatically
+ * calculating the required payment amount based on the contract's rate and payment frequency.
+ * The SDK fetches contract details, validates duration constraints, and derives all
+ * necessary accounts for the rental operation.
+ *
+ * ## Features
+ *
+ * - **Automatic Payment Calculation**: Fetches contract state and calculates exact payment amount
+ * - **Automatic Faction Resolution**: Optionally fetches faction from fleet account if not provided
+ * - **Duration Validation**: Ensures rental duration meets contract constraints
+ * - **Account Derivation**: Automatically derives all required game accounts
+ * - **SAGE Integration**: Sets up fleet ownership transfer in the Star Atlas ecosystem
+ * - **Clockwork Integration**: Configures automated payment scheduling
+ * - **Universal Library Support**: Works with both @solana/kit and @solana/web3.js
+ *
+ * ## Process
+ *
+ * 1. **Fetch Contract**: Retrieves contract state from the blockchain
+ * 2. **Validate Duration**: Checks that rental duration meets contract constraints
+ * 3. **Calculate Payment**: Computes payment amount using contract rate and payment frequency
+ * 4. **Derive Accounts**: Generates required game accounts (starbase, faction, etc.)
+ * 5. **Create Instruction**: Builds the rental acceptance instruction
+ * 6. **Setup Threading**: Configures automated payment processing
+ *
+ * ## Payment Calculation
+ *
+ * The payment amount is calculated using the formula:
+ * ```text
+ * payment = rate × payment_periods × stardust_to_atlas_conversion
+ * ```
+ *
+ * Where:
+ * - `rate`: Contract's rental rate per payment period
+ * - `payment_periods`: Duration divided by payment frequency interval
+ * - `stardust_to_atlas_conversion`: Network-specific conversion factor
+ *
+ * ## Requirements
+ *
+ * - Contract must exist and be active
+ * - Duration must be within contract's min/max limits
+ * - Duration must be multiple of payment frequency
+ * - Borrower must have sufficient ATLAS tokens for payment
  *
  * @example
  * ```typescript
- * // Use devnet defaults
- * const ix = await acceptRental({
+ * import { acceptRental } from '@srsly/sdk';
+ *
+ * // Using smart duration parameters (recommended)
+ * const instruction = await acceptRental({
+ *   borrower: wallet,                      // Wallet object for signing
+ *   borrowerProfile: "ProfileAddr...",     // Borrower's Star Atlas profile
+ *   contract: "ContractAddr...",           // Contract to accept
+ *   duration: { days: 7 }                  // 7 days rental duration
+ *   // borrowerFaction auto-resolved from fleet account
+ * });
+ *
+ * // Different duration formats
+ * const hourlyRental = await acceptRental({
  *   borrower: wallet,
- *   borrowerProfile: profileAddress,
- *   borrowerFaction: 1, // 1 = mud, 2 = oni, 3 = ustur
- *   fleet: fleetAddress,
- *   contract: contractAddress,
- *   rate: 1000, // ATLAS tokens
- *   duration: 86400  // 1 day in seconds (total: 1000 * 86400 * 100M stardust)
+ *   borrowerProfile: "ProfileAddr...",
+ *   contract: "ContractAddr...",
+ *   duration: { hours: 12 }                // 12 hours
  * });
  *
- * // With referral (referrer gets 5% of platform fees)
- * const ix = await acceptRental({
+ * const weeklyRental = await acceptRental({
  *   borrower: wallet,
- *   borrowerProfile: profileAddress,
- *   borrowerFaction: 1,
- *   fleet: fleetAddress,
- *   contract: contractAddress,
- *   rate: 1000,
- *   duration: 86400,
- *   referralTokenAccount: referrerTokenAddress
+ *   borrowerProfile: "ProfileAddr...",
+ *   contract: "ContractAddr...",
+ *   duration: { weeks: 2 }                 // 2 weeks
  * });
  *
- * // Use mainnet configuration
- * const ix = await acceptRental(params).set({ network: 'mainnet' });
+ * const monthlyRental = await acceptRental({
+ *   borrower: wallet,
+ *   borrowerProfile: "ProfileAddr...",
+ *   contract: "ContractAddr...",
+ *   duration: { months: 1 }                // 1 month
+ * });
  *
- * // Override specific constants
- * const ix = await acceptRental(params).set({
- *   network: 'mainnet',
- *   gameId: 'custom-game-id...'
+ * // Backwards compatible - raw seconds
+ * const legacyRental = await acceptRental({
+ *   borrower: wallet,
+ *   borrowerProfile: "ProfileAddr...",
+ *   contract: "ContractAddr...",
+ *   duration: 604800                       // 7 days in seconds
  * });
+ *
+ * // Manual faction specification (optional)
+ * const manualInstruction = await acceptRental({
+ *   borrower: wallet.publicKey.toString(), // Address string for browser
+ *   borrowerProfile: "ProfileAddr...",     // Borrower's Star Atlas profile
+ *   borrowerFaction: 'mud',                // Optional: 'mud', 'oni', or 'ustur'
+ *   contract: "ContractAddr...",           // Contract to accept
+ *   duration: { days: 7 }                  // 7 days rental duration
+ * });
+ *
+ * // Configure for mainnet
+ * const mainnetInstruction = await acceptRental({
+ *   borrower: wallet,                      // Wallet object (CLI style)
+ *   borrowerProfile: "ProfileAddr...",
+ *   borrowerFaction: 1,                    // Can use numbers: 1=mud, 2=oni, 3=ustur
+ *   contract: "ContractAddr...",
+ *   duration: { days: 7 }
+ * }).set({ programs: 'mainnet' });
+ *
+ * // Use with your preferred Solana library
+ * const transaction = new Transaction().add(mainnetInstruction);
+ * await sendAndConfirmTransaction(connection, transaction, [wallet]);
  * ```
  *
- * @param params The simplified parameters for accepting a rental
- * @returns A ConfigSelector that can be configured with .set() or awaited directly
+ * @param params - The rental acceptance parameters including borrower, contract, and duration
+ * @returns A SmartFluentConfigSelector that can be configured with .set() or awaited directly
+ * @throws Error when contract is not found, duration constraints are violated, or payment calculation fails
  */
 function acceptRental(params) {
-    return (0, config_1.createConfigSelector)((config) => _acceptRental(params, config));
+    const baseSelector = (0, config_1.createSdkConfigSelector)(config => _acceptRental(params, config));
+    return (0, instruction_converter_1.createSmartFluentConfigSelector)(baseSelector);
 }
+/**
+ * Low-level function to create a rental acceptance instruction with raw input parameters.
+ *
+ * This function provides direct access to the underlying codama-generated instruction
+ * builder. It's primarily used internally by the SDK but can be used for advanced
+ * use cases where full control over instruction parameters is needed.
+ *
+ * @internal
+ * @param input - Raw instruction input parameters as expected by codama
+ * @param options - Optional instruction options including program address
+ * @returns A SdkConfigSelector for the raw instruction
+ */
 function getAcceptRentalInstructionAsync(input, options) {
-    return (0, config_1.createConfigSelector)(async (config) => {
-        const codamaModule = await (0, config_1.getCachedNetworkModule)('instructions', config?.network);
-        return codamaModule.getAcceptRentalInstructionAsync(input, options);
+    return (0, config_1.createSdkConfigSelector)(async () => {
+        const instructionsModule = (0, config_1.getModule)('instructions');
+        return instructionsModule.getAcceptRentalInstructionAsync(input, options);
     });
 }
+// Demo export for documentation site
+exports.acceptRentalDemo = {
+    tabName: 'accept',
+    description: 'Accept a rental offer from an existing contract',
+    imports: `import { acceptRental } from '@wuwei-labs/srsly';`,
+    instruction: `const instruction = await acceptRental({
+  borrower: {{signerType}}.publicKey?.toBase58(),
+  borrowerProfile: "BORROWER_PROFILE_ADDRESS",
+  contract: "CONTRACT_ADDRESS",
+  duration: { days: 7 }
+});`,
+};
 //# sourceMappingURL=accept.js.map

package/dist/cjs/rental/accept.js.map

@@ -1 +1 @@
-{"version":3,"file":"accept.js","sourceRoot":"","sources":["../../../src/rental/accept.ts"],"names":[],"mappings":";;AA8KA,oCAIC;AAED,0EAKC;AApLD,4CAAwH;AACxH,kDAAsE;AAMtE,oCAEkB;AAuDlB;;GAEG;AACH,KAAK,UAAU,aAAa,CAC1B,MAA0B,EAC1B,MAAsB;IAEtB,MAAM,EACJ,QAAQ,EACR,eAAe,EACf,eAAe,EACf,KAAK,EACL,QAAQ,EACR,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,oBAAoB,GACrB,GAAG,MAAM,CAAC;IAEX,sFAAsF;IACtF,MAAM,YAAY,GAAG,MAAM,IAAI,MAAM,IAAA,yBAAa,EAAC,MAAM,CAAC,CAAC;IAE3D,oDAAoD;IACpD,4EAA4E;IAC5E,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,6BAAiB,CAAC,CAAC;IAE3E,oCAAoC;IACpC,MAAM,EACJ,cAAc,EACd,QAAQ,EACR,cAAc,EACf,GAAG,MAAM,IAAA,0BAAkB,EAC1B,eAAe,EACf,eAAe,EACf,YAA+B,EAC/B,CAAC,EAAE,gBAAgB;IACnB,MAAM,CACP,CAAC;IAEF,gFAAgF;IAChF,MAAM,KAAK,GAAoC;QAC7C,QAAQ;QACR,eAAe;QACf,sBAAsB,EAAE,cAAc;QACtC,KAAK;QACL,QAAQ;QACR,MAAM,EAAE,YAAY;QACpB,QAAQ;QACR,cAAc;QACd,MAAM;QACN,QAAQ;QACR,oBAAoB;KACrB,CAAC;IAEF,uDAAuD;IACvD,MAAM,YAAY,GAAG,MAAM,IAAA,+BAAsB,EAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnF,MAAM,EAAE,+BAA+B,EAAE,qBAAqB,EAAE,GAAG,YAAY,CAAC;IAEhF,OAAO,+BAA+B,CACpC,KAAY,EACZ,EAAE,cAAc,EAAE,qBAAqB,EAAE,CAC1C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,SAAgB,YAAY,CAC1B,MAA0B;IAE1B,OAAO,IAAA,6BAAoB,EAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,SAAgB,+BAA+B,CAAC,KAAU,EAAE,OAAa;IACvE,OAAO,IAAA,6BAAoB,EAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,YAAY,GAAG,MAAM,IAAA,+BAAsB,EAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACnF,OAAO,YAAY,CAAC,+BAA+B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"accept.js","sourceRoot":"","sources":["../../../src/rental/accept.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwUH,oCAKC;AAcD,0EAKC;AA9VD,4CAOyB;AACzB,kDAAkE;AAClE,oCAA8C;AAC9C,0EAKwC;AACxC,4DAAgG;AAChG,wCAAwD;AACxD,oDAAqH;AACrH,4CAAgF;AAEhF,gEAAqE;AA4DrE;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,aAAa,CAC1B,MAA0B,EAC1B,MAAyB;IAEzB,IAAI,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAEtE,gFAAgF;IAChF,MAAM,YAAY,GAAG,IAAA,qBAAY,GAAE,CAAC;IACpC,MAAM,eAAe,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,EAAE,CAAC;IACvD,MAAM,iBAAiB,GAAG,IAAA,gCAAuB,EAAC,eAAe,CAAC,CAAC;IAEnE,wEAAwE;IACxE,MAAM,aAAa,GAAG,MAAM,IAAA,mCAAkB,EAAC,QAAQ,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,MAAM,IAAA,iCAAgB,GAAE,CAAC;IAE7C,mCAAmC;IACnC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,iBAAiB;IAClD,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;IAElC,6DAA6D;IAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,UAAU,GAAG,MAAM,IAAA,gCAAe,EAAC,KAAK,CAAC,CAAC;QAChD,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,8DAA8D;IAC9D,MAAM,eAAe,GAAG,MAAM,IAAA,2CAAwB,EAAC,QAAQ,CAAC,CAAC;IAEjE,wDAAwD;IACxD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAElD,6DAA6D;IAC7D,MAAM,cAAc,GAAG,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC;QAC9D,CAAC,CAAC;YACE,SAAS,EAAE,WAAW;YACtB,QAAQ,EAAE,WAAW;YACrB,SAAS,EAAE,WAAW;YACtB,UAAU,EAAE,WAAW;YACvB,aAAa,EAAE,gBAAgB;YAC/B,SAAS,EAAE,aAAa;SACzB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,aAAa,CAAC,WAAW;QAC3D,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC;IAE9B,yDAAyD;IACzD,MAAM,oBAAoB,GAAG,IAAA,8BAAuB,EAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IAElF,mDAAmD;IACnD,wDAAwD;IACxD,MAAM,MAAM,GAAG,IAAI;UACf,MAAM,CAAC,eAAe,CAAC;UACvB,MAAM,CAAC,oBAAoB,CAAC;UAC5B,WAAW,CAAC,eAAe,CAAC;IAEhC,iDAAiD;IACjD,MAAM,eAAe,GAAG,MAAM,IAAA,kCAAqB,EAAC,WAAW,CAAC,CAAC;IAEjE,sGAAsG;IACtG,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,MAAM,IAAA,0BAAkB,EAC3E,IAAA,qBAAS,EAAC,eAAe,CAAC,EAC1B,eAAe,EACf,CAAC,EAAE,gBAAgB;IACnB,aAAa,CAAC,MAAM,CACrB,CAAC;IAEF,yEAAyE;IACzE,MAAM,QAAQ,GAAG,IAAA,gCAAuB,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE1D,gDAAgD;IAChD,MAAM,cAAc,GAAG,MAAM,IAAA,yBAAY,EACvC,IAAA,qBAAS,EAAC,QAAQ,CAAC,EACnB,QAAQ,CAAC,OAAO,EAAE,mDAAmD;IACrE,iBAAiB,CAAC,mBAAmB,CACtC,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,IAAA,kCAAqB,EAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAE9F,MAAM,eAAe,GAAG,MAAM,IAAA,+BAAkB,EAC9C,kBAAkB,EAClB,cAAc,EACd,iBAAiB,CAAC,qBAAqB,CACxC,CAAC;IAEF,MAAM,KAAK,GAAoC;QAC7C,QAAQ,EAAE,QAAQ;QAClB,eAAe,EAAE,IAAA,qBAAS,EAAC,eAAe,CAAC;QAC3C,sBAAsB,EAAE,IAAA,qBAAS,EAAC,cAAc,CAAC;QACjD,KAAK,EAAE,IAAA,qBAAS,EAAC,KAAK,CAAC;QACvB,QAAQ,EAAE,IAAA,qBAAS,EAAC,QAAQ,CAAC;QAC7B,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,QAAQ,EAAE,IAAA,qBAAS,EAAC,QAAQ,CAAC;QAC7B,cAAc,EAAE,IAAA,qBAAS,EAAC,cAAc,CAAC;QAEzC,iDAAiD;QACjD,WAAW,EAAE,cAAc;QAC3B,eAAe,EAAE,kBAAkB;QACnC,YAAY,EAAE,eAAe;QAE7B,MAAM;QACN,QAAQ,EAAE,eAAe;QACzB,eAAe;QACf,IAAI,EAAE,iBAAiB,CAAC,SAAS;QACjC,WAAW,EAAE,iBAAiB,CAAC,kBAAkB;QACjD,cAAc,EAAE,iBAAiB,CAAC,qBAAqB;KACxD,CAAC;IAEF,gEAAgE;IAChE,MAAM,kBAAkB,GAAG,IAAA,kBAAS,EAAC,cAAc,CAAC,CAAC;IACrD,MAAM,EAAE,+BAA+B,EAAE,GAAG,kBAAkB,CAAC;IAE/D,MAAM,cAAc,GAAG,MAAM,+BAA+B,CAAC,KAAY,EAAE;QACzE,cAAc,EAAE,iBAAiB,CAAC,mBAAmB;KACtD,CAAC,CAAC;IACH,OAAO,IAAA,+CAAuB,EAAC,cAAc,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmHG;AACH,SAAgB,YAAY,CAC1B,MAA0B;IAE1B,MAAM,YAAY,GAAG,IAAA,gCAAuB,EAAC,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACtF,OAAO,IAAA,uDAA+B,EAAC,YAAY,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,+BAA+B,CAAC,KAAU,EAAE,OAAa;IACvE,OAAO,IAAA,gCAAuB,EAAC,KAAK,IAAI,EAAE;QACxC,MAAM,kBAAkB,GAAG,IAAA,kBAAS,EAAC,cAAc,CAAC,CAAC;QACrD,OAAO,kBAAkB,CAAC,+BAA+B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAED,qCAAqC;AACxB,QAAA,gBAAgB,GAAG;IAC9B,OAAO,EAAE,QAAQ;IACjB,WAAW,EAAE,iDAAiD;IAC9D,OAAO,EAAE,mDAAmD;IAC5D,WAAW,EAAE;;;;;IAKX;CACH,CAAC"}

package/dist/cjs/rental/cancel.js

@@ -1,54 +1,184 @@
 "use strict";
+/**
+ * @purpose Rental cancellation with penalty processing and thread cleanup
+ * @reviewed 2025-07-29
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelRentalDemo = void 0;
 exports.cancelRental = cancelRental;
 exports.getCancelRentalInstructionAsync = getCancelRentalInstructionAsync;
 const config_1 = require("../utils/config");
+const constants_1 = require("../utils/constants");
+const signer_1 = require("../utils/signer");
+const instruction_converter_1 = require("../utils/instruction-converter");
+const fetch_accounts_1 = require("../utils/fetch-accounts");
+const derive_pda_1 = require("../utils/derive-pda");
 /**
- * Internal function to cancel a rental instruction with configuration options
+ * Internal function to cancel a rental instruction with configuration options.
+ *
+ * This function handles the core logic of creating a rental cancellation instruction,
+ * including address resolution and instruction generation. The cancellation stops
+ * automated payments and may incur penalty fees.
+ *
+ * @internal
+ * @param params - The rental cancellation parameters
+ * @param config - Optional configuration for network and program settings
+ * @returns Promise resolving to a cancellation instruction
+ * @throws Error when instruction generation fails or required parameters are missing
  */
 async function _cancelRental(params, config) {
-    const { borrower, contract, } = params;
-    // Let codama derive all the optional accounts
+    let { contract, rental } = params;
+    // Validate that at least one parameter is provided
+    if (!contract && !rental) {
+        throw new Error('Either contract or rental must be provided');
+    }
+    // Prioritize rental over contract if both are provided
+    if (rental || !contract) {
+        const rentalState = await (0, fetch_accounts_1.fetchRentalState)((0, constants_1.toAddress)(rental));
+        contract = rentalState.contract;
+    }
+    // Handle borrower using smart signer handler for universal compatibility
+    const borrower = (0, signer_1.createTransactionSigner)(params.borrower);
+    // Get the resolved addresses from config (including network-specific addresses)
+    const globalConfig = (0, config_1.getSdkConfig)();
+    const effectiveConfig = { ...globalConfig, ...config };
+    const resolvedAddresses = (0, config_1.resolveProgramAddresses)(effectiveConfig);
+    // Fetch contract state using high-level function (same pattern as close contract)
+    const contractState = await (0, fetch_accounts_1.fetchContractState)((0, constants_1.toAddress)(contract));
+    // Fetch config state to get the authority using zero-argument overload
+    const configState = await (0, fetch_accounts_1.fetchConfigState)();
+    const authorityAddress = configState.authority;
+    // Derive PDAs individually (same pattern as accept rental to ensure consistency)
+    if (!rental) {
+        rental = await (0, derive_pda_1.deriveRental)((0, constants_1.toAddress)(contract), (0, constants_1.toAddress)(borrower.address), resolvedAddresses.srslyProgramAddress);
+    }
+    const rentalAuthorityPda = await (0, derive_pda_1.deriveRentalAuthority)(resolvedAddresses.srslyProgramAddress);
+    const rentalThreadPda = await (0, derive_pda_1.deriveRentalThread)(rentalAuthorityPda, (0, constants_1.toAddress)(rental), resolvedAddresses.antegenProgramAddress);
+    // Build the input with all required accounts (same pattern as accept rental)
     const input = {
-        borrower,
-        contract,
+        borrower: borrower,
+        owner: (0, constants_1.toAddress)(contractState.owner),
+        contract: (0, constants_1.toAddress)(contract),
+        authority: (0, constants_1.toAddress)(authorityAddress),
+        mint: resolvedAddresses.atlasMint,
+        // Override the auto-generated PDAs with our manually derived ones (same as accept rental)
+        rentalState: (0, constants_1.toAddress)(rental),
+        rentalAuthority: rentalAuthorityPda,
+        rentalThread: rentalThreadPda,
     };
-    // Dynamically import network-specific codama functions
-    const codamaModule = await (0, config_1.getCachedNetworkModule)('instructions', config?.network);
-    const { getCancelRentalInstructionAsync, SRSLY_PROGRAM_ADDRESS } = codamaModule;
-    return getCancelRentalInstructionAsync(input, { programAddress: SRSLY_PROGRAM_ADDRESS });
+    // Get network-specific codama functions from centralized config
+    const instructionsModule = (0, config_1.getModule)('instructions');
+    const { getCancelRentalInstructionAsync } = instructionsModule;
+    const rawInstruction = await getCancelRentalInstructionAsync(input, {
+        programAddress: resolvedAddresses.srslyProgramAddress,
+    });
+    return (0, instruction_converter_1.createFluentInstruction)(rawInstruction);
 }
 /**
  * Creates an instruction to cancel a rental with fluent configuration.
  *
+ * This function allows a borrower to cancel their active rental before the
+ * rental period expires. Canceling a rental stops automated payments but
+ * may incur penalty fees as defined in the contract terms. The fleet ownership
+ * is immediately returned to the original owner.
+ *
+ * ## Features
+ *
+ * - **Immediate Cancellation**: Stops the rental and automated payments immediately
+ * - **Fleet Transfer**: Returns fleet control to the original owner
+ * - **Thread Cleanup**: Cancels the automated payment thread
+ * - **Penalty Processing**: Handles any cancellation fees as defined in the contract
+ * - **Universal Library Support**: Works with both @solana/kit and @solana/web3.js
+ *
+ * ## Process
+ *
+ * 1. **Validate Authority**: Ensures only the borrower can cancel their rental
+ * 2. **Calculate Penalties**: Computes any cancellation fees owed
+ * 3. **Transfer Fleet**: Returns fleet ownership to the original owner
+ * 4. **Cancel Thread**: Stops automated payment processing
+ * 5. **Update State**: Marks rental as canceled in the rental state account
+ *
+ * ## Requirements
+ *
+ * - Rental must be active (not already canceled or completed)
+ * - Caller must be the original borrower
+ * - Borrower must have sufficient funds for any cancellation penalties
+ *
+ * ## Cancellation Effects
+ *
+ * - **Fleet Control**: Immediately returned to owner
+ * - **Automated Payments**: Stopped permanently
+ * - **Rental State**: Marked as canceled
+ * - **Thread Account**: Cleaned up and closed
+ * - **Penalties**: Charged according to contract terms
+ *
  * @example
  * ```typescript
- * // Use devnet defaults
- * const ix = await cancelRental({
+ * import { cancelRental } from '@srsly/sdk';
+ *
+ * // Cancel rental using contract address
+ * const instruction = await cancelRental({
  *   borrower: wallet,
- *   contract: contractAddress
+ *   contract: "ContractAddr..."
  * });
  *
- * // Use mainnet configuration
- * const ix = await cancelRental(params).set({ network: 'mainnet' });
- *
- * // Override specific constants
- * const ix = await cancelRental(params).set({
- *   network: 'mainnet',
- *   sageProgramAddress: 'custom...'
+ * // Cancel rental using rental state address (alternative approach)
+ * const instruction2 = await cancelRental({
+ *   borrower: wallet,
+ *   rental: "RentalStateAddr..."
  * });
+ *
+ * // Configure for mainnet
+ * const mainnetInstruction = await cancelRental({
+ *   borrower: wallet,
+ *   contract: "ContractAddr..."
+ * }).set({ programs: 'mainnet' });
+ *
+ * // Convert to @solana/web3.js format
+ * const web3jsInstruction = await cancelRental({
+ *   borrower: wallet,
+ *   rental: "RentalStateAddr..."
+ * }).web3js();
+ *
+ * // Use with your preferred Solana library
+ * const transaction = new Transaction().add(web3jsInstruction);
+ * await sendAndConfirmTransaction(connection, transaction, [wallet]);
  * ```
  *
- * @param params The simplified parameters for canceling a rental
- * @returns A ConfigSelector that can be configured with .set() or awaited directly
+ * @param params - The rental cancellation parameters including borrower and either contract or rentalState
+ * @returns A SmartFluentConfigSelector that can be configured with .set() or awaited directly
+ * @throws Error when rental is not active, caller is not the borrower, or instruction generation fails
  */
 function cancelRental(params) {
-    return (0, config_1.createConfigSelector)((config) => _cancelRental(params, config));
+    const baseSelector = (0, config_1.createSdkConfigSelector)(config => _cancelRental(params, config));
+    return (0, instruction_converter_1.createSmartFluentConfigSelector)(baseSelector);
 }
+/**
+ * Low-level function to create a rental cancellation instruction with raw input parameters.
+ *
+ * This function provides direct access to the underlying codama-generated instruction
+ * builder. It's primarily used internally by the SDK but can be used for advanced
+ * use cases where full control over instruction parameters is needed.
+ *
+ * @internal
+ * @param input - Raw instruction input parameters as expected by codama
+ * @param options - Optional instruction options including program address
+ * @returns A SdkConfigSelector for the raw instruction
+ */
 function getCancelRentalInstructionAsync(input, options) {
-    return (0, config_1.createConfigSelector)(async (config) => {
-        const codamaModule = await (0, config_1.getCachedNetworkModule)('instructions', config?.network);
-        return codamaModule.getCancelRentalInstructionAsync(input, options);
+    return (0, config_1.createSdkConfigSelector)(async () => {
+        const instructionsModule = (0, config_1.getModule)('instructions');
+        return instructionsModule.getCancelRentalInstructionAsync(input, options);
     });
 }
+// Demo export for documentation site
+exports.cancelRentalDemo = {
+    tabName: 'cancel',
+    description: 'Cancel an active rental (using contract address)',
+    imports: `import { cancelRental } from '@wuwei-labs/srsly';`,
+    instruction: `const instruction = await cancelRental({
+  borrower: {{signerType}}.publicKey?.toBase58(),
+  rental: "RENTAL_STATE_ADDRESS" // or contract: "CONTRACT_ADDRESS"
+});`,
+};
 //# sourceMappingURL=cancel.js.map

package/dist/cjs/rental/cancel.js.map

@@ -1 +1 @@
-{"version":3,"file":"cancel.js","sourceRoot":"","sources":["../../../src/rental/cancel.ts"],"names":[],"mappings":";;AA6EA,oCAIC;AAED,0EAKC;AAnFD,4CAAwH;AAoBxH;;GAEG;AACH,KAAK,UAAU,aAAa,CAC1B,MAA0B,EAC1B,MAAsB;IAEtB,MAAM,EACJ,QAAQ,EACR,QAAQ,GACT,GAAG,MAAM,CAAC;IAEX,8CAA8C;IAC9C,MAAM,KAAK,GAAG;QACZ,QAAQ;QACR,QAAQ;KACT,CAAC;IAEF,uDAAuD;IACvD,MAAM,YAAY,GAAG,MAAM,IAAA,+BAAsB,EAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnF,MAAM,EAAE,+BAA+B,EAAE,qBAAqB,EAAE,GAAG,YAAY,CAAC;IAEhF,OAAO,+BAA+B,CACpC,KAAK,EACL,EAAE,cAAc,EAAE,qBAAqB,EAAE,CAC1C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,YAAY,CAC1B,MAA0B;IAE1B,OAAO,IAAA,6BAAoB,EAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,SAAgB,+BAA+B,CAAC,KAAU,EAAE,OAAa;IACvE,OAAO,IAAA,6BAAoB,EAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,YAAY,GAAG,MAAM,IAAA,+BAAsB,EAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACnF,OAAO,YAAY,CAAC,+BAA+B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"cancel.js","sourceRoot":"","sources":["../../../src/rental/cancel.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAmOH,oCAKC;AAcD,0EAKC;AAzPD,4CAOyB;AACzB,kDAA+C;AAC/C,4CAAgF;AAChF,0EAKwC;AACxC,4DAAiG;AACjG,oDAA8F;AA6C9F;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,aAAa,CAC1B,MAA0B,EAC1B,MAAyB;IAEzB,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAElC,mDAAmD;IACnD,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,uDAAuD;IACvD,IAAI,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxB,MAAM,WAAW,GAAG,MAAM,IAAA,iCAAgB,EAAC,IAAA,qBAAS,EAAC,MAAM,CAAC,CAAC,CAAC;QAC9D,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED,yEAAyE;IACzE,MAAM,QAAQ,GAAG,IAAA,gCAAuB,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE1D,gFAAgF;IAChF,MAAM,YAAY,GAAG,IAAA,qBAAY,GAAE,CAAC;IACpC,MAAM,eAAe,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,EAAE,CAAC;IACvD,MAAM,iBAAiB,GAAG,IAAA,gCAAuB,EAAC,eAAe,CAAC,CAAC;IAEnE,kFAAkF;IAClF,MAAM,aAAa,GAAG,MAAM,IAAA,mCAAkB,EAAC,IAAA,qBAAS,EAAC,QAAQ,CAAC,CAAC,CAAC;IAEpE,uEAAuE;IACvE,MAAM,WAAW,GAAG,MAAM,IAAA,iCAAgB,GAAE,CAAC;IAE7C,MAAM,gBAAgB,GAAG,WAAW,CAAC,SAAS,CAAC;IAE/C,iFAAiF;IACjF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,GAAG,MAAM,IAAA,yBAAY,EACzB,IAAA,qBAAS,EAAC,QAAQ,CAAC,EACnB,IAAA,qBAAS,EAAC,QAAQ,CAAC,OAAO,CAAC,EAC3B,iBAAiB,CAAC,mBAAmB,CACtC,CAAC;IACJ,CAAC;IAED,MAAM,kBAAkB,GAAG,MAAM,IAAA,kCAAqB,EAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAE9F,MAAM,eAAe,GAAG,MAAM,IAAA,+BAAkB,EAC9C,kBAAkB,EAClB,IAAA,qBAAS,EAAC,MAAM,CAAC,EACjB,iBAAiB,CAAC,qBAAqB,CACxC,CAAC;IAEF,6EAA6E;IAC7E,MAAM,KAAK,GAAG;QACZ,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,IAAA,qBAAS,EAAC,aAAa,CAAC,KAAK,CAAC;QACrC,QAAQ,EAAE,IAAA,qBAAS,EAAC,QAAQ,CAAC;QAC7B,SAAS,EAAE,IAAA,qBAAS,EAAC,gBAAgB,CAAC;QACtC,IAAI,EAAE,iBAAiB,CAAC,SAAS;QAEjC,0FAA0F;QAC1F,WAAW,EAAE,IAAA,qBAAS,EAAC,MAAM,CAAC;QAC9B,eAAe,EAAE,kBAAkB;QACnC,YAAY,EAAE,eAAe;KAC9B,CAAC;IAEF,gEAAgE;IAChE,MAAM,kBAAkB,GAAG,IAAA,kBAAS,EAAC,cAAc,CAAC,CAAC;IACrD,MAAM,EAAE,+BAA+B,EAAE,GAAG,kBAAkB,CAAC;IAE/D,MAAM,cAAc,GAAG,MAAM,+BAA+B,CAAC,KAAK,EAAE;QAClE,cAAc,EAAE,iBAAiB,CAAC,mBAAmB;KACtD,CAAC,CAAC;IAEH,OAAO,IAAA,+CAAuB,EAAC,cAAc,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,SAAgB,YAAY,CAC1B,MAA0B;IAE1B,MAAM,YAAY,GAAG,IAAA,gCAAuB,EAAC,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACtF,OAAO,IAAA,uDAA+B,EAAC,YAAY,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,+BAA+B,CAAC,KAAU,EAAE,OAAa;IACvE,OAAO,IAAA,gCAAuB,EAAC,KAAK,IAAI,EAAE;QACxC,MAAM,kBAAkB,GAAG,IAAA,kBAAS,EAAC,cAAc,CAAC,CAAC;QACrD,OAAO,kBAAkB,CAAC,+BAA+B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAED,qCAAqC;AACxB,QAAA,gBAAgB,GAAG;IAC9B,OAAO,EAAE,QAAQ;IACjB,WAAW,EAAE,kDAAkD;IAC/D,OAAO,EAAE,mDAAmD;IAC5D,WAAW,EAAE;;;IAGX;CACH,CAAC"}