@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/models/get-signable-registration-offchain-response.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetSignableRegistrationOffchainResponse
+ */
+export interface GetSignableRegistrationOffchainResponse {
+    /**
+     * Hash of the payload to be signed for user registration offchain
+     * @type {string}
+     * @memberof GetSignableRegistrationOffchainResponse
+     */
+    'payload_hash': string;
+    /**
+     * EIP-712 encoding of the StarkEx Register User Offchain request to be displayed to the user
+     * @type {string}
+     * @memberof GetSignableRegistrationOffchainResponse
+     */
+    'readable_transaction': string;
+    /**
+     * Message to sign with L1 wallet to register user offchain
+     * @type {string}
+     * @memberof GetSignableRegistrationOffchainResponse
+     */
+    'signable_message': string;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof GetSignableRegistrationOffchainResponse
+     */
+    'verification_signature': string;
+}

package/dist/types/imx/models/get-signable-registration-request.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetSignableRegistrationRequest
+ */
+export interface GetSignableRegistrationRequest {
+    /**
+     * Ether key of user
+     * @type {string}
+     * @memberof GetSignableRegistrationRequest
+     */
+    'ether_key': string;
+    /**
+     * Public stark key of the user
+     * @type {string}
+     * @memberof GetSignableRegistrationRequest
+     */
+    'stark_key': string;
+}

package/dist/types/imx/models/get-signable-registration-response.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetSignableRegistrationResponse
+ */
+export interface GetSignableRegistrationResponse {
+    /**
+     * Signature from authorised operator
+     * @type {string}
+     * @memberof GetSignableRegistrationResponse
+     */
+    'operator_signature': string;
+    /**
+     * Hash of the payload to be signed for user registration
+     * @type {string}
+     * @memberof GetSignableRegistrationResponse
+     */
+    'payload_hash': string;
+    /**
+     * EIP-712 encoding of the StarkEx Register User request to be displayed to the user
+     * @type {string}
+     * @memberof GetSignableRegistrationResponse
+     */
+    'readable_transaction': string;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof GetSignableRegistrationResponse
+     */
+    'verification_signature': string;
+}

package/dist/types/imx/models/get-signable-trade-request.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FeeEntry } from './fee-entry';
+/**
+ *
+ * @export
+ * @interface GetSignableTradeRequest
+ */
+export interface GetSignableTradeRequest {
+    /**
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
+     * @type {number}
+     * @memberof GetSignableTradeRequest
+     */
+    'expiration_timestamp'?: number;
+    /**
+     * Inclusion of either maker or taker fees
+     * @type {Array<FeeEntry>}
+     * @memberof GetSignableTradeRequest
+     */
+    'fees'?: Array<FeeEntry>;
+    /**
+     * The ID of the maker order involved
+     * @type {number}
+     * @memberof GetSignableTradeRequest
+     */
+    'order_id': number;
+    /**
+     * Ethereum address of the submitting user
+     * @type {string}
+     * @memberof GetSignableTradeRequest
+     */
+    'user': string;
+}

package/dist/types/imx/models/get-signable-trade-response-fee-info.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FeeInfo } from './fee-info';
+/**
+ * @type GetSignableTradeResponseFeeInfo
+ * Fee information
+ * @export
+ */
+export type GetSignableTradeResponseFeeInfo = FeeInfo;

package/dist/types/imx/models/get-signable-trade-response-result.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GetSignableTradeResult } from './get-signable-trade-result';
+/**
+ * @type GetSignableTradeResponseResult
+ * Signable trade result
+ * @export
+ */
+export type GetSignableTradeResponseResult = GetSignableTradeResult;

package/dist/types/imx/models/get-signable-trade-response.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GetSignableTradeResponseFeeInfo } from './get-signable-trade-response-fee-info';
+/**
+ *
+ * @export
+ * @interface GetSignableTradeResponse
+ */
+export interface GetSignableTradeResponse {
+    /**
+     * Amount to buy
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'amount_buy': string;
+    /**
+     * Amount to sell
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'amount_sell': string;
+    /**
+     * ID of the asset to buy
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'asset_id_buy': string;
+    /**
+     * ID of the asset to sell
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'asset_id_sell': string;
+    /**
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
+     * @type {number}
+     * @memberof GetSignableTradeResponse
+     */
+    'expiration_timestamp': number;
+    /**
+     *
+     * @type {GetSignableTradeResponseFeeInfo}
+     * @memberof GetSignableTradeResponse
+     */
+    'fee_info'?: GetSignableTradeResponseFeeInfo;
+    /**
+     * Nonce of the order
+     * @type {number}
+     * @memberof GetSignableTradeResponse
+     */
+    'nonce': number;
+    /**
+     * Payload Hash
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'payload_hash': string;
+    /**
+     * EIP-712 encoding of the StarkEx trade transaction to be displayed to the user
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'readable_transaction': string;
+    /**
+     * Message to sign with L1 wallet to confirm trade request
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'signable_message': string;
+    /**
+     * Public stark key of the created user
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'stark_key': string;
+    /**
+     * ID of the vault into which the bought asset will be placed
+     * @type {number}
+     * @memberof GetSignableTradeResponse
+     */
+    'vault_id_buy': number;
+    /**
+     * ID of the vault to sell from
+     * @type {number}
+     * @memberof GetSignableTradeResponse
+     */
+    'vault_id_sell': number;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof GetSignableTradeResponse
+     */
+    'verification_signature': string;
+}

package/dist/types/imx/models/get-signable-trade-result-fee-info.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FeeInfo } from './fee-info';
+/**
+ * @type GetSignableTradeResultFeeInfo
+ * Fee details
+ * @export
+ */
+export type GetSignableTradeResultFeeInfo = FeeInfo;

package/dist/types/imx/models/get-signable-trade-result.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GetSignableTradeResultFeeInfo } from './get-signable-trade-result-fee-info';
+/**
+ *
+ * @export
+ * @interface GetSignableTradeResult
+ */
+export interface GetSignableTradeResult {
+    /**
+     * Amount to buy
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'amount_buy'?: string;
+    /**
+     * Amount to sell
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'amount_sell'?: string;
+    /**
+     * ID of the asset to buy
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'asset_id_buy'?: string;
+    /**
+     * ID of the asset to sell
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'asset_id_sell'?: string;
+    /**
+     * Expiration timestamp of this trade
+     * @type {number}
+     * @memberof GetSignableTradeResult
+     */
+    'expiration_timestamp'?: number;
+    /**
+     *
+     * @type {GetSignableTradeResultFeeInfo}
+     * @memberof GetSignableTradeResult
+     */
+    'fee_info'?: GetSignableTradeResultFeeInfo;
+    /**
+     * Nonce of the trade
+     * @type {number}
+     * @memberof GetSignableTradeResult
+     */
+    'nonce'?: number;
+    /**
+     * Payload Hash
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'payload_hash'?: string;
+    /**
+     * EIP-712 encoding of the StarkEx trade transaction to be displayed to the user
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'readable_transaction'?: string;
+    /**
+     * Message to sign with L1 wallet to confirm trade request
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'signable_message'?: string;
+    /**
+     * Public stark key of the trading user
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'stark_key'?: string;
+    /**
+     * ID of the vault into which the traded asset will be placed
+     * @type {number}
+     * @memberof GetSignableTradeResult
+     */
+    'vault_id_buy'?: number;
+    /**
+     * ID of the vault to sell from
+     * @type {number}
+     * @memberof GetSignableTradeResult
+     */
+    'vault_id_sell'?: number;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof GetSignableTradeResult
+     */
+    'verification_signature'?: string;
+}

package/dist/types/imx/models/get-signable-transfer-request-token.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SignableToken } from './signable-token';
+/**
+ * @type GetSignableTransferRequestToken
+ * Token to transfer
+ * @export
+ */
+export type GetSignableTransferRequestToken = SignableToken;

package/dist/types/imx/models/get-signable-transfer-request-v1.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SignableToken } from './signable-token';
+/**
+ *
+ * @export
+ * @interface GetSignableTransferRequestV1
+ */
+export interface GetSignableTransferRequestV1 {
+    /**
+     * Amount of the token to transfer
+     * @type {string}
+     * @memberof GetSignableTransferRequestV1
+     */
+    'amount': string;
+    /**
+     * Ethereum address of the receiving user
+     * @type {string}
+     * @memberof GetSignableTransferRequestV1
+     */
+    'receiver': string;
+    /**
+     * Ethereum address of the transferring user
+     * @type {string}
+     * @memberof GetSignableTransferRequestV1
+     */
+    'sender': string;
+    /**
+     *
+     * @type {SignableToken}
+     * @memberof GetSignableTransferRequestV1
+     */
+    'token': SignableToken;
+}

package/dist/types/imx/models/get-signable-transfer-request-v2.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SignableTransferDetailsV2 } from './signable-transfer-details-v2';
+/**
+ *
+ * @export
+ * @interface GetSignableTransferRequestV2
+ */
+export interface GetSignableTransferRequestV2 {
+    /**
+     * Ethereum address of the transferring user
+     * @type {string}
+     * @memberof GetSignableTransferRequestV2
+     */
+    'sender_ether_key': string;
+    /**
+     * List of signable transfer details
+     * @type {Array<SignableTransferDetailsV2>}
+     * @memberof GetSignableTransferRequestV2
+     */
+    'signable_requests': Array<SignableTransferDetailsV2>;
+}

package/dist/types/imx/models/get-signable-transfer-request.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GetSignableTransferRequestToken } from './get-signable-transfer-request-token';
+/**
+ *
+ * @export
+ * @interface GetSignableTransferRequest
+ */
+export interface GetSignableTransferRequest {
+    /**
+     * Amount of the token to transfer
+     * @type {string}
+     * @memberof GetSignableTransferRequest
+     */
+    'amount': string;
+    /**
+     * Ethereum address of the receiving user
+     * @type {string}
+     * @memberof GetSignableTransferRequest
+     */
+    'receiver': string;
+    /**
+     * Ethereum address of the transferring user
+     * @type {string}
+     * @memberof GetSignableTransferRequest
+     */
+    'sender': string;
+    /**
+     *
+     * @type {GetSignableTransferRequestToken}
+     * @memberof GetSignableTransferRequest
+     */
+    'token': GetSignableTransferRequestToken;
+}

package/dist/types/imx/models/get-signable-transfer-response-v1.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetSignableTransferResponseV1
+ */
+export interface GetSignableTransferResponseV1 {
+    /**
+     * Amount of the asset being transferred
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'amount': string;
+    /**
+     * ID of the asset being transferred
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'asset_id': string;
+    /**
+     * Token in request to match in SDK implementation
+     * @type {number}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'expiration_timestamp': number;
+    /**
+     * Nonce of the transfer
+     * @type {number}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'nonce': number;
+    /**
+     * Hash of the payload
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'payload_hash': string;
+    /**
+     * EIP-712 encoding of the StarkEx transfer transaction to be displayed to the user
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'readable_transaction': string;
+    /**
+     * Receiver of the transfer
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'receiver_stark_key': string;
+    /**
+     * ID of the vault being transferred to
+     * @type {number}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'receiver_vault_id': number;
+    /**
+     * Sender of the transfer
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'sender_stark_key'?: string;
+    /**
+     * ID of the vault being transferred from
+     * @type {number}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'sender_vault_id': number;
+    /**
+     * Message to sign with L1 wallet to confirm transfer request
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'signable_message': string;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof GetSignableTransferResponseV1
+     */
+    'verification_signature': string;
+}

package/dist/types/imx/models/get-signable-transfer-response-v2.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SignableTransferResponseDetails } from './signable-transfer-response-details';
+/**
+ *
+ * @export
+ * @interface GetSignableTransferResponseV2
+ */
+export interface GetSignableTransferResponseV2 {
+    /**
+     * Sender of the transfer
+     * @type {string}
+     * @memberof GetSignableTransferResponseV2
+     */
+    'sender_stark_key': string;
+    /**
+     * Message to sign with L1 wallet to confirm transfer request
+     * @type {string}
+     * @memberof GetSignableTransferResponseV2
+     */
+    'signable_message': string;
+    /**
+     * List of transfer responses without the sender stark key
+     * @type {Array<SignableTransferResponseDetails>}
+     * @memberof GetSignableTransferResponseV2
+     */
+    'signable_responses': Array<SignableTransferResponseDetails>;
+}