@midnight-ntwrk/midnight-did-api 0.5.0-rc1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,218 @@
+# @midnight-ntwrk/midnight-did-api
+
+Programmatic API for creating, updating, deactivating, and resolving Midnight DIDs.
+
+## Responsibilities
+
+- Build/connect providers (node, indexer, proof server)
+- Submit contract circuits for DID operations
+- Map inputs/outputs between app/domain and ledger/runtime
+- Generate and persist DID controller private state for create/rotation flows
+- Provide integration test topology and helpers
+- Return DID resolution data (`didDocument`, `didDocumentMetadata`) for API callers
+
+## Use It When
+
+- you need programmatic DID deployment or mutation flows
+- you need provider bootstrap for standalone, preprod, or env-driven mainnet
+- you are building a higher-level application and do not want to manage raw contract/runtime wiring
+
+## Architecture
+
+```mermaid
+graph TD
+  App[Manager / Tests / Integrator]
+  API[API facade]
+  Domain[Domain validation]
+  DidPkg[DID mapper]
+  Contract[Contract bindings]
+  Providers[Providers]
+  Chain[(Midnight chain)]
+  Indexer[(Indexer)]
+
+  App --> API
+  API --> Domain
+  API --> DidPkg
+  API --> Contract
+  API --> Providers
+  Providers --> Chain
+  Providers --> Indexer
+```
+
+## Update Sequence
+
+```mermaid
+sequenceDiagram
+  participant Caller
+  participant API
+  participant Contract
+  participant Indexer
+
+  Caller->>API: addService / addVerificationMethod / ...
+  API->>API: validate + normalize
+  API->>Contract: submit circuit tx
+  Contract-->>API: accepted tx
+  API->>Indexer: fetch current state
+  API-->>Caller: updated DID state or DID Resolution Result
+```
+
+## State Model
+
+API enforces lifecycle rules around:
+
+- active DID: allows updates
+- deactivated DID: mutating operations rejected
+- controller rotation: generates a new wallet-local secret, derives the next controller public key locally, submits the rotation circuit, and stores the new secret after the transaction succeeds
+
+(Exact schema/canonicalization rules live in `domain`.)
+
+## Resolution Responses
+
+The API package exposes both convenience and DID Core envelope helpers.
+`resolve` returns the ledger-derived DID Document and DID Document metadata, or
+`null` when the contract state is missing. `resolveDIDResolutionResult` returns
+the full DID Core Resolution Result envelope with `didResolutionMetadata`.
+Successful abstract `resolve` responses must not set
+`didResolutionMetadata.contentType`; that field is reserved for
+`resolveRepresentation` responses where the body is a DID Document byte stream.
+
+## Build & Test
+
+- Build: `pnpm --filter ./packages/api build`
+- Typecheck examples: `pnpm --filter ./packages/api typecheck:examples`
+- API import discipline: `pnpm run check:api-source-imports`
+- DID package import discipline: `pnpm run check:source-imports`
+- Unit tests: `pnpm --filter ./packages/api test`
+- Integration tests: `pnpm --filter ./packages/api test-api`
+
+API TypeScript source and tests use explicit `.js` or `.json` extensions for
+relative imports, including Vitest mocks. This keeps the package aligned with
+the emitted ESM graph and avoids resolver-only test behavior.
+The wider `check:source-imports` guard applies the same rule to all DID-owned
+TypeScript package sources outside generated `src/managed` artifacts.
+
+## Runtime Profiles
+
+- `StandaloneConfig`
+- `TestnetLocalConfig`
+- `TestnetRemoteConfig`
+- `PreprodConfig`
+- `MainnetConfig`
+- `ProfileConfig`
+
+Defaults:
+
+- all profile defaults live in `src/config-profiles.ts`
+- `PreprodConfig` and `MainnetConfig` use public indexer v4 endpoints (`/api/v4/graphql` + `/ws`).
+- `MainnetConfig` defaults to local proof server (`http://127.0.0.1:6300`) so it can be used with local proving while targeting mainnet indexer/node.
+- constructing any profile config calls `setNetworkId()` through `applyMidnightNetworkProfile()`, so wallet and contract operations see the correct Midnight network before they start.
+
+You can still override `MainnetConfig` endpoints explicitly when needed. New
+tooling should use `ProfileConfig` when the profile name is data-driven rather
+than hard-coded in a class constructor. Every `ProfileConfig` instance exposes
+the resolved `profileName` so logs and operator tooling can report the active
+profile without inferring it from URLs.
+
+## Network Mapping Helpers
+
+Use the typed mapping helpers when converting between Midnight runtime network
+ids and DID-domain network names:
+
+- `RuntimeToDomain.NetworkMap`: maps runtime `NetworkId` values to DID-domain
+  `MidnightNetwork` values.
+- `DomainToRuntime.NetworkMap`: maps DID-domain `MidnightNetwork` values back
+  to runtime `NetworkId` values.
+- `RuntimeToDomainNetworkMap` and `DomainToRuntimeNetworkMap`: readonly public
+  type aliases exported from the package barrel for downstream configuration
+  and test helpers.
+
+The older `NetworkMapping` export is a compatibility alias for
+`RuntimeToDomain.NetworkMap`. New code should prefer the direction-specific
+helpers so map intent is visible at the call site.
+
+Provider adapters for proof, indexer, and ZK configuration are loaded lazily by
+`configureProviders()`. Importing the API package barrel for mapping helpers,
+types, or examples does not load those runtime adapters.
+
+## Release Artifact Metadata
+
+The package embeds ZK artifact locations for its own published version:
+
+```ts
+import {
+  MIDNIGHT_DID_API_VERSION,
+  createMidnightDidZkArtifactLocations,
+} from "@midnight-ntwrk/midnight-did-api";
+
+const locations = createMidnightDidZkArtifactLocations(MIDNIGHT_DID_API_VERSION);
+```
+
+Use `locations.ghcr.reference` to pull the matching GHCR OCI artifact in Node or
+CI tooling. RC and final release versions also include
+`locations.githubRelease.archiveUrl`; snapshot versions publish workflow
+artifacts and GHCR artifacts only, so `locations.githubRelease` is `null`.
+
+When the ZK bundle is unpacked outside the installed package, set
+`MIDNIGHT_DID_ZK_CONFIG_PATH` to the directory containing `manifest.json`,
+`keys/`, and `zkir/` before importing `@midnight-ntwrk/midnight-did-api`.
+Without this override, the API uses the managed artifacts bundled with the
+installed contract package when available.
+
+`setLogger()` is optional for embedders. Until it is called, API helpers use a
+no-op logger so wallet/provider setup can run in minimal scripts without
+preconfiguring logging.
+
+## Main Source Files
+
+- `src/index.ts`
+- `src/lib.ts` public compatibility facade
+- `src/config-profiles.ts` network profile catalog and network-id application
+- `src/deploy.ts` contract deployment, join, and private-state initialization
+- `src/providers.ts` provider composition for DID runtime dependencies
+- `src/private-state-storage.ts` private-state storage account/password wiring
+- `src/transaction-intents.ts` manual unshielded intent signing workaround
+- `src/wallet-context.ts` SDK wallet construction and restore context assembly
+- `src/wallet-dust.ts` dust-registration workflow helper
+- `src/wallet-provider.ts` wallet facade to Midnight wallet/provider adapter
+- `src/wallet-state.ts` wallet snapshot, sync, balance, and funding wait helpers
+- `src/wallet.ts` wallet construction and restore facade
+- `src/wallet-keys.ts` seed parsing, HD key derivation, and unshielded address helpers
+- `src/wallet-sdk-config.ts` shared wallet SDK configuration builders
+- `src/lightweight.ts` stateless crypto helpers only; wallet wait behavior lives
+  in `src/wallet-state.ts`
+- `src/did-subject.ts` DID subject and bound fragment normalization
+- `src/ledger-mappers.ts` DID document domain-to-ledger DTO mapping helpers
+- `src/update.ts` DID document update, deactivate, and resolve orchestration
+- `src/types.ts`
+- `src/test/`
+
+Type-safety policy:
+
+- production API source must not use `as any` casts
+- `as unknown as` casts must be explicitly allowlisted in
+  `pnpm run check:did-surface-discipline`
+- keep SDK type mismatches localized behind narrow adapter helpers and update
+  the surface-discipline guard when an intentional compatibility escape hatch is
+  unavoidable
+
+Legacy deep source files `src/contract-lifecycle.ts` and `src/did-operations.ts`
+remain as short-lived deprecation shims for external deep source-path imports.
+Internal code should use the split modules above, and package consumers should
+import from `@midnight-ntwrk/midnight-did-api`.
+
+## Deploy And Update Example
+
+See `examples/README.md`, `examples/deploy-did.ts`, and
+`examples/update-did.ts` for package-local deploy/update flows that use only API
+package exports. Resolver services, DID manager UI, and reusable secret storage
+stay in `midnight-did-resolver`.
+
+## Integration Teardown
+
+`packages/api/src/test/commons.ts` now uses:
+
+- unique compose project names per run
+- `env.down({ removeVolumes: true })`
+- fallback `docker compose down --volumes --remove-orphans`
+
+This reduces container/volume leaks when tests fail mid-run.

package/dist/api-logger.d.ts

@@ -0,0 +1,3 @@
+import { type Logger } from "pino";
+export declare const getLogger: () => Logger;
+export declare function setLogger(_logger: Logger): void;

package/dist/api-logger.js

@@ -0,0 +1,8 @@
+import pino from "pino";
+const defaultLogger = pino({ level: "silent" });
+let logger = defaultLogger;
+export const getLogger = () => logger;
+export function setLogger(_logger) {
+    logger = _logger;
+}
+//# sourceMappingURL=api-logger.js.map

package/dist/api-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-logger.js","sourceRoot":"","sources":["../src/api-logger.ts"],"names":[],"mappings":"AAAA,OAAO,IAAqB,MAAM,MAAM,CAAC;AAEzC,MAAM,aAAa,GAAW,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAExD,IAAI,MAAM,GAAW,aAAa,CAAC;AAEnC,MAAM,CAAC,MAAM,SAAS,GAAG,GAAW,EAAE,CAAC,MAAM,CAAC;AAE9C,MAAM,UAAU,SAAS,CAAC,OAAe;IACvC,MAAM,GAAG,OAAO,CAAC;AACnB,CAAC"}

package/dist/browser.d.ts

@@ -0,0 +1,6 @@
+export { DomainToRuntime } from "./domain-to-runtime.js";
+export { randomBytes } from "./lightweight.js";
+export type { DomainToRuntimeNetworkMap, RuntimeToDomainNetworkMap, } from "./network-mapping.js";
+export * from "./release-artifacts.js";
+export { RuntimeToDomain } from "./runtime-to-domain.js";
+export { parseSeed } from "./seed.js";

package/dist/browser.js

@@ -0,0 +1,6 @@
+export { DomainToRuntime } from "./domain-to-runtime.js";
+export { randomBytes } from "./lightweight.js";
+export * from "./release-artifacts.js";
+export { RuntimeToDomain } from "./runtime-to-domain.js";
+export { parseSeed } from "./seed.js";
+//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAK/C,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC"}

package/dist/config-profiles.d.ts

@@ -0,0 +1,75 @@
+import { type NetworkId } from "@midnight-ntwrk/midnight-js-network-id";
+export interface MidnightEndpointConfig {
+    readonly indexer: string;
+    readonly indexerWS: string;
+    readonly node: string;
+    readonly proofServer: string;
+}
+export type MidnightEndpointOverrides = Partial<MidnightEndpointConfig>;
+export interface MidnightNetworkProfile {
+    readonly name: string;
+    readonly networkId: NetworkId;
+    readonly endpoints: MidnightEndpointConfig;
+}
+export declare const MIDNIGHT_NETWORK_PROFILES: {
+    readonly "testnet-local": {
+        readonly name: "testnet-local";
+        readonly networkId: "testnet";
+        readonly endpoints: {
+            readonly indexer: "http://127.0.0.1:8088/api/v3/graphql";
+            readonly indexerWS: "ws://127.0.0.1:8088/api/v3/graphql/ws";
+            readonly node: "http://127.0.0.1:9944";
+            readonly proofServer: "http://127.0.0.1:6300";
+        };
+    };
+    readonly standalone: {
+        readonly name: "standalone";
+        readonly networkId: "undeployed";
+        readonly endpoints: {
+            readonly indexer: "http://127.0.0.1:8088/api/v3/graphql";
+            readonly indexerWS: "ws://127.0.0.1:8088/api/v3/graphql/ws";
+            readonly node: "http://127.0.0.1:9944";
+            readonly proofServer: "http://127.0.0.1:6300";
+        };
+    };
+    readonly "testnet-remote": {
+        readonly name: "testnet-remote";
+        readonly networkId: "testnet";
+        readonly endpoints: {
+            readonly indexer: "https://indexer.testnet-02.midnight.network/api/v3/graphql";
+            readonly indexerWS: "wss://indexer.testnet-02.midnight.network/api/v3/graphql/ws";
+            readonly node: "https://rpc.testnet-02.midnight.network";
+            readonly proofServer: "http://127.0.0.1:6300";
+        };
+    };
+    readonly preprod: {
+        readonly name: "preprod";
+        readonly networkId: "preprod";
+        readonly endpoints: {
+            readonly indexer: "https://indexer.preprod.midnight.network/api/v4/graphql";
+            readonly indexerWS: "wss://indexer.preprod.midnight.network/api/v4/graphql/ws";
+            readonly node: "https://rpc.preprod.midnight.network";
+            readonly proofServer: "http://127.0.0.1:6300";
+        };
+    };
+    readonly mainnet: {
+        readonly name: "mainnet";
+        readonly networkId: "mainnet";
+        readonly endpoints: {
+            readonly indexer: "https://indexer.mainnet.midnight.network/api/v4/graphql";
+            readonly indexerWS: "wss://indexer.mainnet.midnight.network/api/v4/graphql/ws";
+            readonly node: "https://rpc.mainnet.midnight.network";
+            readonly proofServer: "http://127.0.0.1:6300";
+        };
+    };
+};
+export type MidnightNetworkProfileName = keyof typeof MIDNIGHT_NETWORK_PROFILES;
+export interface ResolvedMidnightNetworkConfig extends MidnightEndpointConfig {
+    readonly logDir: string;
+    readonly midnightDbName: string;
+}
+export declare const MIDNIGHT_NETWORK_PROFILE_NAMES: MidnightNetworkProfileName[];
+export declare const isMidnightNetworkProfileName: (profileName: string) => profileName is MidnightNetworkProfileName;
+export declare const getMidnightNetworkProfile: (profileName: string) => MidnightNetworkProfile;
+export declare const applyMidnightNetworkProfile: (profileName: MidnightNetworkProfileName) => void;
+export declare const resolveMidnightNetworkConfig: (currentDir: string, profileName: MidnightNetworkProfileName, endpointOverrides?: MidnightEndpointOverrides, now?: Date) => ResolvedMidnightNetworkConfig;

package/dist/config-profiles.js

@@ -0,0 +1,75 @@
+import path from "node:path";
+import { setNetworkId, } from "@midnight-ntwrk/midnight-js-network-id";
+export const MIDNIGHT_NETWORK_PROFILES = {
+    "testnet-local": {
+        name: "testnet-local",
+        networkId: "testnet",
+        endpoints: {
+            indexer: "http://127.0.0.1:8088/api/v3/graphql",
+            indexerWS: "ws://127.0.0.1:8088/api/v3/graphql/ws",
+            node: "http://127.0.0.1:9944",
+            proofServer: "http://127.0.0.1:6300",
+        },
+    },
+    standalone: {
+        name: "standalone",
+        networkId: "undeployed",
+        endpoints: {
+            indexer: "http://127.0.0.1:8088/api/v3/graphql",
+            indexerWS: "ws://127.0.0.1:8088/api/v3/graphql/ws",
+            node: "http://127.0.0.1:9944",
+            proofServer: "http://127.0.0.1:6300",
+        },
+    },
+    "testnet-remote": {
+        name: "testnet-remote",
+        networkId: "testnet",
+        endpoints: {
+            indexer: "https://indexer.testnet-02.midnight.network/api/v3/graphql",
+            indexerWS: "wss://indexer.testnet-02.midnight.network/api/v3/graphql/ws",
+            node: "https://rpc.testnet-02.midnight.network",
+            proofServer: "http://127.0.0.1:6300",
+        },
+    },
+    preprod: {
+        name: "preprod",
+        networkId: "preprod",
+        endpoints: {
+            indexer: "https://indexer.preprod.midnight.network/api/v4/graphql",
+            indexerWS: "wss://indexer.preprod.midnight.network/api/v4/graphql/ws",
+            node: "https://rpc.preprod.midnight.network",
+            proofServer: "http://127.0.0.1:6300",
+        },
+    },
+    mainnet: {
+        name: "mainnet",
+        networkId: "mainnet",
+        endpoints: {
+            indexer: "https://indexer.mainnet.midnight.network/api/v4/graphql",
+            indexerWS: "wss://indexer.mainnet.midnight.network/api/v4/graphql/ws",
+            node: "https://rpc.mainnet.midnight.network",
+            proofServer: "http://127.0.0.1:6300",
+        },
+    },
+};
+export const MIDNIGHT_NETWORK_PROFILE_NAMES = Object.keys(MIDNIGHT_NETWORK_PROFILES);
+export const isMidnightNetworkProfileName = (profileName) => profileName in MIDNIGHT_NETWORK_PROFILES;
+export const getMidnightNetworkProfile = (profileName) => {
+    if (!isMidnightNetworkProfileName(profileName)) {
+        throw new Error(`Unknown Midnight network profile "${profileName}". Expected one of: ${MIDNIGHT_NETWORK_PROFILE_NAMES.join(", ")}.`);
+    }
+    return MIDNIGHT_NETWORK_PROFILES[profileName];
+};
+export const applyMidnightNetworkProfile = (profileName) => {
+    setNetworkId(getMidnightNetworkProfile(profileName).networkId);
+};
+export const resolveMidnightNetworkConfig = (currentDir, profileName, endpointOverrides = {}, now = new Date()) => {
+    const profile = getMidnightNetworkProfile(profileName);
+    return {
+        ...profile.endpoints,
+        ...endpointOverrides,
+        logDir: path.resolve(currentDir, "logs", profile.name, `${now.toISOString()}.log`),
+        midnightDbName: path.resolve(currentDir, ".midnight-db", profile.name),
+    };
+};
+//# sourceMappingURL=config-profiles.js.map

package/dist/config-profiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-profiles.js","sourceRoot":"","sources":["../src/config-profiles.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAEL,YAAY,GACb,MAAM,wCAAwC,CAAC;AAiBhD,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,eAAe,EAAE;QACf,IAAI,EAAE,eAAe;QACrB,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE;YACT,OAAO,EAAE,sCAAsC;YAC/C,SAAS,EAAE,uCAAuC;YAClD,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EAAE,uBAAuB;SACrC;KACF;IACD,UAAU,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,SAAS,EAAE,YAAY;QACvB,SAAS,EAAE;YACT,OAAO,EAAE,sCAAsC;YAC/C,SAAS,EAAE,uCAAuC;YAClD,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EAAE,uBAAuB;SACrC;KACF;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE;YACT,OAAO,EAAE,4DAA4D;YACrE,SAAS,EAAE,6DAA6D;YACxE,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,uBAAuB;SACrC;KACF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE;YACT,OAAO,EAAE,yDAAyD;YAClE,SAAS,EAAE,0DAA0D;YACrE,IAAI,EAAE,sCAAsC;YAC5C,WAAW,EAAE,uBAAuB;SACrC;KACF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE;YACT,OAAO,EAAE,yDAAyD;YAClE,SAAS,EAAE,0DAA0D;YACrE,IAAI,EAAE,sCAAsC;YAC5C,WAAW,EAAE,uBAAuB;SACrC;KACF;CACwD,CAAC;AAS5D,MAAM,CAAC,MAAM,8BAA8B,GAAG,MAAM,CAAC,IAAI,CACvD,yBAAyB,CACM,CAAC;AAElC,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,WAAmB,EACwB,EAAE,CAC7C,WAAW,IAAI,yBAAyB,CAAC;AAE3C,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,WAAmB,EACK,EAAE;IAC1B,IAAI,CAAC,4BAA4B,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CACb,qCAAqC,WAAW,uBAAuB,8BAA8B,CAAC,IAAI,CACxG,IAAI,CACL,GAAG,CACL,CAAC;IACJ,CAAC;IAED,OAAO,yBAAyB,CAAC,WAAW,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,WAAuC,EACjC,EAAE;IACR,YAAY,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,UAAkB,EAClB,WAAuC,EACvC,oBAA+C,EAAE,EACjD,MAAY,IAAI,IAAI,EAAE,EACS,EAAE;IACjC,MAAM,OAAO,GAAG,yBAAyB,CAAC,WAAW,CAAC,CAAC;IAEvD,OAAO;QACL,GAAG,OAAO,CAAC,SAAS;QACpB,GAAG,iBAAiB;QACpB,MAAM,EAAE,IAAI,CAAC,OAAO,CAClB,UAAU,EACV,MAAM,EACN,OAAO,CAAC,IAAI,EACZ,GAAG,GAAG,CAAC,WAAW,EAAE,MAAM,CAC3B;QACD,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,CAAC,IAAI,CAAC;KACvE,CAAC;AACJ,CAAC,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,37 @@
+import { type MidnightEndpointOverrides, type MidnightNetworkProfileName } from "./config-profiles.js";
+import { contractConfig, currentDir } from "./package-paths.js";
+export { applyMidnightNetworkProfile, getMidnightNetworkProfile, isMidnightNetworkProfileName, MIDNIGHT_NETWORK_PROFILE_NAMES, MIDNIGHT_NETWORK_PROFILES, type MidnightEndpointConfig, type MidnightEndpointOverrides, type MidnightNetworkProfile, type MidnightNetworkProfileName, type ResolvedMidnightNetworkConfig, resolveMidnightNetworkConfig, } from "./config-profiles.js";
+export { contractConfig, currentDir };
+export interface Config {
+    readonly logDir: string;
+    readonly indexer: string;
+    readonly indexerWS: string;
+    readonly node: string;
+    readonly proofServer: string;
+    readonly midnightDbName?: string;
+}
+export declare class ProfileConfig implements Config {
+    readonly profileName: MidnightNetworkProfileName;
+    readonly logDir: string;
+    readonly indexer: string;
+    readonly indexerWS: string;
+    readonly node: string;
+    readonly proofServer: string;
+    readonly midnightDbName: string;
+    constructor(profileName: MidnightNetworkProfileName, endpointOverrides?: MidnightEndpointOverrides);
+}
+export declare class TestnetLocalConfig extends ProfileConfig {
+    constructor();
+}
+export declare class StandaloneConfig extends ProfileConfig {
+    constructor();
+}
+export declare class TestnetRemoteConfig extends ProfileConfig {
+    constructor();
+}
+export declare class PreprodConfig extends ProfileConfig {
+    constructor();
+}
+export declare class MainnetConfig extends ProfileConfig {
+    constructor(input?: MidnightEndpointOverrides);
+}