Skip to content

Commit dd8b20a

Browse files
committed
Update readme
1 parent 81817f6 commit dd8b20a

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ NOTE: In sandbox, testnet funds are automatically sent to new accounts. The sand
1111

1212
## Installation
1313

14+
Requires usage of Node 14 or greater.
15+
1416
```sh
1517
yarn add @neon-exchange/api-client-typescript
1618
```
@@ -20,6 +22,11 @@ yarn add @neon-exchange/api-client-typescript
2022
To get started you need to create an API key. You can find instructions on how to do so further down in this Readme.
2123
Remember, API Keys contain sensitive infomation, if you are using version control be careful not to store the key in the repository.
2224

25+
## API Compatibility
26+
27+
Versions 6 and above include a change to order placement logic. The previous order placement logic will no longer be compatible with the exchange, so it is highly recommended to upgrade to version 6 or higher as previous versions will be deprecated.
28+
29+
2330
## Usage
2431

2532
```typescript

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@
5656
"prepare-release": "One-step: clean, build, test, publish docs, and prep a release"
5757
},
5858
"engines": {
59-
"node": ">=8.9 <16.0.0"
59+
"node": ">=14.3"
6060
},
6161
"dependencies": {
6262
"@absinthe/socket": "0.2.1",
6363
"@cityofzion/neon-js": "4.7.2",
6464
"@neon-exchange/nash-perf": "1.0.4",
65-
"@neon-exchange/nash-protocol": "4.0.5",
65+
"@neon-exchange/nash-protocol": "4.0.7",
6666
"@types/isomorphic-fetch": "0.0.35",
6767
"@types/node": "13.9.8",
6868
"@types/request": "2.48.1",

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -784,10 +784,10 @@
784784
node-fetch "2.6.0"
785785
semver "7.3.2"
786786

787-
"@neon-exchange/nash-protocol@4.0.5":
788-
version "4.0.5"
789-
resolved "https://registry.yarnpkg.com/@neon-exchange/nash-protocol/-/nash-protocol-4.0.5.tgz#df0bb50c757b51c612035542f982d8efcaffe0a5"
790-
integrity sha512-JtG5ctNxgEf/wrWfD7Z2NPZqIIlGjQX+U2HmCRrwWPtJWeh6nDMbTJ42bN8kbthFt1RyxJZRPQgInqIhRZbnyA==
787+
"@neon-exchange/nash-protocol@4.0.7":
788+
version "4.0.7"
789+
resolved "https://registry.yarnpkg.com/@neon-exchange/nash-protocol/-/nash-protocol-4.0.7.tgz#65c927db5a0c38e1e58c7bc7ba1853d45900c132"
790+
integrity sha512-9AVwl61ZpLA3KiM9fRVpG/y0OoYepwwrEk4ZlSBd2FeVCmGqN8cR0VN9DkkVLipD+mQ6/TC88Ym4odp7T7KJmw==
791791
dependencies:
792792
bignumber.js "8.1.1"
793793
bip32 "2.0.3"

0 commit comments

Comments
 (0)