@lucid-evolution/provider 0.1.82 → 0.1.84

package/dist/index.d.cts

@@ -27,14 +27,44 @@ declare class KupmiosError extends KupmiosError_base<{
 }> {
     get message(): string;
 }
+/**
+ * Provides support for interacting with both Kupo and Ogmios APIs.
+ *
+ * @example Using Local URLs (No Authentication):
+ * ```typescript
+ * const kupmios = new Kupmios(
+ *   "http://localhost:1442", // Kupo API URL
+ *   "http://localhost:1337"  // Ogmios API URL
+ * );
+ * ```
+ *
+ * @example Using Authenticated URLs (No Custom Headers):
+ * ```typescript
+ * const kupmios = new Kupmios(
+ *   "https://dmtr_kupoXXX.preprod-v2.kupo-m1.demeter.run", // Kupo Authenticated URL
+ *   "https://dmtr_ogmiosXXX.preprod-v6.ogmios-m1.demeter.run" // Ogmios Authenticated URL
+ * );
+ * ```
+ *
+ * @example Using Public URLs with Custom Headers:
+ * ```typescript
+ * const kupmios = new Kupmios(
+ *   "https://preprod-v2.kupo-m1.demeter.run", // Kupo API URL
+ *   "https://preprod-v6.ogmios-m1.demeter.run", // Ogmios API URL
+ *   {
+ *     kupoHeader: { "dmtr-api-key": "dmtr_kupoXXX" }, // Custom header for Kupo
+ *     ogmiosHeader: { "dmtr-api-key": "dmtr_ogmiosXXX" } // Custom header for Ogmios
+ *   }
+ * );
+ */
 declare class Kupmios implements Provider {
-    kupoUrl: string;
-    ogmiosUrl: string;
-    /**
-     * @param kupoUrl: http(s)://localhost:1442
-     * @param ogmiosUrl: http(s)://localhost:1337
-     */
-    constructor(kupoUrl: string, ogmiosUrl: string);
+    private readonly kupoUrl;
+    private readonly ogmiosUrl;
+    private readonly headers?;
+    constructor(kupoUrl: string, ogmiosUrl: string, headers?: {
+        ogmiosHeader?: Record<string, string>;
+        kupoHeader?: Record<string, string>;
+    });
     getProtocolParameters(): Promise<ProtocolParameters>;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
     getUtxosWithUnit(addressOrCredential: Address | Credential, unit: Unit): Promise<UTxO[]>;
@@ -56,7 +86,7 @@ type EmulatorAccount = {
     outputData?: OutputData;
     privateKey: string;
 };
-declare function generateEmulatorAccountFrommPrivateKey(assets: Assets): Promise<EmulatorAccount>;
+declare function generateEmulatorAccountFromPrivateKey(assets: Assets): Promise<EmulatorAccount>;
 declare function generateEmulatorAccount(assets: Assets): EmulatorAccount;
 declare class Emulator implements Provider {
     ledger: Record<FlatOutRef, {
@@ -139,11 +169,37 @@ declare class KoiosError extends KoiosError_base<{
     get message(): string;
 }
 /**
- * @description This class supports Koios API v1.2a
+ *  Provides support for interacting with the Koios API
+ *
+ * @example Using the Preprod API URL:
+ * ```typescript
+ * const koios = new Koios(
+ *   "https://preview.koios.rest/api/v1", // Preprod Preview Environment
+ *   "optional-bearer-token" // Optional Bearer Token for authentication
+ * );
+ * ```
+ *
+ * @example Using the Preprod Stable API URL:
+ * ```typescript
+ * const koios = new Koios(
+ *   "https://preprod.koios.rest/api/v1", // Preprod Stable Environment
+ *   "optional-bearer-token" // Optional Bearer Token for authentication
+ * );
+ * ```
+ *
+ * @example Using the Mainnet API URL:
+ * ```typescript
+ * const koios = new Koios(
+ *   "https://api.koios.rest/api/v1", // Mainnet Environment
+ *   "optional-bearer-token" // Optional Bearer Token for authentication
+ * );
+ * ```
+ *
  */
 declare class Koios implements Provider {
     private readonly baseUrl;
-    constructor(baseUrl: string);
+    private readonly token?;
+    constructor(baseUrl: string, token?: string);
     getProtocolParameters(): Promise<ProtocolParameters>;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
     getUtxosWithUnit(addressOrCredential: Address | Credential, unit: Unit): Promise<UTxO[]>;
@@ -156,4 +212,4 @@ declare class Koios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, Maestro, type MaestroConfig, type MaestroSupportedNetworks, generateEmulatorAccount, generateEmulatorAccountFrommPrivateKey };
+export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, Maestro, type MaestroConfig, type MaestroSupportedNetworks, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey };

package/dist/index.d.ts

@@ -27,14 +27,44 @@ declare class KupmiosError extends KupmiosError_base<{
 }> {
     get message(): string;
 }
+/**
+ * Provides support for interacting with both Kupo and Ogmios APIs.
+ *
+ * @example Using Local URLs (No Authentication):
+ * ```typescript
+ * const kupmios = new Kupmios(
+ *   "http://localhost:1442", // Kupo API URL
+ *   "http://localhost:1337"  // Ogmios API URL
+ * );
+ * ```
+ *
+ * @example Using Authenticated URLs (No Custom Headers):
+ * ```typescript
+ * const kupmios = new Kupmios(
+ *   "https://dmtr_kupoXXX.preprod-v2.kupo-m1.demeter.run", // Kupo Authenticated URL
+ *   "https://dmtr_ogmiosXXX.preprod-v6.ogmios-m1.demeter.run" // Ogmios Authenticated URL
+ * );
+ * ```
+ *
+ * @example Using Public URLs with Custom Headers:
+ * ```typescript
+ * const kupmios = new Kupmios(
+ *   "https://preprod-v2.kupo-m1.demeter.run", // Kupo API URL
+ *   "https://preprod-v6.ogmios-m1.demeter.run", // Ogmios API URL
+ *   {
+ *     kupoHeader: { "dmtr-api-key": "dmtr_kupoXXX" }, // Custom header for Kupo
+ *     ogmiosHeader: { "dmtr-api-key": "dmtr_ogmiosXXX" } // Custom header for Ogmios
+ *   }
+ * );
+ */
 declare class Kupmios implements Provider {
-    kupoUrl: string;
-    ogmiosUrl: string;
-    /**
-     * @param kupoUrl: http(s)://localhost:1442
-     * @param ogmiosUrl: http(s)://localhost:1337
-     */
-    constructor(kupoUrl: string, ogmiosUrl: string);
+    private readonly kupoUrl;
+    private readonly ogmiosUrl;
+    private readonly headers?;
+    constructor(kupoUrl: string, ogmiosUrl: string, headers?: {
+        ogmiosHeader?: Record<string, string>;
+        kupoHeader?: Record<string, string>;
+    });
     getProtocolParameters(): Promise<ProtocolParameters>;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
     getUtxosWithUnit(addressOrCredential: Address | Credential, unit: Unit): Promise<UTxO[]>;
@@ -56,7 +86,7 @@ type EmulatorAccount = {
     outputData?: OutputData;
     privateKey: string;
 };
-declare function generateEmulatorAccountFrommPrivateKey(assets: Assets): Promise<EmulatorAccount>;
+declare function generateEmulatorAccountFromPrivateKey(assets: Assets): Promise<EmulatorAccount>;
 declare function generateEmulatorAccount(assets: Assets): EmulatorAccount;
 declare class Emulator implements Provider {
     ledger: Record<FlatOutRef, {
@@ -139,11 +169,37 @@ declare class KoiosError extends KoiosError_base<{
     get message(): string;
 }
 /**
- * @description This class supports Koios API v1.2a
+ *  Provides support for interacting with the Koios API
+ *
+ * @example Using the Preprod API URL:
+ * ```typescript
+ * const koios = new Koios(
+ *   "https://preview.koios.rest/api/v1", // Preprod Preview Environment
+ *   "optional-bearer-token" // Optional Bearer Token for authentication
+ * );
+ * ```
+ *
+ * @example Using the Preprod Stable API URL:
+ * ```typescript
+ * const koios = new Koios(
+ *   "https://preprod.koios.rest/api/v1", // Preprod Stable Environment
+ *   "optional-bearer-token" // Optional Bearer Token for authentication
+ * );
+ * ```
+ *
+ * @example Using the Mainnet API URL:
+ * ```typescript
+ * const koios = new Koios(
+ *   "https://api.koios.rest/api/v1", // Mainnet Environment
+ *   "optional-bearer-token" // Optional Bearer Token for authentication
+ * );
+ * ```
+ *
  */
 declare class Koios implements Provider {
     private readonly baseUrl;
-    constructor(baseUrl: string);
+    private readonly token?;
+    constructor(baseUrl: string, token?: string);
     getProtocolParameters(): Promise<ProtocolParameters>;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
     getUtxosWithUnit(addressOrCredential: Address | Credential, unit: Unit): Promise<UTxO[]>;
@@ -156,4 +212,4 @@ declare class Koios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, Maestro, type MaestroConfig, type MaestroSupportedNetworks, generateEmulatorAccount, generateEmulatorAccountFrommPrivateKey };
+export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, Maestro, type MaestroConfig, type MaestroSupportedNetworks, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey };