Skip to content
This repository has been archived by the owner on Dec 11, 2020. It is now read-only.

Commit

Permalink
v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@luciorubeens
luciorubeens committed Jul 26, 2017
1 parent 52f08a1 commit 239c233
Show file tree
Hide file tree
Showing 51 changed files with 342 additions and 325 deletions.
15 changes: 13 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@

> An ARK API wrapper, written in TypeScript to interact with ARK blockchain.
[![npm](https://img.shields.io/npm/dt/ark-ts.svg)]()
[![npm](https://img.shields.io/npm/v/ark-ts.svg)]()
[![license](https://img.shields.io/github/license/arkecosystem/ark-ts.svg)]()

TSARK is a library client designed to facilitate how you interact with the ARK blockchain.

## Why TypeScript

* TypeScript is is a superset of JavaScript which mainly offers optional static typing, classes, and interfaces. The learning curve is not that steep.
* Types are optional, TSARK compiles into ES6 so you can work with both, ECMAScript or TypeScript.
* Types are optional, TSARK compiles into ES5 so you can work with both, ECMAScript or TypeScript.
* A better development experience, including auto-complete and fully documented.

## Documentation
Expand All @@ -20,9 +24,16 @@ TSARK is a library client designed to facilitate how you interact with the ARK b

TSARK is avaliable from `npm`.

```bash
yarn add ark-ts
```

or

```bash
npm i ark-ts --save
```

## Usage

For the best TypeScript experience, you should either use [Visual Studio Code](http://code.visualstudio.com/), or a [plug-in for your favorite text editor](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).
Expand All @@ -45,7 +56,7 @@ client.delegate.list().subscribe((list) => {
> Get address from passphrase.
```js
import { PrivateKey } from 'ark-ts/lib/core';
import { PrivateKey } from 'ark-ts/core';

// if no specify a second param, default is mainnet
const key = PrivateKey.fromSeed('my secret passphrase');
Expand Down
14 changes: 7 additions & 7 deletions docs/classes/_ark_.client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/Ark.ts#L12">Ark.ts:12</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/Ark.ts#L12">Ark.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -131,7 +131,7 @@ <h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <a href="api.accountapi.html" class="tsd-signature-type">AccountApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/Ark.ts#L7">Ark.ts:7</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/Ark.ts#L7">Ark.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -141,7 +141,7 @@ <h3>block</h3>
<div class="tsd-signature tsd-kind-icon">block<span class="tsd-signature-symbol">:</span> <a href="api.blockapi.html" class="tsd-signature-type">BlockApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/Ark.ts#L11">Ark.ts:11</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/Ark.ts#L11">Ark.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -151,7 +151,7 @@ <h3>delegate</h3>
<div class="tsd-signature tsd-kind-icon">delegate<span class="tsd-signature-symbol">:</span> <a href="api.delegateapi.html" class="tsd-signature-type">DelegateApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/Ark.ts#L8">Ark.ts:8</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/Ark.ts#L8">Ark.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -161,7 +161,7 @@ <h3>loader</h3>
<div class="tsd-signature tsd-kind-icon">loader<span class="tsd-signature-symbol">:</span> <a href="api.loaderapi.html" class="tsd-signature-type">LoaderApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/Ark.ts#L10">Ark.ts:10</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/Ark.ts#L10">Ark.ts:10</a></li>
</ul>
</aside>
</section>
Expand All @@ -171,7 +171,7 @@ <h3>peer</h3>
<div class="tsd-signature tsd-kind-icon">peer<span class="tsd-signature-symbol">:</span> <a href="api.peerapi.html" class="tsd-signature-type">PeerApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/Ark.ts#L9">Ark.ts:9</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/Ark.ts#L9">Ark.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -181,7 +181,7 @@ <h3>transaction</h3>
<div class="tsd-signature tsd-kind-icon">transaction<span class="tsd-signature-symbol">:</span> <a href="api.transactionapi.html" class="tsd-signature-type">TransactionApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/Ark.ts#L12">Ark.ts:12</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/Ark.ts#L12">Ark.ts:12</a></li>
</ul>
</aside>
</section>
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/api.accountapi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/AccountApi.ts#L11">api/AccountApi.ts:11</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/AccountApi.ts#L11">api/AccountApi.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -133,7 +133,7 @@ <h3>balance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/AccountApi.ts#L25">api/AccountApi.ts:25</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/AccountApi.ts#L25">api/AccountApi.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -161,7 +161,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/AccountApi.ts#L18">api/AccountApi.ts:18</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/AccountApi.ts#L18">api/AccountApi.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -189,7 +189,7 @@ <h3>public<wbr>Key</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/AccountApi.ts#L32">api/AccountApi.ts:32</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/AccountApi.ts#L32">api/AccountApi.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -217,7 +217,7 @@ <h3>votes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/AccountApi.ts#L39">api/AccountApi.ts:39</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/AccountApi.ts#L39">api/AccountApi.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/api.blockapi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/BlockApi.ts#L12">api/BlockApi.ts:12</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/BlockApi.ts#L12">api/BlockApi.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -134,7 +134,7 @@ <h3>blockchain<wbr>Fee</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/BlockApi.ts#L40">api/BlockApi.ts:40</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/BlockApi.ts#L40">api/BlockApi.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -156,7 +156,7 @@ <h3>blockchain<wbr>Height</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/BlockApi.ts#L47">api/BlockApi.ts:47</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/BlockApi.ts#L47">api/BlockApi.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -178,7 +178,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/BlockApi.ts#L26">api/BlockApi.ts:26</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/BlockApi.ts#L26">api/BlockApi.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -206,7 +206,7 @@ <h3>list</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/BlockApi.ts#L33">api/BlockApi.ts:33</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/BlockApi.ts#L33">api/BlockApi.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -234,7 +234,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> network<wbr>Fees</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/BlockApi.ts#L19">api/BlockApi.ts:19</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/BlockApi.ts#L19">api/BlockApi.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/api.delegateapi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/DelegateApi.ts#L11">api/DelegateApi.ts:11</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/DelegateApi.ts#L11">api/DelegateApi.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -133,7 +133,7 @@ <h3>forged<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/DelegateApi.ts#L44">api/DelegateApi.ts:44</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/DelegateApi.ts#L44">api/DelegateApi.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -161,7 +161,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/DelegateApi.ts#L18">api/DelegateApi.ts:18</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/DelegateApi.ts#L18">api/DelegateApi.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -189,7 +189,7 @@ <h3>list</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/DelegateApi.ts#L25">api/DelegateApi.ts:25</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/DelegateApi.ts#L25">api/DelegateApi.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -217,7 +217,7 @@ <h3>voters</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/DelegateApi.ts#L32">api/DelegateApi.ts:32</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/DelegateApi.ts#L32">api/DelegateApi.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/api.loaderapi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/LoaderApi.ts#L11">api/LoaderApi.ts:11</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/LoaderApi.ts#L11">api/LoaderApi.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -132,7 +132,7 @@ <h3>auto<wbr>Configure</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/LoaderApi.ts#L18">api/LoaderApi.ts:18</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/LoaderApi.ts#L18">api/LoaderApi.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -160,7 +160,7 @@ <h3>loading<wbr>Status</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/LoaderApi.ts#L29">api/LoaderApi.ts:29</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/LoaderApi.ts#L29">api/LoaderApi.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -182,7 +182,7 @@ <h3>synchronisation<wbr>Status</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/LoaderApi.ts#L36">api/LoaderApi.ts:36</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/LoaderApi.ts#L36">api/LoaderApi.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/api.peerapi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/PeerApi.ts#L16">api/PeerApi.ts:16</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/PeerApi.ts#L16">api/PeerApi.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -132,7 +132,7 @@ <h3>find<wbr>Good<wbr>Peer</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/PeerApi.ts#L38">api/PeerApi.ts:38</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/PeerApi.ts#L38">api/PeerApi.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -154,7 +154,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/PeerApi.ts#L23">api/PeerApi.ts:23</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/PeerApi.ts#L23">api/PeerApi.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -185,7 +185,7 @@ <h3>list</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/b9031a1/src/api/PeerApi.ts#L31">api/PeerApi.ts:31</a></li>
<li>Defined in <a href="https://github.com/ArkEcosystem/ark-ts/blob/52f08a1/src/api/PeerApi.ts#L31">api/PeerApi.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 239c233

Please sign in to comment.