liteweb v2.7.4

What is LiteWeb?

Lite Web - Developer Document

LiteWeb aims to deliver a unified, seamless development experience influenced by Ethereum's Web3 implementation. We have taken the core ideas and expanded upon it to unlock the functionality of LITE's unique feature set along with offering new tools for integrating DApps in the browser, Node.js and IoT devices.

Compatibility

• Version built for Node.js v6 and above
• Version built for browsers with more than 0.25% market share

You can access either version specifically from the dist folder.

LiteWeb is also compatible with frontend frameworks such as:

• Angular
• React
• Vue.

You can also ship LiteWeb in a Chrome extension.

Installation

Node.js

npm install liteweb

or

yarn add liteweb

Browser

First, don't use the release section of this repo, it has not updated in a long time.

Then easiest way to use LiteWeb in a browser is to install it as above and copy the dist file to your working folder. For example:

cp node_modules/liteweb/dist/LiteWeb.js ./js/liteweb.js

so that you can call it in your HTML page as

<script src="./js/liteweb.js"><script>

Testnet

Shasta is the official Lite testnet. To use it use the following endpoint:

https://api.shasta.litegrid.io

Get some Shasta XLT at https://www.litegrid.io/shasta and play with it. Anything you do should be explorable on https://shasta.litescan.org

Your local private network for heavy testing

You can set up your own private network, running Lite Quickstart. To do it you must install Docker and, when ready, run a command like

docker run -it --rm \
  -p 9090:9090 \
  -e "defaultBalance=100000" \
  -e "showQueryString=true" \
  -e "showBody=true" \
  -e "formatJson=true" \
  --name lite \
  litetools/quickstart

More details about Lite Quickstart on GitHub

Creating an Instance

First off, in your javascript file, define LiteWeb:

const LiteWeb = require('liteweb')

When you instantiate LiteWeb you can define

• fullNode
• solidityNode
• eventServer
• privateKey

you can also set a

• fullHost

which works as a jolly. If you do so, though, the more precise specification has priority. Supposing you are using a server which provides everything, like LiteGrid, you can instantiate LiteWeb as:

const liteWeb = new LiteWeb({
    fullHost: 'https://api.litegrid.io',
    privateKey: 'your private key'
})

For retro-compatibility, though, you can continue to use the old approach, where any parameter is passed separately:

const liteWeb = new LiteWeb(fullNode, solidityNode, eventServer, privateKey)

If you are, for example, using a server as full and solidity node, and another server for the events, you can set it as:

const liteWeb = new LiteWeb({
    fullHost: 'https://api.litegrid.io',
    eventServer: 'https://api.someotherevent.io',
    privateKey: 'your private key'
  }
)

If you are using different servers for anything, you can do

const liteWeb = new LiteWeb({
    fullNode: 'https://some-node.tld',
    solidityNode: 'https://some-other-node.tld'
    eventServer: 'https://some-event-server.tld',
    privateKey: 'your private key'
  }
)

A full example

The better way to understand how to work with Lite is to clone the MetaCoin example and follow the instructions at https://github.com/Litebox-boxes/metacoin-box

Contributions

In order to contribute you can

• fork this repo and clone it locally
• install the dependencies — npm i
• do your changes to the code
• build the LiteWeb dist files — npm run build
• run a local private network using Lite Quickstart
• run the tests — npm test:node
• push your changes and open a pull request

Recent History

2.7.4

• Fix bugs of xlt.getBrokerage and xlt.getReward function

2.7.3

• Support new apis related to Java-Lite 3.6.5
• Original withdrawBlockRewards method support to withdraw user's reward

2.6.8

• Support extension of transaction expiration
• Allow to add data to the transaction
• Many minor changes and fixes

2.6.3

• Support get unconfirmed transaction function

2.6.0

• Support trigger constant contract, clear abi and add account by id
• Add permission id option in functions related to creating transaction
• Support multi-sign without permission id

2.5.6

• Reverse PR #6

2.5.5

• Ignore receiverAddress during freezeBalance and unfreezeBalance if it is equal to the owner address

2.5.4

• Adds cache in Xlt to cache Contracts locally and make the process more efficient

2.5.2

• Adds static methods Xlt.signString and `Xlt.verifySignature

2.5.0

• Allows freeBandwidth, freeBandwidthLimit, frozenAmount and frozenDuration to be zero

2.3.7

• Get rid of jssha to reduce the size of the package a little bit.

2.3.6

• Supports /wallet/getapprovedlist and /wallet/getsignweight JavaLite API.
• Adds test for multi-sign workflow.

2.3.5

• Fixes a typo in #event.getEventsByContractAddress naming.

2.3.4

• Adds options to #plugin.register to pass parameters to pluginInterface.

2.3.3

• Adds filters during event watching.

2.3.2

• Removes mixed approach instantiating liteWeb. Before you could pass the servers as an object, and the privateKey as a separate parameter. Now, you pass them either in the options object or in the params.

2.3.1

• Adds support for not-tld domain, like http://localhost
• Improve the new format, allow passing the privateKey as a property in the option object

2.3.0

• Introduces new format to instantiate liteWeb, passing an options object instead that fullNode, solidityNode and eventServer as separate params
• Fixes bug in _watch which causes a continuous update of the since parameter

Licence

LiteWeb is distributed under a MIT licence.

For more historic data, check the original repo at https://github.com/liteprotocol/lite-web