beowulf-js

beowulf-js

beowulf-js is the official Beowulf library for Javascript.

Full Documentation

• Please have a look at the Wiki for full documentation, examples, operational details and other information.
• The api documentation can be found in the official beowulf developers portal: https://beowulfchain.com/developer-guide/javascript

Main Functions Supported

1. CHAIN

• get_block
• get_transaction

1. TRANSACTION

• broadcast_transaction
• create transaction transfer
• create account

Requirements

• npm minimum version 6.9.0

Install

npm i beowulf-js

For running on Testnet

const beowulfjs = require('beowulf-js');
beowulfjs.config.set('chain_id', '430b37f23cf146d42f15376f341d7f8f5a1ad6f4e63affdeb5dc61d55d8c95a7');
beowulfjs.config.set('uri', 'https://testnet-bw.beowulfchain.com');

Init

const beowulfjs = require('beowulf-js');
let url = beowulfjs.config.get('uri');
beowulfjs.api.setOptions({ url: url, useAppbaseApi: true });

Example Usage

Get a block

let blockNum = 232967;
beowulfjs.api.getBlock(blockNum, function(err, result) {
  console.log(err, result);
});

Get Transaction

let trxId = '60207c8e17f47bf2790c927701792d95d42e3f46';
beowulfjs.api.getTransaction(trxId, function(err, result) {
  console.log(err, result);
});

Generate a wallet

API

let wallet = beowulfjs.wallet.generateWallet();

Response Example

{
  "owner": "5JY3sGqkfoN7U6kee9HibnG6etQgLNCMqjhPqsVDRXRjGwFNKeA",
  "ownerPubkey": "BEO7GXMArUCaxq1kPNP4JkcnshVDyfpVTfEwL8e8FVAN6BgpU8Y1k"
}

Submit Wallet to Blockchain

API

beowulfjs.wallet.submitWallet({
  ownerPubkey,
  account,
  creator,
  creatorWif,
  fee
}, (err, result) => {

})

Params:

ownerPubkey: string // wallet public key
account: string // Name of Wallet
fee: string // Fee for creating wallet
creator: string // Wallet Name of father of account
creatorWif: string // Private key of father account

let ownerPubkey = 'BEO7GXMArUCaxq1kPNP4JkcnshVDyfpVTfEwL8e8FVAN6BgpU8Y1k';
let account = 'newwallet';
let creator = 'creatorwallet';
let creatorWif = '5Kxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; // replace by your wif
let fee = '0.10000 W'; // Minimum account creation fee

beowulfjs.wallet.submitWallet({
  ownerPubkey,
  account,
  creator,
  creatorWif,
  fee
}, (err, result) => {

})

Submit Transaction

API

beowulfjs.broadcast.transfer(wif, from, to, amount, fee, memo, (err, result) => {
  console.log(err, result);
});

Params:

from: string // Wallet name of sender
wif: string // private key of sender
to: string // Wallet name of receiver
amount: string
memo: string
fee: string // Fee for submiting transaction

let from = 'examplewallet';
let wif = '5Jxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; // replace by your wif
let to = 'examplewallet2';
let amount = '4.00000 BWF';
let memo = 'example';
let fee = '0.01000 W'; // Minimum transfer fee

beowulfjs.broadcast.transfer(wif, from, to, amount, fee, memo, (err, result) => {
  console.log(err, result);
});