Skip to content

Stonebig122/in3

 
 

Repository files navigation

Incubed Client in C

Forks Stars License: AGPL v3

The Incubed client is a

  • Crypto-Economic
  • Non-syncronizing and stateless, but fully verifying
  • Minimal resource consuming

blockchain client (Crypto-Economic Client, Minimal Verification Client, Ultra Light Client). This version is written in C.

Most blockchains, such as Ethereum, require a client to connect to their blockchain network. Often, these clients require a lot of storage, a very high bandwidth or constant computation. While this is possible to perform on laptops or desktop systems, mobile devices, mobile app, and even web applications struggle to meet these requirements. Currently the solution of choice is to use a light client or remote client on mobile devices. While this may work for mobile phones, most IoT devices are unable to run light clients. Connecting an IoT device to a remote node enables even low-performance IoT devices to be connected to blockchain. However, by using distinct remote nodes, the advantages of a decentralized network are undermined introducing a single point of failure. Also, it is unsecure because the client is not able to verify the results by itself. The same applies for mobile apps or web pages. The Trustless Incentivized Remote Node Network, in short Incubed, makes it possible to establish a decentralized and secure network of remote nodes and clients which are able to verify and validate the results, enabling trustworthy and fast access to blockchain for a large number of low-performance IoT, mobile devices, and web applications.

in3

A more detailed explanation of in3 can be found here.

For information on the in3-node, please go here.

For information on the in3 typescript client, please go here.

Installation and Usage

package manager / Bindings Link Use case
Ubuntu Launchpad ubuntu Installs libs and binaries on IoT devices or Linux-Systems

Add the slock.it ppa to your system
sudo add-apt-repository ppa:devops-slock-it/in3

install the commandline tool in3
apt-get install in3

install shared and static libs and header files
apt-get install in3-dev
Docker Hub DockerHub Quick and easy way to get in3 client running as docker container
docker run -d -p 8545:8545 slockit/in3:latest --chainId=goerli -port 8545
More parameters and their descriptions can be found here.
Brew Homebrew Easy to install on MacOS

Add a brew tap
brew tap slockit/in3

install all binaries and libraries
brew install in3
Release page Github Releases including precompiled libraries for major platforms. To build or compile against the incubed, see readthedocs.
WASM npm a WASM-Based npm module running in browsers or nodjs.
npm install --save in3-wasm
See examples on how to use it.
Java Github For integrating with java applications. Take the jar-file from the release.
javac -cp $IN3_JAR_LOCATION/in3.jar *.java
For infromation on how to use maven, examples and documentation see readthedocs

Example

Please have a look at the examples folder in the repo for more detailed examples.

CLI

in3 can be used on the command line in this manner:

in3 [options] method [arguments]

For example,

To get block number, run:

> in3 eth_blockNumber
8610795

A more detailed list with information on arguments can be found here.

C Code

Example C code can be found here

#include <in3/client.h>    // the core client
#include <in3/eth_basic.h> // use the basic module
#include <in3/in3_curl.h>  // transport implementation
#include <inttypes.h>
#include <stdio.h>

int main(int argc, char* argv[]) {
 // register a chain-verifier for basic Ethereum-Support, which is enough to verify blocks
 in3_register_eth_basic();

 in3_register_curl(); // use curl as the default for sending out requests

 in3_t* in3 = in3_for_chain(CHAIN_ID_MAINNET); // create new incubed client

 char *result, *error;  // prepare 2 pointers for the result.

 in3_ret_t res = in3_client_rpc(   // send raw rpc-request, which is then verified
     in3,                    //  the configured client
     "eth_getBlockByNumber", // the rpc-method you want to call.
     "[\"latest\",true]",    // the arguments as json-string
     &result,                // the reference to a pointer whill hold the result
     &error);                // the pointer which may hold a error message

 if (res == IN3_OK) {
   printf("Latest block : \n%s\n", result);
   free(result);
 } else {
   printf("Error verifing the Latest block : \n%s\n", error);
   free(error);
 }
 in3_free(in3);   // cleanup client after usage

}

A more detailed example with information on how to call functions can be found here.

Features

in3 Remote Client Light Client
Failsafe connection ✔️ ✔️
Automatic Nodelist updates ✔️ ✔️
Partial nodelist ✔️ ✔️
Multi-chain support ✔️ ✔️
Full verification of JSON-RPC methods ✔️
IPFS support ✔️ ✔️
Caching support ✔️
Proof-Levels ✔️
POA Support ✔️ ✔️ ✔️
Database setup size-minutes 0-instant️ 0-instant ~50Mb-minutes️
Uses IoT devices,Mobile,browser️ Mobile,browser️️ PC,Laptop️

Resources

Contributors welcome!

We at Blockchains believe in the power of the open source community. Feel free to open any issues you may come across, fork the repository and integrate in your own projects. You can reach us on various social media platforms for any questions and suggestions.

Twitter Blog Youtube LinkedIn Gitter

Got any questions?

Contact us on Gitter or send us an email at team-in3@slock.it

LICENSE

COMMERCIAL LICENSE

Licensees holding a valid commercial license may use this software in accordance with the commercial license agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and slock.it GmbH/Blockchains LLC. For licensing terms and conditions or further information please contact slock.it at in3@slock.it. Alternatively, this software may be used under the AGPL license as follows:

AGPL LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. [Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.] You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Releases

No releases published

Packages

No packages published

Languages

  • C 60.4%
  • Python 16.7%
  • JavaScript 5.0%
  • C# 4.7%
  • Java 4.3%
  • Rust 3.4%
  • Other 5.5%