Overview

getNonce

Returns the nonce for a given wallet address.

 /**
   *
   * @memberof LimitOrder
   * @description Get user nonce for signing
   * @method getNonce
   * @param {string} walletAddress
   * @returns {Promise<nonceResponse>}
   */
  getNonce(walletAddress: string): Promise<nonceResponse>;

getRemainingAmount

This function retrieves the remaining amount for a specific order using the Limit Order SDK. It queries the remaining amount using the LimitOrder.getRemainingAmount() method.

  /**
   *
   * @memberof LimitOrder
   * @description Get remaining amount of order if maker allowed to partially fill
   * @method getRemainingAmount
   * @param {string} orderHash
   * @returns {Promise<string>}
   */
  getRemainingAmount(orderHash: string): Promise<string>;

getOrders

This function retrieves open orders using the Limit Order SDK. It constructs a filter object based on specified parameters and queries the orders using the LimitOrder.getOrders() method.

 /**
   *
   * @memberof LimitOrder
   * @description Get open orders by filter
   * @method getOrders
   * @param {ordersFilter} [filter]
   * @returns {Promise<getOrdersResponse>}
   */
  getOrders(filter?: ordersFilter): Promise<getOrdersResponse>;

fillOrder

This function fills an order with a specified amount using the Limit Order SDK.

  /**
   *
   * @memberof LimitOrder
   * @description Build calldata to fill order by order hash
   * @method fillOrder
   * @param {string} orderHash
   * @returns {Promise<fillOrderResponse>}
   */
  fillOrder(
    orderHash: string,
    fill_amount?: string
  ): Promise<fillOrderResponse>;

signMessage

This function signs a message, typically an order, using the Limit Order SDK.

  /**
   *
   * @memberof LimitOrder
   * @description Sign order message with Fibrous message standard
   * @method signMessage
   * @param {Order} order
   * @param {number} [nonce]
   * @returns {Promise<signMessageResponse>}
   */
  signMessage(order: Order, nonce?: number): Promise<signMessageResponse>;

placeOrder

This function places an order using the Limit Order SDK.

  /**
   *
   * @memberof LimitOrder
   * @description Place order
   * @method placeOrder
   * @param {Order} order
   * @returns {Promise<placeOrderResponse>}
   */
  placeOrder(order: Order): Promise<placeOrderResponse>;
   

cancelOrder

Returns an Call object containing information about the cancel order transaction.

  /**
   * @description Cancel order
   * @method cancelOrder
   * @param {number} nonce
   * @returns  {Call}
   */
  cancelOrder(nonce: number): Call;

Last updated