@ember-finance/sdk 2.6.0-pre.0 → 2.6.0-pre.2

package/dist/src/api/v2/apis/accounts-api.d.ts

@@ -12,6 +12,7 @@
 import type { Configuration } from "../configuration.js";
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios";
 import { type RequestArgs, BaseAPI } from "../base.js";
+import type { AccountHoldback } from "../models/index.js";
 import type { AccountParkingLotClaimable } from "../models/index.js";
 import type { AccountPendingDeposit } from "../models/index.js";
 import type { AccountTransaction } from "../models/index.js";
@@ -41,6 +42,21 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getAccountHistory: (accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, type?: GetAccountHistoryTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+     * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+     * @param {string} accountAddress The address of the account whose shares were swapped
+     * @param {number} startTimeInMs The start time of the events
+     * @param {string} [chain] Chain identifier
+     * @param {number} [endTimeInMs] The end time of the events
+     * @param {number} [limit] The limit of the events
+     * @param {number} [page] Use when provided time range and limit exceed max page size
+     * @param {string} [vaultId] The id of the parent vault
+     * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountHoldbacks: (accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, status?: GetAccountHoldbacksStatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -140,6 +156,21 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getAccountHistory(accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, type?: GetAccountHistoryTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountTransaction>>>;
+    /**
+     * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+     * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+     * @param {string} accountAddress The address of the account whose shares were swapped
+     * @param {number} startTimeInMs The start time of the events
+     * @param {string} [chain] Chain identifier
+     * @param {number} [endTimeInMs] The end time of the events
+     * @param {number} [limit] The limit of the events
+     * @param {number} [page] Use when provided time range and limit exceed max page size
+     * @param {string} [vaultId] The id of the parent vault
+     * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountHoldbacks(accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, status?: GetAccountHoldbacksStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldback>>>;
     /**
      *
      * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -239,6 +270,21 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getAccountHistory(accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, type?: GetAccountHistoryTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<AccountTransaction>>;
+    /**
+     * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+     * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+     * @param {string} accountAddress The address of the account whose shares were swapped
+     * @param {number} startTimeInMs The start time of the events
+     * @param {string} [chain] Chain identifier
+     * @param {number} [endTimeInMs] The end time of the events
+     * @param {number} [limit] The limit of the events
+     * @param {number} [page] Use when provided time range and limit exceed max page size
+     * @param {string} [vaultId] The id of the parent vault
+     * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountHoldbacks(accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, status?: GetAccountHoldbacksStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<AccountHoldback>>;
     /**
      *
      * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -341,6 +387,22 @@ export declare class AccountsApi extends BaseAPI {
      * @memberof AccountsApi
      */
     getAccountHistory(accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, type?: GetAccountHistoryTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountTransaction[], any, {}>>;
+    /**
+     * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+     * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+     * @param {string} accountAddress The address of the account whose shares were swapped
+     * @param {number} startTimeInMs The start time of the events
+     * @param {string} [chain] Chain identifier
+     * @param {number} [endTimeInMs] The end time of the events
+     * @param {number} [limit] The limit of the events
+     * @param {number} [page] Use when provided time range and limit exceed max page size
+     * @param {string} [vaultId] The id of the parent vault
+     * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    getAccountHoldbacks(accountAddress: string, startTimeInMs: number, chain?: string, endTimeInMs?: number, limit?: number, page?: number, vaultId?: string, status?: GetAccountHoldbacksStatusEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldback[], any, {}>>;
     /**
      *
      * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -448,6 +510,14 @@ export declare const GetAccountHistoryTypeEnum: {
     readonly WithdrawalClaimed: "WithdrawalClaimed";
 };
 export type GetAccountHistoryTypeEnum = (typeof GetAccountHistoryTypeEnum)[keyof typeof GetAccountHistoryTypeEnum];
+/**
+ * @export
+ */
+export declare const GetAccountHoldbacksStatusEnum: {
+    readonly Pending: "Pending";
+    readonly Released: "Released";
+};
+export type GetAccountHoldbacksStatusEnum = (typeof GetAccountHoldbacksStatusEnum)[keyof typeof GetAccountHoldbacksStatusEnum];
 /**
  * @export
  */

package/dist/src/api/v2/apis/accounts-api.js

@@ -85,6 +85,68 @@ export const AccountsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions
             };
         },
+        /**
+         * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+         * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+         * @param {string} accountAddress The address of the account whose shares were swapped
+         * @param {number} startTimeInMs The start time of the events
+         * @param {string} [chain] Chain identifier
+         * @param {number} [endTimeInMs] The end time of the events
+         * @param {number} [limit] The limit of the events
+         * @param {number} [page] Use when provided time range and limit exceed max page size
+         * @param {string} [vaultId] The id of the parent vault
+         * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAccountHoldbacks: async (accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, status, options = {}) => {
+            // verify required parameter 'accountAddress' is not null or undefined
+            assertParamExists("getAccountHoldbacks", "accountAddress", accountAddress);
+            // verify required parameter 'startTimeInMs' is not null or undefined
+            assertParamExists("getAccountHoldbacks", "startTimeInMs", startTimeInMs);
+            const localVarPath = `/api/v2/vaults/holdbacks/{accountAddress}`.replace(`{${"accountAddress"}}`, encodeURIComponent(String(accountAddress)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            if (chain !== undefined) {
+                localVarQueryParameter["chain"] = chain;
+            }
+            if (startTimeInMs !== undefined) {
+                localVarQueryParameter["startTimeInMs"] = startTimeInMs;
+            }
+            if (endTimeInMs !== undefined) {
+                localVarQueryParameter["endTimeInMs"] = endTimeInMs;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter["limit"] = limit;
+            }
+            if (page !== undefined) {
+                localVarQueryParameter["page"] = page;
+            }
+            if (vaultId !== undefined) {
+                localVarQueryParameter["vaultId"] = vaultId;
+            }
+            if (status !== undefined) {
+                localVarQueryParameter["status"] = status;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {
+                ...localVarHeaderParameter,
+                ...headersFromBaseOptions,
+                ...options.headers
+            };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions
+            };
+        },
         /**
          *
          * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -432,6 +494,26 @@ export const AccountsApiFp = function (configuration) {
             const localVarOperationServerBasePath = operationServerMap["AccountsApi.getAccountHistory"]?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+         * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+         * @param {string} accountAddress The address of the account whose shares were swapped
+         * @param {number} startTimeInMs The start time of the events
+         * @param {string} [chain] Chain identifier
+         * @param {number} [endTimeInMs] The end time of the events
+         * @param {number} [limit] The limit of the events
+         * @param {number} [page] Use when provided time range and limit exceed max page size
+         * @param {string} [vaultId] The id of the parent vault
+         * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getAccountHoldbacks(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, status, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountHoldbacks(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, status, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap["AccountsApi.getAccountHoldbacks"]?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -573,6 +655,25 @@ export const AccountsApiFactory = function (configuration, basePath, axios) {
                 .getAccountHistory(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, type, options)
                 .then(request => request(axios, basePath));
         },
+        /**
+         * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+         * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+         * @param {string} accountAddress The address of the account whose shares were swapped
+         * @param {number} startTimeInMs The start time of the events
+         * @param {string} [chain] Chain identifier
+         * @param {number} [endTimeInMs] The end time of the events
+         * @param {number} [limit] The limit of the events
+         * @param {number} [page] Use when provided time range and limit exceed max page size
+         * @param {string} [vaultId] The id of the parent vault
+         * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAccountHoldbacks(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, status, options) {
+            return localVarFp
+                .getAccountHoldbacks(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, status, options)
+                .then(request => request(axios, basePath));
+        },
         /**
          *
          * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -708,6 +809,26 @@ export class AccountsApi extends BaseAPI {
             .getAccountHistory(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, type, options)
             .then(request => request(this.axios, this.basePath));
     }
+    /**
+     * When an account swaps ember shares into an Atomic Liquidity Vault it receives most of the collateral immediately and a `holdback` portion is queued for later payout. This lists that account\'s holdback entries — `Pending` while still queued awaiting the operator\'s release, `Released` once a release batch has settled them.
+     * @summary Get the account\'s atomic-vault holdbacks (withheld at swap time)
+     * @param {string} accountAddress The address of the account whose shares were swapped
+     * @param {number} startTimeInMs The start time of the events
+     * @param {string} [chain] Chain identifier
+     * @param {number} [endTimeInMs] The end time of the events
+     * @param {number} [limit] The limit of the events
+     * @param {number} [page] Use when provided time range and limit exceed max page size
+     * @param {string} [vaultId] The id of the parent vault
+     * @param {GetAccountHoldbacksStatusEnum} [status] The status of the holdback entries
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    getAccountHoldbacks(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, status, options) {
+        return AccountsApiFp(this.configuration)
+            .getAccountHoldbacks(accountAddress, startTimeInMs, chain, endTimeInMs, limit, page, vaultId, status, options)
+            .then(request => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Get the account\'s claimable (undeliverable refund) balances across parking lots
@@ -842,6 +963,13 @@ export const GetAccountHistoryTypeEnum = {
     HoldbackClaimed: "HoldbackClaimed",
     WithdrawalClaimed: "WithdrawalClaimed"
 };
+/**
+ * @export
+ */
+export const GetAccountHoldbacksStatusEnum = {
+    Pending: "Pending",
+    Released: "Released"
+};
 /**
  * @export
  */

package/dist/src/api/v2/models/account-holdback.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Ember Protocol Vaults API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Asset } from "./asset.js";
+import type { VaultSlice } from "./vault-slice.js";
+/**
+ * One holdback entry: the portion of a swap\'s collateral withheld at swap time and paid out later by the operator. Created by an ember-share swap and keyed by that swap\'s sequence number, which is the FIFO key a release batch settles against.
+ * @export
+ * @interface AccountHoldback
+ */
+export interface AccountHoldback {
+    /**
+     * Pending while the entry is still queued awaiting the operator\'s holdback release; Released once a release batch has settled it.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    status: AccountHoldbackStatusEnum;
+    /**
+     * The collateral withheld at swap time, in the collateral asset\'s base units. Note this is the amount WITHHELD, not the amount finally paid: the per-entry payout is not emitted on-chain, so for a Released entry the settled figure is this amount scaled by releasedUnwindingPercentageE18.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    holdbackAmount: string;
+    /**
+     * The account whose shares were swapped and whose holdback this is
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    accountAddress: string;
+    /**
+     * On-chain address of the source (ember) vault whose shares were swapped
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    sourceVaultId: string;
+    /**
+     * Off-chain id of the source vault\'s PARENT (matches a vault\'s root `id`) — use to resolve the source vault for name/logo. Null when not indexed by us.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    sourceVaultParentId?: string | null;
+    /**
+     * Off-chain id of the source vault\'s chain-level record (matches a vault\'s detailsByChain[*].id). Null when not indexed by us.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    sourceVaultOffchainId?: string | null;
+    /**
+     * Sequence number of the swap that created this entry. This is the FIFO key the operator\'s release range is matched against, not a queue array index.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    swapSequenceNumber: string;
+    /**
+     * Timestamp in ms the swap queued this holdback
+     * @type {number}
+     * @memberof AccountHoldback
+     */
+    submittedAt: number;
+    /**
+     * Unwinding percentage (1e18 fixed-point, 1e18 = 100%) recorded by the release batch that settled this entry. Null while still Pending.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    releasedUnwindingPercentageE18?: string | null;
+    /**
+     * Tx hash of the release that settled this entry. Null while still Pending.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    releasedTxHash?: string | null;
+    /**
+     * Tx hash of the swap that queued this holdback
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    txHash: string;
+    /**
+     *
+     * @type {Asset}
+     * @memberof AccountHoldback
+     */
+    collateralCoin?: Asset;
+    /**
+     *
+     * @type {VaultSlice}
+     * @memberof AccountHoldback
+     */
+    atomicVault: VaultSlice;
+    /**
+     * Off-chain id of the atomic vault\'s chain-level record (matches a vault\'s detailsByChain[*].id). Null when not indexed by us.
+     * @type {string}
+     * @memberof AccountHoldback
+     */
+    atomicVaultOffchainId?: string | null;
+    /**
+     *
+     * @type {VaultSlice}
+     * @memberof AccountHoldback
+     */
+    sourceVault?: VaultSlice;
+}
+export declare const AccountHoldbackStatusEnum: {
+    readonly Pending: "Pending";
+    readonly Released: "Released";
+};
+export type AccountHoldbackStatusEnum = (typeof AccountHoldbackStatusEnum)[keyof typeof AccountHoldbackStatusEnum];

package/dist/src/api/v2/models/account-holdback.js

@@ -0,0 +1,17 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Ember Protocol Vaults API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const AccountHoldbackStatusEnum = {
+    Pending: "Pending",
+    Released: "Released"
+};

package/dist/src/api/v2/models/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./account-holdback.js";
 export * from "./account-parking-lot-claimable.js";
 export * from "./account-pending-deposit.js";
 export * from "./account-transaction.js";

package/dist/src/api/v2/models/index.js

@@ -1,3 +1,4 @@
+export * from "./account-holdback.js";
 export * from "./account-parking-lot-claimable.js";
 export * from "./account-pending-deposit.js";
 export * from "./account-transaction.js";

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@ember-finance/sdk",
     "description": "Ember Protocol SDK",
-    "version": "2.6.0-pre.0",
+    "version": "2.6.0-pre.2",
     "type": "module",
     "module": "./dist/index.js",
     "main": "./dist/index.js",