@dfns/sdk 0.8.23 → 0.8.25

package/generated/networks/types.d.ts

@@ -38,7 +38,7 @@ export type CreateCantonValidatorBody = {
     kind: "Custom";
     /** Configuration to reach your validator Signing API. We will call the validator External Signing API at the url (and using the credentials) defined below ; for instance `$URL/api/validator/v0/admin/external-party/topology/generate`. See the underlying calls details [here](https://docs.dev.sync.global/app_dev/validator_api/index.html#validator-api-external-signing). */
     validator: {
-        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/environments)) */
+        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/regions)) */
         url: string;
         /** How Dfns will authenticate into your validator/ledger. You should have setup authentication already (see details [here](https://docs.dev.sync.global/validator_operator/validator_helm.html#helm-validator-auth)), you can reuse the same Application details. See examples in this endpoint payload examples above. */
         oauth2: {
@@ -56,7 +56,7 @@ export type CreateCantonValidatorBody = {
     };
     /** Configuration to reach your validator Ledger JSON API. We will call endpoints such as `/v2/state/ledger-end`, `/v2/state/active-contracts`, `/v2/parties/participant-id`, `/v2/interactive-submission/prepare`, `/v2/interactive-submission/execute`, `/v2/commands/completions`. See the underlying details [here](https://docs.dev.sync.global/app_dev/ledger_api/index.html). */
     ledger: {
-        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/environments)) */
+        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/regions)) */
         url: string;
         /** How Dfns will authenticate into your validator/ledger. You should have setup authentication already (see details [here](https://docs.dev.sync.global/validator_operator/validator_helm.html#helm-validator-auth)), you can reuse the same Application details. See examples in this endpoint payload examples above. */
         oauth2: {
@@ -132,7 +132,7 @@ export type GetCantonValidatorResponse = {
 };
 export type GetCantonValidatorRequest = GetCantonValidatorParams;
 export type GetFeesQuery = {
-    network: "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Base" | "BaseGoerli" | "BaseSepolia" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Ink" | "InkSepolia" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Sonic" | "SonicTestnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "Solana" | "SolanaDevnet";
+    network: "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "Litecoin" | "LitecoinTestnet" | "Dogecoin" | "DogecoinTestnet" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Base" | "BaseGoerli" | "BaseSepolia" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Ink" | "InkSepolia" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiPacific1" | "SeiAtlantic2" | "Sonic" | "SonicTestnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "Solana" | "SolanaDevnet";
 };
 export type GetFeesResponse = {
     kind: "Bitcoin";
@@ -158,7 +158,7 @@ export type GetFeesResponse = {
     };
 } | {
     kind: "Eip1559";
-    network: "Adi" | "AdiTestnet" | "AdiTestnetAb" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Base" | "BaseGoerli" | "BaseSepolia" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Ink" | "InkSepolia" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Sonic" | "SonicTestnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia";
+    network: "Adi" | "AdiTestnet" | "AdiTestnetAb" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Base" | "BaseGoerli" | "BaseSepolia" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Ink" | "InkSepolia" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiPacific1" | "SeiAtlantic2" | "Sonic" | "SonicTestnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia";
     blockNumber: number;
     slow: {
         /** Maximum priority fee (tip) per unit of gas, denominated in wei (the lowest denomination). */
@@ -235,7 +235,7 @@ export type UpdateCantonValidatorBody = {
     /** Nickname for this validator. */
     name?: string | undefined;
     validator?: {
-        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/environments)) */
+        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/regions)) */
         url: string;
         /** How Dfns will authenticate into your validator/ledger. You should have setup authentication already (see details [here](https://docs.dev.sync.global/validator_operator/validator_helm.html#helm-validator-auth)), you can reuse the same Application details. See examples in this endpoint payload examples above. */
         oauth2: {
@@ -252,7 +252,7 @@ export type UpdateCantonValidatorBody = {
         };
     } | undefined;
     ledger?: {
-        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/environments)) */
+        /** URL to reach the API at this address. The calls will be originating from our IP addresses (see [Dfns Environments](https://docs.dfns.co/api-reference/regions)) */
         url: string;
         /** How Dfns will authenticate into your validator/ledger. You should have setup authentication already (see details [here](https://docs.dev.sync.global/validator_operator/validator_helm.html#helm-validator-auth)), you can reuse the same Application details. See examples in this endpoint payload examples above. */
         oauth2: {

package/generated/payins/client.d.ts

@@ -0,0 +1,8 @@
+import { DfnsApiClientOptions } from '../../types/generic';
+import * as T from './types';
+export declare class PayinsClient {
+    private apiOptions;
+    constructor(apiOptions: DfnsApiClientOptions);
+    createPayinRecipient(request: T.CreatePayinRecipientRequest): Promise<T.CreatePayinRecipientResponse>;
+    getPayinRecipient(request?: T.GetPayinRecipientRequest): Promise<T.GetPayinRecipientResponse>;
+}

package/generated/payins/client.js

@@ -0,0 +1,36 @@
+"use strict";
+/* eslint @typescript-eslint/no-unused-vars: 0 */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayinsClient = void 0;
+const fetch_1 = require("../../utils/fetch");
+const userActionFetch_1 = require("../../utils/userActionFetch");
+const url_1 = require("../../utils/url");
+class PayinsClient {
+    constructor(apiOptions) {
+        this.apiOptions = apiOptions;
+    }
+    async createPayinRecipient(request) {
+        const path = (0, url_1.buildPathAndQuery)('/payins/recipients', {
+            path: request ?? {},
+            query: {},
+        });
+        const response = await (0, userActionFetch_1.userActionFetch)(path, {
+            method: 'POST',
+            body: request.body,
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
+    async getPayinRecipient(request) {
+        const path = (0, url_1.buildPathAndQuery)('/payins/recipients', {
+            path: request ?? {},
+            query: request?.query ?? {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'GET',
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
+}
+exports.PayinsClient = PayinsClient;

package/generated/payins/delegatedClient.d.ts

@@ -0,0 +1,10 @@
+import { SignUserActionChallengeRequest, UserActionChallengeResponse } from '../../baseAuthApi';
+import { DfnsDelegatedApiClientOptions } from '../../dfnsDelegatedApiClient';
+import * as T from './types';
+export declare class DelegatedPayinsClient {
+    private apiOptions;
+    constructor(apiOptions: DfnsDelegatedApiClientOptions);
+    createPayinRecipientInit(request: T.CreatePayinRecipientRequest): Promise<UserActionChallengeResponse>;
+    createPayinRecipientComplete(request: T.CreatePayinRecipientRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.CreatePayinRecipientResponse>;
+    getPayinRecipient(request?: T.GetPayinRecipientRequest): Promise<T.GetPayinRecipientResponse>;
+}

package/generated/payins/delegatedClient.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DelegatedPayinsClient = void 0;
+const baseAuthApi_1 = require("../../baseAuthApi");
+const fetch_1 = require("../../utils/fetch");
+const url_1 = require("../../utils/url");
+class DelegatedPayinsClient {
+    constructor(apiOptions) {
+        this.apiOptions = apiOptions;
+    }
+    async createPayinRecipientInit(request) {
+        const path = (0, url_1.buildPathAndQuery)('/payins/recipients', {
+            path: request ?? {},
+            query: {},
+        });
+        const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
+            userActionHttpMethod: 'POST',
+            userActionHttpPath: path,
+            userActionPayload: JSON.stringify(request.body),
+            userActionServerKind: 'Api',
+        }, this.apiOptions);
+        return challenge;
+    }
+    async createPayinRecipientComplete(request, signedChallenge) {
+        const path = (0, url_1.buildPathAndQuery)('/payins/recipients', {
+            path: request ?? {},
+            query: {},
+        });
+        const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'POST',
+            body: request.body,
+            headers: { 'x-dfns-useraction': userAction },
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
+    async getPayinRecipient(request) {
+        const path = (0, url_1.buildPathAndQuery)('/payins/recipients', {
+            path: request ?? {},
+            query: request?.query ?? {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'GET',
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
+}
+exports.DelegatedPayinsClient = DelegatedPayinsClient;

package/generated/payins/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './client';
+export * from './delegatedClient';

package/generated/payins/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./client"), exports);
+__exportStar(require("./delegatedClient"), exports);

package/generated/payins/types.d.ts

@@ -0,0 +1,45 @@
+export type CreatePayinRecipientBody = {
+    provider: "CircleMint";
+    /** The wallet to register as a Circle Mint recipient. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+};
+export type CreatePayinRecipientResponse = {
+    /** Payin provider. */
+    provider: "CircleMint";
+    /** The wallet whose address is (to be) registered as a recipient. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+    /** Recipient status. */
+    status: "NotRegistered" | "PendingVerification" | "Active";
+    /** The provider's recipient-registry id, once registered. */
+    recipientAddressId?: string | undefined;
+};
+export type CreatePayinRecipientRequest = {
+    body: CreatePayinRecipientBody;
+};
+export type GetPayinRecipientQuery = {
+    /** The payin provider to check the recipient with. */
+    provider: "CircleMint";
+    /** The wallet whose recipient status to check. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+};
+export type GetPayinRecipientResponse = {
+    /** Payin provider. */
+    provider: "CircleMint";
+    /** The wallet whose address is (to be) registered as a recipient. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+    /** Recipient status. */
+    status: "NotRegistered" | "PendingVerification" | "Active";
+    /** The provider's recipient-registry id, once registered. */
+    recipientAddressId?: string | undefined;
+};
+export type GetPayinRecipientRequest = {
+    query?: GetPayinRecipientQuery;
+};

package/generated/payins/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });