@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/multi-rollup/models/trade-result.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { Trade } from './trade';
+/**
+ *
+ * @export
+ * @interface TradeResult
+ */
+export interface TradeResult {
+    /**
+     *
+     * @type {Trade}
+     * @memberof TradeResult
+     */
+    'result': Trade;
+}

package/dist/types/multi-rollup/models/trade.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { Chain } from './chain';
+import { Fee } from './fee';
+import { Item } from './item';
+import { TradeBlockchainMetadata } from './trade-blockchain-metadata';
+/**
+ *
+ * @export
+ * @interface Trade
+ */
+export interface Trade {
+    /**
+     * Buy items are transferred from the taker to the maker.
+     * @type {Array<Item>}
+     * @memberof Trade
+     */
+    'buy': Array<Item>;
+    /**
+     * Deprecated. Use maker and taker addresses instead of buyer and seller addresses.
+     * @type {string}
+     * @memberof Trade
+     */
+    'buyer_address': string;
+    /**
+     * Deprecated. Use fees instead. The taker always pays the fees.
+     * @type {Array<Fee>}
+     * @memberof Trade
+     */
+    'buyer_fees': Array<Fee>;
+    /**
+     *
+     * @type {Array<Fee>}
+     * @memberof Trade
+     */
+    'fees': Array<Fee>;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Trade
+     */
+    'chain': Chain;
+    /**
+     *
+     * @type {string}
+     * @memberof Trade
+     */
+    'order_id': string;
+    /**
+     *
+     * @type {TradeBlockchainMetadata}
+     * @memberof Trade
+     */
+    'blockchain_metadata': TradeBlockchainMetadata | null;
+    /**
+     * Time the on-chain trade event is indexed by the order book system
+     * @type {string}
+     * @memberof Trade
+     */
+    'indexed_at': string;
+    /**
+     * Global Trade identifier
+     * @type {string}
+     * @memberof Trade
+     */
+    'id': string;
+    /**
+     * Sell items are transferred from the maker to the taker.
+     * @type {Array<Item>}
+     * @memberof Trade
+     */
+    'sell': Array<Item>;
+    /**
+     * Deprecated. Use maker and taker addresses instead of buyer and seller addresses.
+     * @type {string}
+     * @memberof Trade
+     */
+    'seller_address': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Trade
+     */
+    'maker_address': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Trade
+     */
+    'taker_address': string;
+}

package/dist/types/multi-rollup/models/transaction-approval-request.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 TransactionApprovalRequest
+ */
+export interface TransactionApprovalRequest {
+    /**
+     * rollup chain ID
+     * @type {string}
+     * @memberof TransactionApprovalRequest
+     */
+    'chainID'?: string;
+    /**
+     * chain type
+     * @type {string}
+     * @memberof TransactionApprovalRequest
+     */
+    'chainType': TransactionApprovalRequestChainTypeEnum;
+    /**
+     * otp string
+     * @type {string}
+     * @memberof TransactionApprovalRequest
+     */
+    'otp'?: string;
+}
+export declare const TransactionApprovalRequestChainTypeEnum: {
+    readonly Starkex: "starkex";
+    readonly Evm: "evm";
+};
+export type TransactionApprovalRequestChainTypeEnum = typeof TransactionApprovalRequestChainTypeEnum[keyof typeof TransactionApprovalRequestChainTypeEnum];

package/dist/types/multi-rollup/models/transaction-evaluation-request.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { StarkExTransactionEvaluationRequest } from './stark-ex-transaction-evaluation-request';
+import { ZkEvmTransactionEvaluationRequest } from './zk-evm-transaction-evaluation-request';
+/**
+ * @type TransactionEvaluationRequest
+ * @export
+ */
+export type TransactionEvaluationRequest = StarkExTransactionEvaluationRequest | ZkEvmTransactionEvaluationRequest;

package/dist/types/multi-rollup/models/transaction-evaluation-response.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 TransactionEvaluationResponse
+ */
+export interface TransactionEvaluationResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof TransactionEvaluationResponse
+     */
+    'confirmationRequired': boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEvaluationResponse
+     */
+    'confirmationMethod'?: TransactionEvaluationResponseConfirmationMethodEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionEvaluationResponse
+     */
+    'transactionId'?: string;
+}
+export declare const TransactionEvaluationResponseConfirmationMethodEnum: {
+    readonly Otp: "otp";
+    readonly Web: "web";
+};
+export type TransactionEvaluationResponseConfirmationMethodEnum = typeof TransactionEvaluationResponseConfirmationMethodEnum[keyof typeof TransactionEvaluationResponseConfirmationMethodEnum];

package/dist/types/multi-rollup/models/transaction.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { ValidationResult } from './validation-result';
+/**
+ *
+ * @export
+ * @interface Transaction
+ */
+export interface Transaction {
+    /**
+     * Confirmation Candidate ID
+     * @type {string}
+     * @memberof Transaction
+     */
+    'id': string;
+    /**
+     * candidate\'s ether address
+     * @type {string}
+     * @memberof Transaction
+     */
+    'eth_address': string;
+    /**
+     * Status of the starkex transactions
+     * @type {string}
+     * @memberof Transaction
+     */
+    'status': string;
+    /**
+     * Confirmation candidate type
+     * @type {string}
+     * @memberof Transaction
+     */
+    'transaction_type': string;
+    /**
+     * Which version is at
+     * @type {string}
+     * @memberof Transaction
+     */
+    'version': string;
+    /**
+     * Transaction metadata as a string
+     * @type {{ [key: string]: any; }}
+     * @memberof Transaction
+     */
+    'transaction_metadata': {
+        [key: string]: any;
+    };
+    /**
+     * Name of request client
+     * @type {string}
+     * @memberof Transaction
+     */
+    'client_name'?: string;
+    /**
+     *
+     * @type {ValidationResult}
+     * @memberof Transaction
+     */
+    'validation'?: ValidationResult;
+}

package/dist/types/multi-rollup/models/transfer.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { ActivityAsset } from './activity-asset';
+/**
+ * The transfer activity details
+ * @export
+ * @interface Transfer
+ */
+export interface Transfer {
+    /**
+     * The account address the asset was transferred from
+     * @type {string}
+     * @memberof Transfer
+     */
+    'from': string;
+    /**
+     * The account address the asset was transferred to
+     * @type {string}
+     * @memberof Transfer
+     */
+    'to': string;
+    /**
+     * The amount of assets transferred
+     * @type {string}
+     * @memberof Transfer
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Transfer
+     */
+    'asset': ActivityAsset;
+}

package/dist/types/multi-rollup/models/unfulfillable-order.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 UnfulfillableOrder
+ */
+export interface UnfulfillableOrder {
+    /**
+     * OrderID for the requested but unfulfillable order
+     * @type {string}
+     * @memberof UnfulfillableOrder
+     */
+    'order_id': string;
+    /**
+     * Token ID for the ERC721 or ERC1155 token when fulfilling a collection order
+     * @type {string}
+     * @memberof UnfulfillableOrder
+     */
+    'token_id'?: string;
+    /**
+     * Nullable string containing error reason if the signing is unsuccessful for the order
+     * @type {string}
+     * @memberof UnfulfillableOrder
+     */
+    'reason': string;
+}

package/dist/types/multi-rollup/models/unknown-metadata.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 UnknownMetadata
+ */
+export interface UnknownMetadata {
+    /**
+     * Transaction type
+     * @type {string}
+     * @memberof UnknownMetadata
+     */
+    'transaction_type': UnknownMetadataTransactionTypeEnum;
+    /**
+     * Indicate if it is a Smart Contract or EOA
+     * @type {boolean}
+     * @memberof UnknownMetadata
+     */
+    'is_smart_contract': boolean;
+    /**
+     * Is Contract Verified
+     * @type {boolean}
+     * @memberof UnknownMetadata
+     */
+    'is_contract_verified': boolean;
+    /**
+     * Smart Contract Name
+     * @type {string}
+     * @memberof UnknownMetadata
+     */
+    'contract_name': string;
+}
+export declare const UnknownMetadataTransactionTypeEnum: {
+    readonly Unknown: "UNKNOWN";
+};
+export type UnknownMetadataTransactionTypeEnum = typeof UnknownMetadataTransactionTypeEnum[keyof typeof UnknownMetadataTransactionTypeEnum];

package/dist/types/multi-rollup/models/unknown-typed-data-metadata.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 UnknownTypedDataMetadata
+ */
+export interface UnknownTypedDataMetadata {
+    /**
+     * Unknown typed data type
+     * @type {string}
+     * @memberof UnknownTypedDataMetadata
+     */
+    'typed_data_type': UnknownTypedDataMetadataTypedDataTypeEnum;
+}
+export declare const UnknownTypedDataMetadataTypedDataTypeEnum: {
+    readonly Unknown: "UNKNOWN";
+};
+export type UnknownTypedDataMetadataTypedDataTypeEnum = typeof UnknownTypedDataMetadataTypedDataTypeEnum[keyof typeof UnknownTypedDataMetadataTypedDataTypeEnum];

package/dist/types/multi-rollup/models/user-info.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 UserInfo
+ */
+export interface UserInfo {
+    /**
+     * The user\'s id
+     * @type {string}
+     * @memberof UserInfo
+     */
+    'sub': string;
+    /**
+     * The user\'s email address
+     * @type {string}
+     * @memberof UserInfo
+     */
+    'email'?: string;
+    /**
+     * The user\'s Passport address if it has been registered
+     * @type {string}
+     * @memberof UserInfo
+     */
+    'passport_address'?: string;
+    /**
+     * The user\'s list of linked addresses
+     * @type {Array<string>}
+     * @memberof UserInfo
+     */
+    'linked_addresses': Array<string>;
+}

package/dist/types/multi-rollup/models/validation-error-results.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { ValidationStatus } from './validation-status';
+/**
+ *
+ * @export
+ * @interface ValidationErrorResults
+ */
+export interface ValidationErrorResults {
+    /**
+     *
+     * @type {ValidationStatus}
+     * @memberof ValidationErrorResults
+     */
+    'status': ValidationStatus;
+    /**
+     * human-readable error message representing a failure with the simulated transaction, such as a reversion
+     * @type {string}
+     * @memberof ValidationErrorResults
+     */
+    'error': string;
+}

package/dist/types/multi-rollup/models/validation-result.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { ValidationErrorResults } from './validation-error-results';
+import { ValidationSimulationFailedResults } from './validation-simulation-failed-results';
+import { ValidationSuccessResults } from './validation-success-results';
+/**
+ * @type ValidationResult
+ * @export
+ */
+export type ValidationResult = {
+    status: 'error';
+} & ValidationErrorResults | {
+    status: 'simulation_failed';
+} & ValidationSimulationFailedResults | {
+    status: 'success';
+} & ValidationSuccessResults;

package/dist/types/multi-rollup/models/validation-simulation-failed-results.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { ValidationStatus } from './validation-status';
+/**
+ *
+ * @export
+ * @interface ValidationSimulationFailedResults
+ */
+export interface ValidationSimulationFailedResults {
+    /**
+     *
+     * @type {ValidationStatus}
+     * @memberof ValidationSimulationFailedResults
+     */
+    'status': ValidationStatus;
+    /**
+     * human-readable error message representing a failure to simulate the transaction
+     * @type {string}
+     * @memberof ValidationSimulationFailedResults
+     */
+    'error': string;
+}

package/dist/types/multi-rollup/models/validation-status.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+/**
+ * Status of the validation
+ * @export
+ * @enum {string}
+ */
+export declare const ValidationStatus: {
+    readonly Success: "success";
+    readonly Error: "error";
+    readonly SimulationFailed: "simulation_failed";
+};
+export type ValidationStatus = typeof ValidationStatus[keyof typeof ValidationStatus];

package/dist/types/multi-rollup/models/validation-success-results.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 { Analysis } from './analysis';
+import { HighestSeverity } from './highest-severity';
+import { ValidationStatus } from './validation-status';
+/**
+ *
+ * @export
+ * @interface ValidationSuccessResults
+ */
+export interface ValidationSuccessResults {
+    /**
+     *
+     * @type {ValidationStatus}
+     * @memberof ValidationSuccessResults
+     */
+    'status': ValidationStatus;
+    /**
+     *
+     * @type {HighestSeverity}
+     * @memberof ValidationSuccessResults
+     */
+    'highestSeverity': HighestSeverity;
+    /**
+     * Contains a recommended action and warnings pertaining to the simulated transaction, such as interactions with known malicious addresses
+     * @type {Array<Analysis>}
+     * @memberof ValidationSuccessResults
+     */
+    'analysis': Array<Analysis>;
+}

package/dist/types/multi-rollup/models/verification-request-contract-type.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+/**
+ * The contract type associated with the given request
+ * @export
+ * @enum {string}
+ */
+export declare const VerificationRequestContractType: {
+    readonly Erc20: "ERC20";
+    readonly Erc721: "ERC721";
+    readonly Erc1155: "ERC1155";
+};
+export type VerificationRequestContractType = typeof VerificationRequestContractType[keyof typeof VerificationRequestContractType];