Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blockchainsllc/in3-server
Incubed Node/Server repository
https://github.com/blockchainsllc/in3-server
ethereum in3 incubed
Last synced: 2 months ago
JSON representation
Incubed Node/Server repository
- Host: GitHub
- URL: https://github.com/blockchainsllc/in3-server
- Owner: blockchainsllc
- License: other
- Created: 2019-09-04T07:55:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T19:45:19.000Z (almost 2 years ago)
- Last Synced: 2023-03-02T12:01:06.691Z (almost 2 years ago)
- Topics: ethereum, in3, incubed
- Language: TypeScript
- Homepage:
- Size: 33.6 MB
- Stars: 10
- Watchers: 8
- Forks: 8
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Incubed Server
[](https://github.com/slockit/in3-server/network/members)
[](https://github.com/slockit/in3-server/stargazers)
[](https://github.com/slockit/in3-server/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).
This version of the in3 node (server) is written in typescript. The in3-node provides the data and proof used by the client for verification.
The in3-node mainly provides data from the Ethereum clients to the in3-clients. The in3-node can act as a regular RPC-provider,
but in3-nodes also have the ability to provide [merkle-proofs](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getproof)
with signed blockhashes in their responses. The merkle-proofs can be used by the clients to make sure that the
[response was correct](https://in3.readthedocs.io/en/latest/poa.html). The signed blockHeader in the response acts as
a extra layer of security, in case the in3-node was found to have provided a blockHeader that is not part of the chain,
their deposit can be taken away.
Using this technique an in3-client has an insurance that it will receive a valid response, allowing it to query
nodes that it might not be affiliated with.
A more detailed explanation of in3 can be found [here](https://in3.readthedocs.io/en/latest/intro.html).
For information on the in3 typescript client, please go [here](https://github.com/slockit/in3).
For information on the in3 C client, please go [here](https://github.com/slockit/in3-c).
## Installation and Usage
Please only run an in3-node if you have some experience with networking and private key management. It is not expected
for regular users to run their own in3-node, you may always use public in3-nodes. A list of public nodes for use by
anyone can be found [here](https://in3.readthedocs.io/en/latest/getting_started.html#supported-chains).
| | package manager | Link | Use case |
| ------------- |:-------------:| -----:| :----:|
| in3-node (ts) | Docker Hub | [](https://hub.docker.com/r/slockit/in3-node)| To run the in3-node, which the in3-client can use to connect to the in3 network |
### Docker Hub
1. Pull the image from docker using ```docker pull slockit/in3-node```
2. In order to run your own in3-node, you must first register the node. The information for registering a node can be found
[here](https://in3.readthedocs.io/en/latest/getting_started.html#registering-an-incubed-node)
3. Run the in3-node image using a direct docker command, a docker-compose file(the parameters for which are explained
[here](https://in3.readthedocs.io/en/latest/api-node-server.html)) or use our [online helper tool](https://in3-setup.slock.it/) to generate a docker-compose file with
all needed parameters. In case you want to run the server helper tool yourself, [here](https://hub.docker.com/r/slockit/in3-server-setup) is the docker image.
## Example
### POST Request
Once the in3-node has been registered in the in3 network, and the in3-node port has been exposed, you can test the in3-node
with the following POST request to the IP/URL configured to your in3-node:
```
{
"id": 1,
"jsonrpc": "2.0",
"method": "eth_getBlockByNumber",
"params": ["latest",true],
"in3": {
"chainid": "0x5",
"verification": "proof"
}
}
```
This JSON rpc request should return the the latest block of the chain specified in "chainid". The POST request mentioned above
is configured for the Görli test chain.
## Features
| | in3-node | Pruned Node | Full Node |
| -------------------------- | :----------------: | :----------------: | :----------------: |
| Failsafe connection | ✔️ | ❌ | ❌️ |
| Multi-chain support | ✔️ | ❌️ | ❌ |
| Full verification of JSON-RPC methods | ✔️ | ❌ | ✔️ |
| Caching support | ✔️ | ❌ | ❌ |
| Proof-Levels | ✔️ | ❌ | ❌ |
| POA Support | ✔️ | ✔️ | ✔️ |
| Database setup size-minutes| 0-instant️ | ~Hours | ~Days️ |
## Resources
* [in3-Node API reference](https://in3.readthedocs.io/en/latest/api-node.html)
* [Registering your node](https://in3.readthedocs.io/en/latest/api-node.html#registering-your-own-incubed-node)
* [in3 typescript client](https://github.com/slockit/in3)
* [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 any questions
and suggestions.
[](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?
Send us an email at [email protected]