Code Monkey home page Code Monkey logo

seele.js's Introduction

SeeleJS

SeeleJS is a generic scripting API library for the Seele blockchain.

npm install seele.js

Due to problems with the keccak library, some errors will occur during installation, but if Keccak bindings compilation fail. Pure JS implementation will be used. occurs, it doesn't matter, the package is normal. Follow-up will consider blocking this error.

Example

If the last parameter is not bound to a callback function, the console.log is used by default.

var seelejs = require('seele.js');

var client = new seelejs();
client.getInfo(function(info) {
  if (info instanceof Error){
    console.log("Error")
    console.log(info)
    return
  }

  console.log(info)
});

client.exec("getInfo", console.log);

client.exec("getBlock", "", 1, false, console.log);

client.send("getBlock", "", 1, false, function(info) {
  if (info instanceof Error){
    console.log("Error")
    console.log(info)
    return
  }

  console.log(info)
});

Options

You can pass options to the initialization function or use the default options.

var seelejs = require('seele.js');

function seelejs(host, port, headers, user, password, timeout){
  ...
};

Available options and default values:

  • host(String) : A domain name or IP address of the server to issue the request to. Default: localhost.
  • port(String) : ort Port of remote server. Default: 8037.
  • headers(Object) : An object containing request headers, the format must be [{'name':'', 'vaule':''}, {'name':'', 'vaule':''}...].
  • user(String) : Basic authentication i.e. 'user:password' to compute an Authorization header. Not used.
  • password(String) : Basic authentication i.e. 'user:password' to compute an Authorization header. Not used.
  • timeout(Number) : timeout A number specifying the socket timeout in milliseconds. This will set the timeout before the socket is connected. Default: 30000.

Methods

The Seele API is supported as direct methods. Use either camelcase or lowercase.

client.getInfo(function(info) {
  if (info instanceof Error){
    console.log("Error")
    console.log(info)
    return
  }

  console.log(info)
});

.send(command [string], ...arguments..., callback [function])

Sends the given command with optional arguments. Function callback defaults to console.log. All of the API commands are supported in lowercase or camelcase. Or uppercase. Anycase!

client.send("getBlock", "", 1, false, function(info) {
  if (info instanceof Error){
    console.log("Error")
    console.log(info)
    return
  }

  console.log(info)
});

.sendSync(command [string], ...arguments...)

Sends the given command with optional arguments. This function will return a Promise object, and you can use to handle the result. All of the API commands are supported in lowercase or camelcase. Or uppercase. Anycase!

var task1 = function(result){
    console.log("task1")
    errorTask(result)
    console.log(result)
    return client.sendSync("getInfo")
}

var task2 = function(result){
    console.log("task2")
    errorTask(result)
    console.log(result)
    return result.Coinbase
}

var callback = function(result){
    console.log("callback")
    errorTask(result)
    console.log(result)
}

var errorTask = function(data){
    if (data instanceof Error){
        console.log(data)
        throw data
    }

    return data
}

let promise = client.sendSync("getBlock", "", 1, false)
promise.then(task1).then(task2).then(callback).catch(promise.then(task1).then(task2).then(callback).catch(callback)

.exec(command [string], ...arguments..., callback [function])

Executes the given command with optional arguments. Function callback defaults to console.log. All of the API commands are supported in lowercase or camelcase. Or uppercase. Anycase!

client.exec("getInfo");

client.exec("getInfo", function(info){
  if (info instanceof Error){
    console.log("Error")
    console.log(info)
    return
  }

  console.log(info)
});

.execSync(command [string], ...arguments...)

Executes the given command with optional arguments. This function will return a Promise object, and you can use to handle the result. All of the API commands are supported in lowercase or camelcase. Or uppercase. Anycase!

let promise = client.execSync("getBlock", "", 1, false)
promise.then(function(info){
  console.log(info);
}).catch(function(err){
  console.log(err);
})

.generateTx(privatekey [Hex String], rawTx [JSON String]) return tx [Object]

Generate transaction and sign, the rawTx must be in the example format, otherwise an error will occur.

var privatekey = "0x24ce9cadcc9207c94296db166ab7a0fa686f2a6d29f7ea54fe8c22271c40812e"
var rawTx = {
  "From":"0xa61e5b0b30e91c4ae10dda3a6ddeb9d9d35ebfe1",
  "To":"0x0000000000000000000000000000000000000000",
  "Amount":0,
  "AccountNonce":123,
  "GasPrice":1,
  "GasLimit":3000000,
  "Timestamp":0,
  "Payload":""
}

tx = generateTx(privatekey, rawTx)

.filterBlockTx(height [Number], address [Hex String], flag [Number], callback [function]) return tx [Object]

Filtering transactions for a specific address based on block height, an error occurs if the block height does not exist. If the height is -1, it will filter the current block. When the flag is 1, the transaction from equal to the address is filtered in the block. When the flag is 2, the transaction to equal to the address is filtered in the block.

client.filterBlockTx(123, "0x0000000000000000000000000000000000000000", "1")
client.filterBlockTx(-1, "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "2")

seele.js's People

Contributors

buddingleader avatar asdv23 avatar

Watchers

James Cloos avatar MiyaFlower avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.