@lucid-evolution/provider 0.2.6 → 0.3.0

package/dist/index.d.cts

@@ -82,6 +82,12 @@ interface KupmiosOptions {
     readonly requestTimeoutMs?: number;
     /** Overall transaction confirmation deadline in milliseconds. @default 160000 */
     readonly awaitTxTimeoutMs?: number;
+    /**
+     * The `fetch` this provider uses for its Kupo and Ogmios requests, in place
+     * of `globalThis.fetch`. It receives the provider's abort signal in
+     * `init.signal`, which fires on `requestTimeoutMs` and on a caller's abort.
+     */
+    readonly fetchImpl?: typeof globalThis.fetch;
 }
 /**
  * Provides support for interacting with both Kupo and Ogmios APIs.
@@ -121,6 +127,7 @@ declare class Kupmios implements Provider {
     private readonly options;
     private readonly requestTimeoutMs;
     private readonly awaitTxTimeoutMs;
+    private readonly httpLayer;
     constructor(kupoUrl: string, ogmiosUrl: string, options?: KupmiosOptions);
     getProtocolParameters(): Promise<ProtocolParameters>;
     getTreasury(): Promise<bigint>;
@@ -138,8 +145,20 @@ declare class Kupmios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-/** Concatentation of txHash + outputIndex */
+/** Concatenation of txHash + outputIndex */
 type FlatOutRef = string;
+type LedgerEntry = {
+    utxo: UTxO;
+    spent: boolean;
+};
+
+type TransactionHistory = Record<TxHash, {
+    status: "pending";
+} | {
+    status: "confirmed";
+    blockHeight: number;
+    slot: number;
+}>;
 declare const EMULATOR_PROVIDER_BRAND: unique symbol;
 declare const isEmulatorProvider: (provider: Provider | undefined) => provider is Emulator;
 type EmulatorAccount = {
@@ -152,15 +171,16 @@ type EmulatorAccount = {
 declare function generateEmulatorAccountFromPrivateKey(assets: Assets): EmulatorAccount;
 declare function generateEmulatorAccount(assets: Assets): EmulatorAccount;
 declare class Emulator implements Provider {
+    #private;
     readonly [EMULATOR_PROVIDER_BRAND] = true;
-    ledger: Record<FlatOutRef, {
-        utxo: UTxO;
-        spent: boolean;
-    }>;
-    mempool: Record<FlatOutRef, {
-        utxo: UTxO;
-        spent: boolean;
-    }>;
+    /**
+     * The confirmed UTxO set, keyed by txHash + outputIndex: a plain record
+     * that callers may read, edit, replace or snapshot freely. It is an own
+     * enumerable property, defined here so it keeps its place among the
+     * instance's keys.
+     */
+    ledger: Record<FlatOutRef, LedgerEntry>;
+    mempool: Record<FlatOutRef, LedgerEntry>;
     /**
      * Only stake key registrations/delegations and rewards are tracked.
      * Other certificates are not tracked.
@@ -175,16 +195,14 @@ declare class Emulator implements Provider {
     protocolParameters: ProtocolParameters;
     datumTable: Record<DatumHash, Datum>;
     treasury: Lovelace;
-    transactionHistory: Record<TxHash, {
-        status: "pending";
-    } | {
-        status: "confirmed";
-        blockHeight: number;
-        slot: number;
-    }>;
+    /** Every transaction status, keyed by hash; a plain record, like `ledger`. */
+    transactionHistory: TransactionHistory;
     constructor(accounts: EmulatorAccount[], protocolParameters?: ProtocolParameters, treasury?: Lovelace);
     now(): UnixTime;
+    /** Confirms every pending transaction in `transactionHistory`. */
     private confirmPendingTransactions;
+    /** Moves the mempool into the ledger and drops spent entries. */
+    private applyMempool;
     awaitSlot(length?: number): void;
     awaitBlock(height?: number): void;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
@@ -204,41 +222,23 @@ declare class Emulator implements Provider {
      */
     distributeRewards(rewards: Lovelace): void;
     submitTx(tx: Transaction): Promise<TxHash>;
+    /** Validates `tx` and applies it to the mempool; returns its hash. */
+    private applyTx;
+    /**
+     * The ledger's collateral rules for a transaction with redeemers: at least
+     * one and at most `maxCollateralInputs` collateral inputs, a balance (inputs
+     * minus the collateral return) of ADA only that covers
+     * `collateralPercentage` of the fee, a `total_collateral` field, when
+     * present, equal to that balance, and a collateral return holding at least
+     * its minimum ADA.
+     */
+    private checkCollateral;
+    /** Hash of a reference script, computed once per distinct script. */
+    private scriptRefHash;
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
     log(): void;
 }
 
-type MaestroSupportedNetworks = "Mainnet" | "Preprod" | "Preview";
-interface MaestroConfig {
-    network: MaestroSupportedNetworks;
-    apiKey: string;
-    turboSubmit?: boolean;
-}
-declare class Maestro implements Provider {
-    url: string;
-    apiKey: string;
-    turboSubmit: boolean;
-    constructor({ network, apiKey, turboSubmit }: MaestroConfig);
-    getProtocolParameters(): Promise<ProtocolParameters>;
-    getTreasury(): Promise<bigint>;
-    private getUtxosInternal;
-    getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
-    getUtxosWithUnit(addressOrCredential: Address | Credential, unit: Unit): Promise<UTxO[]>;
-    getUtxoByUnit(unit: Unit): Promise<UTxO>;
-    getUtxosByOutRef(outRefs: OutRef[]): Promise<UTxO[]>;
-    getRewardAccount(rewardAddress: RewardAddress): Promise<RewardAccountState>;
-    getDelegation(rewardAddress: RewardAddress): Promise<Delegation>;
-    getDatum(datumHash: DatumHash): Promise<Datum>;
-    awaitTx(txHash: TxHash, checkInterval?: number): Promise<boolean>;
-    getTransactionStatus(txHash: TxHash, options?: TransactionStatusOptions): Promise<TransactionStatus>;
-    submitTx(tx: Transaction): Promise<TxHash>;
-    private commonHeaders;
-    private requireAmountsAsStrings;
-    private maestroUtxoToUtxo;
-    private getAllPagesData;
-    evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
-}
-
 declare const KoiosError_base: new <A extends Record<string, any> = {}>(args: effect_Types.VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => effect_Cause.YieldableError & {
     readonly _tag: "KoiosError";
 } & Readonly<A>;
@@ -294,4 +294,4 @@ declare class Koios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-export { Blockfrost, type BlockfrostOptions, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, type KupmiosOptions, Maestro, type MaestroConfig, type MaestroSupportedNetworks, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };
+export { Blockfrost, type BlockfrostOptions, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, type KupmiosOptions, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };

package/dist/index.d.ts

@@ -82,6 +82,12 @@ interface KupmiosOptions {
     readonly requestTimeoutMs?: number;
     /** Overall transaction confirmation deadline in milliseconds. @default 160000 */
     readonly awaitTxTimeoutMs?: number;
+    /**
+     * The `fetch` this provider uses for its Kupo and Ogmios requests, in place
+     * of `globalThis.fetch`. It receives the provider's abort signal in
+     * `init.signal`, which fires on `requestTimeoutMs` and on a caller's abort.
+     */
+    readonly fetchImpl?: typeof globalThis.fetch;
 }
 /**
  * Provides support for interacting with both Kupo and Ogmios APIs.
@@ -121,6 +127,7 @@ declare class Kupmios implements Provider {
     private readonly options;
     private readonly requestTimeoutMs;
     private readonly awaitTxTimeoutMs;
+    private readonly httpLayer;
     constructor(kupoUrl: string, ogmiosUrl: string, options?: KupmiosOptions);
     getProtocolParameters(): Promise<ProtocolParameters>;
     getTreasury(): Promise<bigint>;
@@ -138,8 +145,20 @@ declare class Kupmios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-/** Concatentation of txHash + outputIndex */
+/** Concatenation of txHash + outputIndex */
 type FlatOutRef = string;
+type LedgerEntry = {
+    utxo: UTxO;
+    spent: boolean;
+};
+
+type TransactionHistory = Record<TxHash, {
+    status: "pending";
+} | {
+    status: "confirmed";
+    blockHeight: number;
+    slot: number;
+}>;
 declare const EMULATOR_PROVIDER_BRAND: unique symbol;
 declare const isEmulatorProvider: (provider: Provider | undefined) => provider is Emulator;
 type EmulatorAccount = {
@@ -152,15 +171,16 @@ type EmulatorAccount = {
 declare function generateEmulatorAccountFromPrivateKey(assets: Assets): EmulatorAccount;
 declare function generateEmulatorAccount(assets: Assets): EmulatorAccount;
 declare class Emulator implements Provider {
+    #private;
     readonly [EMULATOR_PROVIDER_BRAND] = true;
-    ledger: Record<FlatOutRef, {
-        utxo: UTxO;
-        spent: boolean;
-    }>;
-    mempool: Record<FlatOutRef, {
-        utxo: UTxO;
-        spent: boolean;
-    }>;
+    /**
+     * The confirmed UTxO set, keyed by txHash + outputIndex: a plain record
+     * that callers may read, edit, replace or snapshot freely. It is an own
+     * enumerable property, defined here so it keeps its place among the
+     * instance's keys.
+     */
+    ledger: Record<FlatOutRef, LedgerEntry>;
+    mempool: Record<FlatOutRef, LedgerEntry>;
     /**
      * Only stake key registrations/delegations and rewards are tracked.
      * Other certificates are not tracked.
@@ -175,16 +195,14 @@ declare class Emulator implements Provider {
     protocolParameters: ProtocolParameters;
     datumTable: Record<DatumHash, Datum>;
     treasury: Lovelace;
-    transactionHistory: Record<TxHash, {
-        status: "pending";
-    } | {
-        status: "confirmed";
-        blockHeight: number;
-        slot: number;
-    }>;
+    /** Every transaction status, keyed by hash; a plain record, like `ledger`. */
+    transactionHistory: TransactionHistory;
     constructor(accounts: EmulatorAccount[], protocolParameters?: ProtocolParameters, treasury?: Lovelace);
     now(): UnixTime;
+    /** Confirms every pending transaction in `transactionHistory`. */
     private confirmPendingTransactions;
+    /** Moves the mempool into the ledger and drops spent entries. */
+    private applyMempool;
     awaitSlot(length?: number): void;
     awaitBlock(height?: number): void;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
@@ -204,41 +222,23 @@ declare class Emulator implements Provider {
      */
     distributeRewards(rewards: Lovelace): void;
     submitTx(tx: Transaction): Promise<TxHash>;
+    /** Validates `tx` and applies it to the mempool; returns its hash. */
+    private applyTx;
+    /**
+     * The ledger's collateral rules for a transaction with redeemers: at least
+     * one and at most `maxCollateralInputs` collateral inputs, a balance (inputs
+     * minus the collateral return) of ADA only that covers
+     * `collateralPercentage` of the fee, a `total_collateral` field, when
+     * present, equal to that balance, and a collateral return holding at least
+     * its minimum ADA.
+     */
+    private checkCollateral;
+    /** Hash of a reference script, computed once per distinct script. */
+    private scriptRefHash;
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
     log(): void;
 }
 
-type MaestroSupportedNetworks = "Mainnet" | "Preprod" | "Preview";
-interface MaestroConfig {
-    network: MaestroSupportedNetworks;
-    apiKey: string;
-    turboSubmit?: boolean;
-}
-declare class Maestro implements Provider {
-    url: string;
-    apiKey: string;
-    turboSubmit: boolean;
-    constructor({ network, apiKey, turboSubmit }: MaestroConfig);
-    getProtocolParameters(): Promise<ProtocolParameters>;
-    getTreasury(): Promise<bigint>;
-    private getUtxosInternal;
-    getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
-    getUtxosWithUnit(addressOrCredential: Address | Credential, unit: Unit): Promise<UTxO[]>;
-    getUtxoByUnit(unit: Unit): Promise<UTxO>;
-    getUtxosByOutRef(outRefs: OutRef[]): Promise<UTxO[]>;
-    getRewardAccount(rewardAddress: RewardAddress): Promise<RewardAccountState>;
-    getDelegation(rewardAddress: RewardAddress): Promise<Delegation>;
-    getDatum(datumHash: DatumHash): Promise<Datum>;
-    awaitTx(txHash: TxHash, checkInterval?: number): Promise<boolean>;
-    getTransactionStatus(txHash: TxHash, options?: TransactionStatusOptions): Promise<TransactionStatus>;
-    submitTx(tx: Transaction): Promise<TxHash>;
-    private commonHeaders;
-    private requireAmountsAsStrings;
-    private maestroUtxoToUtxo;
-    private getAllPagesData;
-    evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
-}
-
 declare const KoiosError_base: new <A extends Record<string, any> = {}>(args: effect_Types.VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => effect_Cause.YieldableError & {
     readonly _tag: "KoiosError";
 } & Readonly<A>;
@@ -294,4 +294,4 @@ declare class Koios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-export { Blockfrost, type BlockfrostOptions, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, type KupmiosOptions, Maestro, type MaestroConfig, type MaestroSupportedNetworks, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };
+export { Blockfrost, type BlockfrostOptions, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, type KupmiosOptions, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };