Lisk Engine is a consensus engine written in Golang implementing the Lisk v4 protocol.

• Go v1.21 or above

golangci-lint is used for linting. To setup the local environment, refer to Editor Integration in the usage guide.

Execute the folllowing command to view the generated documentation locally:

make godocs

Execute the folllowing command to run Lisk Engine against a known ABI server:

make run.lengine PATH_TO_ABI_SERVER PATH_TO_CONFIG

# Example
# make run.lengine path=~/.lisk/dpos-mainchain/tmp/sockets/abi.ipc config=./cmd/debug/app/config.json

To generate a new codec:

1. Define a new struct with a tag on each property fieldNumber: "n"
2. Add //go:generate go run github.com/LiskHQ/lisk-engine/pkg/codec/gen at the top of the file
3. Call make generate.codec

To run the tests:

• make test - To run all the tests and show a summary
• make test.coverage - To run all the tests and show a detailed coverage report
• make test.coverage.html - To run all the tests and produce a HTML coverage report

https://github.com/LiskHQ/lisk-engine/graphs/contributors

Copyright 2016-2024 Lisk Foundation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.