ChirpJS

A web3js wrapper for accessing Chirp content on the ethereum blockchain

Installation

npm install chirpjs --save 

Initialization

const Chirp = require('chirpjs');

const rpcUrl = "https://rcp.infura.io/ajdij1ij21io3";
const contractAddress = "0x0....";
const contractAbi = [];

Chirp.initialize(rcpUrl, contractAddress, contractAbi, function(chirps) {
   console.log(chirps); // {1:{chirp 1...}, 2: { chirp...1},...} 
});

Functions

• loadChirps(callback): Loads all chirps into an object.

Chirp.loadChirps(function(chirps) {
	console.log(chirps); // {1:{chirp 1...}, 2: { chirp...1},...} 
});

• getChirp(id, callback): Load a chirp by ID with replies included.

Chirp.getChirp(id, function(chirp) {
	console.log(chirp); // {id: 1, body: "[body]", replies: [{chirp}, {chirp}..]} 
});

• getChirpsByChirper(address, callback): Returns all chirps an address chirped.

Chirp.getChirpsByChirper(address, function(chirps) {
	console.log(chirps); // {1:{chirp 1...}, 2: { chirp...1},...} 
});

• getAliasFromAddress(address, callback): Returns an address's alias.

Chirp.getAliasFromAddress(address, function(alias) {
	console.log(alias); // "[alias]" or "" if alias doesn't exist.
});

• getAliasFromAddress(address, callback): Returns an address's Chirp token balance.

Chirp.tokenBalance(address, function(balance) {
	console.log(balance); // 1000
});

• getCount(): Returns number of Chirps on the blockchain.

let chirpCount = Chirp.getCount();
console.log(chirpCount); // 500

• getPurchaseableSupply(): Returns number of tokens available for purchase from the Chirp contract.

let purchaseableSupply = Chirp.getPurchaseableSupply();
console.log(purchaseableSupply); // 100000