@dfns/sdk 0.7.14-rc.0 → 0.7.14

package/generated/policies/types.d.ts

@@ -1005,13 +1005,21 @@ export type CreateApprovalDecisionResponse = {
             externalId?: string | undefined;
         } | undefined;
         swapRequest?: {
+            /** Swap id. */
             id: string;
+            /** Id of the quote this swap is based on. */
             quoteId: string;
+            /** Optional user-defined reference for this Swap. */
             reference: string | null;
+            /** Id of the Dfns wallet spending the sourceAsset. */
             walletId: string;
+            /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
             targetWalletId: string;
+            /** Swap status. */
             status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+            /** Swap provider. */
             provider: "UniswapX" | "UniswapClassic";
+            /** The source asset for this swap transaction. */
             quotedSourceAsset: ({
                 kind: "Native";
                 amount: string;
@@ -1028,6 +1036,7 @@ export type CreateApprovalDecisionResponse = {
                     tid?: string | undefined;
                 };
             };
+            /** The target asset for this swap transaction. */
             quotedTargetAsset: ({
                 kind: "Native";
                 amount: string;
@@ -1044,15 +1053,25 @@ export type CreateApprovalDecisionResponse = {
                     tid?: string | undefined;
                 };
             };
+            /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
             slippageBps: number;
+            /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the swap was initiated. */
             dateCreated: string;
+            /** The full request used for initiating this swap. */
             requestBody: {
+                /** Quote to use for this swap. */
                 quoteId: string;
+                /** An optional reference for this Swap. */
                 reference?: string | undefined;
+                /** Provided for this swap. Used for attesting that the swap is being created with the same parameters as the quote. */
                 provider: "UniswapX" | "UniswapClassic";
+                /** Id of the Dfns wallet spending the sourceAsset. Used for attesting that the swap is being created with the same parameters as the quote. */
                 walletId: string;
+                /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. Used for attesting that the swap is being created with the same parameters as the quote. */
                 targetWalletId?: string | undefined;
+                /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. Used for attesting that the swap is being created with the same parameters as the quote.  */
                 slippageBps: number;
+                /** The source asset that will be spent on the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
                 sourceAsset: {
                     kind: "Native";
                     amount: string;
@@ -1061,6 +1080,7 @@ export type CreateApprovalDecisionResponse = {
                     contract: string;
                     amount: string;
                 };
+                /** The target asset that will be received with the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
                 targetAsset: {
                     kind: "Native";
                     amount: string;
@@ -1071,7 +1091,9 @@ export type CreateApprovalDecisionResponse = {
                 };
             } | {};
             requester: {
+                /** User (could be a service account) who requested the quote. */
                 userId: string;
+                /** Service Account token or Personal Access token used when requesting the quote. */
                 tokenId?: string | undefined;
             };
         } | undefined;
@@ -3324,13 +3346,21 @@ export type GetApprovalResponse = {
             externalId?: string | undefined;
         } | undefined;
         swapRequest?: {
+            /** Swap id. */
             id: string;
+            /** Id of the quote this swap is based on. */
             quoteId: string;
+            /** Optional user-defined reference for this Swap. */
             reference: string | null;
+            /** Id of the Dfns wallet spending the sourceAsset. */
             walletId: string;
+            /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
             targetWalletId: string;
+            /** Swap status. */
             status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+            /** Swap provider. */
             provider: "UniswapX" | "UniswapClassic";
+            /** The source asset for this swap transaction. */
             quotedSourceAsset: ({
                 kind: "Native";
                 amount: string;
@@ -3347,6 +3377,7 @@ export type GetApprovalResponse = {
                     tid?: string | undefined;
                 };
             };
+            /** The target asset for this swap transaction. */
             quotedTargetAsset: ({
                 kind: "Native";
                 amount: string;
@@ -3363,15 +3394,25 @@ export type GetApprovalResponse = {
                     tid?: string | undefined;
                 };
             };
+            /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
             slippageBps: number;
+            /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the swap was initiated. */
             dateCreated: string;
+            /** The full request used for initiating this swap. */
             requestBody: {
+                /** Quote to use for this swap. */
                 quoteId: string;
+                /** An optional reference for this Swap. */
                 reference?: string | undefined;
+                /** Provided for this swap. Used for attesting that the swap is being created with the same parameters as the quote. */
                 provider: "UniswapX" | "UniswapClassic";
+                /** Id of the Dfns wallet spending the sourceAsset. Used for attesting that the swap is being created with the same parameters as the quote. */
                 walletId: string;
+                /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. Used for attesting that the swap is being created with the same parameters as the quote. */
                 targetWalletId?: string | undefined;
+                /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. Used for attesting that the swap is being created with the same parameters as the quote.  */
                 slippageBps: number;
+                /** The source asset that will be spent on the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
                 sourceAsset: {
                     kind: "Native";
                     amount: string;
@@ -3380,6 +3421,7 @@ export type GetApprovalResponse = {
                     contract: string;
                     amount: string;
                 };
+                /** The target asset that will be received with the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
                 targetAsset: {
                     kind: "Native";
                     amount: string;
@@ -3390,7 +3432,9 @@ export type GetApprovalResponse = {
                 };
             } | {};
             requester: {
+                /** User (could be a service account) who requested the quote. */
                 userId: string;
+                /** Service Account token or Personal Access token used when requesting the quote. */
                 tokenId?: string | undefined;
             };
         } | undefined;
@@ -5687,13 +5731,21 @@ export type ListApprovalsResponse = {
                 externalId?: string | undefined;
             } | undefined;
             swapRequest?: {
+                /** Swap id. */
                 id: string;
+                /** Id of the quote this swap is based on. */
                 quoteId: string;
+                /** Optional user-defined reference for this Swap. */
                 reference: string | null;
+                /** Id of the Dfns wallet spending the sourceAsset. */
                 walletId: string;
+                /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
                 targetWalletId: string;
+                /** Swap status. */
                 status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+                /** Swap provider. */
                 provider: "UniswapX" | "UniswapClassic";
+                /** The source asset for this swap transaction. */
                 quotedSourceAsset: ({
                     kind: "Native";
                     amount: string;
@@ -5710,6 +5762,7 @@ export type ListApprovalsResponse = {
                         tid?: string | undefined;
                     };
                 };
+                /** The target asset for this swap transaction. */
                 quotedTargetAsset: ({
                     kind: "Native";
                     amount: string;
@@ -5726,15 +5779,25 @@ export type ListApprovalsResponse = {
                         tid?: string | undefined;
                     };
                 };
+                /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
                 slippageBps: number;
+                /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the swap was initiated. */
                 dateCreated: string;
+                /** The full request used for initiating this swap. */
                 requestBody: {
+                    /** Quote to use for this swap. */
                     quoteId: string;
+                    /** An optional reference for this Swap. */
                     reference?: string | undefined;
+                    /** Provided for this swap. Used for attesting that the swap is being created with the same parameters as the quote. */
                     provider: "UniswapX" | "UniswapClassic";
+                    /** Id of the Dfns wallet spending the sourceAsset. Used for attesting that the swap is being created with the same parameters as the quote. */
                     walletId: string;
+                    /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. Used for attesting that the swap is being created with the same parameters as the quote. */
                     targetWalletId?: string | undefined;
+                    /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. Used for attesting that the swap is being created with the same parameters as the quote.  */
                     slippageBps: number;
+                    /** The source asset that will be spent on the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
                     sourceAsset: {
                         kind: "Native";
                         amount: string;
@@ -5743,6 +5806,7 @@ export type ListApprovalsResponse = {
                         contract: string;
                         amount: string;
                     };
+                    /** The target asset that will be received with the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
                     targetAsset: {
                         kind: "Native";
                         amount: string;
@@ -5753,7 +5817,9 @@ export type ListApprovalsResponse = {
                     };
                 } | {};
                 requester: {
+                    /** User (could be a service account) who requested the quote. */
                     userId: string;
+                    /** Service Account token or Personal Access token used when requesting the quote. */
                     tokenId?: string | undefined;
                 };
             } | undefined;

package/generated/signers/client.d.ts

@@ -3,5 +3,6 @@ import * as T from './types';
 export declare class SignersClient {
     private apiOptions;
     constructor(apiOptions: DfnsApiClientOptions);
+    listKeyStores(): Promise<T.ListKeyStoresResponse>;
     listSigners(): Promise<T.ListSignersResponse>;
 }

package/generated/signers/client.js

@@ -8,6 +8,17 @@ class SignersClient {
     constructor(apiOptions) {
         this.apiOptions = apiOptions;
     }
+    async listKeyStores() {
+        const path = (0, url_1.buildPathAndQuery)('/key-stores', {
+            path: {},
+            query: {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'GET',
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
     async listSigners() {
         const path = (0, url_1.buildPathAndQuery)('/signers', {
             path: {},

package/generated/signers/delegatedClient.d.ts

@@ -3,5 +3,6 @@ import * as T from './types';
 export declare class DelegatedSignersClient {
     private apiOptions;
     constructor(apiOptions: DfnsDelegatedApiClientOptions);
+    listKeyStores(): Promise<T.ListKeyStoresResponse>;
     listSigners(): Promise<T.ListSignersResponse>;
 }

package/generated/signers/delegatedClient.js

@@ -7,6 +7,17 @@ class DelegatedSignersClient {
     constructor(apiOptions) {
         this.apiOptions = apiOptions;
     }
+    async listKeyStores() {
+        const path = (0, url_1.buildPathAndQuery)('/key-stores', {
+            path: {},
+            query: {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'GET',
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
     async listSigners() {
         const path = (0, url_1.buildPathAndQuery)('/signers', {
             path: {},

package/generated/signers/types.d.ts

@@ -1,3 +1,10 @@
+export type ListKeyStoresResponse = {
+    items: {
+        id: string;
+        kind: "Hsm" | "Mpc";
+        primary: boolean;
+    }[];
+};
 export type ListSignersResponse = {
     clusters: {
         clusterId: string;

package/generated/staking/types.d.ts

@@ -476,7 +476,9 @@ export type GetStakesParams = {
     stakeId: string;
 };
 export type GetStakesQuery = {
+    /** Maximum number of items to return. */
     limit?: number | undefined;
+    /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
     paginationToken?: string | undefined;
 };
 export type GetStakesResponse = ({
@@ -690,7 +692,9 @@ export type ListStakeActionsParams = {
     stakeId: string;
 };
 export type ListStakeActionsQuery = {
+    /** Maximum number of items to return. */
     limit?: number | undefined;
+    /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
     paginationToken?: string | undefined;
 };
 export type ListStakeActionsResponse = {
@@ -761,7 +765,9 @@ export type ListStakeActionsRequest = ListStakeActionsParams & {
     query?: ListStakeActionsQuery;
 };
 export type ListStakesQuery = {
+    /** Maximum number of items to return. */
     limit?: number | undefined;
+    /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
     paginationToken?: string | undefined;
 };
 export type ListStakesResponse = {