Interface IMXProvider

Hierarchy

IMXProvider

Implemented by

Index

Methods

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

Methods

getAddress

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

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

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:16

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:22

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:28

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:35

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:42

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:49

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:56

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:63

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:70

deposit

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

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:84

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
- Defined in packages/x-provider/dist/imxProvider.d.ts:92

Generated using TypeDoc