@d8x/perpetuals-sdk 1.1.22 → 1.1.23

package/README.md

@@ -1,24 +1,12 @@
 # @d8x/perpetuals-sdk
 
-Node TypeScript SDK for D8X Perpetual Futures
+This is a node TypeScript SDK for
+[D8X Perpetual Futures](https://d8x.exchange/)
 
-### Installations
+D8X provides fully decentralized perpetual futures implemented on the blockchain.
 
-- install node via nvm, [see here](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-up-node-on-ec2-instance.html)
-- install typescript
-  `npm install -g typescript`
-  `npm install -g ts-node`
-- install yarn [see here](https://classic.yarnpkg.com/en/docs/install/#debian-stable)
-- clone this repo
-- open directory of repo and type `yarn` to install packages
+Using this SDK, you can execute many functions that the smart contracts offer, such as, providing liquidity and participating in the
+exchange revenue, submitting on-chain orders, removing or adding collateral in one of your existing positions, executing any executable orders placed
+and earn an execution fee, liquidating positions and earning a liquidator-fee.
 
-### Test
-
-`yarn test`
-
-### NPM Package Deployment
-
-`yarn build`
-`yarn build:doc`
-`yarn login`
-`yarn publish`
+Get started with the SDK [documentation](doc/d8x-perpetuals-sdk.md) or checkout [D8X gitbooks](https://d8x.gitbook.io/d8x).

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const D8X_SDK_VERSION = "1.1.22";
+export declare const D8X_SDK_VERSION = "1.1.23";

package/dist/cjs/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.D8X_SDK_VERSION = void 0;
-exports.D8X_SDK_VERSION = "1.1.22";
+exports.D8X_SDK_VERSION = "1.1.23";
 //# sourceMappingURL=version.js.map

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const D8X_SDK_VERSION = "1.1.22";
+export declare const D8X_SDK_VERSION = "1.1.23";

package/dist/esm/version.js

@@ -1,2 +1,2 @@
-export const D8X_SDK_VERSION = "1.1.22";
+export const D8X_SDK_VERSION = "1.1.23";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d8x/perpetuals-sdk",
-  "version": "1.1.22",
+  "version": "1.1.23",
   "description": "Node TypeScript SDK for D8X Perpetual Futures",
   "author": "D8X",
   "homepage": "https://github.com/D8-X/d8x-futures-node-sdk#readme",
@@ -12,6 +12,7 @@
   "bugs": {
     "url": "https://github.com/D8-X/d8x-futures-node-sdk/issues"
   },
+  "documentation": "doc",
   "keywords": [
     "d8x",
     "perpetuals",

package/src/version.ts

@@ -1 +1 @@
-export const D8X_SDK_VERSION = "1.1.22";
+export const D8X_SDK_VERSION = "1.1.23";