README
¶
Insolar
Enterprise-ready blockchain platform.
Overview
Insolar is building a 4th generation blockchain platform for business aimed to enable seamless interactions between companies and unlock new growth opportunities. In addition to the blockchain platform, Insolar will provide blockchain services and ecosystem support for companies that are looking to develop and deploy blockchain solutions. Insolar will feature most complete and secure set of production-ready business blockchain tools and services to quickly build or launch blockchain enterprise applications, accelerating the progression path from initial proof-of-concept to full-scale production.
The world’s most innovative companies in finance, logistics, consumer goods, energy, healthcare, transportation, manufacturing and others will be turning to Insolar to create applications and networks that deliver tangible business success. They recognise that even in today’s digital economy, vast amounts of value continue to be trapped inside processes and organisations that don’t connect. Insolar is their remedy, helping them discover and design business value in blockchain networks — starting, accelerating and innovating strategies that replace longstanding business friction with trust and transparency. Delegating trust to a blockchain means that businesses can pursue broader networks, onboard new partners, and enter new ecosystems with ease. Blockchain-based networks that support multiparty collaboration around shared, trusted data and process automation across organisational boundaries bring benefits at many levels, starting with efficiency gains and culminating in reinventing how entire industry ecosystems operate.
Insolar is a global team of 60+ people in North America and Europe, including a 35-strong engineering team with practical blockchain engineering know-how, and 10 leading blockchain academics from major institutions (York University, ETH Zurich, Princeton).
Components
Network
Blockchain network layer.
- Support of heterogeneous network topology.
- Network routing with a host or host group becoming relays for others hosts.
- Ability to limit number of gateways to corporate host group via relays to keep the host group secure.
Ledger
Record storage engine backed by BadgerDB.
Virtual machines
Various engines for smart contract execution:
- wasm - WebAssembly implementation of smart contracts.
Application layer
Application module describes interaction of system components with each other.
Every component of the system is a SmartContract. Members of the system are given the opportunity to build their own dApps by publishing smart contracts in Domain instances.
Domains define the visibility scope for the child contracts and their interaction policies. Actually, Domain is subclass of SmartContract.
See package readme for more details.
Configuration
Provides configuration parameters for all Insolar components and a helper for configuration resources management.
Metrics
Using Prometheus monitoring system and time series database for collecting and store metrics.
Installation
Download the Insolar package:
go get github.com/insolar/insolar
Go to the package directory:
cd $GOPATH/src/github.com/insolar/insolar
Install dependencies and build binaries:
make
Example
Run launcher:
scripts/insolard/launchnet.sh -g
It will generate bootstrap data and launch a number of nodes. Default number is 5, you can uncomment more nodes in scripts/insolard/bootstrap_template.yaml.
After node processes are started you will see messages like “NODE 3 STARTED in background” in log and a PulseWatcher will be started.
When you see Ready in Insolar State you can run test scripts and benchmarks:
bin/apirequester -k=.artifacts/launchnet/configs/ -u=http://127.0.0.1:19101/api
This tool runs a scenario: creates a number of users with wallets and transfers some money between them. For the first time, the script does it sequentially, upon subsequent runs — concurrently.
Options:
-k: Path to root user keypair. All requests to create a new user must be signed by the root user.-u: Node API URL. By default, the first node listens on the127.0.0.1:19101port. It can be changed in configuration.
Run benchmark:
bin/benchmark -c=4 -r=25 -k=.artifacts/launchnet/configs/
Options:
-k: Same as above, path to root user keypair.-c: Number of concurrent threads in which requests will be sent.-r: Number of transfer requests that will be sent in each thread.
After testing, you can stop all nodes by pressing Ctrl+C.
See apirequester and benchmark readmes for more details.
Contributing
License
This project is licensed under the terms of the Apache license 2.0, except for the Network subdirectory, which is licensed under the terms of the Modified BSD 3-Clause Clear License.
Documentation
¶
Overview ¶
Package insolar is the next generation high-performance scalable blockchain platform designed with the express purpose to meet an immense business scope. The enterprise-grade distributed ledger cloud platform will help to increase business velocity, create new revenue streams, and reduce cost and risk by securely extending enterprise SaaS and on-premises applications to drive tamper-resistant transactions on a trusted business network.
Insolar supports public and private blockchains and is able to customize different blockchains for different applications.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
application
|
|
|
cmd
|
|
|
Package configuration holds configuration for all components in Insolar host binary It allows also helps to manage config resources using Holder
|
Package configuration holds configuration for all components in Insolar host binary It allows also helps to manage config resources using Holder |
|
docker
|
|
|
Package insolar contains common definitions used by other modules.
|
Package insolar contains common definitions used by other modules. |
|
backoff
Package backoff provides an exponential-backoff implementation.
|
Package backoff provides an exponential-backoff implementation. |
|
delegationtoken
Package delegationtoken is about an authorization token that allows a node to perform actions it can not normally perform during this pulse
|
Package delegationtoken is about an authorization token that allows a node to perform actions it can not normally perform during this pulse |
|
gen
Package gen contains functions for generating random base insolar types.
|
Package gen contains functions for generating random base insolar types. |
|
jet
Package jet provides objects and interfaces for working with Jet objects.
|
Package jet provides objects and interfaces for working with Jet objects. |
|
jetcoordinator
Package jetcoordinator is responsible for all jet manipulations.
|
Package jetcoordinator is responsible for all jet manipulations. |
|
message
Package message represents message that messagebus can route
|
Package message represents message that messagebus can route |
|
node
Package node contains node storage
|
Package node contains node storage |
|
pulse
Package Pulse contains Pulse storage.
|
Package Pulse contains Pulse storage. |
|
reply
Package reply represents responses to messages of the messagebus
|
Package reply represents responses to messages of the messagebus |
|
store
Package db contains primitives for storing and indexing data.
|
Package db contains primitives for storing and indexing data. |
|
instrumentation
|
|
|
inslogger
Package inslogger contains context helpers for log
|
Package inslogger contains context helpers for log |
|
insmetrics
Package insmetrics provides helpers for opencesus metrics.
|
Package insmetrics provides helpers for opencesus metrics. |
|
instracer
Package instracer contains helpers for opencesus tracer.
|
Package instracer contains helpers for opencesus tracer. |
|
introspector
introspector provides grpc/rest introspection API endpoint on shared tcp port.
|
introspector provides grpc/rest introspection API endpoint on shared tcp port. |
|
introspector/introproto
Package introproto is a reverse proxy.
|
Package introproto is a reverse proxy. |
|
pprof
Package pprof provides http pprof handlers
|
Package pprof provides http pprof handlers |
|
ledger
|
|
|
artifact
artifact contains tools for managing ledger artifacts without network, that required by genesis and other bootstrap stuff
|
artifact contains tools for managing ledger artifacts without network, that required by genesis and other bootstrap stuff |
|
heavy/pulsemanager
Package pulsemanager is responsible for all pulse operations.
|
Package pulsemanager is responsible for all pulse operations. |
|
light/executor
executor contains internal business logic object for light executor.
|
executor contains internal business logic object for light executor. |
|
object
Package object contains code and types for storage records manipulation.
|
Package object contains code and types for storage records manipulation. |
|
Package log contains adapter for third-party loggers
|
Package log contains adapter for third-party loggers |
|
Package logicrunner - infrastructure for executing smartcontracts
|
Package logicrunner - infrastructure for executing smartcontracts |
|
builtin
Package builtin is implementation of builtin contracts engine
|
Package builtin is implementation of builtin contracts engine |
|
builtin/foundation
Package foundation server implementation of smartcontract functions
|
Package foundation server implementation of smartcontract functions |
|
goplugin
Package goplugin - golang plugin in docker runner
|
Package goplugin - golang plugin in docker runner |
|
pulsemanager
Package pulsemanager is responsible for all pulse operations.
|
Package pulsemanager is responsible for all pulse operations. |
|
Package messagebus routes messages (contract calls & responses) and delivers'em to relevant modules.
|
Package messagebus routes messages (contract calls & responses) and delivers'em to relevant modules. |
|
Package metrics is a gateway for Prometheus monitoring system, it based on Prometheus golang client.
|
Package metrics is a gateway for Prometheus monitoring system, it based on Prometheus golang client. |
|
utils
|
|
|
Package version provides project version information.
|
Package version provides project version information. |