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

package/dist/esm/rental/cancel.js

@@ -1,50 +1,179 @@
-import { getCachedNetworkModule, createConfigSelector } from '../utils/config';
 /**
- * Internal function to cancel a rental instruction with configuration options
+ * @purpose Rental cancellation with penalty processing and thread cleanup
+ * @reviewed 2025-07-29
+ */
+import { getModule, createSdkConfigSelector, resolveProgramAddresses, getSdkConfig, } from '../utils/config';
+import { toAddress } from '../utils/constants';
+import { createTransactionSigner } from '../utils/signer';
+import { createFluentInstruction, createSmartFluentConfigSelector, } from '../utils/instruction-converter';
+import { fetchContractState, fetchConfigState, fetchRentalState } from '../utils/fetch-accounts';
+import { deriveRental, deriveRentalAuthority, deriveRentalThread } from '../utils/derive-pda';
+/**
+ * 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 fetchRentalState(toAddress(rental));
+        contract = rentalState.contract;
+    }
+    // Handle borrower using smart signer handler for universal compatibility
+    const borrower = createTransactionSigner(params.borrower);
+    // Get the resolved addresses from config (including network-specific addresses)
+    const globalConfig = getSdkConfig();
+    const effectiveConfig = { ...globalConfig, ...config };
+    const resolvedAddresses = resolveProgramAddresses(effectiveConfig);
+    // Fetch contract state using high-level function (same pattern as close contract)
+    const contractState = await fetchContractState(toAddress(contract));
+    // Fetch config state to get the authority using zero-argument overload
+    const configState = await fetchConfigState();
+    const authorityAddress = configState.authority;
+    // Derive PDAs individually (same pattern as accept rental to ensure consistency)
+    if (!rental) {
+        rental = await deriveRental(toAddress(contract), toAddress(borrower.address), resolvedAddresses.srslyProgramAddress);
+    }
+    const rentalAuthorityPda = await deriveRentalAuthority(resolvedAddresses.srslyProgramAddress);
+    const rentalThreadPda = await deriveRentalThread(rentalAuthorityPda, toAddress(rental), resolvedAddresses.antegenProgramAddress);
+    // Build the input with all required accounts (same pattern as accept rental)
     const input = {
-        borrower,
-        contract,
+        borrower: borrower,
+        owner: toAddress(contractState.owner),
+        contract: toAddress(contract),
+        authority: toAddress(authorityAddress),
+        mint: resolvedAddresses.atlasMint,
+        // Override the auto-generated PDAs with our manually derived ones (same as accept rental)
+        rentalState: toAddress(rental),
+        rentalAuthority: rentalAuthorityPda,
+        rentalThread: rentalThreadPda,
     };
-    // Dynamically import network-specific codama functions
-    const codamaModule = await 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 = getModule('instructions');
+    const { getCancelRentalInstructionAsync } = instructionsModule;
+    const rawInstruction = await getCancelRentalInstructionAsync(input, {
+        programAddress: resolvedAddresses.srslyProgramAddress,
+    });
+    return 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
  */
 export function cancelRental(params) {
-    return createConfigSelector((config) => _cancelRental(params, config));
+    const baseSelector = createSdkConfigSelector(config => _cancelRental(params, config));
+    return 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
+ */
 export function getCancelRentalInstructionAsync(input, options) {
-    return createConfigSelector(async (config) => {
-        const codamaModule = await getCachedNetworkModule('instructions', config?.network);
-        return codamaModule.getCancelRentalInstructionAsync(input, options);
+    return createSdkConfigSelector(async () => {
+        const instructionsModule = getModule('instructions');
+        return instructionsModule.getCancelRentalInstructionAsync(input, options);
     });
 }
+// Demo export for documentation site
+export const 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/esm/rental/cancel.js.map

@@ -1 +1 @@
-{"version":3,"file":"cancel.js","sourceRoot":"","sources":["../../../src/rental/cancel.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAA2C,MAAM,iBAAiB,CAAC;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,sBAAsB,CAAC,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,MAAM,UAAU,YAAY,CAC1B,MAA0B;IAE1B,OAAO,oBAAoB,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,KAAU,EAAE,OAAa;IACvE,OAAO,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAAC,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;AAEH,OAAO,EACL,SAAS,EACT,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,GAGb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAwB,MAAM,iBAAiB,CAAC;AAChF,OAAO,EACL,uBAAuB,EACvB,+BAA+B,GAGhC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACjG,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;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,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9D,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED,yEAAyE;IACzE,MAAM,QAAQ,GAAG,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE1D,gFAAgF;IAChF,MAAM,YAAY,GAAG,YAAY,EAAE,CAAC;IACpC,MAAM,eAAe,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,EAAE,CAAC;IACvD,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,eAAe,CAAC,CAAC;IAEnE,kFAAkF;IAClF,MAAM,aAAa,GAAG,MAAM,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEpE,uEAAuE;IACvE,MAAM,WAAW,GAAG,MAAM,gBAAgB,EAAE,CAAC;IAE7C,MAAM,gBAAgB,GAAG,WAAW,CAAC,SAAS,CAAC;IAE/C,iFAAiF;IACjF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,GAAG,MAAM,YAAY,CACzB,SAAS,CAAC,QAAQ,CAAC,EACnB,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAC3B,iBAAiB,CAAC,mBAAmB,CACtC,CAAC;IACJ,CAAC;IAED,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAE9F,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAC9C,kBAAkB,EAClB,SAAS,CAAC,MAAM,CAAC,EACjB,iBAAiB,CAAC,qBAAqB,CACxC,CAAC;IAEF,6EAA6E;IAC7E,MAAM,KAAK,GAAG;QACZ,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC;QACrC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;QAC7B,SAAS,EAAE,SAAS,CAAC,gBAAgB,CAAC;QACtC,IAAI,EAAE,iBAAiB,CAAC,SAAS;QAEjC,0FAA0F;QAC1F,WAAW,EAAE,SAAS,CAAC,MAAM,CAAC;QAC9B,eAAe,EAAE,kBAAkB;QACnC,YAAY,EAAE,eAAe;KAC9B,CAAC;IAEF,gEAAgE;IAChE,MAAM,kBAAkB,GAAG,SAAS,CAAC,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,uBAAuB,CAAC,cAAc,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,MAAM,UAAU,YAAY,CAC1B,MAA0B;IAE1B,MAAM,YAAY,GAAG,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACtF,OAAO,+BAA+B,CAAC,YAAY,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,+BAA+B,CAAC,KAAU,EAAE,OAAa;IACvE,OAAO,uBAAuB,CAAC,KAAK,IAAI,EAAE;QACxC,MAAM,kBAAkB,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;QACrD,OAAO,kBAAkB,CAAC,+BAA+B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAED,qCAAqC;AACrC,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,QAAQ;IACjB,WAAW,EAAE,kDAAkD;IAC/D,OAAO,EAAE,mDAAmD;IAC5D,WAAW,EAAE;;;IAGX;CACH,CAAC"}

package/dist/esm/rental/close.js

@@ -1,52 +1,179 @@
-import { getCachedNetworkModule, createConfigSelector } from '../utils/config';
 /**
- * Internal function to close a rental instruction with configuration options
+ * @purpose Rental closure with fund transfer and thread cleanup
+ * @reviewed 2025-07-29
+ */
+import { getModule, createSdkConfigSelector, resolveProgramAddresses, getSdkConfig, } from '../utils/config';
+import { toAddress } from '../utils/constants';
+import { createFluentInstruction, createSmartFluentConfigSelector, } from '../utils/instruction-converter';
+import { fetchConfigState, fetchRentalState, fetchContractState, fetchFleetState } from '../utils/fetch-accounts';
+import { deriveRentalThread, deriveRentalAuthority, deriveGameAccounts } from '../utils/derive-pda';
+import { createTransactionSigner } from '../utils/signer';
+/**
+ * Internal function to close a rental instruction with configuration options.
+ *
+ * This function handles the core logic of creating a rental closure instruction,
+ * including address resolution and instruction generation. The closure finalizes
+ * the rental period and transfers any remaining funds to the owner.
+ *
+ * @internal
+ * @param params - The rental closure parameters
+ * @param config - Optional configuration for network and program settings
+ * @returns Promise resolving to a closure instruction
+ * @throws Error when instruction generation fails or required parameters are missing
  */
 async function _closeRental(params, config) {
-    const { borrower, ownerTokenAccount, contract, } = params;
-    // Let codama derive the optional accounts
+    let { payer, rental, borrowerProfile, borrowerFaction } = params;
+    // Get the resolved addresses from config (including network-specific addresses)
+    const globalConfig = getSdkConfig();
+    const effectiveConfig = { ...globalConfig, ...config };
+    const resolvedAddresses = resolveProgramAddresses(effectiveConfig);
+    const rentalState = await fetchRentalState(rental);
+    // Extract required addresses from rental state
+    const contract = rentalState.contract;
+    const borrower = rentalState.borrower;
+    const rentalAuthorityPda = await deriveRentalAuthority(resolvedAddresses.srslyProgramAddress.toString());
+    const rentalThreadPda = await deriveRentalThread(rentalAuthorityPda, toAddress(rental), // Use the passed-in rental state address
+    resolvedAddresses.antegenProgramAddress);
+    // Fetch contract state to get owner and SAGE-related accounts
+    const contractState = await fetchContractState(contract);
+    // Fetch config state to get the authority using zero-argument overload
+    const configState = await fetchConfigState();
+    // Handle payer using smart signer handler for universal compatibility
+    const payerSigner = createTransactionSigner(payer);
+    // Resolve faction - use provided faction or fetch from fleet
+    if (!borrowerFaction) {
+        const fleetState = await fetchFleetState(contractState.fleet);
+        borrowerFaction = fleetState.faction;
+    }
+    // Derive game accounts for the BORROWER (not the owner)
+    const gameAccounts = await deriveGameAccounts(toAddress(borrowerProfile), borrowerFaction, 0, // starbaseSeqId
+    contractState.gameId);
+    const starbase = toAddress(gameAccounts.starbase);
+    const starbasePlayer = toAddress(gameAccounts.starbasePlayer);
+    // Only provide required fields - let Codama auto-generate the rest except rental_thread
     const input = {
-        borrower,
-        ownerTokenAccount,
-        contract,
+        payer: payerSigner, // Pass TransactionSigner for proper handling
+        mint: resolvedAddresses.atlasMint, // Use resolved ATLAS mint from config
+        authority: toAddress(configState.authority), // Config authority for fee collection
+        borrower: toAddress(borrower),
+        owner: toAddress(contractState.owner),
+        contract: toAddress(contract),
+        // Only override rental_thread since Codama can't auto-generate this one
+        rentalThread: rentalThreadPda, // Uses Antegen program ID!
+        // Add SAGE-related accounts
+        fleet: toAddress(contractState.fleet),
+        gameId: contractState.gameId,
+        starbase: toAddress(starbase),
+        starbasePlayer: toAddress(starbasePlayer),
+        sageProgram: resolvedAddresses.sageProgramAddress,
     };
-    // Dynamically import network-specific codama functions
-    const codamaModule = await getCachedNetworkModule('instructions', config?.network);
-    const { getCloseRentalInstructionAsync, SRSLY_PROGRAM_ADDRESS } = codamaModule;
-    return getCloseRentalInstructionAsync(input, { programAddress: SRSLY_PROGRAM_ADDRESS });
+    // Get network-specific codama functions from centralized config
+    const instructionsModule = getModule('instructions');
+    const { getCloseRentalInstructionAsync } = instructionsModule;
+    const rawInstruction = await getCloseRentalInstructionAsync(input, {
+        programAddress: resolvedAddresses.srslyProgramAddress,
+    });
+    return createFluentInstruction(rawInstruction);
 }
 /**
- * Creates an instruction to close a rental with fluent configuration.
+ * Creates an instruction to close a completed rental with fluent configuration.
+ *
+ * This function finalizes a rental that has reached its expiration or been fully paid.
+ * It transfers any remaining funds to the owner, returns fleet control, and cleans up
+ * the rental state account. This instruction can be called by anyone once the rental
+ * period has ended.
+ *
+ * ## Features
+ *
+ * - **Rental Finalization**: Properly closes completed or expired rentals
+ * - **Fund Transfer**: Moves any remaining payments or deposits to the owner
+ * - **Fleet Return**: Ensures fleet ownership is returned to the original owner
+ * - **State Cleanup**: Closes rental state account and returns lamports
+ * - **Thread Cleanup**: Cleans up automated payment threads
+ * - **Universal Library Support**: Works with both @solana/kit and @solana/web3.js
+ *
+ * ## Process
+ *
+ * 1. **Validate Completion**: Ensures rental period has ended or been fully paid
+ * 2. **Transfer Funds**: Moves any remaining ATLAS tokens to owner's account
+ * 3. **Return Fleet**: Transfers fleet ownership back to original owner
+ * 4. **Clean State**: Closes rental state account and returns SOL to payer
+ * 5. **Cancel Thread**: Cleans up any remaining automated payment threads
+ *
+ * ## Requirements
+ *
+ * - Rental must be completed or expired
+ * - Owner token account must be valid ATLAS token account
+ * - Rental state account must exist and be properly initialized
+ *
+ * ## When to Use
+ *
+ * - **Natural Expiration**: When rental period has ended
+ * - **Full Payment**: When all required payments have been made
+ * - **Account Cleanup**: To close expired rental accounts and recover SOL
+ * - **Fleet Recovery**: When fleet needs to be returned to owner
  *
  * @example
  * ```typescript
- * // Use devnet defaults
- * const ix = await closeRental({
- *   borrower: borrowerAddress,
- *   ownerTokenAccount: ownerTokenAccountAddress,
- *   contract: contractAddress
+ * import { closeRental } from '@srsly/sdk';
+ *
+ * // Close a completed rental
+ * const instruction = await closeRental({
+ *   payer: wallet,                         // Transaction payer
+ *   rental: "RentalState..."   // Rental state address
  * });
  *
- * // Use mainnet configuration
- * const ix = await closeRental(params).set({ network: 'mainnet' });
+ * // Configure for mainnet
+ * const mainnetInstruction = await closeRental({
+ *   payer: wallet,
+ *   rental: "RentalState..."
+ * }).set({ programs: 'mainnet' });
  *
- * // Override specific constants
- * const ix = await closeRental(params).set({
- *   network: 'mainnet',
- *   sageProgramAddress: 'custom...'
- * });
+ * // Convert to @solana/web3.js format
+ * const web3jsInstruction = await closeRental({
+ *   payer: wallet,
+ *   rental: "RentalState..."
+ * }).web3js(PublicKey);
+ *
+ * // Use with your preferred Solana library
+ * const transaction = new Transaction().add(web3jsInstruction);
+ * await sendAndConfirmTransaction(connection, transaction, [wallet]);
  * ```
  *
- * @param params The simplified parameters for closing a rental
- * @returns A ConfigSelector that can be configured with .set() or awaited directly
+ * @param params - The rental closure parameters including payer and rental state address
+ * @returns A FluentConfigSelector that can be configured with .set() or awaited directly
+ * @throws Error when rental is not ready for closure or instruction generation fails
  */
 export function closeRental(params) {
-    return createConfigSelector((config) => _closeRental(params, config));
+    const baseSelector = createSdkConfigSelector(config => _closeRental(params, config));
+    return createSmartFluentConfigSelector(baseSelector);
 }
+/**
+ * Low-level function to create a rental closure 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
+ */
 export function getCloseRentalInstructionAsync(input, options) {
-    return createConfigSelector(async (config) => {
-        const codamaModule = await getCachedNetworkModule('instructions', config?.network);
-        return codamaModule.getCloseRentalInstructionAsync(input, options);
+    return createSdkConfigSelector(async () => {
+        const instructionsModule = getModule('instructions');
+        return instructionsModule.getCloseRentalInstructionAsync(input, options);
     });
 }
+// Demo export for documentation site
+export const closeRentalDemo = {
+    tabName: 'close',
+    description: 'Close a completed rental',
+    imports: `import { closeRental } from '@wuwei-labs/srsly';`,
+    instruction: `const instruction = await closeRental({
+  payer: {{signerType}}.publicKey?.toBase58(),
+  rental: "RENTAL_STATE_ADDRESS"
+});`,
+};
 //# sourceMappingURL=close.js.map

package/dist/esm/rental/close.js.map

@@ -1 +1 @@
-{"version":3,"file":"close.js","sourceRoot":"","sources":["../../../src/rental/close.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAA2C,MAAM,iBAAiB,CAAC;AAyBxH;;GAEG;AACH,KAAK,UAAU,YAAY,CACzB,MAAyB,EACzB,MAAsB;IAEtB,MAAM,EACJ,QAAQ,EACR,iBAAiB,EACjB,QAAQ,GACT,GAAG,MAAM,CAAC;IAEX,0CAA0C;IAC1C,MAAM,KAAK,GAAG;QACZ,QAAQ;QACR,iBAAiB;QACjB,QAAQ;KACT,CAAC;IAEF,uDAAuD;IACvD,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnF,MAAM,EAAE,8BAA8B,EAAE,qBAAqB,EAAE,GAAG,YAAY,CAAC;IAE/E,OAAO,8BAA8B,CACnC,KAAK,EACL,EAAE,cAAc,EAAE,qBAAqB,EAAE,CAC1C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,WAAW,CACzB,MAAyB;IAEzB,OAAO,oBAAoB,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,KAAU,EAAE,OAAa;IACtE,OAAO,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACnF,OAAO,YAAY,CAAC,8BAA8B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"close.js","sourceRoot":"","sources":["../../../src/rental/close.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,SAAS,EACT,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,GAGb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EACL,uBAAuB,EACvB,+BAA+B,GAGhC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAClH,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAwB,MAAM,iBAAiB,CAAC;AAwChF;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,YAAY,CACzB,MAAyB,EACzB,MAAyB;IAEzB,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;IAEjE,gFAAgF;IAChF,MAAM,YAAY,GAAG,YAAY,EAAE,CAAC;IACpC,MAAM,eAAe,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,EAAE,CAAC;IACvD,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,eAAe,CAAC,CAAC;IAEnE,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACnD,+CAA+C;IAC/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;IAEtC,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CACpD,iBAAiB,CAAC,mBAAmB,CAAC,QAAQ,EAAE,CACjD,CAAC;IAEF,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAC9C,kBAAkB,EAClB,SAAS,CAAC,MAAM,CAAC,EAAE,yCAAyC;IAC5D,iBAAiB,CAAC,qBAAqB,CACxC,CAAC;IAEF,8DAA8D;IAC9D,MAAM,aAAa,GAAG,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAEzD,uEAAuE;IACvE,MAAM,WAAW,GAAG,MAAM,gBAAgB,EAAE,CAAC;IAE7C,sEAAsE;IACtE,MAAM,WAAW,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAEnD,6DAA6D;IAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9D,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,wDAAwD;IACxD,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAC3C,SAAS,CAAC,eAAe,CAAC,EAC1B,eAAe,EACf,CAAC,EAAE,gBAAgB;IACnB,aAAa,CAAC,MAAM,CACrB,CAAC;IAEF,MAAM,QAAQ,GAAG,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,cAAc,GAAG,SAAS,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IAE9D,wFAAwF;IACxF,MAAM,KAAK,GAAG;QACZ,KAAK,EAAE,WAAW,EAAE,6CAA6C;QACjE,IAAI,EAAE,iBAAiB,CAAC,SAAS,EAAE,sCAAsC;QACzE,SAAS,EAAE,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,sCAAsC;QACnF,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;QAC7B,KAAK,EAAE,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC;QACrC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;QAE7B,wEAAwE;QACxE,YAAY,EAAE,eAAe,EAAE,2BAA2B;QAE1D,4BAA4B;QAC5B,KAAK,EAAE,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC;QACrC,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;QAC7B,cAAc,EAAE,SAAS,CAAC,cAAc,CAAC;QACzC,WAAW,EAAE,iBAAiB,CAAC,kBAAkB;KAClD,CAAC;IAEF,gEAAgE;IAChE,MAAM,kBAAkB,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;IACrD,MAAM,EAAE,8BAA8B,EAAE,GAAG,kBAAkB,CAAC;IAE9D,MAAM,cAAc,GAAG,MAAM,8BAA8B,CAAC,KAAY,EAAE;QACxE,cAAc,EAAE,iBAAiB,CAAC,mBAAmB;KACtD,CAAC,CAAC;IACH,OAAO,uBAAuB,CAAC,cAAc,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,MAAM,UAAU,WAAW,CACzB,MAAyB;IAEzB,MAAM,YAAY,GAAG,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACrF,OAAO,+BAA+B,CAAC,YAAY,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAAU,EAAE,OAAa;IACtE,OAAO,uBAAuB,CAAC,KAAK,IAAI,EAAE;QACxC,MAAM,kBAAkB,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;QACrD,OAAO,kBAAkB,CAAC,8BAA8B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC;AAED,qCAAqC;AACrC,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,OAAO;IAChB,WAAW,EAAE,0BAA0B;IACvC,OAAO,EAAE,kDAAkD;IAC3D,WAAW,EAAE;;;IAGX;CACH,CAAC"}

package/dist/esm/rental/index.js

@@ -1,5 +1,89 @@
-export * from "./accept";
-export * from "./cancel";
-export * from "./close";
-export * from "./reset";
+/**
+ * @purpose Rental operations module with accept, cancel, close, and reset functionality
+ * @reviewed 2025-07-29
+ */
+/**
+ * # Rental Operations Module
+ *
+ * This module provides comprehensive functionality for managing rental operations
+ * on the SRSLY program. It includes functions for accepting, canceling, closing,
+ * and resetting rentals, with full support for both @solana/kit and @solana/web3.js libraries.
+ *
+ * ## Available Functions
+ *
+ * - **acceptRental**: Accept an existing rental contract as a borrower
+ * - **cancelRental**: Cancel an active rental before completion
+ * - **closeRental**: Close a completed or expired rental
+ * - **resetRental**: Reset a canceled rental to make the contract available again
+ *
+ * ## Rental Lifecycle
+ *
+ * ```text
+ * Contract Created → Accept → [Active Rental] → Close (Complete)
+ *                     ↓            ↓
+ *                 [Payment]    Cancel → Reset → [Available Again]
+ *                     ↑            ↓
+ *                 [Automated]   [Cleanup]
+ * ```
+ *
+ * ## Features
+ *
+ * - **Universal Library Support**: Works with both major Solana libraries
+ * - **String-Based Addresses**: Eliminates library-specific type conflicts
+ * - **Fluent API**: Chainable configuration and format conversion
+ * - **Network Agnostic**: Supports different Solana networks
+ * - **Automated Payments**: Integration with Clockwork for scheduled payments
+ * - **SAGE Integration**: Fleet ownership management in Star Atlas ecosystem
+ *
+ * ## Common Patterns
+ *
+ * ### Accept a Rental
+ * ```typescript
+ * import { acceptRental } from '@srsly/sdk';
+ *
+ * const instruction = await acceptRental({
+ *   borrower: wallet,
+ *   borrowerProfile: "ProfileAddr...",
+ *   contract: "ContractAddr...",
+ *   duration: { days: 7 }  // Smart parameter format
+ * });
+ * ```
+ *
+ * ### Cancel Active Rental
+ * ```typescript
+ * import { cancelRental } from '@srsly/sdk';
+ *
+ * const instruction = await cancelRental({
+ *   borrower: wallet,
+ *   contract: "ContractAddr..."
+ * });
+ * ```
+ *
+ * ### Close Completed Rental
+ * ```typescript
+ * import { closeRental } from '@srsly/sdk';
+ *
+ * const instruction = await closeRental({
+ *   payer: wallet,
+ *   rental: "RentalStateAddr..."
+ * });
+ * ```
+ *
+ * ### Reset Canceled Rental
+ * ```typescript
+ * import { resetRental } from '@srsly/sdk';
+ *
+ * const instruction = await resetRental({
+ *   payer: wallet,
+ *   contract: "ContractAddr..."
+ *   // fleet, rental, faction, ownerProfile auto-fetched if not provided
+ * });
+ * ```
+ *
+ * @module Rental
+ */
+export * from './accept';
+export * from './cancel';
+export * from './close';
+export * from './reset';
 //# sourceMappingURL=index.js.map

package/dist/esm/rental/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rental/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rental/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}