cantonjs-splice-validator 0.3.0

package/README.md

@@ -0,0 +1,143 @@
+# cantonjs-splice-validator
+
+Validator-facing Splice clients layered on top of `cantonjs`.
+
+This package ships three surfaces:
+
+- `createAnsClient()` for the GA `ans-external` API.
+- `createScanProxyClient()` for a carefully filtered GA subset of `scan-proxy` whose underlying Scan semantics are tagged `external` in the vendored Scan spec.
+- `createLegacyWalletClient()` for `wallet-external` compatibility flows that remain useful for existing transfer-offer and buy-traffic integrations.
+
+`validator-internal` is intentionally excluded from this package.
+
+## Status
+
+- **GA:** `createAnsClient()` and the filtered `createScanProxyClient()` surface on the Splice `0.5.x` line
+- **Legacy compatibility:** `createLegacyWalletClient()` for existing `wallet-external` integrations only
+- **Experimental:** `cantonjs-splice-validator/experimental`, pinned to `vendor/splice/0.5.17` and outside the GA promise
+
+## Install
+
+```bash
+npm install cantonjs cantonjs-splice-validator
+```
+
+## Package Policy
+
+- Generated low-level types are committed in `src/generated/*.types.ts`.
+- The GA validator surface is limited to ANS external plus the filtered Scan Proxy wrapper.
+- Proxy operations backed by internal, deprecated, or pre-alpha Scan semantics are intentionally excluded from the main client.
+- `legacyWallet` is a legacy compatibility surface. For new transfer flows, prefer Token Standard integrations instead of `wallet-external`.
+- The package is documented against the Splice `0.5.x` line, with vendored inputs currently pinned to `0.5.17`.
+
+## Experimental APIs
+
+> [!WARNING]
+> Experimental Validator imports are pinned to `vendor/splice/0.5.17`.
+> They may break on any upstream release. Import them only from `cantonjs-splice-validator/experimental`.
+
+The experimental subpath isolates two unstable upstream surfaces:
+
+- `createExperimentalValidatorInternalClient()` for the vendored `validator-internal.yaml` surface.
+- `createExperimentalScanProxyClient()` for `scan-proxy` routes whose backing Scan semantics are tagged `internal` in the vendored `scan.yaml`.
+
+```ts
+import {
+  createExperimentalScanProxyClient,
+  createExperimentalValidatorInternalClient,
+} from 'cantonjs-splice-validator/experimental'
+
+const validatorInternal = createExperimentalValidatorInternalClient({
+  url: 'https://example.com/api/validator',
+  token: process.env.SPLICE_VALIDATOR_JWT,
+})
+
+const experimentalScanProxy = createExperimentalScanProxyClient({
+  url: 'https://example.com/api/validator',
+  token: process.env.SPLICE_VALIDATOR_JWT,
+})
+
+const operator = await validatorInternal.getValidatorUserInfo()
+const featured = await experimentalScanProxy.lookupFeaturedAppRight({
+  provider_party_id: 'Alice::validator',
+})
+```
+
+The stable `cantonjs-splice-validator` entrypoint intentionally continues to omit these APIs.
+
+## Quick Start
+
+```ts
+import {
+  createAnsClient,
+  createScanProxyClient,
+} from 'cantonjs-splice-validator'
+
+const ans = createAnsClient({
+  url: 'https://example.com/api/validator',
+  token: process.env.SPLICE_VALIDATOR_JWT,
+})
+
+const scanProxy = createScanProxyClient({
+  url: 'https://example.com/api/validator',
+  token: process.env.SPLICE_VALIDATOR_JWT,
+})
+
+const created = await ans.createAnsEntry({
+  name: 'app.unverified.ans',
+  url: 'https://app.example.com',
+  description: 'Validator app',
+})
+
+const entries = await ans.listAnsEntries()
+const dso = await scanProxy.getDsoInfo()
+const namedEntry = await scanProxy.lookupAnsEntryByName({ name: 'app.ans' })
+```
+
+## GA Scan Proxy Surface
+
+`createScanProxyClient()` exposes only the proxy operations whose underlying Scan operations are tagged `external` in the vendored `scan.yaml`:
+
+- `getDsoPartyId`
+- `getDsoInfo`
+- `getOpenAndIssuingMiningRounds`
+- `listAnsEntries`
+- `lookupAnsEntryByParty`
+- `lookupAnsEntryByName`
+- `getHoldingsSummaryAt`
+- `listUnclaimedDevelopmentFundCoupons`
+
+Validator-local proxy methods backed by internal Scan semantics, such as featured-app lookups, amulet rules, ANS rules, and transfer-command proxying, are intentionally left out.
+
+## Legacy Wallet Compatibility
+
+`createLegacyWalletClient()` is a legacy/deprecated-oriented compatibility wrapper for `wallet-external`, especially the transfer-offer flow that predates Token Standard-first integration.
+
+Use a clearly named `legacyWallet` client so the callsites stay obviously separate from the GA validator surface:
+
+```ts
+import { createLegacyWalletClient } from 'cantonjs-splice-validator'
+
+const legacyWallet = createLegacyWalletClient({
+  url: 'https://example.com/api/validator',
+  token: process.env.SPLICE_VALIDATOR_JWT,
+})
+
+const offer = await legacyWallet.createTransferOffer({
+  receiver_party_id: 'Receiver::validator',
+  amount: '10.0',
+  description: 'Legacy transfer offer',
+  expires_at: 1_780_000_000_000_000,
+  tracking_id: 'offer-123',
+})
+
+const status = await legacyWallet.lookupTransferOfferStatus({
+  tracking_id: 'offer-123',
+})
+```
+
+For new transfer flows, prefer Token Standard surfaces. Reach for `legacyWallet` only when you need compatibility with existing `wallet-external` workflows.
+
+## License
+
+[Apache-2.0](https://github.com/merged-one/cantonjs/blob/main/LICENSE)

package/dist/createAnsClient.d.ts

@@ -0,0 +1,33 @@
+import { type TransportConfig } from 'cantonjs';
+import type { components, operations } from './generated/ans.types.js';
+type OperationName = keyof operations;
+type JsonResponse<TName extends OperationName> = operations[TName] extends {
+    responses: {
+        200: {
+            content: {
+                'application/json': infer T;
+            };
+        };
+    };
+} ? T : never;
+type JsonRequestBody<TName extends OperationName> = operations[TName] extends {
+    requestBody: {
+        content: {
+            'application/json': infer T;
+        };
+    };
+} ? T : never;
+export type AnsClientConfig = TransportConfig;
+export type AnsRequestOptions = {
+    readonly signal?: AbortSignal;
+};
+export type AnsEntry = components['schemas']['AnsEntryResponse'];
+export type AnsCreateEntryRequest = JsonRequestBody<'createAnsEntry'>;
+export type AnsCreateEntryResponse = JsonResponse<'createAnsEntry'>;
+export type AnsListEntriesResponse = JsonResponse<'listAnsEntries'>;
+export type AnsClient = {
+    createAnsEntry: (request: AnsCreateEntryRequest, options?: AnsRequestOptions) => Promise<AnsCreateEntryResponse>;
+    listAnsEntries: (options?: AnsRequestOptions) => Promise<AnsListEntriesResponse>;
+};
+export declare function createAnsClient(config: AnsClientConfig): AnsClient;
+export {};

package/dist/createAnsClient.js

@@ -0,0 +1,22 @@
+import { jsonApi } from 'cantonjs';
+export function createAnsClient(config) {
+    const transport = jsonApi(config);
+    return {
+        async createAnsEntry(request, options) {
+            return await transport.request({
+                method: 'POST',
+                path: '/v0/entry/create',
+                body: request,
+                signal: options?.signal,
+            });
+        },
+        async listAnsEntries(options) {
+            return await transport.request({
+                method: 'GET',
+                path: '/v0/entry/all',
+                signal: options?.signal,
+            });
+        },
+    };
+}
+//# sourceMappingURL=createAnsClient.js.map

package/dist/createAnsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createAnsClient.js","sourceRoot":"","sources":["../src/createAnsClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,MAAM,UAAU,CAAA;AAkCxD,MAAM,UAAU,eAAe,CAAC,MAAuB;IACrD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEjC,OAAO;QACL,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO;YACnC,OAAO,MAAM,SAAS,CAAC,OAAO,CAAyB;gBACrD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,cAAc,CAAC,OAAO;YAC1B,OAAO,MAAM,SAAS,CAAC,OAAO,CAAyB;gBACrD,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;KACF,CAAA;AACH,CAAC"}

package/dist/createLegacyWalletClient.d.ts

@@ -0,0 +1,51 @@
+import { type TransportConfig } from 'cantonjs';
+import type { components, operations } from './generated/walletExternal.types.js';
+type OperationName = keyof operations;
+type JsonResponse<TName extends OperationName> = operations[TName] extends {
+    responses: {
+        200: {
+            content: {
+                'application/json': infer T;
+            };
+        };
+    };
+} ? T : never;
+type JsonRequestBody<TName extends OperationName> = operations[TName] extends {
+    requestBody: {
+        content: {
+            'application/json': infer T;
+        };
+    };
+} ? T : never;
+type PathParameters<TName extends OperationName> = operations[TName] extends {
+    parameters: {
+        path?: infer T;
+    };
+} ? T : never;
+export type LegacyWalletClientConfig = TransportConfig;
+export type LegacyWalletRequestOptions = {
+    readonly signal?: AbortSignal;
+};
+export type LegacyWalletTransferOffer = components['schemas']['Contract'];
+export type LegacyWalletCreateTransferOfferRequest = JsonRequestBody<'createTransferOffer'>;
+export type LegacyWalletCreateTransferOfferResponse = JsonResponse<'createTransferOffer'>;
+export type LegacyWalletListTransferOffersResponse = JsonResponse<'listTransferOffers'>;
+export type LegacyWalletGetTransferOfferStatusRequest = PathParameters<'getTransferOfferStatus'>;
+export type LegacyWalletTransferOfferStatusResponse = JsonResponse<'getTransferOfferStatus'>;
+export type LegacyWalletTransferOfferStatus = LegacyWalletTransferOfferStatusResponse['status'];
+export type LegacyWalletCreateBuyTrafficRequest = JsonRequestBody<'createBuyTrafficRequest'>;
+export type LegacyWalletCreateBuyTrafficRequestResponse = JsonResponse<'createBuyTrafficRequest'>;
+export type LegacyWalletGetBuyTrafficRequestStatusRequest = PathParameters<'getBuyTrafficRequestStatus'>;
+export type LegacyWalletBuyTrafficRequestStatusResponse = JsonResponse<'getBuyTrafficRequestStatus'>;
+export type LegacyWalletBuyTrafficRequestStatus = LegacyWalletBuyTrafficRequestStatusResponse['status'];
+export type LegacyWalletClient = {
+    createTransferOffer: (request: LegacyWalletCreateTransferOfferRequest, options?: LegacyWalletRequestOptions) => Promise<LegacyWalletCreateTransferOfferResponse>;
+    listTransferOffers: (options?: LegacyWalletRequestOptions) => Promise<LegacyWalletListTransferOffersResponse>;
+    getTransferOfferStatus: (request: LegacyWalletGetTransferOfferStatusRequest, options?: LegacyWalletRequestOptions) => Promise<LegacyWalletTransferOfferStatusResponse>;
+    lookupTransferOfferStatus: (request: LegacyWalletGetTransferOfferStatusRequest, options?: LegacyWalletRequestOptions) => Promise<LegacyWalletTransferOfferStatusResponse | undefined>;
+    createBuyTrafficRequest: (request: LegacyWalletCreateBuyTrafficRequest, options?: LegacyWalletRequestOptions) => Promise<LegacyWalletCreateBuyTrafficRequestResponse>;
+    getBuyTrafficRequestStatus: (request: LegacyWalletGetBuyTrafficRequestStatusRequest, options?: LegacyWalletRequestOptions) => Promise<LegacyWalletBuyTrafficRequestStatusResponse>;
+    lookupBuyTrafficRequestStatus: (request: LegacyWalletGetBuyTrafficRequestStatusRequest, options?: LegacyWalletRequestOptions) => Promise<LegacyWalletBuyTrafficRequestStatusResponse | undefined>;
+};
+export declare function createLegacyWalletClient(config: LegacyWalletClientConfig): LegacyWalletClient;
+export {};

package/dist/createLegacyWalletClient.js

@@ -0,0 +1,81 @@
+import { jsonApi } from 'cantonjs';
+export function createLegacyWalletClient(config) {
+    const transport = jsonApi(config);
+    return {
+        async createTransferOffer(request, options) {
+            return await transport.request({
+                method: 'POST',
+                path: '/v0/wallet/transfer-offers',
+                body: request,
+                signal: options?.signal,
+            });
+        },
+        async listTransferOffers(options) {
+            return await transport.request({
+                method: 'GET',
+                path: '/v0/wallet/transfer-offers',
+                signal: options?.signal,
+            });
+        },
+        async getTransferOfferStatus(request, options) {
+            return await transport.request({
+                method: 'POST',
+                path: buildPath('/v0/wallet/transfer-offers/{tracking_id}/status', request),
+                signal: options?.signal,
+            });
+        },
+        async lookupTransferOfferStatus(request, options) {
+            try {
+                return await this.getTransferOfferStatus(request, options);
+            }
+            catch (error) {
+                if (isNotFoundHttpError(error)) {
+                    return undefined;
+                }
+                throw error;
+            }
+        },
+        async createBuyTrafficRequest(request, options) {
+            return await transport.request({
+                method: 'POST',
+                path: '/v0/wallet/buy-traffic-requests',
+                body: request,
+                signal: options?.signal,
+            });
+        },
+        async getBuyTrafficRequestStatus(request, options) {
+            return await transport.request({
+                method: 'POST',
+                path: buildPath('/v0/wallet/buy-traffic-requests/{tracking_id}/status', request),
+                signal: options?.signal,
+            });
+        },
+        async lookupBuyTrafficRequestStatus(request, options) {
+            try {
+                return await this.getBuyTrafficRequestStatus(request, options);
+            }
+            catch (error) {
+                if (isNotFoundHttpError(error)) {
+                    return undefined;
+                }
+                throw error;
+            }
+        },
+    };
+}
+function buildPath(pathTemplate, pathParams) {
+    return pathTemplate.replace(/\{([^}]+)\}/g, (_match, key) => {
+        const value = pathParams[key];
+        if (value === undefined) {
+            throw new Error(`Missing required legacy wallet path parameter: ${key}`);
+        }
+        return encodeURIComponent(String(value));
+    });
+}
+function isNotFoundHttpError(error) {
+    const candidate = typeof error === 'object' && error !== null
+        ? error
+        : undefined;
+    return candidate?.name === 'HttpError' && candidate.status === 404;
+}
+//# sourceMappingURL=createLegacyWalletClient.js.map

package/dist/createLegacyWalletClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createLegacyWalletClient.js","sourceRoot":"","sources":["../src/createLegacyWalletClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,MAAM,UAAU,CAAA;AAwExD,MAAM,UAAU,wBAAwB,CACtC,MAAgC;IAEhC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEjC,OAAO;QACL,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO;YACxC,OAAO,MAAM,SAAS,CAAC,OAAO,CAA0C;gBACtE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,4BAA4B;gBAClC,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,kBAAkB,CAAC,OAAO;YAC9B,OAAO,MAAM,SAAS,CAAC,OAAO,CAAyC;gBACrE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,4BAA4B;gBAClC,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,sBAAsB,CAAC,OAAO,EAAE,OAAO;YAC3C,OAAO,MAAM,SAAS,CAAC,OAAO,CAA0C;gBACtE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,SAAS,CAAC,iDAAiD,EAAE,OAAO,CAAC;gBAC3E,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,yBAAyB,CAAC,OAAO,EAAE,OAAO;YAC9C,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAC5D,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC/B,OAAO,SAAS,CAAA;gBAClB,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;QAED,KAAK,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO;YAC5C,OAAO,MAAM,SAAS,CAAC,OAAO,CAA8C;gBAC1E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,iCAAiC;gBACvC,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,0BAA0B,CAAC,OAAO,EAAE,OAAO;YAC/C,OAAO,MAAM,SAAS,CAAC,OAAO,CAA8C;gBAC1E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,SAAS,CAAC,sDAAsD,EAAE,OAAO,CAAC;gBAChF,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,6BAA6B,CAAC,OAAO,EAAE,OAAO;YAClD,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,CAAC,0BAA0B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAChE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC/B,OAAO,SAAS,CAAA;gBAClB,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KACF,CAAA;AACH,CAAC;AAED,SAAS,SAAS,CAAC,YAAoB,EAAE,UAAgC;IACvE,OAAO,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,GAAW,EAAE,EAAE;QAClE,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAA;QAC7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,GAAG,EAAE,CAAC,CAAA;QAC1E,CAAC;QACD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAc;IACzC,MAAM,SAAS,GACb,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QACzC,CAAC,CAAE,KAA8C;QACjD,CAAC,CAAC,SAAS,CAAA;IAEf,OAAO,SAAS,EAAE,IAAI,KAAK,WAAW,IAAI,SAAS,CAAC,MAAM,KAAK,GAAG,CAAA;AACpE,CAAC"}

package/dist/createScanProxyClient.d.ts

@@ -0,0 +1,108 @@
+import { type TransportConfig } from 'cantonjs';
+import type { components, operations } from './generated/scanProxy.types.js';
+type OperationName = keyof operations;
+type JsonResponse<TName extends OperationName> = operations[TName] extends {
+    responses: {
+        200: {
+            content: {
+                'application/json': infer T;
+            };
+        };
+    };
+} ? T : never;
+type JsonRequestBody<TName extends OperationName> = operations[TName] extends {
+    requestBody: {
+        content: {
+            'application/json': infer T;
+        };
+    };
+} ? T : never;
+type QueryParameters<TName extends OperationName> = operations[TName] extends {
+    parameters: {
+        query?: infer T;
+    };
+} ? T : never;
+type PathParameters<TName extends OperationName> = operations[TName] extends {
+    parameters: {
+        path?: infer T;
+    };
+} ? T : never;
+export type ScanProxyClientConfig = TransportConfig;
+export type ScanProxyRequestOptions = {
+    readonly signal?: AbortSignal;
+};
+export type ScanProxyAnsEntry = components['schemas']['AnsEntry'];
+export type ScanProxyDsoPartyIdResponse = JsonResponse<'getDsoPartyId'>;
+export type ScanProxyDsoInfoResponse = JsonResponse<'getDsoInfo'>;
+export type ScanProxyOpenAndIssuingMiningRoundsResponse = JsonResponse<'getOpenAndIssuingMiningRounds'>;
+export type ScanProxyListAnsEntriesRequest = QueryParameters<'listAnsEntries'>;
+export type ScanProxyListAnsEntriesResponse = JsonResponse<'listAnsEntries'>;
+export type ScanProxyLookupAnsEntryByPartyRequest = PathParameters<'lookupAnsEntryByParty'>;
+export type ScanProxyLookupAnsEntryByPartyResponse = JsonResponse<'lookupAnsEntryByParty'>;
+export type ScanProxyLookupAnsEntryByNameRequest = PathParameters<'lookupAnsEntryByName'>;
+export type ScanProxyLookupAnsEntryByNameResponse = JsonResponse<'lookupAnsEntryByName'>;
+export type ScanProxyHoldingsSummaryRequest = JsonRequestBody<'getHoldingsSummaryAt'>;
+export type ScanProxyHoldingsSummaryResponse = JsonResponse<'getHoldingsSummaryAt'>;
+export type ScanProxyUnclaimedDevelopmentFundCouponsResponse = JsonResponse<'listUnclaimedDevelopmentFundCoupons'>;
+export declare const GA_SCAN_PROXY_OPERATIONS: readonly [{
+    readonly clientMethod: "getDsoPartyId";
+    readonly proxyOperationId: "getDsoPartyId";
+    readonly scanOperationId: "getDsoPartyId";
+    readonly method: "GET";
+    readonly path: "/v0/scan-proxy/dso-party-id";
+}, {
+    readonly clientMethod: "getDsoInfo";
+    readonly proxyOperationId: "getDsoInfo";
+    readonly scanOperationId: "getDsoInfo";
+    readonly method: "GET";
+    readonly path: "/v0/scan-proxy/dso";
+}, {
+    readonly clientMethod: "getOpenAndIssuingMiningRounds";
+    readonly proxyOperationId: "getOpenAndIssuingMiningRounds";
+    readonly scanOperationId: "getOpenAndIssuingMiningRounds";
+    readonly method: "GET";
+    readonly path: "/v0/scan-proxy/open-and-issuing-mining-rounds";
+}, {
+    readonly clientMethod: "lookupAnsEntryByParty";
+    readonly proxyOperationId: "lookupAnsEntryByParty";
+    readonly scanOperationId: "lookupAnsEntryByParty";
+    readonly method: "GET";
+    readonly path: "/v0/scan-proxy/ans-entries/by-party/{party}";
+}, {
+    readonly clientMethod: "listAnsEntries";
+    readonly proxyOperationId: "listAnsEntries";
+    readonly scanOperationId: "listAnsEntries";
+    readonly method: "GET";
+    readonly path: "/v0/scan-proxy/ans-entries";
+}, {
+    readonly clientMethod: "lookupAnsEntryByName";
+    readonly proxyOperationId: "lookupAnsEntryByName";
+    readonly scanOperationId: "lookupAnsEntryByName";
+    readonly method: "GET";
+    readonly path: "/v0/scan-proxy/ans-entries/by-name/{name}";
+}, {
+    readonly clientMethod: "getHoldingsSummaryAt";
+    readonly proxyOperationId: "getHoldingsSummaryAt";
+    readonly scanOperationId: "getHoldingsSummaryAt";
+    readonly method: "POST";
+    readonly path: "/v0/scan-proxy/holdings/summary";
+}, {
+    readonly clientMethod: "listUnclaimedDevelopmentFundCoupons";
+    readonly proxyOperationId: "listUnclaimedDevelopmentFundCoupons";
+    readonly scanOperationId: "listUnclaimedDevelopmentFundCoupons";
+    readonly method: "GET";
+    readonly path: "/v0/scan-proxy/unclaimed-development-fund-coupons";
+}];
+export type GaScanProxyOperation = (typeof GA_SCAN_PROXY_OPERATIONS)[number];
+export type ScanProxyClient = {
+    getDsoPartyId: (options?: ScanProxyRequestOptions) => Promise<ScanProxyDsoPartyIdResponse>;
+    getDsoInfo: (options?: ScanProxyRequestOptions) => Promise<ScanProxyDsoInfoResponse>;
+    getOpenAndIssuingMiningRounds: (options?: ScanProxyRequestOptions) => Promise<ScanProxyOpenAndIssuingMiningRoundsResponse>;
+    listAnsEntries: (request: ScanProxyListAnsEntriesRequest, options?: ScanProxyRequestOptions) => Promise<ScanProxyListAnsEntriesResponse>;
+    lookupAnsEntryByParty: (request: ScanProxyLookupAnsEntryByPartyRequest, options?: ScanProxyRequestOptions) => Promise<ScanProxyLookupAnsEntryByPartyResponse>;
+    lookupAnsEntryByName: (request: ScanProxyLookupAnsEntryByNameRequest, options?: ScanProxyRequestOptions) => Promise<ScanProxyLookupAnsEntryByNameResponse>;
+    getHoldingsSummaryAt: (request: ScanProxyHoldingsSummaryRequest, options?: ScanProxyRequestOptions) => Promise<ScanProxyHoldingsSummaryResponse>;
+    listUnclaimedDevelopmentFundCoupons: (options?: ScanProxyRequestOptions) => Promise<ScanProxyUnclaimedDevelopmentFundCouponsResponse>;
+};
+export declare function createScanProxyClient(config: ScanProxyClientConfig): ScanProxyClient;
+export {};

package/dist/createScanProxyClient.js

@@ -0,0 +1,161 @@
+import { jsonApi } from 'cantonjs';
+export const GA_SCAN_PROXY_OPERATIONS = [
+    {
+        clientMethod: 'getDsoPartyId',
+        proxyOperationId: 'getDsoPartyId',
+        scanOperationId: 'getDsoPartyId',
+        method: 'GET',
+        path: '/v0/scan-proxy/dso-party-id',
+    },
+    {
+        clientMethod: 'getDsoInfo',
+        proxyOperationId: 'getDsoInfo',
+        scanOperationId: 'getDsoInfo',
+        method: 'GET',
+        path: '/v0/scan-proxy/dso',
+    },
+    {
+        clientMethod: 'getOpenAndIssuingMiningRounds',
+        proxyOperationId: 'getOpenAndIssuingMiningRounds',
+        scanOperationId: 'getOpenAndIssuingMiningRounds',
+        method: 'GET',
+        path: '/v0/scan-proxy/open-and-issuing-mining-rounds',
+    },
+    {
+        clientMethod: 'lookupAnsEntryByParty',
+        proxyOperationId: 'lookupAnsEntryByParty',
+        scanOperationId: 'lookupAnsEntryByParty',
+        method: 'GET',
+        path: '/v0/scan-proxy/ans-entries/by-party/{party}',
+    },
+    {
+        clientMethod: 'listAnsEntries',
+        proxyOperationId: 'listAnsEntries',
+        scanOperationId: 'listAnsEntries',
+        method: 'GET',
+        path: '/v0/scan-proxy/ans-entries',
+    },
+    {
+        clientMethod: 'lookupAnsEntryByName',
+        proxyOperationId: 'lookupAnsEntryByName',
+        scanOperationId: 'lookupAnsEntryByName',
+        method: 'GET',
+        path: '/v0/scan-proxy/ans-entries/by-name/{name}',
+    },
+    {
+        clientMethod: 'getHoldingsSummaryAt',
+        proxyOperationId: 'getHoldingsSummaryAt',
+        scanOperationId: 'getHoldingsSummaryAt',
+        method: 'POST',
+        path: '/v0/scan-proxy/holdings/summary',
+    },
+    {
+        clientMethod: 'listUnclaimedDevelopmentFundCoupons',
+        proxyOperationId: 'listUnclaimedDevelopmentFundCoupons',
+        scanOperationId: 'listUnclaimedDevelopmentFundCoupons',
+        method: 'GET',
+        path: '/v0/scan-proxy/unclaimed-development-fund-coupons',
+    },
+];
+export function createScanProxyClient(config) {
+    const transport = jsonApi(config);
+    return {
+        async getDsoPartyId(options) {
+            return await transport.request({
+                method: 'GET',
+                path: '/v0/scan-proxy/dso-party-id',
+                signal: options?.signal,
+            });
+        },
+        async getDsoInfo(options) {
+            return await transport.request({
+                method: 'GET',
+                path: '/v0/scan-proxy/dso',
+                signal: options?.signal,
+            });
+        },
+        async getOpenAndIssuingMiningRounds(options) {
+            return await transport.request({
+                method: 'GET',
+                path: '/v0/scan-proxy/open-and-issuing-mining-rounds',
+                signal: options?.signal,
+            });
+        },
+        async listAnsEntries(request, options) {
+            return await transport.request({
+                method: 'GET',
+                path: buildRequestPath('/v0/scan-proxy/ans-entries', {
+                    query: request,
+                }),
+                signal: options?.signal,
+            });
+        },
+        async lookupAnsEntryByParty(request, options) {
+            return await transport.request({
+                method: 'GET',
+                path: buildRequestPath('/v0/scan-proxy/ans-entries/by-party/{party}', {
+                    pathParams: request,
+                }),
+                signal: options?.signal,
+            });
+        },
+        async lookupAnsEntryByName(request, options) {
+            return await transport.request({
+                method: 'GET',
+                path: buildRequestPath('/v0/scan-proxy/ans-entries/by-name/{name}', {
+                    pathParams: request,
+                }),
+                signal: options?.signal,
+            });
+        },
+        async getHoldingsSummaryAt(request, options) {
+            return await transport.request({
+                method: 'POST',
+                path: '/v0/scan-proxy/holdings/summary',
+                body: request,
+                signal: options?.signal,
+            });
+        },
+        async listUnclaimedDevelopmentFundCoupons(options) {
+            return await transport.request({
+                method: 'GET',
+                path: '/v0/scan-proxy/unclaimed-development-fund-coupons',
+                signal: options?.signal,
+            });
+        },
+    };
+}
+function buildRequestPath(pathTemplate, options) {
+    const path = interpolatePathParams(pathTemplate, options?.pathParams);
+    const queryString = buildQueryString(options?.query);
+    return queryString.length === 0 ? path : `${path}?${queryString}`;
+}
+function interpolatePathParams(pathTemplate, pathParams) {
+    return pathTemplate.replace(/\{([^}]+)\}/g, (_match, key) => {
+        const value = pathParams?.[key];
+        if (value === undefined) {
+            throw new Error(`Missing required Scan Proxy path parameter: ${key}`);
+        }
+        return encodeURIComponent(String(value));
+    });
+}
+function buildQueryString(query) {
+    if (query === undefined) {
+        return '';
+    }
+    const params = new URLSearchParams();
+    for (const [key, value] of Object.entries(query)) {
+        if (value === undefined || value === null) {
+            continue;
+        }
+        if (Array.isArray(value)) {
+            for (const item of value) {
+                params.append(key, String(item));
+            }
+            continue;
+        }
+        params.append(key, String(value));
+    }
+    return params.toString();
+}
+//# sourceMappingURL=createScanProxyClient.js.map

package/dist/createScanProxyClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createScanProxyClient.js","sourceRoot":"","sources":["../src/createScanProxyClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,MAAM,UAAU,CAAA;AAgDxD,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC;QACE,YAAY,EAAE,eAAe;QAC7B,gBAAgB,EAAE,eAAe;QACjC,eAAe,EAAE,eAAe;QAChC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,6BAA6B;KACpC;IACD;QACE,YAAY,EAAE,YAAY;QAC1B,gBAAgB,EAAE,YAAY;QAC9B,eAAe,EAAE,YAAY;QAC7B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,oBAAoB;KAC3B;IACD;QACE,YAAY,EAAE,+BAA+B;QAC7C,gBAAgB,EAAE,+BAA+B;QACjD,eAAe,EAAE,+BAA+B;QAChD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,+CAA+C;KACtD;IACD;QACE,YAAY,EAAE,uBAAuB;QACrC,gBAAgB,EAAE,uBAAuB;QACzC,eAAe,EAAE,uBAAuB;QACxC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,6CAA6C;KACpD;IACD;QACE,YAAY,EAAE,gBAAgB;QAC9B,gBAAgB,EAAE,gBAAgB;QAClC,eAAe,EAAE,gBAAgB;QACjC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,4BAA4B;KACnC;IACD;QACE,YAAY,EAAE,sBAAsB;QACpC,gBAAgB,EAAE,sBAAsB;QACxC,eAAe,EAAE,sBAAsB;QACvC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,2CAA2C;KAClD;IACD;QACE,YAAY,EAAE,sBAAsB;QACpC,gBAAgB,EAAE,sBAAsB;QACxC,eAAe,EAAE,sBAAsB;QACvC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,iCAAiC;KACxC;IACD;QACE,YAAY,EAAE,qCAAqC;QACnD,gBAAgB,EAAE,qCAAqC;QACvD,eAAe,EAAE,qCAAqC;QACtD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,mDAAmD;KAC1D;CACO,CAAA;AA+BV,MAAM,UAAU,qBAAqB,CAAC,MAA6B;IACjE,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEjC,OAAO;QACL,KAAK,CAAC,aAAa,CAAC,OAAO;YACzB,OAAO,MAAM,SAAS,CAAC,OAAO,CAA8B;gBAC1D,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,OAAO;YACtB,OAAO,MAAM,SAAS,CAAC,OAAO,CAA2B;gBACvD,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,oBAAoB;gBAC1B,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,6BAA6B,CAAC,OAAO;YACzC,OAAO,MAAM,SAAS,CAAC,OAAO,CAA8C;gBAC1E,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,+CAA+C;gBACrD,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO;YACnC,OAAO,MAAM,SAAS,CAAC,OAAO,CAAkC;gBAC9D,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gBAAgB,CAAC,4BAA4B,EAAE;oBACnD,KAAK,EAAE,OAAgC;iBACxC,CAAC;gBACF,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO;YAC1C,OAAO,MAAM,SAAS,CAAC,OAAO,CAAyC;gBACrE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gBAAgB,CAAC,6CAA6C,EAAE;oBACpE,UAAU,EAAE,OAA+B;iBAC5C,CAAC;gBACF,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO;YACzC,OAAO,MAAM,SAAS,CAAC,OAAO,CAAwC;gBACpE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gBAAgB,CAAC,2CAA2C,EAAE;oBAClE,UAAU,EAAE,OAA+B;iBAC5C,CAAC;gBACF,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO;YACzC,OAAO,MAAM,SAAS,CAAC,OAAO,CAAmC;gBAC/D,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,iCAAiC;gBACvC,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,mCAAmC,CAAC,OAAO;YAC/C,OAAO,MAAM,SAAS,CAAC,OAAO,CAAmD;gBAC/E,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,mDAAmD;gBACzD,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;KACF,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CACvB,YAAoB,EACpB,OAGC;IAED,MAAM,IAAI,GAAG,qBAAqB,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACrE,MAAM,WAAW,GAAG,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACpD,OAAO,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,WAAW,EAAE,CAAA;AACnE,CAAC;AAED,SAAS,qBAAqB,CAC5B,YAAoB,EACpB,UAAiC;IAEjC,OAAO,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,GAAW,EAAE,EAAE;QAClE,MAAM,KAAK,GAAG,UAAU,EAAE,CAAC,GAAG,CAAC,CAAA;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,+CAA+C,GAAG,EAAE,CAAC,CAAA;QACvE,CAAC;QACD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAA6B;IACrD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IAEpC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC1C,SAAQ;QACV,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;YAClC,CAAC;YACD,SAAQ;QACV,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACnC,CAAC;IAED,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC"}