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

package/dist/esm/index.js

@@ -1,7 +1,215 @@
+/**
+ * @purpose SRSLY SDK - Solana Rental System Library main entry point
+ * @reviewed 2025-07-29
+ *
+ * A comprehensive TypeScript SDK for interacting with the SRSLY Solana program,
+ * which facilitates fleet rentals in the Star Atlas ecosystem. This SDK provides
+ * a fluent, developer-friendly interface that works with both @solana/kit and
+ * @solana/web3.js libraries.
+ *
+ * ## Features
+ *
+ * - **Universal Compatibility**: Works with both @solana/kit and @solana/web3.js
+ * - **Fluent API**: Chainable methods for intuitive development experience
+ * - **String-Based Addresses**: Uses strings for all addresses to eliminate library conflicts
+ * - **Network Agnostic**: Supports mainnet, devnet, and custom RPC endpoints
+ * - **Type Safety**: Full TypeScript support with comprehensive type definitions
+ * - **Auto-Generated Types**: Types generated from Solana program IDL for accuracy
+ *
+ * ## Quick Start
+ *
+ * ```typescript
+ * import { createContract, acceptRental } from '@srsly/sdk';
+ *
+ * // Create a rental contract
+ * const instruction = await createContract({
+ *   owner: wallet,
+ *   fleet: "FleetAddress123...",
+ *   ownerProfile: "ProfileAddr...",
+ *   rate: 1000,
+ *   durationMax: 7,  // 7 payment periods (7 days for @daily)
+ *   paymentsFreq: 'daily'
+ * });
+ *
+ * // Accept a rental
+ * const rentalInstruction = await acceptRental({
+ *   borrower: borrowerWallet,
+ *   contract: contractAddress,
+ *   amount: 7000,
+ *   duration: { days: 7 }  // Smart parameter format
+ * });
+ * ```
+ *
+ * ## Architecture
+ *
+ * The SDK is organized into several main modules:
+ * - **Contract**: Functions for creating and managing rental contracts
+ * - **Rental**: Functions for rental operations (accept, cancel, close)
+ * - **Utils**: Helper functions for duration, payment frequency, and account management
+ * - **Types**: TypeScript type definitions and interfaces
+ *
+ * @packageDocumentation
+ */
 // Export main SDK functions
-export * from "./contract";
-export * from "./rental";
-export * from "./utils";
-// Export PaymentFrequency from utils since it's not in codama
-export { PaymentFrequency } from "./utils/constants";
+export * from './contract';
+export * from './rental';
+// Export config instruction functions
+export * from './config';
+// Export config functions with public-facing names from utils
+export { setSdkConfig as setConfig, getSdkConfig as getConfig, clearSdkConfig as clearConfig, resolveProgramAddresses, } from './utils/config';
+export * from './utils';
+/**
+ * Account fetch functions that work with any RPC endpoint.
+ *
+ * These functions accept RPC URL strings and return account data,
+ * making it easy to fetch program state from any network.
+ *
+ * @example
+ * ```typescript
+ * const contract = await fetchContractState(
+ *   "https://api.mainnet-beta.solana.com",
+ *   contractAddress
+ * );
+ *
+ * // Fetch SAGE fleet data using manual struct parsing
+ * const fleet = await fetchFleetState(fleetAddress);
+ * ```
+ */
+export { fetchContractState, fetchRentalState, fetchConfigState, fetchFleetState, fetchMultipleContractStates, fetchMultipleRentalStates, } from './utils/fetch-accounts';
+/**
+ * Payment frequency enum generated from the Rust program.
+ *
+ * This enum mirrors the Rust PaymentFrequency type and provides
+ * type-safe payment frequency values for contract creation.
+ */
+export { PaymentFrequency } from './types/payment-frequency';
+/**
+ * Payment frequency types and validation utilities.
+ *
+ * These exports provide string-based payment frequency handling,
+ * validation functions, and mapping between different representations.
+ *
+ * @example
+ * ```typescript
+ * if (isValidPaymentFrequency('daily')) {
+ *   const frequency = getPaymentFrequencyFromString('daily');
+ * }
+ * ```
+ */
+export { VALID_PAYMENT_FREQUENCIES, PAYMENT_FREQUENCY_MAP, PAYMENT_FREQUENCY_CONSTANTS, PAYMENT_FREQUENCY_TO_CRON, CRON_TO_PAYMENT_FREQUENCY, getPaymentFrequencyFromString, isValidPaymentFrequency, } from './types/payment-frequency';
+/**
+ * Payment frequency utilities that mirror the Rust program implementation.
+ *
+ * These functions provide conversion between payment frequencies and time durations,
+ * ensuring consistency with the on-chain program logic.
+ *
+ * @example
+ * ```typescript
+ * const seconds = paymentFrequencyStringToSeconds('weekly');
+ * validateDurationAlignment(duration, 'daily');
+ * ```
+ */
+export { paymentFrequencyToSeconds, paymentFrequencyStringToSeconds, validateDurationAlignment, normalizePaymentSchedule, } from './utils/payment-frequency';
+/**
+ * Cron expression utilities for advanced payment scheduling.
+ *
+ * These functions provide cron expression parsing, validation, and scheduling
+ * capabilities using the croner library, mirroring the Rust implementation.
+ *
+ * @example
+ * ```typescript
+ * // Validate a cron expression
+ * if (validateCronExpression("0 9 * * MON-FRI")) {
+ *   // Calculate next payment time
+ *   const nextPayment = getNextCronOccurrence("@daily", Date.now() / 1000);
+ * }
+ *
+ * // Preview payment schedule
+ * const schedule = calculatePaymentSchedule("@hourly", startTime, duration);
+ * console.log(`${schedule.totalPayments} payments will occur`);
+ * ```
+ */
+export { getNextCronOccurrence, validateCronExpression, paymentFrequencyToCron, parseScheduleString, calculatePaymentSchedule, formatPaymentSchedulePreview, } from './utils/cron';
+/**
+ * Schedule validation utilities for rental contracts.
+ *
+ * These functions validate payment schedules against contract constraints
+ * and provide detailed feedback on potential issues.
+ *
+ * @example
+ * ```typescript
+ * const validation = validateRentalSchedule(
+ *   "@daily",
+ *   { days: 7 },   // Smart parameter format
+ *   { days: 1 },   // Smart parameter format
+ *   { days: 30 }   // Smart parameter format
+ * );
+ *
+ * if (validation.valid) {
+ *   console.log(`${validation.paymentCount} payments scheduled`);
+ * }
+ * ```
+ */
+export { validateRentalSchedule, validateFrequencyForDuration, } from './utils/schedule-validation';
+/**
+ * Schedule builder for creating and previewing payment schedules.
+ *
+ * Provides a fluent API for building payment schedules with validation
+ * and preview capabilities.
+ *
+ * @example
+ * ```typescript
+ * // From standard frequency
+ * const schedule = ScheduleBuilder
+ *   .fromFrequency("daily")
+ *   .preview(Date.now() / 1000, { days: 7 });
+ *
+ * // Custom cron expression
+ * const custom = ScheduleBuilder
+ *   .fromCron("0 12 * * MON")
+ *   .validate({ days: 30 }, { days: 1 }, { days: 90 });
+ *
+ * // Common intervals
+ * const every3Hours = ScheduleBuilder
+ *   .every('hours', 3)
+ *   .preview(Date.now() / 1000, { days: 1 });
+ * ```
+ */
+export { ScheduleBuilder, createSchedule, } from './utils/schedule-builder';
+/**
+ * Duration helper functions (DEPRECATED)
+ *
+ * Duration helper functions have been deprecated in favor of smart parameters.
+ * Use the smart parameter format instead for better type safety and clarity.
+ *
+ * @example
+ * ```typescript
+ * // Old approach (deprecated):
+ * // const rentalDuration = days(7);
+ *
+ * // New approach with smart parameters:
+ * const rentalDuration = { days: 7 };
+ * const paymentPeriod = { hours: 6 };
+ * const longRental = { weeks: 2 };
+ * ```
+ */
+/**
+ * SRSLY Program IDL
+ *
+ * Export the complete IDL for the SRSLY program, useful for:
+ * - Building custom decoders
+ * - Generating client code
+ * - Inspecting program structure
+ * - Version-aware deserialization
+ */
+export { IDL } from './idl';
+/**
+ * Legacy versioned decoders are now deprecated.
+ *
+ * Use the native Codama lazy decoder instead:
+ * - Replace: fetchMaybeRentalStateVersioned(rpc, address)
+ * - With: fetchMaybeRentalState(rpc, address, { lazy: true })
+ *
+ * The lazy decoder is available in all generated account fetch functions.
+ */
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AAuBxB,8DAA8D;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAEH,4BAA4B;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AAEzB,sCAAsC;AACtC,cAAc,UAAU,CAAC;AAEzB,8DAA8D;AAC9D,OAAO,EACL,YAAY,IAAI,SAAS,EACzB,YAAY,IAAI,SAAS,EACzB,cAAc,IAAI,WAAW,EAC7B,uBAAuB,GAMxB,MAAM,gBAAgB,CAAC;AAExB,cAAc,SAAS,CAAC;AA0BxB;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,2BAA2B,EAC3B,yBAAyB,GAE1B,MAAM,wBAAwB,CAAC;AAEhC;;;;;GAKG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D;;;;;;;;;;;;GAYG;AACH,OAAO,EAEL,yBAAyB,EACzB,qBAAqB,EACrB,2BAA2B,EAC3B,yBAAyB,EACzB,yBAAyB,EACzB,6BAA6B,EAC7B,uBAAuB,GACxB,MAAM,2BAA2B,CAAC;AAEnC;;;;;;;;;;;GAWG;AACH,OAAO,EACL,yBAAyB,EACzB,+BAA+B,EAC/B,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EACL,sBAAsB,EACtB,4BAA4B,GAE7B,MAAM,6BAA6B,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,EACL,eAAe,EACf,cAAc,GAGf,MAAM,0BAA0B,CAAC;AAElC;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;GAQG;AACH,OAAO,EAAE,GAAG,EAAuB,MAAM,OAAO,CAAC;AAEjD;;;;;;;;GAQG"}

package/dist/esm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wuwei-labs/srsly",
-  "version": "2.0.0-beta.9",
+  "version": "2.3.2",
   "description": "",
   "source": "./src/index.ts",
   "sideEffects": false,
@@ -11,10 +11,8 @@
     "dist/cjs",
     "dist/esm",
     "dist/types",
-    "target/idl/srsly-mainnet.json",
-    "target/idl/srsly-devnet.json",
-    "target/types/srsly-mainnet.ts",
-    "target/types/srsly-devnet.ts"
+    "target/idl/srsly.json",
+    "target/types/srsly.ts"
   ],
   "keywords": [
     "SRSLY",
@@ -23,42 +21,43 @@
     "sdk"
   ],
   "scripts": {
-    "package": "pnpm run clean && pnpm build && pnpm run package:cjs && pnpm run package:esm",
+    "build": "pnpm run generate && pnpm run package",
+    "build:quick": "pnpm run generate && pnpm run package",
+    "package": "pnpm run package:cjs && pnpm run package:esm",
     "package:cjs": "tsc -p tsconfig.cjs.json && tsconfig-to-dual-package tsconfig.cjs.json",
     "package:esm": "tsc -p tsconfig.esm.json && tsconfig-to-dual-package tsconfig.esm.json",
-    "clean": "rm -rf dist && cargo clean && pnpm install",
     "generate": "node generate.mjs",
-    "build": "pnpm build:mainnet && pnpm build:devnet",
-    "build:mainnet": "anchor build -- --features mainnet && NETWORK=mainnet pnpm run generate",
-    "build:devnet": "NETWORK=devnet anchor build && pnpm run generate",
+    "dev": "vitest",
+    "pretest": "pnpm run build:quick",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "clean": "rm -rf dist target && cargo clean",
     "docs": "typedoc",
-    "test": "vitest",
-    "test:manual": "node tests/test-complete-idl.js && node tests/test-cjs.js && node tests/test-webpack-sim.js",
-    "test:cjs": "node tests/test-cjs.js",
-    "test:webpack": "node tests/test-webpack-sim.js",
-    "test:npm-install": "node tests/test-npm-install.js",
-    "test:pnpm-install": "node tests/test-pnpm-install.js",
-    "test:package-managers": "node tests/test-npm-install.js && node tests/test-pnpm-install.js",
-    "test:idl": "node tests/test-idl-types.js"
+    "format": "prettier --write \"src/**/*.{ts,js,json}\" --ignore-path .prettierignore",
+    "format:check": "prettier --check \"src/**/*.{ts,js,json}\" --ignore-path .prettierignore",
+    "lint": "pnpm run format:check"
   },
   "author": "",
   "license": "ISC",
-  "packageManager": "pnpm@10.6.5",
+  "packageManager": "pnpm@10.13.1",
+  "dependencies": {
+    "@solana/kit": "^2.1.1",
+    "cron-parser": "^5.3.0"
+  },
+  "optionalDependencies": {
+    "@srsly/program": "workspace:*"
+  },
   "devDependencies": {
     "@codama/nodes-from-anchor": "^1.1.13",
-    "@codama/renderers": "^1.0.21",
-    "@types/bn.js": "^5.1.6",
+    "@wuwei-labs/renderers-js": "^1.4.2",
+    "@types/node": "^24.0.3",
     "codama": "^1.2.13",
-    "ts-node": "^10.9.2",
+    "nodemon": "^3.0.2",
     "tsconfig-to-dual-package": "^1.2.0",
-    "typedoc": "^0.28.3",
-    "typescript": "^5.8.3",
-    "vitest": "^3.1.2"
-  },
-  "dependencies": {
-    "@coral-xyz/anchor": "^0.31.1",
-    "@solana/kit": "^2.1.0",
-    "@solana/web3.js": "^1.98.2"
+    "typedoc": "^0.27.6",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4",
+    "webpack": "^5.99.9"
   },
   "type": "module"
 }

package/dist/esm/rental/accept.js

@@ -1,86 +1,258 @@
-import { getCachedNetworkModule, createConfigSelector } from '../utils/config';
-import { getSageGameId, ATLAS_TO_STARDUST } from '../utils/constants';
-import { deriveGameAccounts, } from '../utils';
 /**
- * Internal function to accept a rental instruction with configuration options
+ * @purpose Rental contract acceptance with payment calculation and SAGE integration
+ * @reviewed 2025-07-29
+ */
+import { getModule, createSdkConfigSelector, resolveProgramAddresses, getSdkConfig, } from '../utils/config';
+import { toAddress } from '../utils/constants';
+import { deriveGameAccounts } from '../utils';
+import { createFluentInstruction, createSmartFluentConfigSelector, } from '../utils/instruction-converter';
+import { fetchContractState, fetchFleetState, fetchConfigState } from '../utils/fetch-accounts';
+import { getActualPeriodDuration } from '../utils/cron';
+import { deriveRentalThread, deriveRental, deriveRentalAuthority, deriveFeeTokenAccount } from '../utils/derive-pda';
+import { createTransactionSigner } from '../utils/signer';
+import { convertDurationToSeconds } from '../utils/param-converters';
+/**
+ * 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 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(ATLAS_TO_STARDUST);
-    // Derive the three accounts we need
-    const { profileFaction, starbase, starbasePlayer } = await 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 = getSdkConfig();
+    const effectiveConfig = { ...globalConfig, ...config };
+    const resolvedAddresses = resolveProgramAddresses(effectiveConfig);
+    // Fetch contract state to get payment frequency and validate parameters
+    const contractState = await fetchContractState(contract);
+    const configState = await 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 fetchFleetState(fleet);
+        borrowerFaction = fleetState.faction;
+    }
+    // Convert duration to seconds using smart parameter converter
+    const durationSeconds = await 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 = 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 deriveFeeTokenAccount(configState);
+    // Manually derive ALL game accounts - they all use different program addresses than main SAGE program
+    const { profileFaction, starbase, starbasePlayer } = await deriveGameAccounts(toAddress(borrowerProfile), borrowerFaction, 0, // starbaseSeqId
+    contractState.gameId);
+    // Handle borrower using smart signer handler for universal compatibility
+    const borrower = createTransactionSigner(params.borrower);
+    // Manually derive PDAs with correct program IDs
+    const rentalStatePda = await deriveRental(toAddress(contract), borrower.address, // Use TransactionSigner.address for PDA derivation
+    resolvedAddresses.srslyProgramAddress);
+    const rentalAuthorityPda = await deriveRentalAuthority(resolvedAddresses.srslyProgramAddress);
+    const rentalThreadPda = await deriveRentalThread(rentalAuthorityPda, rentalStatePda, resolvedAddresses.antegenProgramAddress);
     const input = {
-        borrower,
-        borrowerProfile,
-        borrowerProfileFaction: profileFaction,
-        fleet,
-        contract,
-        gameId: actualGameId,
-        starbase,
-        starbasePlayer,
+        borrower: borrower,
+        borrowerProfile: toAddress(borrowerProfile),
+        borrowerProfileFaction: toAddress(profileFaction),
+        fleet: toAddress(fleet),
+        contract: toAddress(contract),
+        gameId: contractState.gameId,
+        starbase: toAddress(starbase),
+        starbasePlayer: 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 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 = getModule('instructions');
+    const { getAcceptRentalInstructionAsync } = instructionsModule;
+    const rawInstruction = await getAcceptRentalInstructionAsync(input, {
+        programAddress: resolvedAddresses.srslyProgramAddress,
+    });
+    return 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
  */
 export function acceptRental(params) {
-    return createConfigSelector((config) => _acceptRental(params, config));
+    const baseSelector = createSdkConfigSelector(config => _acceptRental(params, config));
+    return 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
+ */
 export function getAcceptRentalInstructionAsync(input, options) {
-    return createConfigSelector(async (config) => {
-        const codamaModule = await getCachedNetworkModule('instructions', config?.network);
-        return codamaModule.getAcceptRentalInstructionAsync(input, options);
+    return createSdkConfigSelector(async () => {
+        const instructionsModule = getModule('instructions');
+        return instructionsModule.getAcceptRentalInstructionAsync(input, options);
     });
 }
+// Demo export for documentation site
+export const 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/esm/rental/accept.js.map

@@ -1 +1 @@
-{"version":3,"file":"accept.js","sourceRoot":"","sources":["../../../src/rental/accept.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAA2C,MAAM,iBAAiB,CAAC;AACxH,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAMtE,OAAO,EACL,kBAAkB,GACnB,MAAM,UAAU,CAAC;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,aAAa,CAAC,MAAM,CAAC,CAAC;IAE3D,oDAAoD;IACpD,4EAA4E;IAC5E,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAE3E,oCAAoC;IACpC,MAAM,EACJ,cAAc,EACd,QAAQ,EACR,cAAc,EACf,GAAG,MAAM,kBAAkB,CAC1B,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,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,KAAY,EACZ,EAAE,cAAc,EAAE,qBAAqB,EAAE,CAC1C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;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":"accept.js","sourceRoot":"","sources":["../../../src/rental/accept.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,SAAS,EACT,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,GAGb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAqB,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EACL,uBAAuB,EACvB,+BAA+B,GAGhC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChG,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AACrH,OAAO,EAAE,uBAAuB,EAAwB,MAAM,iBAAiB,CAAC;AAEhF,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;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,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,wEAAwE;IACxE,MAAM,aAAa,GAAG,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,MAAM,gBAAgB,EAAE,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,eAAe,CAAC,KAAK,CAAC,CAAC;QAChD,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,8DAA8D;IAC9D,MAAM,eAAe,GAAG,MAAM,wBAAwB,CAAC,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,uBAAuB,CAAC,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,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEjE,sGAAsG;IACtG,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,MAAM,kBAAkB,CAC3E,SAAS,CAAC,eAAe,CAAC,EAC1B,eAAe,EACf,CAAC,EAAE,gBAAgB;IACnB,aAAa,CAAC,MAAM,CACrB,CAAC;IAEF,yEAAyE;IACzE,MAAM,QAAQ,GAAG,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE1D,gDAAgD;IAChD,MAAM,cAAc,GAAG,MAAM,YAAY,CACvC,SAAS,CAAC,QAAQ,CAAC,EACnB,QAAQ,CAAC,OAAO,EAAE,mDAAmD;IACrE,iBAAiB,CAAC,mBAAmB,CACtC,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAE9F,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAC9C,kBAAkB,EAClB,cAAc,EACd,iBAAiB,CAAC,qBAAqB,CACxC,CAAC;IAEF,MAAM,KAAK,GAAoC;QAC7C,QAAQ,EAAE,QAAQ;QAClB,eAAe,EAAE,SAAS,CAAC,eAAe,CAAC;QAC3C,sBAAsB,EAAE,SAAS,CAAC,cAAc,CAAC;QACjD,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;QACvB,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;QAC7B,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;QAC7B,cAAc,EAAE,SAAS,CAAC,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,SAAS,CAAC,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,uBAAuB,CAAC,cAAc,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmHG;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,iDAAiD;IAC9D,OAAO,EAAE,mDAAmD;IAC5D,WAAW,EAAE;;;;;IAKX;CACH,CAAC"}