Class GenericIMXProvider

Hierarchy

GenericIMXProvider
- x.MetaMaskIMXProvider
- x.MetaMaskIMXProvider

Implements

x.IMXProvider

Index

Constructors

Properties

Methods

getAddress isRegisteredOffchain registerOffchain batchNftTransfer cancelOrder completeWithdrawal createOrder createTrade deposit exchangeTransfer isRegisteredOnchain prepareWithdrawal transfer

Constructors

constructor

new GenericIMXProvider(config, ethSigner, starkSigner): x.GenericIMXProvider
Parameters
- config: x.ProviderConfiguration
- ethSigner: x.EthSigner
- starkSigner: x.StarkSigner
Returns x.GenericIMXProvider
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:9

Properties

`Private` `Readonly` config

config: any

`Private` `Readonly` signers

signers: any

Methods

getAddress

getAddress(): Promise<string>
Get the Signer address

Returns Promise<string>
Returns a promise that resolves with the signer's address
Implementation of IMXProvider.getAddress
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:10

isRegisteredOffchain

isRegisteredOffchain(): Promise<boolean>
Checks if a User is registered off-chain

Returns Promise<boolean>
Returns a promise that resolves with true if the User is registered with IMX, false otherwise
Implementation of IMXProvider.isRegisteredOffchain
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:11

registerOffchain

registerOffchain(): Promise<RegisterUserResponse>
Register a User to Immutable X if they are not already registered

Returns Promise<RegisterUserResponse>
Returns a promise that resolves with the user registration response
Implementation of IMXProvider.registerOffchain
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:12

batchNftTransfer

batchNftTransfer(request): Promise<CreateTransferResponse>
Create a batch of NFT transfer requests
Parameters
- request: x.NftTransferDetails[]
  
  An array of NFT transfer details
Returns Promise<CreateTransferResponse>
Resolves a promise that resolves with the list of Transfer IDs
Implementation of IMXProvider.batchNftTransfer
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:13

cancelOrder

cancelOrder(request): Promise<CancelOrderResponse>
Cancel an Order
Parameters
- request: x.GetSignableCancelOrderRequest
  
  The signable cancel order request
Returns Promise<CancelOrderResponse>
Returns a promise that resolves with the cancelled Order
Implementation of IMXProvider.cancelOrder
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:14

completeWithdrawal

completeWithdrawal(starkPublicKey, token): Promise<x.TransactionResponse>
Completes a Withdrawal
Parameters
- starkPublicKey: string
  
  The stark public key
- token: x.AnyToken
  
  The token to withdraw
Returns Promise<x.TransactionResponse>
Returns a promise that resolves with the transaction
Implementation of IMXProvider.completeWithdrawal
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:15

createOrder

createOrder(request): Promise<CreateOrderResponse>
Create an Order
Parameters
- request: x.UnsignedOrderRequest
  
  The unsigned order request to create an order
Returns Promise<CreateOrderResponse>
Returns a promise that resolves with the created Order
Implementation of IMXProvider.createOrder
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:16

createTrade

createTrade(request): Promise<x.CreateTradeResponse>
Create a Trade
Parameters
- request: x.GetSignableTradeRequest
  
  The signable trade request
Returns Promise<x.CreateTradeResponse>
Returns a promise that resolves with the created Trade
Implementation of IMXProvider.createTrade
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:17

deposit

deposit(tokenAmount): Promise<x.TransactionResponse>
Deposit either ETH, ERC20 or ERC721 tokens
Parameters
- tokenAmount: x.TokenAmount
Returns Promise<x.TransactionResponse>
Returns a promise that resolves with the transaction
Implementation of IMXProvider.deposit
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:18

exchangeTransfer

exchangeTransfer(request): Promise<CreateTransferResponseV1>
Create a new Exchange transaction
Parameters
- request: x.UnsignedExchangeTransferRequest
  
  The unsigned exchange transfer request
Returns Promise<CreateTransferResponseV1>
Returns a promise that resolves with the created Exchange Transaction
Implementation of IMXProvider.exchangeTransfer
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:19

isRegisteredOnchain

isRegisteredOnchain(): Promise<boolean>
Checks if a User is registered on-chain

Returns Promise<boolean>
Returns a promise that resolves with true if the User is registered, false otherwise
Implementation of IMXProvider.isRegisteredOnchain
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:20

prepareWithdrawal

prepareWithdrawal(request): Promise<CreateWithdrawalResponse>
Create a Withdrawal
Parameters
- request: x.TokenAmount
  
  The token type amount in its corresponding unit
Returns Promise<CreateWithdrawalResponse>
Returns a promise that resolves with the created Withdrawal
Implementation of IMXProvider.prepareWithdrawal
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:21

transfer

transfer(request): Promise<CreateTransferResponseV1>
Create a new Transfer request
Parameters
- request: x.UnsignedTransferRequest
  
  The unsigned transfer request
Returns Promise<CreateTransferResponseV1>
Returns a promise that resolves with the created Transfer
Implementation of IMXProvider.transfer
- Defined in packages/x-provider/dist/genericImxProvider.d.ts:22

Generated using TypeDoc