npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@unidexexchange/sdk

v0.0.22

Published

Communicate with the unidex API to submit and manage orders

Downloads

1

Readme

Unidex SDK

This SDK helps you interact with The Unidex backend. Please see https://unidexexchange.gitbook.io/unidex/api-information/ for a description on how to manually connect to our API.

Installation

In your favorite package manager:

npm install @unidexexchange/sdk

In your code:

import LimitOrdersApi from '@unidex/sdk';

function SubmitLimitOrder() {
  // get order details
  const tx = await LimitOrdersApi.placeOrder(request);
  submitTransaction(tx);
}

Typical Flow

Most users will use this library to submit limit orders to Unidex's backend. As shown in the example above, the first step is to call placeOrder. Once this is done, an order will be executed by our contracts in the background and balances on the blockchain will be updated.

If a user desires to cancel a previously submitted order, they must fetch all pertinent information using listOrders and subsequently, submit the result of cancelOrder to the blockchain.

Below we provide a description of the API. Most names are selfexplanatory.

API

LimitOrdersApi.listOrders

Fetch all orders for an account/network.

Request:

interface FetchLimitOrdersTxRequest {
  account: string;
  chainId: number;
  includeCancelled: boolean;
  includeExecuted: boolean;
}

Response: A list of OpenLimitOrders

interface OpenLimitOrder {
  id: string;
  blockNumber: string;
  createdAt: string;
  inputToken: string;
  inputAmount: string;
  outputToken: string;
  minReturn: string;
  module: string;
  owner: string;
  witness: string;
  createdTxHash: string;
  executedTxHash: string;
  cancelledTxHash: string;
  vault: string;
  updatedAt: string;
}

LimitOrdersApi.placeOrder

Fetch the EVM transaction that creates a Limit Order in the Unidex system. The returned transaction should be submitted to the blockchain.

Request:

interface PlaceLimitOrderTxRequest {
  chainId: number;
  account: string;
  sellToken: string;
  sellAmount: string;
  buyToken: string;
  buyAmount: string;
}

Response: Transaction to be submitted

interface Transaction {
  to: string;
  from?: string;
  data: any;
  value?: string;
  gasLimit?: string;
}

LimitOrdersApi.cancelOrder

Cancel an already submitted limit order. Make sure all the parameters matched those returned by listOrders

Request:

interface CancelLimitOrderTxRequest {
  account: string;
  chainId: number;
  module: string;
  inputToken: string;
  outputToken: string;
  minReturn: string;
  owner: string;
  witness: string;
}

Response:

interface Transaction {
  to: string;
  from?: string;
  data: any;
  value?: string;
  gasLimit?: string;
}