@vechain/connex

Connex

The out of the box Connex implementation for browser.

Installation

Include in <script> tag

Just include the CDN link within a script tag. Connex will then be registered as a global variable.

<!-- install the latest v2 -->
<script src="https://unpkg.com/@vechain/connex@2" />

NPM

It's recommended when your project is a bit large.

$ npm i @vechain/connex

import Connex from '@vechain/connex'

Startup

Create a Connex object connects to VeChain mainnet

const connex = new Connex({
    node: 'https://mainnet.veblocks.net/', // veblocks public node, use your own if needed
    network: 'main' // defaults to mainnet, so it can be omitted here
})

Connect to testnet

const connex = new Connex({
    node: 'https://testnet.veblocks.net/',
    network: 'test'
})

Or connect to private network

const connex = new Connex({
    node: <the API url of your node>,
    // the genesis block of your private network
    network: {
        id: 0x...,
        ...
    }
})

Create Vendor module only

In some cases, e.g. the classic 'Buy me a coffee' demo, you don't need the ability to access blockchain. You can opt-out Connex.Thor module, and just create Connex.Vendor module.

const vendor = new Connex.Vendor('main')

License

This package is licensed under the GNU Lesser General Public License v3.0, also included in LICENSE file in the repository.