Skip to main content

The XBR Protocol - blockchain protocol for decentralized open data markets

Project description

Docs (on CDN) Docs (on S3) Travis Coverage

This repository contains the XBR smart contracts, with Ethereum as target blockchain, and Solidity as implementation language for the XBR Protocol.

Please see the documentation for more information.

XBR Client Library

The XBR Protocol - at its core - is made of the XBR smart contracts, and the primary artifacts built are the contract ABI files (in ./build/contracts/*.json).

Technically, these files are all you need to interact and talk to the XBR smart contracts.

However, doing it that way (using the raw ABI files and presumably some generic Ethereum library) is cumbersome and error prone to maintain.

Therefore, we create wrapper libraries for XBR, currently for Python and JavaScript, that make interaction with XBR contract super easy.

The libraries are available here:

XBR Lib for Browser

To use XBR Lib for JavaScript (in a browser Dapp), add a reference to the latest development version we host:

<script>
    XBR_DEBUG_TOKEN_ADDR = '0x67b5656d60a809915323bf2c40a8bef15a152e3e';
    XBR_DEBUG_NETWORK_ADDR = '0x2612af3a521c2df9eaf28422ca335b04adf3ac66';
</script>
<script src="https://xbr.network/lib/xbr.min.js"></script>

Then to use

xbr.setProvider(window.web3.currentProvider);

As long as we haven't deployed the XBR smart contracts to any public
network (testnets or mainnet), a user must set the addresses of our
deployed token and network smart contracts on the (private) network
the user is connecting to and where the XBR contracts need to be
deployed.

XBR Lib for NodeJS

XBR Lib for NodeJS:

npm install autobahn

XBR Lib for Python

XBR Lib for Python is published on PyPI and can be installed:

pip install xbr

To use XBR Lib for Python, export the following environment variables

export XBR_DEBUG_TOKEN_ADDR="0x67b5656d60a809915323bf2c40a8bef15a152e3e"
export XBR_DEBUG_NETWORK_ADDR="0x2612af3a521c2df9eaf28422ca335b04adf3ac66"

import the library and set the Web3 provider:

import xbr
from web3.auto import w3

xbr.setProvider(w3)

Copyright Crossbar.io Technologies GmbH. Licensed under the Apache 2.0 license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xbr-18.11.4.tar.gz (271.2 kB view details)

Uploaded Source

Built Distribution

xbr-18.11.4-py2.py3-none-any.whl (299.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file xbr-18.11.4.tar.gz.

File metadata

  • Download URL: xbr-18.11.4.tar.gz
  • Upload date:
  • Size: 271.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for xbr-18.11.4.tar.gz
Algorithm Hash digest
SHA256 3f19d11ee624cbe50012f44aa8af6d541a127ae55a8a0878ae47dcbceb965926
MD5 5caa6248296d80741cedad49b515c53b
BLAKE2b-256 601e3478509533a609eeaed60557308742a7d4e284d088b5ef55cdbc1fc7b008

See more details on using hashes here.

File details

Details for the file xbr-18.11.4-py2.py3-none-any.whl.

File metadata

  • Download URL: xbr-18.11.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 299.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for xbr-18.11.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b4aa30f82b179fc8afad124fbfabf09746285212052d6f07a4bfc6306decf8e9
MD5 458451738afd23b63411b177041049e1
BLAKE2b-256 7a5d4166d4ebaef0ca1b7ac9098679cfb223cc671ddf9be227937c3602a33305

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page