Miss any of our Open RFC calls?Watch the recordings here! »

vort_x

1.1.3 • Public • Published

Build Status License: MIT

Introduction

Vortex is an Ethereum Dapp redux store that handles transactions, smart contracts, events, accounts, method calls, web3 status, IPFS fetching ... Very easy to use with React, it will allow your Dapp to be more reactive (no need to refresh anything), and will make less requests with web3, for even better results. You can also fetch IPFS data and cache it into the redux store.

  • Load all your contracts inside a Redux Store instantly
  • Keep in cache all the informations you need about your actions
  • Track precisely how your transactions are doing
  • Track the balance of your account
  • Keep constant data from your contracts in your cache
  • Get notified when an Event is triggered
  • The Backlink will refresh all your data ONLY when trully necessary (NO MORE POLLING)
  • Support for Solidity Events
  • Access all this data accross your React Components
  • Use already built components
  • Make your Dapp simply incredible !

Documentation

Vortex Components

Embark Demonstration

Truffle Demonstration

Contribution


Installation

npm install --save vort_x vort_x-components

Get started

For Embark Users ...

import {
    VortexGate,
    VortexWeb3Loaded,
    VortexWeb3Loading,
    VortexWeb3LoadError,
    VortexWeb3NetworkError,
    VortexWeb3Locked,
    VortexMetamaskLoader
} from 'vort_x-components';
import Web3 from 'web3'; // 1.0.0-beta.34+ is preferable :)
import SimpleStorageContractInstance from 'Embark/contracts/SimpleStorage';
import Chains from '../chains.json';
 
 
...
 
 
<VortexGate
 
    // Configure your contracts
    contracts={{
        type: 'embark',
        embark_contracts: {
            SimpleStorage: SimpleStorageContractInstance
        },
        chains: Chains,
        preloaded_contracts: [
            "SimpleStorage"
        ]
    }}
 
    // Provide a custom Web3 loader
    loader={VortexMetamaskLoader(Web3)}
 
    // Configure your IPFS Endpoint
    ipfs_config={{
        host: 'ipfs.infura.io',
        port: '5001',
        options: {
            protocol: 'https'
        }
    }}
 
 
    // Configure your backlink endpoint
    backlink_config={{
         url: {
             "mainnet": "wss://mainnet.infura.io/ws",
             "default": "ws://localhost:8545/ws"
         }
    }}>
 
    <VortexWeb3Loaded>
        // Renders this when everything went well.
    </VortexWeb3Loaded>
 
    <VortexWeb3Loading>
        // Renders this when web3 is still loading.
    </VortexWeb3Loading>
 
    <VortexWeb3LoadError>
        // Renders this when an error occured while loading web3.
    </VortexWeb3LoadError>
 
    <VortexWeb3NetworkError>
        // Renders this if the contracts are not on the current network
    </VortexWeb3NetworkError>
 
    <VortexWeb3Locked>
        // Renders this if the wallet provider (Metamask, Mist) is locked
    </VortexWeb3Locked>
 
</VortexGate>

... and for Truffle Users.

import {
    VortexGate,
    VortexWeb3Loaded,
    VortexWeb3Loading,
    VortexWeb3LoadError,
    VortexWeb3NetworkError,
    VortexWeb3Locked,
    VortexMetamaskLoader
} from 'vort_x-components';
import Web3 from 'web3'; // 1.0.0-beta.34+ is preferable :)
import SimpleStorage from '../build/contracts/SimpleStorage.json'
 
 
...
 
 
<VortexGate
 
    // Configure your contracts
    contracts={{
        type: 'truffle',
        truffle_contracts: [SimpleStorage],
        preloaded_contracts: ["SimpleStorage"],
        network_contracts: [SimpleStorage]
    }}
 
    // Provide a custom Web3 loader
    loader={VortexMetamaskLoader(Web3)}
 
    // Configure your IPFS Endpoint
    ipfs_config={{
        host: 'ipfs.infura.io',
        port: '5001',
        options: {
            protocol: 'https'
        }
    }}
 
 
    // Configure your backlink endpoint
    backlink_config={{
         url: {
             "mainnet": "wss://mainnet.infura.io/ws",
             "default": "ws://localhost:8545/ws"
         }
    }}>
 
    <VortexWeb3Loaded>
        // Renders this when everything went well.
    </VortexWeb3Loaded>
 
    <VortexWeb3Loading>
        // Renders this when web3 is still loading.
    </VortexWeb3Loading>
 
    <VortexWeb3LoadError>
        // Renders this when an error occured while loading web3.
    </VortexWeb3LoadError>
 
    <VortexWeb3NetworkError>
        // Renders this if the contracts are not on the current network
    </VortexWeb3NetworkError>
 
    <VortexWeb3Locked>
        // Renders this if the wallet provider (Metamask, Mist) is locked
    </VortexWeb3Locked>
 
</VortexGate>

Install

npm i vort_x

DownloadsWeekly Downloads

0

Version

1.1.3

License

MIT

Unpacked Size

214 kB

Total Files

57

Last publish

Collaborators

  • avatar