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

package/dist/cjs/index.js

@@ -1,4 +1,56 @@
 "use strict";
+/**
+ * @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
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,12 +66,200 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentFrequency = void 0;
+exports.IDL = exports.createSchedule = exports.ScheduleBuilder = exports.validateFrequencyForDuration = exports.validateRentalSchedule = exports.formatPaymentSchedulePreview = exports.calculatePaymentSchedule = exports.parseScheduleString = exports.paymentFrequencyToCron = exports.validateCronExpression = exports.getNextCronOccurrence = exports.normalizePaymentSchedule = exports.validateDurationAlignment = exports.paymentFrequencyStringToSeconds = exports.paymentFrequencyToSeconds = exports.isValidPaymentFrequency = exports.getPaymentFrequencyFromString = exports.CRON_TO_PAYMENT_FREQUENCY = exports.PAYMENT_FREQUENCY_TO_CRON = exports.PAYMENT_FREQUENCY_CONSTANTS = exports.PAYMENT_FREQUENCY_MAP = exports.VALID_PAYMENT_FREQUENCIES = exports.PaymentFrequency = exports.fetchMultipleRentalStates = exports.fetchMultipleContractStates = exports.fetchFleetState = exports.fetchConfigState = exports.fetchRentalState = exports.fetchContractState = exports.resolveProgramAddresses = exports.clearConfig = exports.getConfig = exports.setConfig = void 0;
 // Export main SDK functions
 __exportStar(require("./contract"), exports);
 __exportStar(require("./rental"), exports);
+// Export config instruction functions
+__exportStar(require("./config"), exports);
+// Export config functions with public-facing names from utils
+var config_1 = require("./utils/config");
+Object.defineProperty(exports, "setConfig", { enumerable: true, get: function () { return config_1.setSdkConfig; } });
+Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return config_1.getSdkConfig; } });
+Object.defineProperty(exports, "clearConfig", { enumerable: true, get: function () { return config_1.clearSdkConfig; } });
+Object.defineProperty(exports, "resolveProgramAddresses", { enumerable: true, get: function () { return config_1.resolveProgramAddresses; } });
 __exportStar(require("./utils"), exports);
-// Export PaymentFrequency from utils since it's not in codama
-var constants_1 = require("./utils/constants");
-Object.defineProperty(exports, "PaymentFrequency", { enumerable: true, get: function () { return constants_1.PaymentFrequency; } });
+/**
+ * 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);
+ * ```
+ */
+var fetch_accounts_1 = require("./utils/fetch-accounts");
+Object.defineProperty(exports, "fetchContractState", { enumerable: true, get: function () { return fetch_accounts_1.fetchContractState; } });
+Object.defineProperty(exports, "fetchRentalState", { enumerable: true, get: function () { return fetch_accounts_1.fetchRentalState; } });
+Object.defineProperty(exports, "fetchConfigState", { enumerable: true, get: function () { return fetch_accounts_1.fetchConfigState; } });
+Object.defineProperty(exports, "fetchFleetState", { enumerable: true, get: function () { return fetch_accounts_1.fetchFleetState; } });
+Object.defineProperty(exports, "fetchMultipleContractStates", { enumerable: true, get: function () { return fetch_accounts_1.fetchMultipleContractStates; } });
+Object.defineProperty(exports, "fetchMultipleRentalStates", { enumerable: true, get: function () { return fetch_accounts_1.fetchMultipleRentalStates; } });
+/**
+ * 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.
+ */
+var payment_frequency_1 = require("./types/payment-frequency");
+Object.defineProperty(exports, "PaymentFrequency", { enumerable: true, get: function () { return payment_frequency_1.PaymentFrequency; } });
+/**
+ * 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');
+ * }
+ * ```
+ */
+var payment_frequency_2 = require("./types/payment-frequency");
+Object.defineProperty(exports, "VALID_PAYMENT_FREQUENCIES", { enumerable: true, get: function () { return payment_frequency_2.VALID_PAYMENT_FREQUENCIES; } });
+Object.defineProperty(exports, "PAYMENT_FREQUENCY_MAP", { enumerable: true, get: function () { return payment_frequency_2.PAYMENT_FREQUENCY_MAP; } });
+Object.defineProperty(exports, "PAYMENT_FREQUENCY_CONSTANTS", { enumerable: true, get: function () { return payment_frequency_2.PAYMENT_FREQUENCY_CONSTANTS; } });
+Object.defineProperty(exports, "PAYMENT_FREQUENCY_TO_CRON", { enumerable: true, get: function () { return payment_frequency_2.PAYMENT_FREQUENCY_TO_CRON; } });
+Object.defineProperty(exports, "CRON_TO_PAYMENT_FREQUENCY", { enumerable: true, get: function () { return payment_frequency_2.CRON_TO_PAYMENT_FREQUENCY; } });
+Object.defineProperty(exports, "getPaymentFrequencyFromString", { enumerable: true, get: function () { return payment_frequency_2.getPaymentFrequencyFromString; } });
+Object.defineProperty(exports, "isValidPaymentFrequency", { enumerable: true, get: function () { return payment_frequency_2.isValidPaymentFrequency; } });
+/**
+ * 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');
+ * ```
+ */
+var payment_frequency_3 = require("./utils/payment-frequency");
+Object.defineProperty(exports, "paymentFrequencyToSeconds", { enumerable: true, get: function () { return payment_frequency_3.paymentFrequencyToSeconds; } });
+Object.defineProperty(exports, "paymentFrequencyStringToSeconds", { enumerable: true, get: function () { return payment_frequency_3.paymentFrequencyStringToSeconds; } });
+Object.defineProperty(exports, "validateDurationAlignment", { enumerable: true, get: function () { return payment_frequency_3.validateDurationAlignment; } });
+Object.defineProperty(exports, "normalizePaymentSchedule", { enumerable: true, get: function () { return payment_frequency_3.normalizePaymentSchedule; } });
+/**
+ * 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`);
+ * ```
+ */
+var cron_1 = require("./utils/cron");
+Object.defineProperty(exports, "getNextCronOccurrence", { enumerable: true, get: function () { return cron_1.getNextCronOccurrence; } });
+Object.defineProperty(exports, "validateCronExpression", { enumerable: true, get: function () { return cron_1.validateCronExpression; } });
+Object.defineProperty(exports, "paymentFrequencyToCron", { enumerable: true, get: function () { return cron_1.paymentFrequencyToCron; } });
+Object.defineProperty(exports, "parseScheduleString", { enumerable: true, get: function () { return cron_1.parseScheduleString; } });
+Object.defineProperty(exports, "calculatePaymentSchedule", { enumerable: true, get: function () { return cron_1.calculatePaymentSchedule; } });
+Object.defineProperty(exports, "formatPaymentSchedulePreview", { enumerable: true, get: function () { return cron_1.formatPaymentSchedulePreview; } });
+/**
+ * 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`);
+ * }
+ * ```
+ */
+var schedule_validation_1 = require("./utils/schedule-validation");
+Object.defineProperty(exports, "validateRentalSchedule", { enumerable: true, get: function () { return schedule_validation_1.validateRentalSchedule; } });
+Object.defineProperty(exports, "validateFrequencyForDuration", { enumerable: true, get: function () { return schedule_validation_1.validateFrequencyForDuration; } });
+/**
+ * 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 });
+ * ```
+ */
+var schedule_builder_1 = require("./utils/schedule-builder");
+Object.defineProperty(exports, "ScheduleBuilder", { enumerable: true, get: function () { return schedule_builder_1.ScheduleBuilder; } });
+Object.defineProperty(exports, "createSchedule", { enumerable: true, get: function () { return schedule_builder_1.createSchedule; } });
+/**
+ * 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
+ */
+var idl_1 = require("./idl");
+Object.defineProperty(exports, "IDL", { enumerable: true, get: function () { return idl_1.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/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4BAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB;AACzB,0CAAwB;AAuBxB,8DAA8D;AAC9D,+CAAqD;AAA5C,6GAAA,gBAAgB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;;;;;;;;;;;;;;;;;AAEH,4BAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB;AAEzB,sCAAsC;AACtC,2CAAyB;AAEzB,8DAA8D;AAC9D,yCAUwB;AATtB,mGAAA,YAAY,OAAa;AACzB,mGAAA,YAAY,OAAa;AACzB,qGAAA,cAAc,OAAe;AAC7B,iHAAA,uBAAuB,OAAA;AAQzB,0CAAwB;AA0BxB;;;;;;;;;;;;;;;;GAgBG;AACH,yDAQgC;AAP9B,oHAAA,kBAAkB,OAAA;AAClB,kHAAA,gBAAgB,OAAA;AAChB,kHAAA,gBAAgB,OAAA;AAChB,iHAAA,eAAe,OAAA;AACf,6HAAA,2BAA2B,OAAA;AAC3B,2HAAA,yBAAyB,OAAA;AAI3B;;;;;GAKG;AACH,+DAA6D;AAApD,qHAAA,gBAAgB,OAAA;AAEzB;;;;;;;;;;;;GAYG;AACH,+DASmC;AAPjC,8HAAA,yBAAyB,OAAA;AACzB,0HAAA,qBAAqB,OAAA;AACrB,gIAAA,2BAA2B,OAAA;AAC3B,8HAAA,yBAAyB,OAAA;AACzB,8HAAA,yBAAyB,OAAA;AACzB,kIAAA,6BAA6B,OAAA;AAC7B,4HAAA,uBAAuB,OAAA;AAGzB;;;;;;;;;;;GAWG;AACH,+DAKmC;AAJjC,8HAAA,yBAAyB,OAAA;AACzB,oIAAA,+BAA+B,OAAA;AAC/B,8HAAA,yBAAyB,OAAA;AACzB,6HAAA,wBAAwB,OAAA;AAG1B;;;;;;;;;;;;;;;;;;GAkBG;AACH,qCAOsB;AANpB,6GAAA,qBAAqB,OAAA;AACrB,8GAAA,sBAAsB,OAAA;AACtB,8GAAA,sBAAsB,OAAA;AACtB,2GAAA,mBAAmB,OAAA;AACnB,gHAAA,wBAAwB,OAAA;AACxB,oHAAA,4BAA4B,OAAA;AAG9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,mEAIqC;AAHnC,6HAAA,sBAAsB,OAAA;AACtB,mIAAA,4BAA4B,OAAA;AAI9B;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,6DAKkC;AAJhC,mHAAA,eAAe,OAAA;AACf,kHAAA,cAAc,OAAA;AAKhB;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;GAQG;AACH,6BAAiD;AAAxC,0FAAA,GAAG,OAAA;AAEZ;;;;;;;;GAQG"}

package/dist/cjs/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": "commonjs"
 }