100x-client - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

CHANGELOG.md

@@ -8,1 +8,12 @@ # 100x Client SDK
 - Added contributing guidelines.
+
+## 1.0.1
+
+- Updated README.
+- Updated release workflow for better ordering.
+
+## 1.0.2
+
+- Added missing entry points to package.json.
+- Tweaks to the TypeScript config.
+- Updated various docs.

lib/enums.d.ts

@@ -22,3 +22,3 @@ declare enum Environment {
 declare enum OrderStatus {
-    CANCELED = "CANCELLED",
+    CANCELLED = "CANCELLED",
     EXPIRED = "EXPIRED",
@@ -25,0 +25,0 @@ FILLED = "FILLED",

lib/enums.js

@@ -26,3 +26,3 @@ // src/enums.ts
 var OrderStatus = /* @__PURE__ */ ((OrderStatus2) => {
-  OrderStatus2["CANCELED"] = "CANCELLED";
+  OrderStatus2["CANCELLED"] = "CANCELLED";
   OrderStatus2["EXPIRED"] = "EXPIRED";
@@ -29,0 +29,0 @@ OrderStatus2["FILLED"] = "FILLED";

lib/index.js

@@ -12,3 +12,3 @@ import logger, { levels } from 'pino';
   __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
+  return member.get(obj);
 };
@@ -22,3 +22,3 @@ var __privateAdd = (obj, member, value) => {
   __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
+  member.set(obj, value);
   return value;
@@ -25,0 +25,0 @@ };

package.json

 {
   "name": "100x-client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A TypesScript SDK for the 100x exchange API.",
@@ -45,2 +45,4 @@ "keywords": [
   },
+  "main": "./lib/index.js",
+  "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -47,0 +49,0 @@ "files": [

README.md

@@ -1,6 +0,8 @@
-<div align="center">
-  <img src="https://app.100x.finance/brand/100x-bg-blue.webp" alt="100x Logo" width="480" height="270" style="margin: 1rem 0;">
-</div>
+<p align="center">
+  <img alt="100x Logo" src="https://app.100x.finance/brand/100x-bg-blue.webp" />
+</p>
 
-# 100x TypeScript Client SDK [![Test & Release](https://github.com/MeanBoyCousin/100xClient/actions/workflows/release.yml/badge.svg)](https://github.com/MeanBoyCousin/100xClient/actions/workflows/release.yml) [![npm version](https://badge.fury.io/js/100x-client.svg)](https://badge.fury.io/js/100xclient)
+![Build](https://img.shields.io/github/actions/workflow/status/MeanBoyCousin/100xClient/release.yml?style=flat-square&label=Build&color=%234177f6)
+![NPM Version](https://img.shields.io/npm/v/100x-client?style=flat-square&label=NPM&color=%234177f6)
+![Discord](https://img.shields.io/discord/1203621012659249192?style=flat-square&logo=discord&logoColor=%23fff&label=Discord&color=%234177f6)
 
@@ -56,3 +58,3 @@ Interact with the [100x decentralized exchange](https://100x.finance/) and trade pre-launch tokens, BTC, ETH, SOL, BLUR and other cryptocurrency perp futures with leverage. Live on [Blast](https://blast.io/en).
 
-To get started, you will need to deposit funds and make a trade. Let's look at how we can do that now.
+To get started, you will need to deposit funds and make a trade. Let's look at how we can do that now. If you're in need of testnet funds, please head over to the [100x Discord server](https://discord.gg/100xdex) where we will be happy to help.
 
@@ -86,2 +88,17 @@ ```ts
 
+### Handy enums
+
+A series of useful enums can be imported from `100x-client/enums` and used to help match against responses or compose payloads.
+
+| Name         | Values                                                                                 | Description                                          |
+|--------------|----------------------------------------------------------------------------------------|------------------------------------------------------|
+| Environment  | MAINNET \| TESTNET                                                                     | The environment to use when initialising the client. |
+| Interval     | '1M' \| '5M' \| '15M' \| '30M' \| '1H' \| '2H' \| '4H' \| '8H' \| '1D' \| '3D' \| '1W' | The interval to use when fetching K-line data.       |
+| MarginAssets | USDB                                                                                   | Symbol values of supported margin assets.            |
+| OrderStatus  | CANCELLED \| EXPIRED \| FILLED \| OPEN \| PENDING \| REJECTED                          | Defines the possible states an order can be in.      |
+| OrderType    | LIMIT \| LIMIT_MAKER \| MARKET                                                         | Order types for building order payloads.             |
+| TimeInForce  | GTC \| FOK \| IOC                                                                      | Time in force values for building order payloads.    |
+
+### Further support
+
 For more detailed information on specific endpoints, please refer to the official [100x API docs](https://100x.readme.io/reference/100x-api-introduction). Each function in this client contains detailed JSDocs on arguments and return types to aid the developer experience as well as links to their respective endpoints within the official docs.
@@ -95,3 +112,3 @@
 
-Having troubles getting started? Feel free to join us the official [100x Discord sever](https://discord.gg/100xdex) where you can get full support from the team.
+Having troubles getting started? Feel free to join us the official [100x Discord server](https://discord.gg/100xdex) where you can get full support from the team.
 
@@ -98,0 +115,0 @@ ## License

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

75230

increased by2.48%

Number of lines in readme file

115

increased by17.35%

No dependency changes