Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blockchainsllc/in3-legacy
[Deprecated] Typescript-version of the IN3 client.
https://github.com/blockchainsllc/in3-legacy
client client-library ethereum incubed merkle-proof typescript verification
Last synced: about 2 months ago
JSON representation
[Deprecated] Typescript-version of the IN3 client.
- Host: GitHub
- URL: https://github.com/blockchainsllc/in3-legacy
- Owner: blockchainsllc
- License: other
- Created: 2018-03-13T09:54:57.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T15:23:12.000Z (about 2 years ago)
- Last Synced: 2024-10-07T08:19:45.479Z (3 months ago)
- Topics: client, client-library, ethereum, incubed, merkle-proof, typescript, verification
- Language: TypeScript
- Homepage: https://github.com/blockchainsllc/in3
- Size: 3.19 MB
- Stars: 76
- Watchers: 12
- Forks: 17
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Incubed Client
[](https://github.com/slockit/in3/forks)
[](https://github.com/slockit/in3/watchers)
[](https://github.com/slockit/in3/blob/master/LICENSE.AGPL)
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).
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.
A more detailed explanation of in3 can be found in the concept on [readthedocs](https://in3.readthedocs.io/en/latest/intro.html).
# Platforms
**Incubed** can be used in different ways
| Stack | Size | Code Base | Use Case |
|-----------------------|------|-----------|----------|
| [TS/ JavaScript](#typescriptjavascript) | 2.7MB | https://github.com/slockit/in3 | WebApplication (decentralized RPC-Client in the Browser) or Mobile Applications |
| [TS/ JS with WASM](#typescriptjavascript) | 330kB | https://github.com/slockit/in3-c | WebApplication (decentralized RPC-Client in the Browser) or Mobile Applications |
| [C/C++](#c---implementation) | 200kB| https://github.com/slockit/in3-c | IoT-Devices, can be integrated nicely on many micro controllers (like [zephyr-supported boards] (https://docs.zephyrproject.org/latest/boards/index.html) ) or anny other C/C++ -Application |
| [Java](#java) | 705kB| https://github.com/slockit/in3-c | Java-Implementation of a native-wrapper |
| [Docker](#docker) | 2.6MB | https://github.com/slockit/in3 | For replacing existing clients with this docker and connect to incubed via localhost:8545 without the need to change the architecture |
| [bash](#commandline-tool) | 400kB | https://github.com/slockit/in3-c | the in3-commandline utils can be used directly as executable within bash-script or on the shell |
other Languages (like C#, Python, Go, Rust) will be supported soon (until then you can simply use the shared library directly).
For information on the in3-node, [sources on github](https://github.com/slockit/in3-server) or [readthedocs](https://in3.readthedocs.io/en/latest/api-node-server.html) will help you.
For information on the in3 client implementation in C, please go [in3-c](https://github.com/slockit/in3-c) or [API Documentation](https://in3.readthedocs.io/en/latest/api-c.html).
## Installation and Usage
[](https://www.npmjs.com/package/in3 )
Installing the in3-client is as easy as installing other modules:
```npm install --save in3```
Import incubed with:
```import In3Client from "in3"```
## Example
```
// import in3-Module
import In3Client from 'in3'
async function demo() {
// use the In3Client as Http-Provider
const in3 = new In3Client({
proof : 'standard',
signatureCount: 1,
requestCount : 2,
chainId : 'mainnet',
replaceLatestBlock: 10
})
// use the web3
const block = await in3.eth.getBlock('latest')
console.log(`Incubed signed block hash ${block.hash}`)
}
...
}
```
## Example with Web3 (as Provider)
```
// import in3-Module
import In3Client from 'in3'
import Web3 from 'web3'
async function demo() {
// use the In3Client as Http-Provider
const web3 = new Web3(new In3Client({
proof : 'standard',
signatureCount: 1,
requestCount : 2,
chainId : 'mainnet',
replaceLatestBlock: 10
}).createWeb3Provider())
// use the web3
const block = await web3.eth.getBlock('latest')
console.log(`Incubed signed block hash ${block.hash}`)
}
...
}
```
Detailed examples with usage of in3 in typescript programs can be found [here](https://in3.readthedocs.io/en/latest/api-ts.html).
## 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
* [TypeScript API reference](https://in3.readthedocs.io/en/latest/api-ts.html)
* [TypeScript examples](https://in3.readthedocs.io/en/latest/api-ts.html#examples)
* [in3-node](https://github.com/slockit/in3-server)
* [in3 C client](https://github.com/slockit/in3-c)
* [Website](https://slock.it/incubed/)
* [ReadTheDocs](https://in3.readthedocs.io/en/latest/)
* [Blog](https://blog.slock.it/)
* [Incubed concept video by Christoph Jentzsch](https://www.youtube.com/watch?v=_vodQubed2A)
* [Ethereum verification explained by Simon Jentzsch](https://www.youtube.com/watch?v=wlUlypmt6Oo)
## Contributors welcome!
We at Slock.it 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 questions.
[](https://twitter.com/slockitproject?s=17)
[](https://blog.slock.it/)
[](https://www.youtube.com/channel/UCPOrzp3CZmdb5HJWxSjv4Ig)
[](https://www.linkedin.com/company/10327305)
[](https://gitter.im/slockit-in3/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## Got any questions?
Contact us on [](https://gitter.im/slockit-in3/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) or
send us an email at [email protected]