@kadi.build/deploy-ability 0.0.3 → 0.0.5

package/dist/targets/akash/bid-types.d.ts

@@ -1,297 +0,0 @@
-/**
- * Bid Types and Pricing
- *
- * Type definitions for enhanced provider bids including comprehensive pricing
- * calculations across multiple time periods (hour, day, week, month) and
- * currencies (uAKT, AKT, USD).
- *
- * @module targets/akash/bid-types
- */
-import type { Bid as ProviderBid } from '@akashnetwork/akash-api/akash/market/v1beta4';
-import type { ProviderInfo } from './provider-metadata.js';
-/**
- * Comprehensive bid pricing across multiple time periods and currencies
- *
- * Provides pre-calculated pricing for a lease in various formats to support
- * different use cases and display preferences. All calculations are derived
- * from the raw per-block price returned by the blockchain.
- *
- * **Price Calculation Background:**
- *
- * Akash leases are priced per block on the blockchain. The raw price from
- * providers is in uAKT (micro AKT) per block. We calculate prices for
- * different time periods using:
- * - Blocks per hour = 3600 seconds/hour ÷ 6.098 seconds/block ≈ 590.8 blocks
- * - Blocks per day = 24 hours × blocks per hour ≈ 14,179 blocks
- * - Blocks per week = 7 days × blocks per day ≈ 99,254 blocks
- * - Blocks per month = 30.437 days × blocks per day ≈ 431,572 blocks
- *
- * **USD Conversion:**
- *
- * USD prices require the current AKT market price, which must be provided
- * by the caller via the `toUSD()` method. This keeps the library free from
- * external API dependencies while allowing flexible price display.
- *
- * @example Display pricing in multiple formats
- * ```typescript
- * const bid: EnhancedBid = // ... from queryBids
- *
- * // Display in uAKT
- * console.log(`${bid.pricing.uakt.perMonth} uAKT/month`);
- *
- * // Display in AKT
- * console.log(`${bid.pricing.akt.perMonth.toFixed(2)} AKT/month`);
- *
- * // Display in USD (requires AKT price)
- * const aktPrice = 0.50; // $0.50 per AKT
- * const usd = bid.pricing.toUSD(aktPrice);
- * console.log(`$${usd.perMonth.toFixed(2)}/month`);
- * console.log(`$${usd.perHour.toFixed(4)}/hour`);
- * ```
- */
-export interface BidPricing {
-    /**
-     * Raw price from blockchain (per block)
-     *
-     * This is the authoritative source - all other prices are computed from this.
-     */
-    readonly raw: {
-        /** Denomination (typically "uakt") */
-        readonly denom: string;
-        /** Amount per block as string */
-        readonly amount: string;
-    };
-    /**
-     * Pre-computed prices in uAKT for different time periods
-     *
-     * All values are in micro AKT (uAKT). To convert to AKT, divide by 1,000,000.
-     */
-    readonly uakt: {
-        /** Price in uAKT per block */
-        readonly perBlock: number;
-        /** Price in uAKT per hour (~590.8 blocks) */
-        readonly perHour: number;
-        /** Price in uAKT per day (~14,179 blocks) */
-        readonly perDay: number;
-        /** Price in uAKT per week (~99,254 blocks) */
-        readonly perWeek: number;
-        /** Price in uAKT per month (~431,572 blocks, 30.437 days) */
-        readonly perMonth: number;
-    };
-    /**
-     * Pre-computed prices in AKT (1 AKT = 1,000,000 uAKT)
-     *
-     * Convenient for display without manual conversion.
-     */
-    readonly akt: {
-        /** Price in AKT per block */
-        readonly perBlock: number;
-        /** Price in AKT per hour */
-        readonly perHour: number;
-        /** Price in AKT per day */
-        readonly perDay: number;
-        /** Price in AKT per week */
-        readonly perWeek: number;
-        /** Price in AKT per month */
-        readonly perMonth: number;
-    };
-    /**
-     * Convert prices to USD using current AKT market price
-     *
-     * **Important:** This method requires you to provide the current AKT price.
-     * deploy-ability does not fetch market data to remain pure and dependency-free.
-     *
-     * **Where to get AKT price:**
-     * - CoinGecko API: https://api.coingecko.com/api/v3/simple/price?ids=akash-network&vs_currencies=usd
-     * - Your own price oracle
-     * - Akash Console API (if available)
-     * - Cached/hardcoded value for estimates
-     *
-     * @param aktPriceUSD - Current price of 1 AKT in USD
-     * @returns Prices in USD for different time periods
-     *
-     * @example
-     * ```typescript
-     * const aktPrice = 0.50; // $0.50 per AKT
-     * const usdPricing = bid.pricing.toUSD(aktPrice);
-     * console.log(`$${usdPricing.perMonth.toFixed(2)}/month`);
-     * ```
-     */
-    toUSD(aktPriceUSD: number): {
-        readonly perHour: number;
-        readonly perDay: number;
-        readonly perWeek: number;
-        readonly perMonth: number;
-    };
-}
-/**
- * Create BidPricing instance from blockchain price data
- *
- * Calculates all time-period prices from the raw per-block price.
- *
- * @param price - Price object from blockchain bid
- * @param price.denom - Denomination (typically "uakt")
- * @param price.amount - Amount per block as string
- * @returns Complete pricing information across all time periods
- *
- * @example
- * ```typescript
- * const pricing = createBidPricing({
- *   denom: 'uakt',
- *   amount: '1234'
- * });
- * console.log(pricing.akt.perMonth); // Monthly cost in AKT
- * ```
- */
-export declare function createBidPricing(price: {
-    denom: string;
-    amount: string;
-}): BidPricing;
-/**
- * Enhanced provider bid with complete information
- *
- * Combines the raw blockchain bid data with enriched provider information
- * and pre-calculated pricing. This is the primary type developers work with
- * when selecting providers for their deployments.
- *
- * **Design Philosophy:**
- *
- * This type provides all the information needed to make an informed provider
- * selection decision in a single, convenient package:
- * - Provider identity and metadata
- * - Location information for latency/compliance needs
- * - Reliability metrics for quality assessment
- * - Comprehensive pricing in multiple formats
- * - Raw bid data for advanced use cases
- *
- * **Data Availability:**
- *
- * Not all fields will be populated for all providers:
- * - New providers may not have reliability data yet
- * - Some providers may not expose location information
- * - Provider metadata (name, email, website) is optional
- *
- * Always check for undefined before using optional provider fields.
- *
- * @example Displaying bid information
- * ```typescript
- * function displayBid(bid: EnhancedBid, aktPrice: number): void {
- *   const usd = bid.pricing.toUSD(aktPrice);
- *
- *   console.log(`
- *     Provider: ${bid.provider.name || 'Unknown'}
- *     Location: ${bid.provider.location?.country || 'Unknown'}
- *     Uptime (7d): ${bid.provider.reliability
- *       ? (bid.provider.reliability.uptime7d * 100).toFixed(1) + '%'
- *       : 'No data'}
- *     Price: $${usd.perMonth.toFixed(2)}/month
- *     Audited: ${bid.provider.isAudited ? 'Yes' : 'No'}
- *   `);
- * }
- * ```
- *
- * @example Filtering by criteria
- * ```typescript
- * function selectAffordableReliableBid(
- *   bids: EnhancedBid[],
- *   maxUsdPerMonth: number,
- *   aktPrice: number,
- *   minUptime: number
- * ): EnhancedBid | null {
- *   const filtered = bids.filter(bid => {
- *     const usd = bid.pricing.toUSD(aktPrice);
- *     const uptime = bid.provider.reliability?.uptime7d ?? 0;
- *     return usd.perMonth <= maxUsdPerMonth && uptime >= minUptime;
- *   });
- *
- *   return filtered[0] ?? null;
- * }
- * ```
- */
-export interface EnhancedBid {
-    /**
-     * Unique identifier for this bid
-     *
-     * Constructed from the bid coordinates (owner/dseq/gseq/oseq/provider).
-     * Useful for React keys, logging, and bid tracking.
-     */
-    readonly id: string;
-    /**
-     * Raw bid data from Akash blockchain
-     *
-     * Contains the original protobuf bid object with all coordinates
-     * (bidId, price, state, etc.). Useful for advanced operations that
-     * need direct access to blockchain data.
-     */
-    readonly bid: ProviderBid;
-    /**
-     * Complete provider information
-     *
-     * Includes identity, location, reliability metrics, and audit status.
-     * Some fields may be undefined for providers without complete metadata.
-     */
-    readonly provider: ProviderInfo;
-    /**
-     * Pre-calculated pricing across all time periods
-     *
-     * Includes pricing in uAKT, AKT, and a method for USD conversion.
-     * Makes it easy to display prices in user-friendly formats.
-     */
-    readonly pricing: BidPricing;
-    /**
-     * When this bid was created
-     *
-     * Timestamp when the provider submitted the bid to the blockchain.
-     * Useful for sorting by bid age or showing "time since bid" UI.
-     */
-    readonly createdAt: Date;
-}
-/**
- * Bid selection function signature
- *
- * A function that takes an array of enhanced bids and returns the selected bid
- * (or null if none are acceptable). Can be synchronous or asynchronous to support
- * different selection strategies:
- *
- * - **Synchronous**: Simple algorithmic selection (cheapest, most reliable, etc.)
- * - **Asynchronous**: Interactive selection (user prompts, API calls, external validation)
- *
- * **Contract:**
- * - Input: Array of at least one EnhancedBid
- * - Output: Selected EnhancedBid or null if none are acceptable
- * - Throws: Should not throw - return null instead for unacceptable bids
- *
- * **Return null when:**
- * - No bids meet your criteria
- * - User cancels selection (in interactive mode)
- * - External validation fails
- *
- * @example Simple synchronous selector
- * ```typescript
- * const selectCheapest: BidSelector = (bids) => {
- *   if (bids.length === 0) return null;
- *   return bids.reduce((cheapest, current) =>
- *     current.pricing.uakt.perMonth < cheapest.pricing.uakt.perMonth
- *       ? current
- *       : cheapest
- *   );
- * };
- * ```
- *
- * @example Asynchronous interactive selector
- * ```typescript
- * const selectInteractive: BidSelector = async (bids) => {
- *   console.log('Available providers:');
- *   bids.forEach((bid, i) => {
- *     console.log(`${i + 1}. ${bid.provider.name} - ${bid.pricing.akt.perMonth} AKT/month`);
- *   });
- *
- *   const choice = await promptUser('Select provider (1-' + bids.length + '): ');
- *   const index = parseInt(choice) - 1;
- *
- *   return bids[index] ?? null;
- * };
- * ```
- */
-export type BidSelector = ((bids: EnhancedBid[]) => Promise<EnhancedBid | null>) | ((bids: EnhancedBid[]) => EnhancedBid | null);
-//# sourceMappingURL=bid-types.d.ts.map

package/dist/targets/akash/bid-types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bid-types.d.ts","sourceRoot":"","sources":["../../../src/targets/akash/bid-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,GAAG,IAAI,WAAW,EAAE,MAAM,8CAA8C,CAAC;AACvF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAyB3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE;QACZ,sCAAsC;QACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,iCAAiC;QACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,CAAC;IAEF;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE;QACb,8BAA8B;QAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,6CAA6C;QAC7C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,6CAA6C;QAC7C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,8CAA8C;QAC9C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,6DAA6D;QAC7D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE;QACZ,6BAA6B;QAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,4BAA4B;QAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,2BAA2B;QAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,4BAA4B;QAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,6BAA6B;QAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG;QAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,UAAU,CA2Cb;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;IAE1B;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAEhC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,MAAM,WAAW,GACnB,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC,GACtD,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,WAAW,GAAG,IAAI,CAAC,CAAC"}

package/dist/targets/akash/bid-types.js

@@ -1,89 +0,0 @@
-/**
- * Bid Types and Pricing
- *
- * Type definitions for enhanced provider bids including comprehensive pricing
- * calculations across multiple time periods (hour, day, week, month) and
- * currencies (uAKT, AKT, USD).
- *
- * @module targets/akash/bid-types
- */
-/**
- * Average time between blocks on Akash Network (in seconds)
- *
- * This value is determined empirically by observing actual block times.
- * Akash Console uses 6.098 seconds as the average.
- *
- * Used for calculating time-based pricing from per-block prices.
- */
-const AVERAGE_BLOCK_TIME_SECONDS = 6.098;
-/**
- * Average number of days in a month (365.25 / 12)
- *
- * Using the astronomical year (365.25 days) divided by 12 months
- * provides accurate monthly cost estimates accounting for leap years.
- */
-const AVERAGE_DAYS_IN_MONTH = 30.437;
-/**
- * Conversion factor: 1 AKT = 1,000,000 uAKT
- */
-const UAKT_PER_AKT = 1_000_000;
-/**
- * Create BidPricing instance from blockchain price data
- *
- * Calculates all time-period prices from the raw per-block price.
- *
- * @param price - Price object from blockchain bid
- * @param price.denom - Denomination (typically "uakt")
- * @param price.amount - Amount per block as string
- * @returns Complete pricing information across all time periods
- *
- * @example
- * ```typescript
- * const pricing = createBidPricing({
- *   denom: 'uakt',
- *   amount: '1234'
- * });
- * console.log(pricing.akt.perMonth); // Monthly cost in AKT
- * ```
- */
-export function createBidPricing(price) {
-    // Parse raw price per block
-    const pricePerBlock = parseFloat(price.amount);
-    // Calculate number of blocks for each time period
-    const blocksPerHour = (60 * 60) / AVERAGE_BLOCK_TIME_SECONDS;
-    const blocksPerDay = (24 * 60 * 60) / AVERAGE_BLOCK_TIME_SECONDS;
-    const blocksPerWeek = (7 * 24 * 60 * 60) / AVERAGE_BLOCK_TIME_SECONDS;
-    const blocksPerMonth = (AVERAGE_DAYS_IN_MONTH * 24 * 60 * 60) / AVERAGE_BLOCK_TIME_SECONDS;
-    // Calculate prices in uAKT for all time periods
-    const uaktPricing = {
-        perBlock: pricePerBlock,
-        perHour: pricePerBlock * blocksPerHour,
-        perDay: pricePerBlock * blocksPerDay,
-        perWeek: pricePerBlock * blocksPerWeek,
-        perMonth: pricePerBlock * blocksPerMonth,
-    };
-    // Calculate prices in AKT (divide uAKT by 1,000,000)
-    const aktPricing = {
-        perBlock: uaktPricing.perBlock / UAKT_PER_AKT,
-        perHour: uaktPricing.perHour / UAKT_PER_AKT,
-        perDay: uaktPricing.perDay / UAKT_PER_AKT,
-        perWeek: uaktPricing.perWeek / UAKT_PER_AKT,
-        perMonth: uaktPricing.perMonth / UAKT_PER_AKT,
-    };
-    // Return pricing object with USD conversion method
-    return {
-        raw: {
-            denom: price.denom,
-            amount: price.amount,
-        },
-        uakt: uaktPricing,
-        akt: aktPricing,
-        toUSD: (aktPriceUSD) => ({
-            perHour: aktPricing.perHour * aktPriceUSD,
-            perDay: aktPricing.perDay * aktPriceUSD,
-            perWeek: aktPricing.perWeek * aktPriceUSD,
-            perMonth: aktPricing.perMonth * aktPriceUSD,
-        }),
-    };
-}
-//# sourceMappingURL=bid-types.js.map

package/dist/targets/akash/bid-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bid-types.js","sourceRoot":"","sources":["../../../src/targets/akash/bid-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH;;;;;;;GAOG;AACH,MAAM,0BAA0B,GAAG,KAAK,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,YAAY,GAAG,SAAS,CAAC;AAyH/B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAGhC;IACC,4BAA4B;IAC5B,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/C,kDAAkD;IAClD,MAAM,aAAa,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,0BAA0B,CAAC;IAC7D,MAAM,YAAY,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,0BAA0B,CAAC;IACjE,MAAM,aAAa,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,0BAA0B,CAAC;IACtE,MAAM,cAAc,GAAG,CAAC,qBAAqB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,0BAA0B,CAAC;IAE3F,gDAAgD;IAChD,MAAM,WAAW,GAAG;QAClB,QAAQ,EAAE,aAAa;QACvB,OAAO,EAAE,aAAa,GAAG,aAAa;QACtC,MAAM,EAAE,aAAa,GAAG,YAAY;QACpC,OAAO,EAAE,aAAa,GAAG,aAAa;QACtC,QAAQ,EAAE,aAAa,GAAG,cAAc;KACzC,CAAC;IAEF,qDAAqD;IACrD,MAAM,UAAU,GAAG;QACjB,QAAQ,EAAE,WAAW,CAAC,QAAQ,GAAG,YAAY;QAC7C,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,YAAY;QAC3C,MAAM,EAAE,WAAW,CAAC,MAAM,GAAG,YAAY;QACzC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,YAAY;QAC3C,QAAQ,EAAE,WAAW,CAAC,QAAQ,GAAG,YAAY;KAC9C,CAAC;IAEF,mDAAmD;IACnD,OAAO;QACL,GAAG,EAAE;YACH,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,MAAM,EAAE,KAAK,CAAC,MAAM;SACrB;QACD,IAAI,EAAE,WAAW;QACjB,GAAG,EAAE,UAAU;QACf,KAAK,EAAE,CAAC,WAAmB,EAAE,EAAE,CAAC,CAAC;YAC/B,OAAO,EAAE,UAAU,CAAC,OAAO,GAAG,WAAW;YACzC,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,WAAW;YACvC,OAAO,EAAE,UAAU,CAAC,OAAO,GAAG,WAAW;YACzC,QAAQ,EAAE,UAAU,CAAC,QAAQ,GAAG,WAAW;SAC5C,CAAC;KACH,CAAC;AACJ,CAAC"}