An Introduction To AriseBank’s AriseJS Library For AriseCoin.

We are excited to announce the first AriseCoin livenet software release with AriseJS 0.5.4. AriseJS enables developers to integrate AriseCoin’s blockchain activity, features, network and information into their own application, without running a full network node.

What Is AriseJS?

Arise JS is a JavaScript library for sending AriseCoin (ACO) transactions. It's main benefit is that it does not require a locally installed ACO node and instead utilizes the existing peers on the network. It can be used from the client as a browserify compiled module, or on the server as a standard Node.js module.

Installation

npm install arisejs

Tests

npm test

Tests written using mocha + schedule.js.

AriseJS Examples

On the client:

<script src="node_modules/arisejs/app.js"></script>

On the server:

var aco = require('arisejs');

Generating a key pair

To generate a public / private key pair from a given passphrase:

var keys = aco.crypto.getKeys("passphrase");

Returning:

{
publicKey: "5d036a858ce89f844491762eb89e2bfbd50a4a0a0da658e4b2628b25b117ae09",
privateKey: "2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a2…44491762eb89e2bfbd50a4a0a0da658e4b2628b25b117ae09"
}

Generating an address

To generate a unique Aco address from a given public key:

var address = aco.crypto.getAddress("5d036a858ce89f844491762eb89e2bfbd50a4a0a0da658e4b2628b25b117ae09");

Returning:

AGihocTkwDygiFvmg6aG8jThYTic47GzU9

Creating a transaction

To create a signed transaction object, which can then be posted onto the network:

var amount      = 1000 * Math.pow(10, 8); // 100000000000
var transaction = aco.transaction.createTransaction("AGihocTkwDygiFvmg6aG8jThYTic47GzU9", amount, null, "passphrase", "secondPassphrase");

Returning:

{
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 ACO 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 posting 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.

{ "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:

var nethash;
$.ajax({
url: 'https://main.arisecoin.com/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:

var nethash;
request({
url: 'https://main.arisecoin.com/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:

Method: POST
Content-Type: application/json

{
"transactions" : [{
...
}]
}

Sending transaction on the Client

Using jQuery:

var success = function(data) {
console.log(data);
};

$.ajax({
url: 'https://main.arisecoin.com/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:

var request = require('request');

var callback = function(error, response, body) {
console.log(error || body);
};

request({
url: 'https://main.arisecoin.com/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:

{ "success": true, "result": "5318121831703437738" }

If the transaction is deemed invalid, or an error is encountered, the receiving node will respond with:

{ "success": false, "message": "Error message" }

Other transaction types

Creating a delegate transaction

var transaction = aco.delegate.createDelegate("secret", "username", "secondSecret");

Creating a second signature transaction

var transaction = aco.signature.createTransaction("secret", "secondSecret");

Creating a vote transaction

var transaction = aco.vote.createVote("secret", ["+58199578191950019299181920120128129"], "secondSecret");

AriseJS is just the beginning. We plan on releasing the initial livenet release for AriseCoin Core, our core network software for the AriseCoin blockchain, along with Arise-CLI, as well as other exciting announcements that are just around the corner. Thanks for reading!