@imtbl/sdk 0.44.4-alpha.1 → 0.45.0

package/dist/passport.d.ts

@@ -9846,7 +9846,7 @@ interface ImxOverrides {
 interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
 }
 
-declare class ImmutableXClient {
+declare class IMXClient {
     private immutableX;
     depositsApi: DepositsApi$1;
     mintsApi: MintsApi$1;
@@ -20972,7 +20972,7 @@ interface PassportOverrides {
     magicProviderId: string;
     passportDomain: string;
     imxPublicApiDomain: string;
-    immutableXClient: ImmutableXClient;
+    immutableXClient: IMXClient;
     imxApiClients: ImxApiClients;
     zkEvmRpcUrl: string;
     relayerUrl: string;

package/dist/passport.js

@@ -8724,7 +8724,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.44.4-alpha.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.45.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -8792,7 +8792,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.44.4-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-0.45.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -8838,7 +8838,7 @@ class ImxConfiguration {
     }
 }
 
-class ImmutableXClient {
+class IMXClient {
     immutableX;
     depositsApi;
     mintsApi;
@@ -15518,7 +15518,7 @@ class Passport {
         this.magicAdapter = new MagicAdapter(this.config);
         this.confirmationScreen = new ConfirmationScreen(this.config);
         this.immutableXClient = passportModuleConfiguration.overrides?.immutableXClient
-            || new ImmutableXClient({
+            || new IMXClient({
                 baseConfig: passportModuleConfiguration.baseConfig,
             });
         this.multiRollupApiClients = new MultiRollupApiClients(this.config.multiRollupConfig);

package/dist/{immutablex_client.d.ts → x.d.ts}

@@ -2601,6 +2601,31 @@ interface CreateTransferRequestV1 {
     'stark_signature': string;
 }
 
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.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 CreateTransferResponse
+ */
+interface CreateTransferResponse {
+    /**
+     * List of transfer IDs
+     * @type {Array<number>}
+     * @memberof CreateTransferResponse
+     */
+    'transfer_ids': Array<number>;
+}
+
 /**
  * Immutable X API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -9770,7 +9795,7 @@ interface ImxOverrides {
 interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
 }
 
-declare class ImmutableXClient {
+declare class IMXClient {
     private immutableX;
     depositsApi: DepositsApi;
     mintsApi: MintsApi;
@@ -10116,4 +10141,132 @@ declare class ImmutableXClient {
     getNftPrimaryTransactions(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest): Promise<NftprimarytransactionListTransactionsResponse>;
 }
 
-export { AnyToken, ERC20Amount, ERC20Token, ERC721Token, ETHAmount, ETHToken, ExchangeTokenAmount, IMXError, ImmutableXClient, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, NftTransferDetails, StarkSigner, TokenAmount, UnsignedExchangeTransferRequest, UnsignedMintRequest, UnsignedOrderRequest, UnsignedTransferRequest, WalletConnection, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey };
+interface IMXProvider {
+    /**
+     * Get the Signer address
+     *
+     * @return {Promise<string>} Returns a promise that resolves with the signer's address
+     */
+    getAddress(): Promise<string>;
+    /**
+     * Register a User to Immutable X if they are not already registered
+     *
+     * @return {Promise<RegisterUserResponse>} Returns a promise that resolves with the user registration response
+     */
+    registerOffchain(): Promise<RegisterUserResponse>;
+    /**
+     *  Checks if a User is registered off-chain
+     *
+     *  @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered with IMX, false otherwise
+     */
+    isRegisteredOffchain(): Promise<boolean>;
+    /**
+     * Checks if a User is registered on-chain
+     *
+     * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered, false otherwise
+     */
+    isRegisteredOnchain(): Promise<boolean>;
+    /**
+     * Create an Order
+     *
+     * @param {UnsignedOrderRequest} request The unsigned order request to create an order
+     * @return {Promise<CreateOrderResponse>} Returns a promise that resolves with the created Order
+     */
+    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
+    /**
+     * Cancel an Order
+     *
+     * @param {GetSignableCancelOrderRequest} request The signable cancel order request
+     * @return {Promise<CancelOrderResponse>} Returns a promise that resolves with the cancelled Order
+     */
+    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
+    /**
+     * Create a Trade
+     *
+     * @param {GetSignableTradeRequest} request The signable trade request
+     * @return {Promise<CreateTradeResponse>} Returns a promise that resolves with the created Trade
+     */
+    createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
+    /**
+     * Create a new Transfer request
+     *
+     * @param {UnsignedTransferRequest} request The unsigned transfer request
+     * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Transfer
+     */
+    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1>;
+    /**
+     * Create a batch of NFT transfer requests
+     *
+     * @param {Array<NftTransferDetails>} request An array of NFT transfer details
+     * @return {Promise<CreateTransferResponse>} Resolves a promise that resolves with the list of Transfer IDs
+     */
+    batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
+    /**
+     * Create a new Exchange transaction
+     *
+     * @param {UnsignedExchangeTransferRequest} request The unsigned exchange transfer request
+     * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Exchange Transaction
+     */
+    exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
+    /**
+     * Deposit either ETH, ERC20 or ERC721 tokens
+     *
+     * @param {TokenAmount} request The token type amount in its corresponding unit
+     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
+     */
+    deposit(deposit: TokenAmount): Promise<TransactionResponse>;
+    /**
+     * Create a Withdrawal
+     *
+     * @param {TokenAmount} request The token type amount in its corresponding unit
+     * @return {Promise<CreateWithdrawalResponse>} Returns a promise that resolves with the created Withdrawal
+     */
+    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
+    /**
+     * Completes a Withdrawal
+     *
+     * @param {string} starkPublicKey The stark public key
+     * @param {AnyToken} token The token to withdraw
+     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
+     */
+    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
+}
+
+interface ProviderOverrides {
+    immutableXConfig: ImmutableXConfiguration;
+}
+interface ProviderModuleConfiguration extends ModuleConfiguration<ProviderOverrides> {
+}
+declare class ProviderConfiguration {
+    readonly immutableXConfig: ImmutableXConfiguration;
+    readonly baseConfig: ImmutableConfiguration;
+    constructor({ baseConfig, overrides }: ProviderModuleConfiguration);
+}
+
+declare class GenericIMXProvider implements IMXProvider {
+    private readonly config;
+    private readonly signers;
+    constructor(config: ProviderConfiguration, ethSigner: Signer, starkSigner: StarkSigner);
+    getAddress(): Promise<string>;
+    isRegisteredOffchain(): Promise<boolean>;
+    registerOffchain(): Promise<RegisterUserResponse>;
+    batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
+    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
+    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
+    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
+    createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
+    deposit(tokenAmount: TokenAmount): Promise<TransactionResponse>;
+    exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
+    isRegisteredOnchain(): Promise<boolean>;
+    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
+    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1>;
+}
+
+declare class MetaMaskIMXProvider extends GenericIMXProvider {
+    private static imxSigner;
+    static connect(config: ProviderConfiguration): Promise<MetaMaskIMXProvider>;
+    static disconnect(): Promise<void>;
+    static signMessage(message: string): Promise<string>;
+}
+
+export { AnyToken, ERC20Amount, ERC20Token, ERC721Token, ETHAmount, ETHToken, ExchangeTokenAmount, GenericIMXProvider, IMXClient, IMXError, IMXProvider, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, MetaMaskIMXProvider, NftTransferDetails, ProviderConfiguration, StarkSigner, TokenAmount, UnsignedExchangeTransferRequest, UnsignedMintRequest, UnsignedOrderRequest, UnsignedTransferRequest, WalletConnection, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey };