Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ArkEcosystemArchive/ark-js
An ARK Client for JavaScript.
https://github.com/ArkEcosystemArchive/ark-js
ark blockchain cryptocurrency
Last synced: about 2 months ago
JSON representation
An ARK Client for JavaScript.
- Host: GitHub
- URL: https://github.com/ArkEcosystemArchive/ark-js
- Owner: ArkEcosystemArchive
- License: mit
- Archived: true
- Created: 2016-11-02T09:26:33.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-14T08:38:46.000Z (about 6 years ago)
- Last Synced: 2024-11-06T19:54:44.381Z (about 2 months ago)
- Topics: ark, blockchain, cryptocurrency
- Language: JavaScript
- Homepage:
- Size: 246 KB
- Stars: 99
- Watchers: 22
- Forks: 60
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ark - Ark-JS - JavaScript library for sending Ark transactions from the client or server (Libraries)
README
**:warning: DEPRECATED IN FAVOR OF https://github.com/ArkEcosystem/core/tree/master/packages/crypto :warning:***
[](https://travis-ci.org/ArkEcosystem/ark-js)
# Ark JS
Ark JS is a JavaScript library for sending ARK transactions. It's main benefit is that it does not require a locally installed ARK node, and instead utilizes the existing peers on the network. It can be used from the client as a [browserify](http://browserify.org/) compiled module, or on the server as a standard Node.js module.
## Installation
[](https://nodei.co/npm/arkjs/)
## Building
Build the browserify module for client use:
```sh
npm build:browserify
```
Clean:
```sh
npm clean:browserify
```
## Tests
```
npm test
```
Tests written using mocha + schedule.js.
***
## Usage
On the client:
```html
```
On the server:
```js
var ark = require("arkjs");
```
### Generating a key pair
To generate a public / private key pair from a given passphrase:
```js
var keys = ark.crypto.getKeys("passphrase");
```
Returning:
```js
{
publicKey: "02e012f0a7cac12a74bdc17d844cbc9f637177b470019c32a53cef94c7a56e2ea9",
privateKey: ""
}
```
To get the private key:
```js
keys.d.toBuffer().toString("hex");
```
Returning:
```
1e089e3c5323ad80a90767bdd5907297b4138163f027097fd3bdbeab528d2d68
```
### Generating an address
To generate a unique Ark address from a given public key:
```js
var address = ark.crypto.getAddress("5d036a858ce89f844491762eb89e2bfbd50a4a0a0da658e4b2628b25b117ae09");
```
Returning:
```
AGihocTkwDygiFvmg6aG8jThYTic47GzU9
```
### Creating a transaction
To create a signed transaction object, which can then be broadcasted onto the network:
```js
var amount = 1000 * Math.pow(10, 8); // 100000000000
var transaction = ark.transaction.createTransaction("AGihocTkwDygiFvmg6aG8jThYTic47GzU9", amount, null, "passphrase", "secondPassphrase");
```
Returning:
```js
{
type: 0, // Transaction type. 0 = Normal transaction.
amount: 100000000000, // The amount to send expressed as an integer value.
asset: {}, // Transaction asset, dependent on tx type.
fee: 100000000, // 0.1 ARK expressed as an integer value.
id: "500224999259823996", // Transaction ID.
recipientId: "AGihocTkwDygiFvmg6aG8jThYTic47GzU9", // Recipient ID.
senderPublicKey: "56e106a1d4a53dbe22cac52fefd8fc4123cfb4ee482f8f25a4fc72eb459b38a5", // Sender's public key.
signSignature: "03fdd33bed30270b97e77ada44764cc8628f6ad3bbd84718571695262a5a18baa37bd76a62dd25bc21beacd61eaf2c63af0cf34edb0d191d225f4974cd3aa509", // Sender's second passphrase signature.
signature: "9419ca3cf11ed2e3fa4c63bc9a4dc18b5001648e74522bc0f22bda46a188e462da4785e5c71a43cfc0486af08d447b9340ba8b93258c4c7f50798060fff2d709", // Transaction signature.
timestamp: 27953413 // Based on UTC time of genesis since epoch.
}
```
### Network identification with Nethash
You need to obtain the nethash in order to be sure you are broadcasting to the right network (testnet, mainnet or others). The nethash is simply the payload hash from the genesisBlock. If no nethash or wrong nethash is provided in the headers, the request will be rejected returning the expected nethash.
```json
{ "success": false, "message": "Request is made on the wrong network", "expected":"e2f8f69ec6ab4b12550a314bd867c46e64e429961bb427514a3a534c602ff467", "received":"wrong-nethash" }
```
The nethash for a given network can be obtained at the following API endpoint:
```
/api/blocks/getNetHash
```
You can also get the nethash from a peer this way:
On the client using [jQuery](https://jquery.com/):
```js
var nethash;
$.ajax({
url: "https://api.arknode.net/peer/transactions/",
data: JSON.stringify({}),
dataType: "json",
method: "POST",
headers: {
"Content-Type": "application/json",
"os": "linux3.2.0-4-amd64",
"version": "0.3.0",
"port": 1,
"nethash": "wrong-nethash"
},
success: function(data) {
nethash = data.body.expected;
}
});
```
From a server using [Request](https://github.com/request/request):
```js
var nethash;
request({
url: "https://api.arknode.net/peer/transactions",
json: { },
method: "POST",
headers: {
"Content-Type": "application/json",
"os": "linux3.2.0-4-amd64",
"version": "0.3.0",
"port": 1,
"nethash": "wrong-nethash"
}
}, function(error, response, body) {
nethash = body.expected;
});
```
### Posting a transaction
Transaction objects are sent to `/peer/transactions`, using the `POST` method.
Example:
```js
Method: POST
Content-Type: application/json
{
"transactions" : [{
...
}]
}
```
#### Sending transaction on the Client
Using [jQuery](https://jquery.com/):
```js
var success = function(data) {
console.log(data);
};
$.ajax({
url: "https://api.arknode.net/peer/transactions",
data: JSON.stringify({ transactions: [transaction] }),
dataType: "json",
method: "POST",
headers: {
"Content-Type": "application/json",
"os": "linux3.2.0-4-amd64",
"version": "0.3.0",
"port": 1,
"nethash":nethash
},
success: success
});
```
#### Sending transaction on the Server
Using [Request](https://github.com/request/request):
```js
var request = require("request");
var callback = function(error, response, body) {
console.log(error || body);
};
request({
url: "https://api.arknode.net/peer/transactions",
json: { transactions: [transaction] },
method: "POST",
headers: {
"Content-Type": "application/json",
"os": "linux3.2.0-4-amd64",
"version": "0.3.0",
"port": 1,
"nethash": nethash
}
}, callback);
```
#### Peer Response
Upon successfully accepting a transaction, the receiving node will respond with:
```json
{ "success": true, "result": "5318121831703437738" }
```
If the transaction is deemed invalid, or an error is encountered, the receiving node will respond with:
```json
{ "success": false, "message": "Error message" }
```
***
### Other transaction types
#### Creating a delegate transaction
```js
var transaction = ark.delegate.createDelegate("secret", "username", "secondSecret");
```
#### Creating a second signature transaction
```js
var transaction = ark.signature.createSignature("secret", "secondSecret");
```
#### Creating a vote transaction
```js
var transaction = ark.vote.createVote("secret", ["+58199578191950019299181920120128129"], "secondSecret");
```
***
## Security
If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.
## Authors
- FX Thoorens
- Guillaume Verbal
- Boris Povod
- Oliver Beddows
## License
The MIT License (MIT)
Copyright (c) 2016-2017 ARK.io
Copyright (c) 2016 Lisk
Copyright (c) 2015 Crypti
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.