From 239c2338a6ce2231dd97a9ed9d72d5c116de9a72 Mon Sep 17 00:00:00 2001 From: Lucio Rubens Date: Wed, 26 Jul 2017 15:23:15 -0300 Subject: [PATCH] v0.2.0 --- README.md | 15 ++++++-- docs/classes/_ark_.client.html | 14 ++++---- docs/classes/api.accountapi.html | 10 +++--- docs/classes/api.blockapi.html | 12 +++---- docs/classes/api.delegateapi.html | 10 +++--- docs/classes/api.loaderapi.html | 8 ++--- docs/classes/api.peerapi.html | 8 ++--- docs/classes/api.transactionapi.html | 20 +++++------ docs/classes/core.hdnode.html | 30 ++++++++-------- docs/classes/core.privatekey.html | 16 ++++----- docs/classes/core.publickey.html | 22 ++++++------ docs/classes/core.tx.html | 26 +++++++------- docs/classes/model.account.html | 20 +++++------ docs/classes/model.accountqueryparams.html | 2 +- docs/classes/model.accountresponse.html | 8 ++--- docs/classes/model.accountvoter.html | 10 +++--- docs/classes/model.accountvotesresponse.html | 6 ++-- docs/classes/model.block.html | 34 +++++++++--------- docs/classes/model.blockfee.html | 6 ++-- docs/classes/model.blockfees.html | 6 ++-- docs/classes/model.blockheight.html | 8 ++--- docs/classes/model.blockqueryparams.html | 2 +- docs/classes/model.blockresponse.html | 8 ++--- docs/classes/model.delegate.html | 20 +++++------ docs/classes/model.delegatequeryparams.html | 16 ++++----- docs/classes/model.delegateresponse.html | 10 +++--- docs/classes/model.delegatevoters.html | 6 ++-- docs/classes/model.fees.html | 12 +++---- docs/classes/model.forgeddetails.html | 10 +++--- docs/classes/model.loaderautoconfigure.html | 6 ++-- docs/classes/model.loadernetworkresponse.html | 12 +++---- docs/classes/model.loaderstatus.html | 10 +++--- docs/classes/model.loaderstatussync.html | 12 +++---- docs/classes/model.network.html | 28 +++++++-------- docs/classes/model.peer.html | 16 ++++----- docs/classes/model.peerqueryparams.html | 18 +++++----- docs/classes/model.peerresponse.html | 8 ++--- docs/classes/model.transaction.html | 36 +++++++++---------- docs/classes/model.transactiondelegate.html | 8 ++--- docs/classes/model.transactionpayload.html | 2 +- .../classes/model.transactionqueryparams.html | 16 ++++----- docs/classes/model.transactionresponse.html | 12 +++---- docs/classes/model.transactionsend.html | 14 ++++---- docs/classes/model.transactionvote.html | 10 +++--- docs/classes/services.http.html | 12 +++---- docs/classes/utils.crypto.html | 30 ++++++++-------- docs/classes/utils.slot.html | 14 ++++---- docs/enums/model.networktype.html | 4 +-- docs/enums/model.transactiontype.html | 10 +++--- docs/enums/model.votetype.html | 4 +-- docs/index.html | 10 ++++-- 51 files changed, 342 insertions(+), 325 deletions(-) diff --git a/README.md b/README.md index 34ae3cf..68b53bb 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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). @@ -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'); diff --git a/docs/classes/_ark_.client.html b/docs/classes/_ark_.client.html index ce00f38..172af22 100644 --- a/docs/classes/_ark_.client.html +++ b/docs/classes/_ark_.client.html @@ -109,7 +109,7 @@

constructor

  • Parameters

    @@ -131,7 +131,7 @@

    account

    account: AccountApi
    @@ -141,7 +141,7 @@

    block

    block: BlockApi
    @@ -151,7 +151,7 @@

    delegate

    delegate: DelegateApi
    @@ -161,7 +161,7 @@

    loader

    loader: LoaderApi
    @@ -171,7 +171,7 @@

    peer

    peer: PeerApi
    @@ -181,7 +181,7 @@

    transaction

    transaction: TransactionApi
    diff --git a/docs/classes/api.accountapi.html b/docs/classes/api.accountapi.html index 016334d..17b7d10 100644 --- a/docs/classes/api.accountapi.html +++ b/docs/classes/api.accountapi.html @@ -107,7 +107,7 @@

    constructor

  • Parameters

    @@ -133,7 +133,7 @@

    balance

  • @@ -161,7 +161,7 @@

    get

  • @@ -189,7 +189,7 @@

    publicKey

  • @@ -217,7 +217,7 @@

    votes

  • diff --git a/docs/classes/api.blockapi.html b/docs/classes/api.blockapi.html index 97294d6..28c8c87 100644 --- a/docs/classes/api.blockapi.html +++ b/docs/classes/api.blockapi.html @@ -108,7 +108,7 @@

    constructor

  • Parameters

    @@ -134,7 +134,7 @@

    blockchainFee

  • @@ -156,7 +156,7 @@

    blockchainHeight

  • @@ -178,7 +178,7 @@

    get

  • @@ -206,7 +206,7 @@

    list

  • @@ -234,7 +234,7 @@

    Static networkFees

  • diff --git a/docs/classes/api.delegateapi.html b/docs/classes/api.delegateapi.html index 51d1fa0..e8f0553 100644 --- a/docs/classes/api.delegateapi.html +++ b/docs/classes/api.delegateapi.html @@ -107,7 +107,7 @@

    constructor

  • Parameters

    @@ -133,7 +133,7 @@

    forgedData

  • @@ -161,7 +161,7 @@

    get

  • @@ -189,7 +189,7 @@

    list

  • @@ -217,7 +217,7 @@

    voters

  • diff --git a/docs/classes/api.loaderapi.html b/docs/classes/api.loaderapi.html index 487e781..a25b65b 100644 --- a/docs/classes/api.loaderapi.html +++ b/docs/classes/api.loaderapi.html @@ -106,7 +106,7 @@

    constructor

  • Parameters

    @@ -132,7 +132,7 @@

    autoConfigure

  • @@ -160,7 +160,7 @@

    loadingStatus

  • @@ -182,7 +182,7 @@

    synchronisationStatus

  • diff --git a/docs/classes/api.peerapi.html b/docs/classes/api.peerapi.html index eaa98cc..6b96f1e 100644 --- a/docs/classes/api.peerapi.html +++ b/docs/classes/api.peerapi.html @@ -106,7 +106,7 @@

    constructor

  • Parameters

    @@ -132,7 +132,7 @@

    findGoodPeer

  • @@ -154,7 +154,7 @@

    get

  • @@ -185,7 +185,7 @@

    list

  • diff --git a/docs/classes/api.transactionapi.html b/docs/classes/api.transactionapi.html index 1c098f2..8f97dc9 100644 --- a/docs/classes/api.transactionapi.html +++ b/docs/classes/api.transactionapi.html @@ -112,7 +112,7 @@

    constructor

  • Parameters

    @@ -138,7 +138,7 @@

    createDelegate

  • @@ -166,7 +166,7 @@

    createSignature

  • @@ -197,7 +197,7 @@

    createTransaction

  • @@ -225,7 +225,7 @@

    createVote

  • @@ -253,7 +253,7 @@

    get

  • @@ -281,7 +281,7 @@

    getUnconfirmed

  • @@ -309,7 +309,7 @@

    list

  • @@ -337,7 +337,7 @@

    listUnconfirmed

  • @@ -365,7 +365,7 @@

    post

  • diff --git a/docs/classes/core.hdnode.html b/docs/classes/core.hdnode.html index 82f8d59..bba9cdc 100644 --- a/docs/classes/core.hdnode.html +++ b/docs/classes/core.hdnode.html @@ -122,7 +122,7 @@

    constructor

  • Returns HDNode

    @@ -138,7 +138,7 @@

    chainCode

    chainCode: Buffer
    @@ -148,7 +148,7 @@

    childNumber

    childNumber: Buffer
    @@ -158,7 +158,7 @@

    depth

    depth: number
    @@ -168,7 +168,7 @@

    fingerPrint

    fingerPrint: Buffer
    @@ -178,7 +178,7 @@

    isPrivate

    isPrivate: boolean
    @@ -188,7 +188,7 @@

    key

    key: PrivateKey
    @@ -198,7 +198,7 @@

    network

    network: string
    @@ -208,7 +208,7 @@

    version

    version: Buffer
    @@ -225,7 +225,7 @@

    childKey

  • Parameters

    @@ -248,7 +248,7 @@

    serialize

  • Returns string

    @@ -265,7 +265,7 @@

    toPublic

  • Returns HDNode

    @@ -282,7 +282,7 @@

    Static createMasterKey

  • Parameters

    @@ -308,7 +308,7 @@

    Static generateSeed

  • Returns Buffer

    @@ -325,7 +325,7 @@

    Static unserialize

  • Parameters

    diff --git a/docs/classes/core.privatekey.html b/docs/classes/core.privatekey.html index 8914f3a..717cc4f 100644 --- a/docs/classes/core.privatekey.html +++ b/docs/classes/core.privatekey.html @@ -115,7 +115,7 @@

    constructor

  • Parameters

    @@ -140,7 +140,7 @@

    Optional hash

    hash: Buffer
    @@ -157,7 +157,7 @@

    getPublicKey

  • Returns PublicKey

    @@ -174,7 +174,7 @@

    sign

  • Parameters

    @@ -197,7 +197,7 @@

    toHex

  • Returns string

    @@ -214,7 +214,7 @@

    toWIF

  • Returns any

    @@ -231,7 +231,7 @@

    Static fromSeed

  • Parameters

    @@ -257,7 +257,7 @@

    Static fromWIF

  • Parameters

    diff --git a/docs/classes/core.publickey.html b/docs/classes/core.publickey.html index 69716e5..6c78859 100644 --- a/docs/classes/core.publickey.html +++ b/docs/classes/core.publickey.html @@ -118,7 +118,7 @@

    constructor

  • Parameters

    @@ -146,7 +146,7 @@

    hash

    hash: Buffer
    @@ -156,7 +156,7 @@

    isCompressed

    isCompressed: boolean
    @@ -166,7 +166,7 @@

    Optional network

    network: Network
    @@ -183,7 +183,7 @@

    getAddress

  • Returns string

    @@ -200,7 +200,7 @@

    setNetwork

  • @@ -229,7 +229,7 @@

    toHex

  • Returns string

    @@ -246,7 +246,7 @@

    verifySignature

  • Parameters

    @@ -272,7 +272,7 @@

    Static fromAddress

  • Parameters

    @@ -295,7 +295,7 @@

    Static fromHex

  • Parameters

    @@ -318,7 +318,7 @@

    Static validateAddress

  • Parameters

    diff --git a/docs/classes/core.tx.html b/docs/classes/core.tx.html index d3ff1fd..6d3bdc1 100644 --- a/docs/classes/core.tx.html +++ b/docs/classes/core.tx.html @@ -120,7 +120,7 @@

    constructor

  • Parameters

    @@ -151,7 +151,7 @@

    transaction

    transaction: Transaction
    @@ -168,7 +168,7 @@

    generate

  • @@ -191,7 +191,7 @@

    getHash

  • Parameters

    @@ -217,7 +217,7 @@

    getId

  • @@ -239,7 +239,7 @@

    secondSign

  • @@ -261,7 +261,7 @@

    secondVerify

  • @@ -283,7 +283,7 @@

    setAddress

  • @@ -306,7 +306,7 @@

    setAssetSignature

  • @@ -328,7 +328,7 @@

    sign

  • @@ -350,7 +350,7 @@

    toBytes

  • @@ -381,7 +381,7 @@

    verify

  • @@ -403,7 +403,7 @@

    Static fromBytes

  • diff --git a/docs/classes/model.account.html b/docs/classes/model.account.html index 7875ddd..f7380a8 100644 --- a/docs/classes/model.account.html +++ b/docs/classes/model.account.html @@ -112,7 +112,7 @@

    constructor

  • Returns Account

    @@ -128,7 +128,7 @@

    address

    address: string
    @@ -138,7 +138,7 @@

    balance

    balance: string
    @@ -148,7 +148,7 @@

    multiSignatures

    multiSignatures: any[]
    @@ -158,7 +158,7 @@

    publicKey

    publicKey: string
    @@ -168,7 +168,7 @@

    secondPublicKey

    secondPublicKey: object
    @@ -178,7 +178,7 @@

    secondSignature

    secondSignature: number
    @@ -188,7 +188,7 @@

    uMultiSignatures

    uMultiSignatures: any[]
    @@ -198,7 +198,7 @@

    unconfirmedBalance

    unconfirmedBalance: string
    @@ -208,7 +208,7 @@

    unconfirmedSignature

    unconfirmedSignature: number
    diff --git a/docs/classes/model.accountqueryparams.html b/docs/classes/model.accountqueryparams.html index c89da40..4c5cd06 100644 --- a/docs/classes/model.accountqueryparams.html +++ b/docs/classes/model.accountqueryparams.html @@ -94,7 +94,7 @@

    address

    address: string
    diff --git a/docs/classes/model.accountresponse.html b/docs/classes/model.accountresponse.html index a266fea..ce8ae77 100644 --- a/docs/classes/model.accountresponse.html +++ b/docs/classes/model.accountresponse.html @@ -106,7 +106,7 @@

    constructor

  • Returns AccountResponse

    @@ -122,7 +122,7 @@

    Optional account

    account: Account
    @@ -132,7 +132,7 @@

    Optional publicKey

    publicKey: string
    @@ -142,7 +142,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.accountvoter.html b/docs/classes/model.accountvoter.html index 6f60fd4..de43bc8 100644 --- a/docs/classes/model.accountvoter.html +++ b/docs/classes/model.accountvoter.html @@ -107,7 +107,7 @@

    constructor

  • Returns AccountVoter

    @@ -123,7 +123,7 @@

    address

    address: string
    @@ -133,7 +133,7 @@

    balance

    balance: string
    @@ -143,7 +143,7 @@

    publicKey

    publicKey: string
    @@ -153,7 +153,7 @@

    username

    username: string
    diff --git a/docs/classes/model.accountvotesresponse.html b/docs/classes/model.accountvotesresponse.html index 261dab1..2bc234e 100644 --- a/docs/classes/model.accountvotesresponse.html +++ b/docs/classes/model.accountvotesresponse.html @@ -105,7 +105,7 @@

    constructor

  • Returns AccountVotesResponse

    @@ -121,7 +121,7 @@

    delegates

    delegates: Delegate[]
    @@ -131,7 +131,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.block.html b/docs/classes/model.block.html index 01f86d5..1fd95cd 100644 --- a/docs/classes/model.block.html +++ b/docs/classes/model.block.html @@ -119,7 +119,7 @@

    constructor

  • Returns Block

    @@ -135,7 +135,7 @@

    blockSignature

    blockSignature: string
    @@ -145,7 +145,7 @@

    confirmations

    confirmations: number
    @@ -155,7 +155,7 @@

    generatorId

    generatorId: string
    @@ -165,7 +165,7 @@

    generatorPublicKey

    generatorPublicKey: string
    @@ -175,7 +175,7 @@

    height

    height: number
    @@ -185,7 +185,7 @@

    id

    id: number
    @@ -195,7 +195,7 @@

    numberOfTransactions

    numberOfTransactions: number
    @@ -205,7 +205,7 @@

    payloadHash

    payloadHash: string
    @@ -215,7 +215,7 @@

    payloadLength

    payloadLength: number
    @@ -225,7 +225,7 @@

    previousBlock

    previousBlock: number
    @@ -235,7 +235,7 @@

    reward

    reward: number
    @@ -245,7 +245,7 @@

    timestamp

    timestamp: number
    @@ -255,7 +255,7 @@

    totalAmount

    totalAmount: number
    @@ -265,7 +265,7 @@

    totalFee

    totalFee: number
    @@ -275,7 +275,7 @@

    totalForged

    totalForged: string
    @@ -285,7 +285,7 @@

    version

    version: number
    diff --git a/docs/classes/model.blockfee.html b/docs/classes/model.blockfee.html index 53f3186..26fb10a 100644 --- a/docs/classes/model.blockfee.html +++ b/docs/classes/model.blockfee.html @@ -105,7 +105,7 @@

    constructor

  • Returns BlockFee

    @@ -121,7 +121,7 @@

    fee

    fee: number
    @@ -131,7 +131,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.blockfees.html b/docs/classes/model.blockfees.html index dc1e0ac..c33fd59 100644 --- a/docs/classes/model.blockfees.html +++ b/docs/classes/model.blockfees.html @@ -105,7 +105,7 @@

    constructor

  • Returns BlockFees

    @@ -121,7 +121,7 @@

    fees

    fees: Fees
    @@ -131,7 +131,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.blockheight.html b/docs/classes/model.blockheight.html index 889631e..e1d0297 100644 --- a/docs/classes/model.blockheight.html +++ b/docs/classes/model.blockheight.html @@ -106,7 +106,7 @@

    constructor

  • Returns BlockHeight

    @@ -122,7 +122,7 @@

    height

    height: number
    @@ -132,7 +132,7 @@

    id

    id: number
    @@ -142,7 +142,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.blockqueryparams.html b/docs/classes/model.blockqueryparams.html index d35c5bd..1880dbc 100644 --- a/docs/classes/model.blockqueryparams.html +++ b/docs/classes/model.blockqueryparams.html @@ -94,7 +94,7 @@

    id

    id: string
    diff --git a/docs/classes/model.blockresponse.html b/docs/classes/model.blockresponse.html index 749b510..f0eb38a 100644 --- a/docs/classes/model.blockresponse.html +++ b/docs/classes/model.blockresponse.html @@ -106,7 +106,7 @@

    constructor

  • Returns BlockResponse

    @@ -122,7 +122,7 @@

    Optional block

    block: Block
    @@ -132,7 +132,7 @@

    Optional blocks

    blocks: Block[]
    @@ -142,7 +142,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.delegate.html b/docs/classes/model.delegate.html index 719daf3..d9bd23b 100644 --- a/docs/classes/model.delegate.html +++ b/docs/classes/model.delegate.html @@ -112,7 +112,7 @@

    constructor

  • Returns Delegate

    @@ -128,7 +128,7 @@

    address

    address: string
    @@ -138,7 +138,7 @@

    approval

    approval: number
    @@ -148,7 +148,7 @@

    missedBlocks

    missedBlocks: number
    @@ -158,7 +158,7 @@

    producedBlocks

    producedBlocks: number
    @@ -168,7 +168,7 @@

    productivity

    productivity: number
    @@ -178,7 +178,7 @@

    publicKey

    publicKey: string
    @@ -188,7 +188,7 @@

    rate

    rate: number
    @@ -198,7 +198,7 @@

    username

    username: string
    @@ -208,7 +208,7 @@

    vote

    vote: string
    diff --git a/docs/classes/model.delegatequeryparams.html b/docs/classes/model.delegatequeryparams.html index 0ca073d..994b45d 100644 --- a/docs/classes/model.delegatequeryparams.html +++ b/docs/classes/model.delegatequeryparams.html @@ -110,7 +110,7 @@

    constructor

  • Returns DelegateQueryParams

    @@ -126,7 +126,7 @@

    Optional delegate

    delegate: Delegate
    @@ -136,7 +136,7 @@

    Optional generatorPublic<
    generatorPublicKey: string
    @@ -146,7 +146,7 @@

    Optional limit

    limit: number
    @@ -156,7 +156,7 @@

    Optional offset

    offset: number
    @@ -166,7 +166,7 @@

    Optional orderBy

    orderBy: string
    @@ -176,7 +176,7 @@

    Optional publicKey

    publicKey: string
    @@ -186,7 +186,7 @@

    Optional username

    username: string
    diff --git a/docs/classes/model.delegateresponse.html b/docs/classes/model.delegateresponse.html index 846be76..fdbea0b 100644 --- a/docs/classes/model.delegateresponse.html +++ b/docs/classes/model.delegateresponse.html @@ -107,7 +107,7 @@

    constructor

  • Returns DelegateResponse

    @@ -123,7 +123,7 @@

    Optional delegate

    delegate: Delegate
    @@ -133,7 +133,7 @@

    Optional delegates

    delegates: Delegate[]
    @@ -143,7 +143,7 @@

    success

    success: boolean
    @@ -153,7 +153,7 @@

    totalCount

    totalCount: number
    diff --git a/docs/classes/model.delegatevoters.html b/docs/classes/model.delegatevoters.html index 1b13a3f..6f878ac 100644 --- a/docs/classes/model.delegatevoters.html +++ b/docs/classes/model.delegatevoters.html @@ -105,7 +105,7 @@

    constructor

  • Returns DelegateVoters

    @@ -121,7 +121,7 @@

    accounts

    accounts: AccountVoter[]
    @@ -131,7 +131,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.fees.html b/docs/classes/model.fees.html index 3f59b8b..ca8b6b5 100644 --- a/docs/classes/model.fees.html +++ b/docs/classes/model.fees.html @@ -108,7 +108,7 @@

    constructor

  • Returns Fees

    @@ -124,7 +124,7 @@

    delegate

    delegate: number
    @@ -134,7 +134,7 @@

    multisignature

    multisignature: number
    @@ -144,7 +144,7 @@

    secondsignature

    secondsignature: number
    @@ -154,7 +154,7 @@

    send

    send: number
    @@ -164,7 +164,7 @@

    vote

    vote: number
    diff --git a/docs/classes/model.forgeddetails.html b/docs/classes/model.forgeddetails.html index 70d08d0..13a0609 100644 --- a/docs/classes/model.forgeddetails.html +++ b/docs/classes/model.forgeddetails.html @@ -107,7 +107,7 @@

    constructor

  • Returns ForgedDetails

    @@ -123,7 +123,7 @@

    fees

    fees: string
    @@ -133,7 +133,7 @@

    forged

    forged: string
    @@ -143,7 +143,7 @@

    rewards

    rewards: string
    @@ -153,7 +153,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.loaderautoconfigure.html b/docs/classes/model.loaderautoconfigure.html index b7bafb0..0e10fe1 100644 --- a/docs/classes/model.loaderautoconfigure.html +++ b/docs/classes/model.loaderautoconfigure.html @@ -105,7 +105,7 @@

    constructor

  • Returns LoaderAutoConfigure

    @@ -121,7 +121,7 @@

    network

    network: LoaderNetworkResponse
    @@ -131,7 +131,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.loadernetworkresponse.html b/docs/classes/model.loadernetworkresponse.html index e779771..f7de0d4 100644 --- a/docs/classes/model.loadernetworkresponse.html +++ b/docs/classes/model.loadernetworkresponse.html @@ -108,7 +108,7 @@

    constructor

  • Returns LoaderNetworkResponse

    @@ -124,7 +124,7 @@

    explorer

    explorer: string
    @@ -134,7 +134,7 @@

    nethash

    nethash: string
    @@ -144,7 +144,7 @@

    symbol

    symbol: string
    @@ -154,7 +154,7 @@

    token

    token: string
    @@ -164,7 +164,7 @@

    version

    version: string
    diff --git a/docs/classes/model.loaderstatus.html b/docs/classes/model.loaderstatus.html index acea6be..157a963 100644 --- a/docs/classes/model.loaderstatus.html +++ b/docs/classes/model.loaderstatus.html @@ -107,7 +107,7 @@

    constructor

  • Returns LoaderStatus

    @@ -123,7 +123,7 @@

    blocksCount

    blocksCount: number
    @@ -133,7 +133,7 @@

    loaded

    loaded: false
    @@ -143,7 +143,7 @@

    now

    now: number
    @@ -153,7 +153,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.loaderstatussync.html b/docs/classes/model.loaderstatussync.html index ea96628..1abbe35 100644 --- a/docs/classes/model.loaderstatussync.html +++ b/docs/classes/model.loaderstatussync.html @@ -108,7 +108,7 @@

    constructor

  • Returns LoaderStatusSync

    @@ -124,7 +124,7 @@

    blocks

    blocks: number
    @@ -134,7 +134,7 @@

    height

    height: number
    @@ -144,7 +144,7 @@

    id

    id: string
    @@ -154,7 +154,7 @@

    success

    success: boolean
    @@ -164,7 +164,7 @@

    syncing

    syncing: false
    diff --git a/docs/classes/model.network.html b/docs/classes/model.network.html index 16d2d1b..3c9d708 100644 --- a/docs/classes/model.network.html +++ b/docs/classes/model.network.html @@ -121,7 +121,7 @@

    constructor

  • Returns Network

    @@ -137,7 +137,7 @@

    activePeer

    activePeer: Peer
    @@ -147,7 +147,7 @@

    explorer

    explorer: string
    @@ -157,7 +157,7 @@

    name

    name: string
    @@ -167,7 +167,7 @@

    nethash

    nethash: string
    @@ -177,7 +177,7 @@

    symbol

    symbol: string
    @@ -187,7 +187,7 @@

    token

    token: string
    @@ -197,7 +197,7 @@

    type

    type: NetworkType
    @@ -207,7 +207,7 @@

    version

    version: number
    @@ -217,7 +217,7 @@

    Optional wif

    wif: number
    @@ -234,7 +234,7 @@

    getPeerUrl

  • @@ -256,7 +256,7 @@

    setPeer

  • @@ -284,7 +284,7 @@

    Static getAll

  • @@ -306,7 +306,7 @@

    Static getDefault

  • diff --git a/docs/classes/model.peer.html b/docs/classes/model.peer.html index 94a5e4e..724fd05 100644 --- a/docs/classes/model.peer.html +++ b/docs/classes/model.peer.html @@ -110,7 +110,7 @@

    constructor

  • Returns Peer

    @@ -126,7 +126,7 @@

    Optional delay

    delay: number
    @@ -136,7 +136,7 @@

    Optional height

    height: number
    @@ -146,7 +146,7 @@

    ip

    ip: string
    @@ -156,7 +156,7 @@

    Optional os

    os: string
    @@ -166,7 +166,7 @@

    port

    port: number
    @@ -176,7 +176,7 @@

    Optional status

    status: string
    @@ -186,7 +186,7 @@

    Optional version

    version: string
    diff --git a/docs/classes/model.peerqueryparams.html b/docs/classes/model.peerqueryparams.html index e0bc87f..b1ac364 100644 --- a/docs/classes/model.peerqueryparams.html +++ b/docs/classes/model.peerqueryparams.html @@ -102,7 +102,7 @@

    Optional ip

    ip: string
    @@ -112,7 +112,7 @@

    Optional limit

    limit: number
    @@ -122,7 +122,7 @@

    Optional offset

    offset: number
    @@ -132,7 +132,7 @@

    Optional orderBy

    orderBy: string
    @@ -142,7 +142,7 @@

    Optional os

    os: string
    @@ -152,7 +152,7 @@

    Optional port

    port: number
    @@ -162,7 +162,7 @@

    Optional shared

    shared: string
    @@ -172,7 +172,7 @@

    Optional status

    status: string
    @@ -182,7 +182,7 @@

    Optional version

    version: string
    diff --git a/docs/classes/model.peerresponse.html b/docs/classes/model.peerresponse.html index 918792d..0db640f 100644 --- a/docs/classes/model.peerresponse.html +++ b/docs/classes/model.peerresponse.html @@ -106,7 +106,7 @@

    constructor

  • Returns PeerResponse

    @@ -122,7 +122,7 @@

    peer

    peer: Peer
    @@ -132,7 +132,7 @@

    peers

    peers: Peer[]
    @@ -142,7 +142,7 @@

    success

    success: boolean
    diff --git a/docs/classes/model.transaction.html b/docs/classes/model.transaction.html index 347b245..56ca575 100644 --- a/docs/classes/model.transaction.html +++ b/docs/classes/model.transaction.html @@ -120,7 +120,7 @@

    constructor

  • Returns Transaction

    @@ -136,7 +136,7 @@

    Optional amount

    amount: number
    @@ -146,7 +146,7 @@

    Optional asset

    asset: object
    @@ -156,7 +156,7 @@

    Optional blockId

    blockId: string
    @@ -166,7 +166,7 @@

    Optional confirmations

    confirmations: number
    @@ -176,7 +176,7 @@

    Optional fee

    fee: number
    @@ -186,7 +186,7 @@

    Optional height

    height: number
    @@ -196,7 +196,7 @@

    Optional id

    id: string
    @@ -206,7 +206,7 @@

    Optional recipientId

    recipientId: string
    @@ -216,7 +216,7 @@

    Optional requesterPublic<
    requesterPublicKey: string
    @@ -226,7 +226,7 @@

    Optional secondSendersecondSenderPublicKey: string @@ -236,7 +236,7 @@

    Optional senderId

    senderId: string
    @@ -246,7 +246,7 @@

    Optional senderPublicsenderPublicKey: string @@ -256,7 +256,7 @@

    Optional signSignaturesignSignature: string @@ -266,7 +266,7 @@

    Optional signature

    signature: string
    @@ -276,7 +276,7 @@

    Optional timestamp

    timestamp: number
    @@ -286,7 +286,7 @@

    Optional type

    type: TransactionType
    @@ -296,7 +296,7 @@

    Optional vendorField

    vendorField: string
    diff --git a/docs/classes/model.transactiondelegate.html b/docs/classes/model.transactiondelegate.html index 7796c2a..f7fdec9 100644 --- a/docs/classes/model.transactiondelegate.html +++ b/docs/classes/model.transactiondelegate.html @@ -106,7 +106,7 @@

    constructor

  • Returns TransactionDelegate

    @@ -122,7 +122,7 @@

    passphrase

    passphrase: string
    @@ -132,7 +132,7 @@

    Optional secondPassphrase
    secondPassphrase: string
    @@ -142,7 +142,7 @@

    username

    username: string
    diff --git a/docs/classes/model.transactionpayload.html b/docs/classes/model.transactionpayload.html index 6ed566d..4b7f73d 100644 --- a/docs/classes/model.transactionpayload.html +++ b/docs/classes/model.transactionpayload.html @@ -94,7 +94,7 @@

    transactions

    transactions: Transaction[]
    diff --git a/docs/classes/model.transactionqueryparams.html b/docs/classes/model.transactionqueryparams.html index d9bc534..f05e53f 100644 --- a/docs/classes/model.transactionqueryparams.html +++ b/docs/classes/model.transactionqueryparams.html @@ -101,7 +101,7 @@

    Optional blockId

    blockId: string
    @@ -111,7 +111,7 @@

    Optional id

    id: string
    @@ -121,7 +121,7 @@

    Optional limit

    limit: number
    @@ -131,7 +131,7 @@

    Optional offset

    offset: number
    @@ -141,7 +141,7 @@

    Optional orderBy

    orderBy: string
    @@ -151,7 +151,7 @@

    Optional recipientId

    recipientId: string
    @@ -161,7 +161,7 @@

    Optional senderId

    senderId: string
    @@ -171,7 +171,7 @@

    Optional type

    type: TransactionType
    diff --git a/docs/classes/model.transactionresponse.html b/docs/classes/model.transactionresponse.html index f7f45a7..44410e0 100644 --- a/docs/classes/model.transactionresponse.html +++ b/docs/classes/model.transactionresponse.html @@ -108,7 +108,7 @@

    constructor

  • Returns TransactionResponse

    @@ -124,7 +124,7 @@

    count

    count: string
    @@ -134,7 +134,7 @@

    error

    error: string
    @@ -144,7 +144,7 @@

    success

    success: boolean
    @@ -154,7 +154,7 @@

    transaction

    transaction: Transaction
    @@ -164,7 +164,7 @@

    transactions

    transactions: Transaction[]
    diff --git a/docs/classes/model.transactionsend.html b/docs/classes/model.transactionsend.html index 02dd66b..2151419 100644 --- a/docs/classes/model.transactionsend.html +++ b/docs/classes/model.transactionsend.html @@ -109,7 +109,7 @@

    constructor

  • Returns TransactionSend

    @@ -125,7 +125,7 @@

    amount

    amount: number
    @@ -135,7 +135,7 @@

    passphrase

    passphrase: string
    @@ -145,7 +145,7 @@

    Optional publicKey

    publicKey: string
    @@ -155,7 +155,7 @@

    recipientId

    recipientId: string
    @@ -165,7 +165,7 @@

    Optional secondPassphrase
    secondPassphrase: string
    @@ -175,7 +175,7 @@

    Optional vendorField

    vendorField: string
    diff --git a/docs/classes/model.transactionvote.html b/docs/classes/model.transactionvote.html index ab983a5..85157d2 100644 --- a/docs/classes/model.transactionvote.html +++ b/docs/classes/model.transactionvote.html @@ -107,7 +107,7 @@

    constructor

  • Returns TransactionVote

    @@ -123,7 +123,7 @@

    delegatePublicKey

    delegatePublicKey: string
    @@ -133,7 +133,7 @@

    passphrase

    passphrase: string
    @@ -143,7 +143,7 @@

    Optional secondPassphrase
    secondPassphrase: string
    @@ -153,7 +153,7 @@

    type

    type: VoteType
    diff --git a/docs/classes/services.http.html b/docs/classes/services.http.html index 5cdd0a1..31415a4 100644 --- a/docs/classes/services.http.html +++ b/docs/classes/services.http.html @@ -113,7 +113,7 @@

    constructor

  • Parameters

    @@ -135,7 +135,7 @@

    Optional network

    network: Network
    @@ -152,7 +152,7 @@

    get

  • Type parameters

    @@ -189,7 +189,7 @@

    getNative

  • Type parameters

    @@ -226,7 +226,7 @@

    post

  • Type parameters

    @@ -263,7 +263,7 @@

    put

  • Parameters

    diff --git a/docs/classes/utils.crypto.html b/docs/classes/utils.crypto.html index 594299d..60d75e8 100644 --- a/docs/classes/utils.crypto.html +++ b/docs/classes/utils.crypto.html @@ -112,7 +112,7 @@

    Static addPrivateKeys<

  • Parameters

    @@ -138,7 +138,7 @@

    Static addPublicKeys

    Parameters

    @@ -164,7 +164,7 @@

    Static bs58decode

  • Parameters

    @@ -187,7 +187,7 @@

    Static bs58encode

  • Parameters

    @@ -210,7 +210,7 @@

    Static decodeCurvePoin

  • Parameters

    @@ -233,7 +233,7 @@

    Static hash160

  • Parameters

    @@ -256,7 +256,7 @@

    Static hash256

  • Parameters

    @@ -279,7 +279,7 @@

    Static hmacSha512

  • Parameters

    @@ -305,7 +305,7 @@

    Static int32toBuffer

  • Parameters

    @@ -328,7 +328,7 @@

    Static randomSeed

  • Parameters

    @@ -351,7 +351,7 @@

    Static ripemd160

  • Parameters

    @@ -374,7 +374,7 @@

    Static sha1

  • Parameters

    @@ -397,7 +397,7 @@

    Static sha256

  • Parameters

    @@ -420,7 +420,7 @@

    Static validateCurve

  • Parameters

    @@ -443,7 +443,7 @@

    Static validateKey

  • Parameters

    diff --git a/docs/classes/utils.slot.html b/docs/classes/utils.slot.html index 77ea4d5..4404f12 100644 --- a/docs/classes/utils.slot.html +++ b/docs/classes/utils.slot.html @@ -104,7 +104,7 @@

    Static getDurationTime
  • @@ -132,7 +132,7 @@

    Static getLastSlot

    Parameters

    @@ -155,7 +155,7 @@

    Static getNextSlot

    Returns number

    @@ -172,7 +172,7 @@

    Static getSlotNumber

    Parameters

    @@ -195,7 +195,7 @@

    Static getSlotTime

    Parameters

    @@ -218,7 +218,7 @@

    Static getTime

  • Returns number

    @@ -235,7 +235,7 @@

    Static getTransactionT
  • diff --git a/docs/enums/model.networktype.html b/docs/enums/model.networktype.html index 93f5f41..9879dc9 100644 --- a/docs/enums/model.networktype.html +++ b/docs/enums/model.networktype.html @@ -87,7 +87,7 @@

    Devnet

    Devnet:
    @@ -97,7 +97,7 @@

    Mainnet

    Mainnet:
    diff --git a/docs/enums/model.transactiontype.html b/docs/enums/model.transactiontype.html index 3254dcb..e2fd437 100644 --- a/docs/enums/model.transactiontype.html +++ b/docs/enums/model.transactiontype.html @@ -90,7 +90,7 @@

    CreateDelegate

    CreateDelegate: = 2
    @@ -100,7 +100,7 @@

    MultiSignature

    MultiSignature: = 4
    @@ -110,7 +110,7 @@

    SecondSignature

    SecondSignature: = 1
    @@ -120,7 +120,7 @@

    SendArk

    SendArk: = 0
    @@ -130,7 +130,7 @@

    Vote

    Vote: = 3
    diff --git a/docs/enums/model.votetype.html b/docs/enums/model.votetype.html index 9886a91..93198cf 100644 --- a/docs/enums/model.votetype.html +++ b/docs/enums/model.votetype.html @@ -87,7 +87,7 @@

    Add

    Add:
    @@ -97,7 +97,7 @@

    Remove

    Remove:
    diff --git a/docs/index.html b/docs/index.html index 813e3e8..3ee68a8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -65,11 +65,14 @@

    TSARK

    An ARK API wrapper, written in TypeScript to interact with ARK blockchain.

    +

    npm + npm + license

    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

    @@ -78,6 +81,9 @@

    Documentation

    Installation

    TSARK is avaliable from npm.

    + 
    yarn add ark-ts
+
    +

    or

    npm i ark-ts --save

    Usage

    @@ -98,7 +104,7 @@

    Basic Examples

    Get address from passphrase.

    - 
    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');