@dfns/sdk 0.7.15 → 0.7.17

package/dfnsApiClient.d.ts

@@ -13,6 +13,7 @@ import { WebhooksClient } from './generated/webhooks';
 import { CredentialSigner } from './signer';
 import { SwapsClient } from './generated/swaps';
 import { AgreementsClient } from './generated/agreements';
+import { AllocationsClient } from './generated/allocations/client';
 export type DfnsApiClientOptions = DfnsBaseApiOptions & {
     /** Needs to be specified to use any endpoint that required User Action Signing flow */
     signer?: CredentialSigner;
@@ -28,6 +29,7 @@ export declare class DfnsApiClient {
     get permissions(): PermissionsClient;
     get policies(): PoliciesClient;
     get staking(): StakingClient;
+    get allocations(): AllocationsClient;
     get swaps(): SwapsClient;
     get agreements(): AgreementsClient;
     get signers(): SignersClient;

package/dfnsApiClient.js

@@ -14,6 +14,7 @@ const wallets_1 = require("./generated/wallets");
 const webhooks_1 = require("./generated/webhooks");
 const swaps_1 = require("./generated/swaps");
 const agreements_1 = require("./generated/agreements");
+const client_1 = require("./generated/allocations/client");
 class DfnsApiClient {
     constructor(apiOptions) {
         this.apiOptions = apiOptions;
@@ -42,6 +43,9 @@ class DfnsApiClient {
     get staking() {
         return new staking_1.StakingClient(this.apiOptions);
     }
+    get allocations() {
+        return new client_1.AllocationsClient(this.apiOptions);
+    }
     get swaps() {
         return new swaps_1.SwapsClient(this.apiOptions);
     }

package/generated/allocations/client.d.ts

@@ -0,0 +1,11 @@
+import { DfnsApiClientOptions } from '../../types/generic';
+import * as T from './types';
+export declare class AllocationsClient {
+    private apiOptions;
+    constructor(apiOptions: DfnsApiClientOptions);
+    createAllocation(request: T.CreateAllocationRequest): Promise<T.CreateAllocationResponse>;
+    createAllocationAction(request: T.CreateAllocationActionRequest): Promise<T.CreateAllocationActionResponse>;
+    getAllocation(request: T.GetAllocationRequest): Promise<T.GetAllocationResponse>;
+    listAllocationActions(request: T.ListAllocationActionsRequest): Promise<T.ListAllocationActionsResponse>;
+    listAllocations(request?: T.ListAllocationsRequest): Promise<T.ListAllocationsResponse>;
+}

package/generated/{yields → allocations}/client.js

@@ -1,16 +1,16 @@
 "use strict";
 /* eslint @typescript-eslint/no-unused-vars: 0 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.YieldsClient = void 0;
+exports.AllocationsClient = void 0;
 const fetch_1 = require("../../utils/fetch");
 const userActionFetch_1 = require("../../utils/userActionFetch");
 const url_1 = require("../../utils/url");
-class YieldsClient {
+class AllocationsClient {
     constructor(apiOptions) {
         this.apiOptions = apiOptions;
     }
-    async createYield(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields', {
+    async createAllocation(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations', {
             path: request ?? {},
             query: {},
         });
@@ -21,8 +21,8 @@ class YieldsClient {
         });
         return response.json();
     }
-    async createYieldAction(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields/:yieldId/actions', {
+    async createAllocationAction(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations/:allocationId/actions', {
             path: request ?? {},
             query: {},
         });
@@ -33,8 +33,8 @@ class YieldsClient {
         });
         return response.json();
     }
-    async getYield(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields/:yieldId', {
+    async getAllocation(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations/:allocationId', {
             path: request ?? {},
             query: {},
         });
@@ -44,8 +44,8 @@ class YieldsClient {
         });
         return response.json();
     }
-    async listYieldActions(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields/:yieldId/actions', {
+    async listAllocationActions(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations/:allocationId/actions', {
             path: request ?? {},
             query: request.query ?? {},
         });
@@ -55,8 +55,8 @@ class YieldsClient {
         });
         return response.json();
     }
-    async listYields(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields', {
+    async listAllocations(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations', {
             path: request ?? {},
             query: request?.query ?? {},
         });
@@ -67,4 +67,4 @@ class YieldsClient {
         return response.json();
     }
 }
-exports.YieldsClient = YieldsClient;
+exports.AllocationsClient = AllocationsClient;

package/generated/allocations/delegatedClient.d.ts

@@ -0,0 +1,14 @@
+import { SignUserActionChallengeRequest, UserActionChallengeResponse } from '../../baseAuthApi';
+import { DfnsDelegatedApiClientOptions } from '../../dfnsDelegatedApiClient';
+import * as T from './types';
+export declare class DelegatedAllocationsClient {
+    private apiOptions;
+    constructor(apiOptions: DfnsDelegatedApiClientOptions);
+    createAllocationInit(request: T.CreateAllocationRequest): Promise<UserActionChallengeResponse>;
+    createAllocationComplete(request: T.CreateAllocationRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.CreateAllocationResponse>;
+    createAllocationActionInit(request: T.CreateAllocationActionRequest): Promise<UserActionChallengeResponse>;
+    createAllocationActionComplete(request: T.CreateAllocationActionRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.CreateAllocationActionResponse>;
+    getAllocation(request: T.GetAllocationRequest): Promise<T.GetAllocationResponse>;
+    listAllocationActions(request: T.ListAllocationActionsRequest): Promise<T.ListAllocationActionsResponse>;
+    listAllocations(request?: T.ListAllocationsRequest): Promise<T.ListAllocationsResponse>;
+}

package/generated/{yields → allocations}/delegatedClient.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DelegatedYieldsClient = void 0;
+exports.DelegatedAllocationsClient = void 0;
 const baseAuthApi_1 = require("../../baseAuthApi");
 const fetch_1 = require("../../utils/fetch");
 const url_1 = require("../../utils/url");
-class DelegatedYieldsClient {
+class DelegatedAllocationsClient {
     constructor(apiOptions) {
         this.apiOptions = apiOptions;
     }
-    async createYieldInit(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields', {
+    async createAllocationInit(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations', {
             path: request ?? {},
             query: {},
         });
@@ -21,8 +21,8 @@ class DelegatedYieldsClient {
         }, this.apiOptions);
         return challenge;
     }
-    async createYieldComplete(request, signedChallenge) {
-        const path = (0, url_1.buildPathAndQuery)('/yields', {
+    async createAllocationComplete(request, signedChallenge) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations', {
             path: request ?? {},
             query: {},
         });
@@ -35,8 +35,8 @@ class DelegatedYieldsClient {
         });
         return response.json();
     }
-    async createYieldActionInit(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields/:yieldId/actions', {
+    async createAllocationActionInit(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations/:allocationId/actions', {
             path: request ?? {},
             query: {},
         });
@@ -48,8 +48,8 @@ class DelegatedYieldsClient {
         }, this.apiOptions);
         return challenge;
     }
-    async createYieldActionComplete(request, signedChallenge) {
-        const path = (0, url_1.buildPathAndQuery)('/yields/:yieldId/actions', {
+    async createAllocationActionComplete(request, signedChallenge) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations/:allocationId/actions', {
             path: request ?? {},
             query: {},
         });
@@ -62,8 +62,8 @@ class DelegatedYieldsClient {
         });
         return response.json();
     }
-    async getYield(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields/:yieldId', {
+    async getAllocation(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations/:allocationId', {
             path: request ?? {},
             query: {},
         });
@@ -73,8 +73,8 @@ class DelegatedYieldsClient {
         });
         return response.json();
     }
-    async listYieldActions(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields/:yieldId/actions', {
+    async listAllocationActions(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations/:allocationId/actions', {
             path: request ?? {},
             query: request.query ?? {},
         });
@@ -84,8 +84,8 @@ class DelegatedYieldsClient {
         });
         return response.json();
     }
-    async listYields(request) {
-        const path = (0, url_1.buildPathAndQuery)('/yields', {
+    async listAllocations(request) {
+        const path = (0, url_1.buildPathAndQuery)('/allocations', {
             path: request ?? {},
             query: request?.query ?? {},
         });
@@ -96,4 +96,4 @@ class DelegatedYieldsClient {
         return response.json();
     }
 }
-exports.DelegatedYieldsClient = DelegatedYieldsClient;
+exports.DelegatedAllocationsClient = DelegatedAllocationsClient;

package/generated/{yields → allocations}/types.d.ts

@@ -1,4 +1,4 @@
-export type CreateYieldBody = {
+export type CreateAllocationBody = {
     /** Wallet id. */
     walletId: string;
     /** Ofns protocol */
@@ -18,14 +18,14 @@ export type CreateYieldBody = {
     /** 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're 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;
 };
-export type CreateYieldResponse = {
-    /** Unique identifier for the yield investment. */
+export type CreateAllocationResponse = {
+    /** Unique identifier for the allocation investment. */
     id: string;
     /** Wallet id. */
     walletId: string;
-    /** The DeFi protocol used for yield generation. Currently supports OFNS protocol */
+    /** The DeFi protocol used for allocation generation. Currently supports OFNS protocol */
     protocol: "0fns";
-    /** The total amount currently invested in this yield. */
+    /** The total amount currently invested in this allocation. */
     amount: ({
         kind: "Native";
         amount: string;
@@ -42,7 +42,7 @@ export type CreateYieldResponse = {
             tid?: string | undefined;
         };
     };
-    /** The total interest earned so far in this yield. */
+    /** The total rewards earned so far in this allocation. */
     rewards: ({
         kind: "Native";
         amount: string;
@@ -62,15 +62,15 @@ export type CreateYieldResponse = {
     dateCreated: string;
 } & {
     actions: {
-        /** Unique identifier for the yield action. */
+        /** Unique identifier for the allocation action. */
         id: string;
-        /** Unique identifier for the yield investment. */
-        yieldId: string;
+        /** Unique identifier for the allocation investment. */
+        allocationId: string;
         /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
         externalId?: string | undefined;
-        /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+        /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
         kind: "Deposit" | "Withdraw";
-        /** Status of the yield action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
+        /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
         requester: {
             /** User (could be a service account) who requested the resource. */
@@ -78,9 +78,9 @@ export type CreateYieldResponse = {
             /** Service Account token or Personal Access token used when requesting the resource. */
             tokenId?: string | undefined;
         };
-        /** The full request used for initiating this yield action. */
+        /** The full request used for initiating this allocation action. */
         requestBody: {
-            /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+            /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
             kind: "Deposit" | "Withdraw";
             /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
             externalId?: string | undefined;
@@ -119,11 +119,11 @@ export type CreateYieldResponse = {
         dateCreated: string;
     }[];
 };
-export type CreateYieldRequest = {
-    body: CreateYieldBody;
+export type CreateAllocationRequest = {
+    body: CreateAllocationBody;
 };
-export type CreateYieldActionBody = {
-    /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+export type CreateAllocationActionBody = {
+    /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
     kind: "Deposit" | "Withdraw";
     /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
     externalId?: string | undefined;
@@ -140,18 +140,18 @@ export type CreateYieldActionBody = {
     /** 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're 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;
 };
-export type CreateYieldActionParams = {
-    /** Unique identifier for the yield investment. */
-    yieldId: string;
+export type CreateAllocationActionParams = {
+    /** Unique identifier for the allocation investment. */
+    allocationId: string;
 };
-export type CreateYieldActionResponse = {
-    /** Unique identifier for the yield investment. */
+export type CreateAllocationActionResponse = {
+    /** Unique identifier for the allocation investment. */
     id: string;
     /** Wallet id. */
     walletId: string;
-    /** The DeFi protocol used for yield generation. Currently supports OFNS protocol */
+    /** The DeFi protocol used for allocation generation. Currently supports OFNS protocol */
     protocol: "0fns";
-    /** The total amount currently invested in this yield. */
+    /** The total amount currently invested in this allocation. */
     amount: ({
         kind: "Native";
         amount: string;
@@ -168,7 +168,7 @@ export type CreateYieldActionResponse = {
             tid?: string | undefined;
         };
     };
-    /** The total interest earned so far in this yield. */
+    /** The total rewards earned so far in this allocation. */
     rewards: ({
         kind: "Native";
         amount: string;
@@ -188,15 +188,15 @@ export type CreateYieldActionResponse = {
     dateCreated: string;
 } & {
     actions: {
-        /** Unique identifier for the yield action. */
+        /** Unique identifier for the allocation action. */
         id: string;
-        /** Unique identifier for the yield investment. */
-        yieldId: string;
+        /** Unique identifier for the allocation investment. */
+        allocationId: string;
         /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
         externalId?: string | undefined;
-        /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+        /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
         kind: "Deposit" | "Withdraw";
-        /** Status of the yield action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
+        /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
         requester: {
             /** User (could be a service account) who requested the resource. */
@@ -204,9 +204,9 @@ export type CreateYieldActionResponse = {
             /** Service Account token or Personal Access token used when requesting the resource. */
             tokenId?: string | undefined;
         };
-        /** The full request used for initiating this yield action. */
+        /** The full request used for initiating this allocation action. */
         requestBody: {
-            /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+            /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
             kind: "Deposit" | "Withdraw";
             /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
             externalId?: string | undefined;
@@ -245,21 +245,21 @@ export type CreateYieldActionResponse = {
         dateCreated: string;
     }[];
 };
-export type CreateYieldActionRequest = CreateYieldActionParams & {
-    body: CreateYieldActionBody;
+export type CreateAllocationActionRequest = CreateAllocationActionParams & {
+    body: CreateAllocationActionBody;
 };
-export type GetYieldParams = {
-    /** Unique identifier for the yield investment. */
-    yieldId: string;
+export type GetAllocationParams = {
+    /** Unique identifier for the allocation investment. */
+    allocationId: string;
 };
-export type GetYieldResponse = {
-    /** Unique identifier for the yield investment. */
+export type GetAllocationResponse = {
+    /** Unique identifier for the allocation investment. */
     id: string;
     /** Wallet id. */
     walletId: string;
-    /** The DeFi protocol used for yield generation. Currently supports OFNS protocol */
+    /** The DeFi protocol used for allocation generation. Currently supports OFNS protocol */
     protocol: "0fns";
-    /** The total amount currently invested in this yield. */
+    /** The total amount currently invested in this allocation. */
     amount: ({
         kind: "Native";
         amount: string;
@@ -276,7 +276,7 @@ export type GetYieldResponse = {
             tid?: string | undefined;
         };
     };
-    /** The total interest earned so far in this yield. */
+    /** The total rewards earned so far in this allocation. */
     rewards: ({
         kind: "Native";
         amount: string;
@@ -296,15 +296,15 @@ export type GetYieldResponse = {
     dateCreated: string;
 } & {
     actions: {
-        /** Unique identifier for the yield action. */
+        /** Unique identifier for the allocation action. */
         id: string;
-        /** Unique identifier for the yield investment. */
-        yieldId: string;
+        /** Unique identifier for the allocation investment. */
+        allocationId: string;
         /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
         externalId?: string | undefined;
-        /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+        /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
         kind: "Deposit" | "Withdraw";
-        /** Status of the yield action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
+        /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
         requester: {
             /** User (could be a service account) who requested the resource. */
@@ -312,9 +312,9 @@ export type GetYieldResponse = {
             /** Service Account token or Personal Access token used when requesting the resource. */
             tokenId?: string | undefined;
         };
-        /** The full request used for initiating this yield action. */
+        /** The full request used for initiating this allocation action. */
         requestBody: {
-            /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+            /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
             kind: "Deposit" | "Withdraw";
             /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
             externalId?: string | undefined;
@@ -353,29 +353,29 @@ export type GetYieldResponse = {
         dateCreated: string;
     }[];
 };
-export type GetYieldRequest = GetYieldParams;
-export type ListYieldActionsParams = {
-    /** Unique identifier for the yield investment. */
-    yieldId: string;
+export type GetAllocationRequest = GetAllocationParams;
+export type ListAllocationActionsParams = {
+    /** Unique identifier for the allocation investment. */
+    allocationId: string;
 };
-export type ListYieldActionsQuery = {
+export type ListAllocationActionsQuery = {
     /** 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 ListYieldActionsResponse = {
+export type ListAllocationActionsResponse = {
     /** Current page items. */
     items: {
-        /** Unique identifier for the yield action. */
+        /** Unique identifier for the allocation action. */
         id: string;
-        /** Unique identifier for the yield investment. */
-        yieldId: string;
+        /** Unique identifier for the allocation investment. */
+        allocationId: string;
         /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
         externalId?: string | undefined;
-        /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+        /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
         kind: "Deposit" | "Withdraw";
-        /** Status of the yield action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
+        /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
         requester: {
             /** User (could be a service account) who requested the resource. */
@@ -383,9 +383,9 @@ export type ListYieldActionsResponse = {
             /** Service Account token or Personal Access token used when requesting the resource. */
             tokenId?: string | undefined;
         };
-        /** The full request used for initiating this yield action. */
+        /** The full request used for initiating this allocation action. */
         requestBody: {
-            /** The type of action being performed on the yield investment: Deposit to add funds or Withdraw to remove funds. */
+            /** The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds. */
             kind: "Deposit" | "Withdraw";
             /** An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations. */
             externalId?: string | undefined;
@@ -426,25 +426,25 @@ export type ListYieldActionsResponse = {
     /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
-export type ListYieldActionsRequest = ListYieldActionsParams & {
-    query?: ListYieldActionsQuery;
+export type ListAllocationActionsRequest = ListAllocationActionsParams & {
+    query?: ListAllocationActionsQuery;
 };
-export type ListYieldsQuery = {
+export type ListAllocationsQuery = {
     /** 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 ListYieldsResponse = {
+export type ListAllocationsResponse = {
     /** Current page items. */
     items: {
-        /** Unique identifier for the yield investment. */
+        /** Unique identifier for the allocation investment. */
         id: string;
         /** Wallet id. */
         walletId: string;
-        /** The DeFi protocol used for yield generation. Currently supports OFNS protocol */
+        /** The DeFi protocol used for allocation generation. Currently supports OFNS protocol */
         protocol: "0fns";
-        /** The total amount currently invested in this yield. */
+        /** The total amount currently invested in this allocation. */
         amount: ({
             kind: "Native";
             amount: string;
@@ -461,7 +461,7 @@ export type ListYieldsResponse = {
                 tid?: string | undefined;
             };
         };
-        /** The total interest earned so far in this yield. */
+        /** The total rewards earned so far in this allocation. */
         rewards: ({
             kind: "Native";
             amount: string;
@@ -483,6 +483,6 @@ export type ListYieldsResponse = {
     /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
-export type ListYieldsRequest = {
-    query?: ListYieldsQuery;
+export type ListAllocationsRequest = {
+    query?: ListAllocationsQuery;
 };