# Get Started

Connex is the standard interface to connect VeChain apps with VeChain blockchain and users. Aiming to help developers building decentralized applications. Sync or other connex compatible clients will expose connex API by an injected object on Window Object.

Connex Overview

# How To

As Connex is already attached to the Window Object, just use it in your favourite way. Below is a sample of getting network status,

const el = document.createElement('h1')

const status = connex.thor.status
el.innerText = 'You are \'connexed\' to vechain, the status is ' + (status.progress === 1 ? 'synced': 'syncing')

document.querySelector('body').append(el)

This project is the type definition of Connex API which can be used to in typescript projects. Install by the following command:

npm install @vechain/connex --save-dev

Place following line in any .ts file of your project

import '@vechain/connex'

or

add @vechain/connex to compilerOptions.types in tsconfig.json then you are good to go!

# Bootstrap Your APP

VeChain apps are usually web apps. On app load, you always need to detect Connex component in the environment. If Connex is not available, you may instruct users to setup Connex environment.

To simplify these steps, simply perform redirection:

if(!window.connex) {
    location.href = 'https://env.vechain.org/r/#' + encodeURIComponent(location.href)
}

Additionally, network can be specified:

if(!window.connex) {
    // the app prefers running on test net
    location.href = 'https://env.vechain.org/r/#/test/' + encodeURIComponent(location.href)
}

# Compatible Client

# Desktop

  • Sync : The official desktop wallet firstly supports Connex. It provides seamless experience for users and developers. Which is designed to provide the superior user experiences for VeChain Apps, and serves as the dApp environment to provide unlimited potential for developers and users.

# Mobile

  • VeChainThor Mobile Wallet (iOS / Android) : VeChainThor Wallet is a light mobile wallet app. We aim to provide users with a powerful, secure, simple, fully functional portal of the VeChainThor blockchain.

  • Sync Mobile beta : Official mobile wallet fully supports Connex. Provide superior user experience for VeChain Apps, and serves as the dApp environment to provide unlimited potential for developers and users.

# Resources