@bluefin-exchange/pro-sdk 0.1.13 → 0.1.15

package/dist/example.js

@@ -174,6 +174,10 @@ function main() {
             // Withdraw 10 USD
             yield client.withdraw("USDC", "10000000000");
             logger.info("Withdraw request success");
+            yield client.authorizeAccount(bfSigner.getAddress());
+            logger.info("Authorize account request success");
+            yield client.deauthorizeAccount(bfSigner.getAddress());
+            logger.info("Deauthorize account request success");
             // Keep connection alive
             yield new Promise((resolve) => setTimeout(resolve, 50000));
         }

package/dist/src/api.d.ts

@@ -72,19 +72,19 @@ export interface Account {
      * @type {string}
      * @memberof Account
      */
-    'totalMaintMarginRequiredE9': string;
+    'totalMaintenanceMarginRequiredE9': string;
     /**
      * The amount of margin available before liquidation (e9 format).
      * @type {string}
      * @memberof Account
      */
-    'maintMarginAvailableE9': string;
+    'maintenanceMarginAvailableE9': string;
     /**
      * The ratio of the maintenance margin required to the account value (e9 format).
      * @type {string}
      * @memberof Account
      */
-    'accountMaintMarginRatioE9': string;
+    'accountMaintenanceMarginRatioE9': string;
     /**
      * The leverage of the account (e9 format).
      * @type {string}
@@ -108,7 +108,7 @@ export interface Account {
      * @type {number}
      * @memberof Account
      */
-    'lastUpdatedAtUtcMillis': number;
+    'lastUpdatedAtMillis': number;
     /**
      *
      * @type {Array<Asset>}
@@ -121,6 +121,74 @@ export interface Account {
      * @memberof Account
      */
     'positions': Array<Position>;
+    /**
+     * The accounts that are authorized to trade on behalf of the current account.
+     * @type {Array<string>}
+     * @memberof Account
+     */
+    'authorizedAccounts': Array<string>;
+}
+/**
+ *
+ * @export
+ * @interface AccountAuthorizationRequest
+ */
+export interface AccountAuthorizationRequest {
+    /**
+     *
+     * @type {AccountAuthorizationRequestSignedFields}
+     * @memberof AccountAuthorizationRequest
+     */
+    'signedFields': AccountAuthorizationRequestSignedFields;
+    /**
+     * The signature of the request, encoded from the signedFields
+     * @type {string}
+     * @memberof AccountAuthorizationRequest
+     */
+    'signature': string;
+    /**
+     * Used to uniquely identify the request. Created by hex encoding the bcs encoded signedFields.
+     * @type {string}
+     * @memberof AccountAuthorizationRequest
+     */
+    'requestHash': string;
+}
+/**
+ *
+ * @export
+ * @interface AccountAuthorizationRequestSignedFields
+ */
+export interface AccountAuthorizationRequestSignedFields {
+    /**
+     * The account address of the parent account that is authorizing/deauthorizing this account
+     * @type {string}
+     * @memberof AccountAuthorizationRequestSignedFields
+     */
+    'accountAddress': string;
+    /**
+     * The address of the account that should be authorized/deauthorized
+     * @type {string}
+     * @memberof AccountAuthorizationRequestSignedFields
+     */
+    'authorizedAccountAddress': string;
+    /**
+     * The random generated salt. Should always be a number
+     * @type {string}
+     * @memberof AccountAuthorizationRequestSignedFields
+     */
+    'salt': string;
+    /**
+     * the ID of the internal datastore for the target network
+     * @type {string}
+     * @memberof AccountAuthorizationRequestSignedFields
+     */
+    'idsId': string;
+    /**
+     * The timestamp when the request was signed
+     * @type {number}
+     * @memberof AccountAuthorizationRequestSignedFields
+     */
+    'signedAtUtcMillis': number;
 }
 /**
  * Represents the type of account data stream.
@@ -844,7 +912,7 @@ export interface Asset {
      * @type {number}
      * @memberof Asset
      */
-    'lastUpdatedAtUtcMillis': number;
+    'lastUpdatedAtMillis': number;
 }
 /**
  *
@@ -2504,7 +2572,7 @@ export interface Position {
      * @type {string}
      * @memberof Position
      */
-    'maintMarginE9': string;
+    'maintenanceMarginE9': string;
     /**
      * If the position is isolated.
      * @type {boolean}
@@ -2522,7 +2590,7 @@ export interface Position {
      * @type {number}
      * @memberof Position
      */
-    'lastUpdatedAtUtcMillis': number;
+    'lastUpdatedAtMillis': number;
 }
 /**
  * The side of the position, either long or short
@@ -3247,7 +3315,7 @@ export interface Trade {
      * @type {number}
      * @memberof Trade
      */
-    'executedAtUtcMilli': number;
+    'executedAtMillis': number;
 }
 export declare const TradeTradingFeeAssetEnum: {
     readonly Usdc: "USDC";
@@ -3413,6 +3481,12 @@ export interface Transaction {
      * @memberof Transaction
      */
     'tradeId'?: string;
+    /**
+     * Transaction timestamp in milliseconds since Unix epoch.
+     * @type {number}
+     * @memberof Transaction
+     */
+    'executedAtMillis': number;
 }
 /**
  * The type of transaction.
@@ -3535,28 +3609,28 @@ export declare const AccountDataApiAxiosParamCreator: (configuration?: Configura
      *
      * @summary Get user\'s trade history.
      * @param {string} symbol Market address to filter trades by.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {TradeTypeEnum} [tradeType] Type of trade. By default returns all.
      * @param {number} [page] The page number to retrieve in a paginated response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountTrades: (symbol: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getAccountTrades: (symbol: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get user\'s transaction history (any change in balance).
      * @param {Array<TransactionTypeEnum>} [types] Optional query parameter to filter transactions by type.
      * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {number} [page] The page number to retrieve in a paginated response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountTransactionHistory: (types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getAccountTransactionHistory: (types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AccountDataApi - functional programming interface
@@ -3581,28 +3655,28 @@ export declare const AccountDataApiFp: (configuration?: Configuration) => {
      *
      * @summary Get user\'s trade history.
      * @param {string} symbol Market address to filter trades by.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {TradeTypeEnum} [tradeType] Type of trade. By default returns all.
      * @param {number} [page] The page number to retrieve in a paginated response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountTrades(symbol: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Trade>>>;
+    getAccountTrades(symbol: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Trade>>>;
     /**
      *
      * @summary Get user\'s transaction history (any change in balance).
      * @param {Array<TransactionTypeEnum>} [types] Optional query parameter to filter transactions by type.
      * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {number} [page] The page number to retrieve in a paginated response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountTransactionHistory(types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Transaction>>>;
+    getAccountTransactionHistory(types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Transaction>>>;
 };
 /**
  * AccountDataApi - factory interface
@@ -3627,28 +3701,28 @@ export declare const AccountDataApiFactory: (configuration?: Configuration, base
      *
      * @summary Get user\'s trade history.
      * @param {string} symbol Market address to filter trades by.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {TradeTypeEnum} [tradeType] Type of trade. By default returns all.
      * @param {number} [page] The page number to retrieve in a paginated response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountTrades(symbol: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Trade>>;
+    getAccountTrades(symbol: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Trade>>;
     /**
      *
      * @summary Get user\'s transaction history (any change in balance).
      * @param {Array<TransactionTypeEnum>} [types] Optional query parameter to filter transactions by type.
      * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {number} [page] The page number to retrieve in a paginated response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountTransactionHistory(types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Transaction>>;
+    getAccountTransactionHistory(types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Transaction>>;
 };
 /**
  * AccountDataApi - object-oriented interface
@@ -3677,8 +3751,8 @@ export declare class AccountDataApi extends BaseAPI {
      *
      * @summary Get user\'s trade history.
      * @param {string} symbol Market address to filter trades by.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {TradeTypeEnum} [tradeType] Type of trade. By default returns all.
      * @param {number} [page] The page number to retrieve in a paginated response.
@@ -3686,21 +3760,21 @@ export declare class AccountDataApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AccountDataApi
      */
-    getAccountTrades(symbol: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Trade[], any>>;
+    getAccountTrades(symbol: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeTypeEnum, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Trade[], any>>;
     /**
      *
      * @summary Get user\'s transaction history (any change in balance).
      * @param {Array<TransactionTypeEnum>} [types] Optional query parameter to filter transactions by type.
      * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address.
-     * @param {number} [startTimeAtUtcMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
-     * @param {number} [endTimeAtUtcMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
+     * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified.
+     * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart.
      * @param {number} [limit] Default 500; max 1000.
      * @param {number} [page] The page number to retrieve in a paginated response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountDataApi
      */
-    getAccountTransactionHistory(types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtUtcMillis?: number, endTimeAtUtcMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Transaction[], any>>;
+    getAccountTransactionHistory(types?: Array<TransactionTypeEnum>, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Transaction[], any>>;
 }
 /**
  * AuthApi - axios parameter creator
@@ -4324,6 +4398,22 @@ export declare const TradeApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     postWithdraw: (withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Authorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Authorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putAuthorizeAccount: (accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Deauthorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putDeauthorizeAccount: (accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Updates leverage for positions of a given market, closes all open orders for that market
      * @summary Updates leverage for positions
@@ -4370,6 +4460,22 @@ export declare const TradeApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postWithdraw(withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Authorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Authorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putAuthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Deauthorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putDeauthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Updates leverage for positions of a given market, closes all open orders for that market
      * @summary Updates leverage for positions
@@ -4416,6 +4522,22 @@ export declare const TradeApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     postWithdraw(withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Authorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Authorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putAuthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Deauthorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putDeauthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Updates leverage for positions of a given market, closes all open orders for that market
      * @summary Updates leverage for positions
@@ -4468,6 +4590,24 @@ export declare class TradeApi extends BaseAPI {
      * @memberof TradeApi
      */
     postWithdraw(withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Authorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Authorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TradeApi
+     */
+    putAuthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account
+     * @summary Deauthorizes an account
+     * @param {AccountAuthorizationRequest} accountAuthorizationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TradeApi
+     */
+    putDeauthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Updates leverage for positions of a given market, closes all open orders for that market
      * @summary Updates leverage for positions