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

package/dist/types/rental/cancel.d.ts

@@ -1,20 +1,111 @@
-import { Address, TransactionSigner } from '@solana/kit';
-import { type NetworkSelector } from '../network';
+import { type ConfigSelector } from '../utils/config';
+type UniversalAddress = string;
+type UniversalSigner = any;
 type CancelRentalInstruction = any;
 /**
- * Simplified parameters for canceling a rental
+ * Parameters for canceling an active rental.
+ *
+ * This interface defines the required parameters for a borrower to cancel their
+ * active rental. Canceling a rental stops automated payments but typically
+ * incurs a penalty fee as defined in the contract terms.
+ *
+ * @interface CancelRentalParams
  */
 export interface CancelRentalParams {
     /**
-     * The borrower wallet that will sign the transaction
+     * The borrower who wants to cancel the rental (must be a signer object).
+     * Must be the original borrower who accepted the rental contract.
+     * This account will pay any cancellation penalties.
      */
-    borrower: TransactionSigner<string>;
+    borrower: UniversalSigner;
     /**
-     * The rental contract account address
+     * String address of the rental contract associated with the active rental.
+     * The rental state for this contract will be canceled and automated payments stopped.
      */
-    contract: Address<string>;
+    contract: UniversalAddress;
 }
-export declare function cancelRental(params: CancelRentalParams): NetworkSelector<CancelRentalInstruction>;
-export declare function getCancelRentalInstructionAsync(input: any, options?: any): NetworkSelector<any>;
+/**
+ * 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
+ * import { cancelRental } from '@srsly/sdk';
+ *
+ * // Basic rental cancellation
+ * const instruction = await cancelRental({
+ *   borrower: wallet,            // Borrower's wallet (must be original borrower)
+ *   contract: "ContractAddr..."  // Contract address for the active rental
+ * });
+ *
+ * // 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,
+ *   contract: "ContractAddr..."
+ * }).web3js();
+ *
+ * // Use with your preferred Solana library
+ * const transaction = new Transaction().add(web3jsInstruction);
+ * await sendAndConfirmTransaction(connection, transaction, [wallet]);
+ * ```
+ *
+ * @param params - The rental cancellation parameters including borrower and contract
+ * @returns A ConfigSelector 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 declare function cancelRental(params: CancelRentalParams): ConfigSelector<CancelRentalInstruction>;
+/**
+ * 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 ConfigSelector for the raw instruction
+ */
+export declare function getCancelRentalInstructionAsync(input: any, options?: any): ConfigSelector<any>;
 export {};
 //# sourceMappingURL=cancel.d.ts.map

package/dist/types/rental/cancel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cancel.d.ts","sourceRoot":"","sources":["../../../src/rental/cancel.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,iBAAiB,EAClB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAiD,KAAK,eAAe,EAAgB,MAAM,YAAY,CAAC;AAG/G,KAAK,uBAAuB,GAAG,GAAG,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3B;AAgDD,wBAAgB,YAAY,CAC1B,MAAM,EAAE,kBAAkB,GACzB,eAAe,CAAC,uBAAuB,CAAC,CAE1C;AAED,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,CAK/F"}
+{"version":3,"file":"cancel.d.ts","sourceRoot":"","sources":["../../../src/rental/cancel.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4D,KAAK,cAAc,EAAsB,MAAM,iBAAiB,CAAC;AAIpI,KAAK,gBAAgB,GAAG,MAAM,CAAC;AAC/B,KAAK,eAAe,GAAG,GAAG,CAAC;AAC3B,KAAK,uBAAuB,GAAG,GAAG,CAAC;AAEnC;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,EAAE,eAAe,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AA8CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,kBAAkB,GACzB,cAAc,CAAC,uBAAuB,CAAC,CAEzC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,CAK9F"}

package/dist/types/rental/close.d.ts

@@ -1,24 +1,111 @@
-import { Address } from '@solana/kit';
-import { type NetworkSelector } from '../network';
-type CloseRentalInstruction = any;
+import { type ConfigSelector } from '../utils/config';
+import { type FluentInstruction, type SmartFluentConfigSelector } from '../utils/instruction-converter';
+type UniversalAddress = string;
+type UniversalSigner = any;
 /**
- * Simplified parameters for closing a rental
+ * Parameters for closing a completed rental.
+ *
+ * This interface defines the required parameters for closing a rental that has
+ * reached its expiration or been fully paid. Closing a rental finalizes the
+ * rental period, transfers any remaining funds, and cleans up the rental state.
+ *
+ * @interface CloseRentalParams
  */
 export interface CloseRentalParams {
     /**
-     * The borrower address (not a signer in this transaction)
+     * The payer for transaction fees (must be a signer object).
+     * This account will pay for the transaction and receive any lamports
+     * from closed accounts.
      */
-    borrower: Address<string>;
+    payer: UniversalSigner;
     /**
-     * The owner's token account address for receiving ATLAS
+     * String address of the rental state to close.
+     * This is the unique rental state account that tracks the rental.
      */
-    ownerTokenAccount: Address<string>;
-    /**
-     * The rental contract account address
-     */
-    contract: Address<string>;
+    rentalStateAddress: UniversalAddress;
 }
-export declare function closeRental(params: CloseRentalParams): NetworkSelector<CloseRentalInstruction>;
-export declare function getCloseRentalInstructionAsync(input: any, options?: any): NetworkSelector<any>;
+/**
+ * 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
+ * import { closeRental } from '@srsly/sdk';
+ *
+ * // Close a completed rental
+ * const instruction = await closeRental({
+ *   payer: wallet,                         // Transaction payer
+ *   rentalStateAddress: "RentalState..."   // Rental state address
+ * });
+ *
+ * // Configure for mainnet
+ * const mainnetInstruction = await closeRental({
+ *   payer: wallet,
+ *   rentalStateAddress: "RentalState..."
+ * }).set({ programs: 'mainnet' });
+ *
+ * // Convert to @solana/web3.js format
+ * const web3jsInstruction = await closeRental({
+ *   payer: wallet,
+ *   rentalStateAddress: "RentalState..."
+ * }).web3js();
+ *
+ * // Use with your preferred Solana library
+ * const transaction = new Transaction().add(web3jsInstruction);
+ * await sendAndConfirmTransaction(connection, transaction, [wallet]);
+ * ```
+ *
+ * @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 declare function closeRental(params: CloseRentalParams): SmartFluentConfigSelector<FluentInstruction>;
+/**
+ * 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 ConfigSelector for the raw instruction
+ */
+export declare function getCloseRentalInstructionAsync(input: any, options?: any): ConfigSelector<any>;
 export {};
 //# sourceMappingURL=close.d.ts.map

package/dist/types/rental/close.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"close.d.ts","sourceRoot":"","sources":["../../../src/rental/close.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACR,MAAM,aAAa,CAAC;AAErB,OAAO,EAAiD,KAAK,eAAe,EAAgB,MAAM,YAAY,CAAC;AAG/G,KAAK,sBAAsB,GAAG,GAAG,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3B;AAmDD,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,GACxB,eAAe,CAAC,sBAAsB,CAAC,CAEzC;AAED,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,CAK9F"}
+{"version":3,"file":"close.d.ts","sourceRoot":"","sources":["../../../src/rental/close.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4D,KAAK,cAAc,EAAsB,MAAM,iBAAiB,CAAC;AAGpI,OAAO,EAA4D,KAAK,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAMlK,KAAK,gBAAgB,GAAG,MAAM,CAAC;AAC/B,KAAK,eAAe,GAAG,GAAG,CAAC;AAE3B;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,KAAK,EAAE,eAAe,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,EAAE,gBAAgB,CAAC;CACtC;AAqHD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,GACxB,yBAAyB,CAAC,iBAAiB,CAAC,CAG9C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,CAK7F"}

package/dist/types/rental/index.d.ts

@@ -1,5 +1,90 @@
+/**
+ * # 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, days } from '@srsly/sdk';
+ *
+ * const instruction = await acceptRental({
+ *   borrower: wallet,
+ *   borrowerProfile: "ProfileAddr...",
+ *   borrowerFaction: 'mud',
+ *   contract: "ContractAddr...",
+ *   duration: days(7)
+ * });
+ * ```
+ *
+ * ### 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({
+ *   borrower: "BorrowerAddr...",
+ *   ownerTokenAccount: "TokenAcct...",
+ *   contract: "ContractAddr..."
+ * });
+ * ```
+ *
+ * ### Reset Canceled Rental
+ * ```typescript
+ * import { resetRental } from '@srsly/sdk';
+ *
+ * const instruction = await resetRental({
+ *   fleet: "FleetAddr...",
+ *   contract: "ContractAddr...",
+ *   rentalState: "RentalStateAddr...",
+ *   faction: 'mud',
+ *   ownerProfile: "OwnerProfileAddr..."
+ * });
+ * ```
+ *
+ * @module Rental
+ */
 export * from "./accept";
 export * from "./cancel";
 export * from "./close";
 export * from "./reset";
+export * from "./reset-contract-temp";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/rental/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","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.d.ts","sourceRoot":"","sources":["../../../src/rental/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,uBAAuB,CAAC"}

package/dist/types/rental/reset-contract-temp.d.ts

@@ -0,0 +1,77 @@
+import { type FluentInstruction, type SmartFluentConfigSelector } from '../utils/instruction-converter';
+type UniversalAddress = string;
+type UniversalSigner = any;
+/**
+ * Parameters for resetting a contract temporarily (devnet testing).
+ *
+ * This interface defines the required parameters for resetting a contract's
+ * rental state and properly resetting the fleet in SAGE.
+ *
+ * @interface ResetContractTempParams
+ */
+export interface ResetContractTempParams {
+    /**
+     * The signer who will execute the reset (must be a signer object).
+     */
+    signer: UniversalSigner;
+    /**
+     * String address of the contract to reset.
+     */
+    contract: UniversalAddress;
+    /**
+     * Faction identifier for fleet operations.
+     * Can be provided as a number (1 = MUD, 2 = ONI, 3 = Ustur) or string ('mud', 'oni', 'ustur').
+     * Used for deriving SAGE accounts.
+     * @example 'mud' // or 1
+     */
+    faction: number | string;
+    /**
+     * String address of the owner's profile in Star Atlas.
+     * Used for SAGE fleet operations.
+     */
+    ownerProfile: UniversalAddress;
+}
+/**
+ * Creates a temporary instruction to reset a contract's fleet in SAGE (devnet testing).
+ *
+ * This function properly resets a contract by:
+ * 1. Resetting the fleet in SAGE via CPI call to invalidate_rental(context, false)
+ * 2. Setting the contract's current_rental_state to system_program::ID
+ * 3. Making the contract available for new rentals
+ *
+ * ## Features
+ *
+ * - **Fleet Reset**: Properly resets fleet in SAGE ecosystem
+ * - **Contract Reset**: Updates contract state to be available for new rentals
+ * - **Account Derivation**: Automatically derives all required SAGE accounts
+ * - **Network Support**: Works across mainnet, atlasnet, and holosim
+ * - **Universal Library Support**: Works with both @solana/kit and @solana/web3.js
+ *
+ * @example
+ * ```typescript
+ * import { resetContractTemp } from '@wuwei-labs/srsly';
+ *
+ * // Reset a contract for testing
+ * const instruction = await resetContractTemp({
+ *   signer: wallet,
+ *   contract: "5YqtCEiGPLH3FqoTCkWXFCLtNFC7StnUydgaYfLSPHWv",
+ *   faction: 'mud',
+ *   ownerProfile: "OwnerProfileAddr..."
+ * });
+ *
+ * // Configure for specific network
+ * const instruction = await resetContractTemp({
+ *   signer: wallet,
+ *   contract: "ContractAddr...",
+ *   faction: 2,
+ *   ownerProfile: "OwnerProfileAddr..."
+ * }).set({ programs: 'holosim' });
+ * ```
+ *
+ * @param params - The contract reset parameters
+ * @returns A FluentConfigSelector that can be configured with .set() or awaited directly
+ * @throws Error when contract is not found or account derivation fails
+ */
+export declare function resetContractTemp(params: ResetContractTempParams): SmartFluentConfigSelector<FluentInstruction>;
+export {};
+//# sourceMappingURL=reset-contract-temp.d.ts.map

package/dist/types/rental/reset-contract-temp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reset-contract-temp.d.ts","sourceRoot":"","sources":["../../../src/rental/reset-contract-temp.ts"],"names":[],"mappings":"AAGA,OAAO,EAA4D,KAAK,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAKlK,KAAK,gBAAgB,GAAG,MAAM,CAAC;AAC/B,KAAK,eAAe,GAAG,GAAG,CAAC;AAE3B;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAE3B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;;OAGG;IACH,YAAY,EAAE,gBAAgB,CAAC;CAChC;AA8ED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,uBAAuB,GAC9B,yBAAyB,CAAC,iBAAiB,CAAC,CAG9C"}

package/dist/types/rental/reset.d.ts

@@ -1,40 +1,155 @@
-import { Address } from '@solana/kit';
-import { type NetworkSelector } from '../network';
+import { type ConfigSelector } from '../utils/config';
+type UniversalAddress = string;
+type UniversalSigner = any;
 type ResetRentalInstruction = any;
 /**
- * Simplified parameters for resetting a rental
+ * Parameters for resetting a rental after cancellation.
+ *
+ * This interface defines the required parameters for resetting a rental contract
+ * after it has been canceled. Resetting clears the rental state and makes the
+ * contract available for new rentals again.
+ *
+ * @interface ResetRentalParams
  */
 export interface ResetRentalParams {
     /**
-     * The fleet account address
+     * The payer for transaction fees (must be a signer object).
+     * This account will pay for the transaction and receive any lamports
+     * from closed accounts.
      */
-    fleet: Address<string>;
+    payer: UniversalSigner;
     /**
-     * The rental contract account address
+     * String address of the fleet associated with the rental contract.
+     * The fleet's rental state will be reset to allow for new rentals.
      */
-    contract: Address<string>;
+    fleet: UniversalAddress;
     /**
-     * The rental state account address
+     * String address of the rental contract to reset.
+     * This contract will be made available for new rentals after reset.
      */
-    rentalState: Address<string>;
+    contract: UniversalAddress;
     /**
-     * The game ID account address
-     * Defaults to the standard game ID if not provided
+     * String address of the rental state account to be reset.
+     * This account contains the canceled rental data that needs to be cleared.
      */
-    gameId?: Address<string>;
+    rentalState: UniversalAddress;
     /**
-     * Optional faction (1 = mud, 2 = oni, 3 = ustur)
-     * Or as string: 'mud', 'oni', 'ustur'
-     * Only needed if starbase and starbasePlayer are not provided
+     * Faction identifier for Star Atlas integration.
+     * Can be provided as a number (1 = MUD, 2 = ONI, 3 = Ustur) or string ('mud', 'oni', 'ustur').
+     * Used for deriving faction-specific game accounts required by SAGE.
+     * @example 'mud' // or 1
      */
     faction: number | string;
     /**
-     * The owner's profile address
-     * Needed only if faction is provided to derive starbasePlayer
+     * String address of the owner's profile in the Star Atlas game.
+     * Required for deriving game accounts (starbase, starbasePlayer) needed by SAGE.
+     * Must be the profile of the original fleet owner.
      */
-    ownerProfile: Address<string>;
+    ownerProfile: UniversalAddress;
 }
-export declare function resetRental(params: ResetRentalParams): NetworkSelector<ResetRentalInstruction>;
-export declare function getResetRentalInstructionAsync(input: any, options?: any): NetworkSelector<any>;
+/**
+ * Creates an instruction to reset a rental contract after cancellation with fluent configuration.
+ *
+ * This function clears the rental state from a canceled rental, making the contract
+ * available for new rentals. It's typically called after a rental has been canceled
+ * to clean up the state and allow the fleet to be rented out again.
+ *
+ * ## Features
+ *
+ * - **State Cleanup**: Clears canceled rental state from accounts
+ * - **Contract Reactivation**: Makes the contract available for new rentals
+ * - **Fleet Preparation**: Ensures fleet is ready for future rental operations
+ * - **SAGE Integration**: Updates fleet status in the Star Atlas ecosystem
+ * - **Account Derivation**: Automatically derives required game accounts
+ * - **Universal Library Support**: Works with both @solana/kit and @solana/web3.js
+ *
+ * ## Process
+ *
+ * 1. **Validate State**: Ensures rental was properly canceled before reset
+ * 2. **Derive Accounts**: Generates required game accounts (starbase, etc.)
+ * 3. **Clear State**: Removes canceled rental data from accounts
+ * 4. **Update SAGE**: Resets fleet status in the Star Atlas ecosystem
+ * 5. **Reactivate Contract**: Makes contract available for new rentals
+ *
+ * ## Requirements
+ *
+ * - Rental must be in canceled state (not active or completed)
+ * - Caller must have authority to reset the rental
+ * - All accounts must be properly initialized
+ * - Fleet must be under owner control
+ *
+ * ## When to Use
+ *
+ * - **After Cancellation**: When a rental has been canceled and needs cleanup
+ * - **Contract Reuse**: To make a contract available for new rentals
+ * - **State Recovery**: When rental state needs to be cleared
+ * - **Fleet Management**: To prepare fleet for future rental operations
+ *
+ * @example
+ * ```typescript
+ * import { resetRental } from '@srsly/sdk';
+ *
+ * // Reset a canceled rental
+ * const instruction = await resetRental({
+ *   fleet: "FleetAddress123...",        // Fleet to reset
+ *   contract: "ContractAddr...",        // Contract to reactivate
+ *   rentalState: "RentalStateAddr...",  // Canceled rental state
+ *   faction: 'mud',                     // Owner's faction
+ *   ownerProfile: "OwnerProfileAddr..." // Owner's Star Atlas profile
+ * });
+ *
+ * // Configure for mainnet
+ * const mainnetInstruction = await resetRental({
+ *   fleet: "FleetAddress123...",
+ *   contract: "ContractAddr...",
+ *   rentalState: "RentalStateAddr...",
+ *   faction: 1,                         // Can use numbers: 1=mud, 2=oni, 3=ustur
+ *   ownerProfile: "OwnerProfileAddr..."
+ * }).set({ programs: 'mainnet' });
+ *
+ * // Override specific game configuration
+ * const customInstruction = await resetRental({
+ *   fleet: "FleetAddress123...",
+ *   contract: "ContractAddr...",
+ *   rentalState: "RentalStateAddr...",
+ *   faction: 'mud',
+ *   ownerProfile: "OwnerProfileAddr..."
+ * }).set({
+ *   programs: 'mainnet',
+ *   gameId: 'custom-game-id...'
+ * });
+ *
+ * // Convert to @solana/web3.js format
+ * const web3jsInstruction = await resetRental({
+ *   fleet: "FleetAddress123...",
+ *   contract: "ContractAddr...",
+ *   rentalState: "RentalStateAddr...",
+ *   faction: 'mud',
+ *   ownerProfile: "OwnerProfileAddr..."
+ * }).web3js();
+ *
+ * // Use with your preferred Solana library
+ * const transaction = new Transaction().add(web3jsInstruction);
+ * await sendAndConfirmTransaction(connection, transaction, [wallet]);
+ * ```
+ *
+ * @param params - The rental reset parameters including fleet, contract, rental state, and owner details
+ * @returns A ConfigSelector that can be configured with .set() or awaited directly
+ * @throws Error when rental is not in canceled state or instruction generation fails
+ */
+export declare function resetRental(params: ResetRentalParams): ConfigSelector<ResetRentalInstruction>;
+/**
+ * Low-level function to create a rental reset 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 ConfigSelector for the raw instruction
+ */
+export declare function getResetRentalInstructionAsync(input: any, options?: any): ConfigSelector<any>;
 export {};
 //# sourceMappingURL=reset.d.ts.map

package/dist/types/rental/reset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reset.d.ts","sourceRoot":"","sources":["../../../src/rental/reset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACR,MAAM,aAAa,CAAC;AAErB,OAAO,EAAiD,KAAK,eAAe,EAAgB,MAAM,YAAY,CAAC;AAG/G,KAAK,sBAAsB,GAAG,GAAG,CAAC;AAOlC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEzB;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B;AA8ED,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,GACxB,eAAe,CAAC,sBAAsB,CAAC,CAEzC;AAED,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,CAK9F"}
+{"version":3,"file":"reset.d.ts","sourceRoot":"","sources":["../../../src/rental/reset.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4D,KAAK,cAAc,EAAsB,MAAM,iBAAiB,CAAC;AAKpI,KAAK,gBAAgB,GAAG,MAAM,CAAC;AAC/B,KAAK,eAAe,GAAG,GAAG,CAAC;AAC3B,KAAK,sBAAsB,GAAG,GAAG,CAAC;AAElC;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;;OAGG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAE3B;;;OAGG;IACF,WAAW,EAAE,gBAAgB,CAAC;IAE/B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;;;OAIG;IACH,YAAY,EAAE,gBAAgB,CAAC;CAChC;AAkED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,GACxB,cAAc,CAAC,sBAAsB,CAAC,CAExC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,CAK7F"}