@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/multi-rollup/domain/guardian-api.d.ts

@@ -0,0 +1,519 @@
+/**
+ * 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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { ERC191MessageEvaluationRequest } from '../models';
+import { EVMMessage } from '../models';
+import { Erc191MessageResponse } from '../models';
+import { MessageEvaluationRequest } from '../models';
+import { MessageEvaluationResponse } from '../models';
+import { Transaction } from '../models';
+import { TransactionApprovalRequest } from '../models';
+import { TransactionEvaluationRequest } from '../models';
+import { TransactionEvaluationResponse } from '../models';
+/**
+ * GuardianApi - axios parameter creator
+ * @export
+ */
+export declare const GuardianApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Approve a pending erc191 message
+     * @summary Approve a pending erc191 message
+     * @param {string} messageID id for the message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingERC191Message: (messageID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Approve a pending evm message
+     * @summary Approve a pending evm message
+     * @param {string} messageID id for the message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingMessage: (messageID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Approve a pending transaction
+     * @summary Approve a pending transaction given chain
+     * @param {string} payloadHash Hash for the payload
+     * @param {TransactionApprovalRequest} transactionApprovalRequest request body for approving a pending transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingTransaction: (payloadHash: string, transactionApprovalRequest: TransactionApprovalRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Check if a given erc191 message is valid
+     * @summary Evaluate an erc191 message to sign
+     * @param {ERC191MessageEvaluationRequest} eRC191MessageEvaluationRequest Specifies the kind of transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateErc191Message: (eRC191MessageEvaluationRequest: ERC191MessageEvaluationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Check if a given message is valid  for EVM
+     * @summary Evaluate an evm message to sign
+     * @param {MessageEvaluationRequest} messageEvaluationRequest Specifies the kind of transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateMessage: (messageEvaluationRequest: MessageEvaluationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Check if the transaction is valid by transaction ID for both StarkEx and EVM
+     * @summary Evaluate a transaction
+     * @param {string} id Transaction identifier: payloadHash on StarkEx or EVM ID
+     * @param {TransactionEvaluationRequest} transactionEvaluationRequest Specifies the kind of transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateTransaction: (id: string, transactionEvaluationRequest: TransactionEvaluationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an erc191 message by id
+     * @summary Info for a specific erc191 message
+     * @param {string} messageID The id of the erc191 message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getErc191MessageByID: (messageID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an evm message by id
+     * @summary Info for a specific evm message
+     * @param {string} messageID The id of the evm message
+     * @param {boolean} [includeSimulation] Include simulation results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMessageByID: (messageID: string, includeSimulation?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a transaction by payload hash
+     * @summary Info for a specific transaction
+     * @param {string} transactionID The id of the starkex transaction to retrieve
+     * @param {GetTransactionByIDChainTypeEnum} chainType roll up type
+     * @param {string} [chainID] ID of evm chain
+     * @param {boolean} [includeSimulation] Include simulation results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransactionByID: (transactionID: string, chainType: GetTransactionByIDChainTypeEnum, chainID?: string, includeSimulation?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * GuardianApi - functional programming interface
+ * @export
+ */
+export declare const GuardianApiFp: (configuration?: Configuration) => {
+    /**
+     * Approve a pending erc191 message
+     * @summary Approve a pending erc191 message
+     * @param {string} messageID id for the message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingERC191Message(messageID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Approve a pending evm message
+     * @summary Approve a pending evm message
+     * @param {string} messageID id for the message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingMessage(messageID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Approve a pending transaction
+     * @summary Approve a pending transaction given chain
+     * @param {string} payloadHash Hash for the payload
+     * @param {TransactionApprovalRequest} transactionApprovalRequest request body for approving a pending transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingTransaction(payloadHash: string, transactionApprovalRequest: TransactionApprovalRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Check if a given erc191 message is valid
+     * @summary Evaluate an erc191 message to sign
+     * @param {ERC191MessageEvaluationRequest} eRC191MessageEvaluationRequest Specifies the kind of transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateErc191Message(eRC191MessageEvaluationRequest: ERC191MessageEvaluationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageEvaluationResponse>>;
+    /**
+     * Check if a given message is valid  for EVM
+     * @summary Evaluate an evm message to sign
+     * @param {MessageEvaluationRequest} messageEvaluationRequest Specifies the kind of transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateMessage(messageEvaluationRequest: MessageEvaluationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageEvaluationResponse>>;
+    /**
+     * Check if the transaction is valid by transaction ID for both StarkEx and EVM
+     * @summary Evaluate a transaction
+     * @param {string} id Transaction identifier: payloadHash on StarkEx or EVM ID
+     * @param {TransactionEvaluationRequest} transactionEvaluationRequest Specifies the kind of transaction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateTransaction(id: string, transactionEvaluationRequest: TransactionEvaluationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionEvaluationResponse>>;
+    /**
+     * Get an erc191 message by id
+     * @summary Info for a specific erc191 message
+     * @param {string} messageID The id of the erc191 message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getErc191MessageByID(messageID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Erc191MessageResponse>>;
+    /**
+     * Get an evm message by id
+     * @summary Info for a specific evm message
+     * @param {string} messageID The id of the evm message
+     * @param {boolean} [includeSimulation] Include simulation results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMessageByID(messageID: string, includeSimulation?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EVMMessage>>;
+    /**
+     * Get a transaction by payload hash
+     * @summary Info for a specific transaction
+     * @param {string} transactionID The id of the starkex transaction to retrieve
+     * @param {GetTransactionByIDChainTypeEnum} chainType roll up type
+     * @param {string} [chainID] ID of evm chain
+     * @param {boolean} [includeSimulation] Include simulation results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransactionByID(transactionID: string, chainType: GetTransactionByIDChainTypeEnum, chainID?: string, includeSimulation?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Transaction>>;
+};
+/**
+ * GuardianApi - factory interface
+ * @export
+ */
+export declare const GuardianApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Approve a pending erc191 message
+     * @summary Approve a pending erc191 message
+     * @param {GuardianApiApprovePendingERC191MessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingERC191Message(requestParameters: GuardianApiApprovePendingERC191MessageRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Approve a pending evm message
+     * @summary Approve a pending evm message
+     * @param {GuardianApiApprovePendingMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingMessage(requestParameters: GuardianApiApprovePendingMessageRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Approve a pending transaction
+     * @summary Approve a pending transaction given chain
+     * @param {GuardianApiApprovePendingTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approvePendingTransaction(requestParameters: GuardianApiApprovePendingTransactionRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Check if a given erc191 message is valid
+     * @summary Evaluate an erc191 message to sign
+     * @param {GuardianApiEvaluateErc191MessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateErc191Message(requestParameters: GuardianApiEvaluateErc191MessageRequest, options?: AxiosRequestConfig): AxiosPromise<MessageEvaluationResponse>;
+    /**
+     * Check if a given message is valid  for EVM
+     * @summary Evaluate an evm message to sign
+     * @param {GuardianApiEvaluateMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateMessage(requestParameters: GuardianApiEvaluateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<MessageEvaluationResponse>;
+    /**
+     * Check if the transaction is valid by transaction ID for both StarkEx and EVM
+     * @summary Evaluate a transaction
+     * @param {GuardianApiEvaluateTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    evaluateTransaction(requestParameters: GuardianApiEvaluateTransactionRequest, options?: AxiosRequestConfig): AxiosPromise<TransactionEvaluationResponse>;
+    /**
+     * Get an erc191 message by id
+     * @summary Info for a specific erc191 message
+     * @param {GuardianApiGetErc191MessageByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getErc191MessageByID(requestParameters: GuardianApiGetErc191MessageByIDRequest, options?: AxiosRequestConfig): AxiosPromise<Erc191MessageResponse>;
+    /**
+     * Get an evm message by id
+     * @summary Info for a specific evm message
+     * @param {GuardianApiGetMessageByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMessageByID(requestParameters: GuardianApiGetMessageByIDRequest, options?: AxiosRequestConfig): AxiosPromise<EVMMessage>;
+    /**
+     * Get a transaction by payload hash
+     * @summary Info for a specific transaction
+     * @param {GuardianApiGetTransactionByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransactionByID(requestParameters: GuardianApiGetTransactionByIDRequest, options?: AxiosRequestConfig): AxiosPromise<Transaction>;
+};
+/**
+ * Request parameters for approvePendingERC191Message operation in GuardianApi.
+ * @export
+ * @interface GuardianApiApprovePendingERC191MessageRequest
+ */
+export interface GuardianApiApprovePendingERC191MessageRequest {
+    /**
+     * id for the message
+     * @type {string}
+     * @memberof GuardianApiApprovePendingERC191Message
+     */
+    readonly messageID: string;
+}
+/**
+ * Request parameters for approvePendingMessage operation in GuardianApi.
+ * @export
+ * @interface GuardianApiApprovePendingMessageRequest
+ */
+export interface GuardianApiApprovePendingMessageRequest {
+    /**
+     * id for the message
+     * @type {string}
+     * @memberof GuardianApiApprovePendingMessage
+     */
+    readonly messageID: string;
+}
+/**
+ * Request parameters for approvePendingTransaction operation in GuardianApi.
+ * @export
+ * @interface GuardianApiApprovePendingTransactionRequest
+ */
+export interface GuardianApiApprovePendingTransactionRequest {
+    /**
+     * Hash for the payload
+     * @type {string}
+     * @memberof GuardianApiApprovePendingTransaction
+     */
+    readonly payloadHash: string;
+    /**
+     * request body for approving a pending transaction
+     * @type {TransactionApprovalRequest}
+     * @memberof GuardianApiApprovePendingTransaction
+     */
+    readonly transactionApprovalRequest: TransactionApprovalRequest;
+}
+/**
+ * Request parameters for evaluateErc191Message operation in GuardianApi.
+ * @export
+ * @interface GuardianApiEvaluateErc191MessageRequest
+ */
+export interface GuardianApiEvaluateErc191MessageRequest {
+    /**
+     * Specifies the kind of transaction
+     * @type {ERC191MessageEvaluationRequest}
+     * @memberof GuardianApiEvaluateErc191Message
+     */
+    readonly eRC191MessageEvaluationRequest: ERC191MessageEvaluationRequest;
+}
+/**
+ * Request parameters for evaluateMessage operation in GuardianApi.
+ * @export
+ * @interface GuardianApiEvaluateMessageRequest
+ */
+export interface GuardianApiEvaluateMessageRequest {
+    /**
+     * Specifies the kind of transaction
+     * @type {MessageEvaluationRequest}
+     * @memberof GuardianApiEvaluateMessage
+     */
+    readonly messageEvaluationRequest: MessageEvaluationRequest;
+}
+/**
+ * Request parameters for evaluateTransaction operation in GuardianApi.
+ * @export
+ * @interface GuardianApiEvaluateTransactionRequest
+ */
+export interface GuardianApiEvaluateTransactionRequest {
+    /**
+     * Transaction identifier: payloadHash on StarkEx or EVM ID
+     * @type {string}
+     * @memberof GuardianApiEvaluateTransaction
+     */
+    readonly id: string;
+    /**
+     * Specifies the kind of transaction
+     * @type {TransactionEvaluationRequest}
+     * @memberof GuardianApiEvaluateTransaction
+     */
+    readonly transactionEvaluationRequest: TransactionEvaluationRequest;
+}
+/**
+ * Request parameters for getErc191MessageByID operation in GuardianApi.
+ * @export
+ * @interface GuardianApiGetErc191MessageByIDRequest
+ */
+export interface GuardianApiGetErc191MessageByIDRequest {
+    /**
+     * The id of the erc191 message
+     * @type {string}
+     * @memberof GuardianApiGetErc191MessageByID
+     */
+    readonly messageID: string;
+}
+/**
+ * Request parameters for getMessageByID operation in GuardianApi.
+ * @export
+ * @interface GuardianApiGetMessageByIDRequest
+ */
+export interface GuardianApiGetMessageByIDRequest {
+    /**
+     * The id of the evm message
+     * @type {string}
+     * @memberof GuardianApiGetMessageByID
+     */
+    readonly messageID: string;
+    /**
+     * Include simulation results
+     * @type {boolean}
+     * @memberof GuardianApiGetMessageByID
+     */
+    readonly includeSimulation?: boolean;
+}
+/**
+ * Request parameters for getTransactionByID operation in GuardianApi.
+ * @export
+ * @interface GuardianApiGetTransactionByIDRequest
+ */
+export interface GuardianApiGetTransactionByIDRequest {
+    /**
+     * The id of the starkex transaction to retrieve
+     * @type {string}
+     * @memberof GuardianApiGetTransactionByID
+     */
+    readonly transactionID: string;
+    /**
+     * roll up type
+     * @type {'starkex' | 'evm'}
+     * @memberof GuardianApiGetTransactionByID
+     */
+    readonly chainType: GetTransactionByIDChainTypeEnum;
+    /**
+     * ID of evm chain
+     * @type {string}
+     * @memberof GuardianApiGetTransactionByID
+     */
+    readonly chainID?: string;
+    /**
+     * Include simulation results
+     * @type {boolean}
+     * @memberof GuardianApiGetTransactionByID
+     */
+    readonly includeSimulation?: boolean;
+}
+/**
+ * GuardianApi - object-oriented interface
+ * @export
+ * @class GuardianApi
+ * @extends {BaseAPI}
+ */
+export declare class GuardianApi extends BaseAPI {
+    /**
+     * Approve a pending erc191 message
+     * @summary Approve a pending erc191 message
+     * @param {GuardianApiApprovePendingERC191MessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    approvePendingERC191Message(requestParameters: GuardianApiApprovePendingERC191MessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Approve a pending evm message
+     * @summary Approve a pending evm message
+     * @param {GuardianApiApprovePendingMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    approvePendingMessage(requestParameters: GuardianApiApprovePendingMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Approve a pending transaction
+     * @summary Approve a pending transaction given chain
+     * @param {GuardianApiApprovePendingTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    approvePendingTransaction(requestParameters: GuardianApiApprovePendingTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Check if a given erc191 message is valid
+     * @summary Evaluate an erc191 message to sign
+     * @param {GuardianApiEvaluateErc191MessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    evaluateErc191Message(requestParameters: GuardianApiEvaluateErc191MessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageEvaluationResponse, any>>;
+    /**
+     * Check if a given message is valid  for EVM
+     * @summary Evaluate an evm message to sign
+     * @param {GuardianApiEvaluateMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    evaluateMessage(requestParameters: GuardianApiEvaluateMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageEvaluationResponse, any>>;
+    /**
+     * Check if the transaction is valid by transaction ID for both StarkEx and EVM
+     * @summary Evaluate a transaction
+     * @param {GuardianApiEvaluateTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    evaluateTransaction(requestParameters: GuardianApiEvaluateTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionEvaluationResponse, any>>;
+    /**
+     * Get an erc191 message by id
+     * @summary Info for a specific erc191 message
+     * @param {GuardianApiGetErc191MessageByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    getErc191MessageByID(requestParameters: GuardianApiGetErc191MessageByIDRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Erc191MessageResponse, any>>;
+    /**
+     * Get an evm message by id
+     * @summary Info for a specific evm message
+     * @param {GuardianApiGetMessageByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    getMessageByID(requestParameters: GuardianApiGetMessageByIDRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EVMMessage, any>>;
+    /**
+     * Get a transaction by payload hash
+     * @summary Info for a specific transaction
+     * @param {GuardianApiGetTransactionByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GuardianApi
+     */
+    getTransactionByID(requestParameters: GuardianApiGetTransactionByIDRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Transaction, any>>;
+}
+/**
+ * @export
+ */
+export declare const GetTransactionByIDChainTypeEnum: {
+    readonly Starkex: "starkex";
+    readonly Evm: "evm";
+};
+export type GetTransactionByIDChainTypeEnum = typeof GetTransactionByIDChainTypeEnum[keyof typeof GetTransactionByIDChainTypeEnum];