RIPA JS
RIPA JS is a JavaScript library for sending RIPA transactions. It's main benefit is that it does not require a locally installed RIPA 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
Building
Build the browserify module for client use:
npm build:browserify
Clean:
npm clean:browserify
Tests
npm test
Tests written using mocha + schedule.js.
Usage
On the client:
On the server:
var ripajs = ;
Generating a key pair
To generate a public / private key pair from a given passphrase:
var keys = ripajscrypto;
Returning:
publicKey: "02e012f0a7cac12a74bdc17d844cbc9f637177b470019c32a53cef94c7a56e2ea9" privateKey: ""
To get the private key:
keysd;
Returning:
1e089e3c5323ad80a90767bdd5907297b4138163f027097fd3bdbeab528d2d68
Generating an address
To generate a unique RIPA address from a given public key:
var address = ripajscrypto;
Returning:
AGihocTkwDygiFvmg6aG8jThYTic47GzU9
Creating a transaction
To create a signed transaction object, which can then be broadcasted onto the network:
var amount = 1000 * Math; // 100000000000var transaction = ripajstransaction;
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 RIPA 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.
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;$;
From a server using Request:
var nethash;;
Posting a transaction
Transaction objects are sent to /peer/transactions
, using the POST
method.
Example:
Method: POSTContent-Type: application/json "transactions" : ...
Sending transaction on the Client
Using jQuery:
var { console;}; $;
Sending transaction on the Server
Using Request:
var request = ; var { console;}; ;
Peer Response
Upon successfully accepting a transaction, the receiving node will respond with:
If the transaction is deemed invalid, or an error is encountered, the receiving node will respond with:
Other transaction types
Creating a delegate transaction
var transaction = ripajsdelegate;
Creating a second signature transaction
var transaction = ripajssignature;
Creating a vote transaction
var transaction = ripajsvote;
Authors
- Giovanni Silvestri gsit80@gmail.com
- FX Thoorens fx@ark.io
- Guillaume Verbal doweig@ark.io
License
RIPAEX is licensed under the MIT License - see the LICENSE file for details.