Skip to content

Commit 76f0cb0

Browse files
authored
Merge pull request #9 from nash-io/readme
Update gitlab references, new home is github :)
2 parents bc3002c + b09c1d0 commit 76f0cb0

File tree

3 files changed

+15
-241
lines changed

3 files changed

+15
-241
lines changed

.gitlab-ci.yml

Lines changed: 0 additions & 236 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ yarn add @neon-exchange/api-client-typescript
1818

1919
## Getting started
2020

21-
To get started you need to create an API key. You can find instructions on how to do so on our [wiki page](https://gitlab.com/nash-io-public/api-client-typescript/-/wikis/Setting-up-API-keys).
22-
21+
To get started you need to create an API key. You can find instructions on how to do so further down in this Readme.
2322
Remember, API Keys contain sensitive infomation, if you are using version control be careful not to store the key in the repository.
2423

2524
## Usage
@@ -111,10 +110,21 @@ connection.onUpdatedAccountOrders(
111110

112111
See also the [websockets example](https://github.com/nash-io/api-client-typescript/tree/master/examples/sockets-orderbook).
113112

114-
## Managing API key policies
113+
---
114+
115+
## Setting up API keys
116+
117+
Setting up an API key is very easy. Start by navigating to your profile page, from the profile page, click on the API Keys tab, and click on the 'Generate new key' to open a create API Key wizard.
118+
After going through the wizard. Remember to save your API key, and store it somewhere accessible to your project.
119+
120+
[This video](https://youtu.be/5DQ0PCbCwkI) shows how to set up a new API Key.
121+
122+
## API key policies & transferring funds to external wallets
115123

116-
For more information on how to set up policies for API keys, consult the [API key policies wiki page](https://gitlab.com/nash-io-public/api-client-typescript/-/wikis/Apikey-policies).
124+
Using API keys allows users to apply policies to operations performed by the SDK. One such operation is to transfer funds to external accounts. This is done by using the transferToExternal method on the Client.
125+
Before being allowed to send funds, addresses have to be explicitly whitelisted. Otherwise the all calls to the method will result in a permission violation.
117126

127+
Whitelisted addresses can be set up both before and after creating the API key. [This video](https://youtu.be/5hAa3FqknFA) shows how to whitelist two addresses for an API key.
118128

119129
## State signing
120130

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"main": "build/main/index.js",
66
"typings": "build/main/index.d.ts",
77
"module": "build/module/index.js",
8-
"repository": "https://gitlab.com/nash-io-public/api-client-typescript",
8+
"repository": "https://github.com/nash-io/api-client-typescript",
99
"license": "MIT",
1010
"keywords": [],
1111
"scripts": {

0 commit comments

Comments
 (0)