commit a5ae8ef0aacb56be97c7f311399284267cf1662a Author: mratsim Date: Fri Jul 20 15:46:03 2018 +0200 initial commit diff --git a/.appveyor.yml b/.appveyor.yml new file mode 100644 index 000000000..86374cfb4 --- /dev/null +++ b/.appveyor.yml @@ -0,0 +1,77 @@ +# Appveyor config. + +version: '{build}' + +cache: +- nim-0.18.0_x64.zip +- x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z +- i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z +- packages -> **\packages.config +- '%LocalAppData%\NuGet\Cache -> **\packages.config' + +matrix: + fast_finish: true + +environment: + matrix: + - MINGW_ARCHIVE: x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z + MINGW_DIR: mingw64 + # We need to hardcode a mirror otherwise the download fails + MINGW_URL: https://ayera.dl.sourceforge.net/project/mingw-w64/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/4.9.2/threads-win32/seh/x86_64-4.9.2-release-win32-seh-rt_v4-rev4.7z + # NIM_ARCHIVE: nim-0.18.0_x64.zip + # NIM_DIR: nim-0.18.0 + # NIM_URL: https://nim-lang.org/download/nim-0.18.0_x64.zip + platform: x64 + - MINGW_ARCHIVE: i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z + MINGW_DIR: mingw32 + # We need to hardcode a mirror otherwise the download fails + MINGW_URL: https://netcologne.dl.sourceforge.net/project/mingw-w64/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/4.9.2/threads-win32/dwarf/i686-4.9.2-release-win32-dwarf-rt_v4-rev4.7z + # NIM_ARCHIVE: nim-0.18.0_x64.zip + # NIM_DIR: nim-0.18.0 + # NIM_URL: https://nim-lang.org/download/nim-0.18.0_x32.zip + platform: x86 + +## Use the following to test against stable +# install: +# - MKDIR %CD%\tools_tmp +# - IF not exist "%MINGW_ARCHIVE%" appveyor DownloadFile "%MINGW_URL%" -FileName "%MINGW_ARCHIVE%" +# - 7z x -y "%MINGW_ARCHIVE%" -o"%CD%\tools_tmp"> nul +# - IF not exist "%NIM_ARCHIVE%" appveyor DownloadFile "%NIM_URL%" -FileName "%NIM_ARCHIVE%" +# - 7z x -y "%NIM_ARCHIVE%" -o"%CD%\tools_tmp"> nul +# - SET PATH=%CD%\tools_tmp\%NIM_DIR%\bin;%CD%\tools_tmp\%MINGW_DIR%\bin;%PATH% +# # - ps: nuget install YourDependency -o "${env:APPVEYOR_BUILD_FOLDER}" +# # - ps: cp YourDependency.0.1.2.3/lib/native/bin/x64/libyourdependency.dll yourdependency.dll +# - SET PATH=%PATH%;%CD% + +## Test against devel with Status patches +install: + - setlocal EnableExtensions EnableDelayedExpansion + - IF not exist "%MINGW_ARCHIVE%" appveyor DownloadFile "%MINGW_URL%" -FileName "%MINGW_ARCHIVE%" + - 7z x -y "%MINGW_ARCHIVE%" > nul + - SET PATH=%CD%\%MINGW_DIR%\bin;%CD%\Nim\bin;%PATH% + - git clone https://github.com/nim-lang/Nim.git + - cd %CD%\Nim + - git remote add statusim https://github.com/status-im/Nim.git + - git fetch statusim + - git config --global user.email "you@example.com" + - git config --global user.name "Your Name" + - for /f "tokens=*" %%G IN ('git branch -a --list ^"statusim/status-autopatch-*^"') DO (git merge %%G) + - git clone --depth 1 https://github.com/nim-lang/csources + - cd csources + - IF "%PLATFORM%" == "x64" ( build64.bat ) else ( build.bat ) + - cd .. + - bin\nim c koch + - koch boot -d:release + - koch nimble +build_script: + - cd C:\projects\%APPVEYOR_PROJECT_SLUG% + - nimble install -y + +build_script: + - nimble.exe refresh + +test_script: +# - git submodule update --init --recursive + - nimble.exe test + +deploy: off diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..ef56d2862 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +nimcache/ + +# Executables shall be put in an ignored build/ directory +# Ignore dynamic, static libs and libtool archive files +build/ +*.so +*.dylib +*.a +*.la +*.exe +*.dll diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..b3b98bf1f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,42 @@ +# Travis config for beacon_chain using Status Nim docker. + +matrix: + # allow_failures: + # - os: osx + + include: + - os: linux + sudo: required + services: + - docker + before_install: + - docker pull statusteam/nim-base + script: + - docker run statusteam/nim-base nim --version + - docker run -v "$(pwd):/project" -w /project statusteam/nim-base sh -c "nimble install -dy && nimble test" + + - os: osx + before_install: + - brew update + - brew install rocksdb + # - brew install gcc + + - git clone https://github.com/nim-lang/nim.git + - cd nim + - git remote add statusim https://github.com/status-im/nim.git + - git fetch statusim + - git config --global user.email "you@example.com" + - git config --global user.name "Your Name" + - for b in $(git branch -a --list 'statusim/status-autopatch-*'); do git merge $b; done + - git clone --depth 1 https://github.com/nim-lang/csources.git + - cd csources + - sh build.sh + - cd .. + - export PATH=$PWD/bin:$PATH + - nim c koch + - ./koch boot -d:release + - ./koch nimble + - cd .. + + script: + - nimble install -dy && nimble test diff --git a/LICENSE-APACHEv2 b/LICENSE-APACHEv2 new file mode 100644 index 000000000..81e878725 --- /dev/null +++ b/LICENSE-APACHEv2 @@ -0,0 +1,205 @@ +beacon_chain is licensed under the Apache License version 2 +Copyright (c) 2018 Status Research & Development GmbH +----------------------------------------------------- + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 Status Research & Development GmbH + + 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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 000000000..4b6dda470 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +beacon_chain is licensed under the MIT License +Copyright (c) 2018 Status Research & Development GmbH +----------------------------------------------------- + +The MIT License (MIT) + +Copyright (c) 2018 Status Research & Development GmbH + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 000000000..a17dfb17f --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Ethereum Beacon Chain +[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-beacon-chain/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-beacon-chain) +[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/jarradh/nim-beacon-chain/master.svg?label=Windows "Windows build status (Appveyor)")](https://travis-ci.org/jarradh/nim-beacon-chain) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg) + +An alternative implementation of the Ethereum beacon chain in Nim. + +Please see [Full Casper chain v2.1](https://notes.ethereum.org/SCIg8AH5SA-O4C1G1LYZHQ?view) specs and the Ethereum Foundation [reference implementation](https://github.com/ethereum/beacon_chain). + +You can check where the beacon chain fits in the Ethereum research ecosystem in the [Status Athenaeum](https://github.com/status-im/athenaeum/blob/b465626cc551e361492e56d32517b2cdadd7493f/ethereum_research_records.json#L38). + +## Installation + +You can install the developement version of the library through nimble with the following command +``` +nimble install https://github.com/status-im/nim-beacon-chain@#master +``` + +## License + +Licensed and distributed under either of + * MIT license (license terms in the root directory or at http://opensource.org/licenses/MIT). + * Apache v2 license (license terms in the root directory or at http://www.apache.org/licenses/LICENSE-2.0). +at your option. This file may not be copied, modified, or distributed except according to those terms. + diff --git a/beacon_chain.nimble b/beacon_chain.nimble new file mode 100644 index 000000000..0a3483e6d --- /dev/null +++ b/beacon_chain.nimble @@ -0,0 +1,25 @@ +packageName = "beacon_chain" +version = "0.0.1" +author = "Status Research & Development GmbH" +description = "" +license = "MIT or Apache License 2.0" +srcDir = "src" + +### Dependencies +requires "nim >= 0.18.0" + +### Helper functions +proc test(name: string, defaultLang = "c") = + # TODO, don't forget to change defaultLang to `cpp` if the project requires C++ + if not dirExists "build": + mkDir "build" + if not dirExists "nimcache": + mkDir "nimcache" + --run + --nimcache: "nimcache" + switch("out", ("./build/" & name)) + setCommand defaultLang, "tests/" & name & ".nim" + +### tasks +task test, "Run all tests": + test "all_tests" diff --git a/src/beacon_chain.nim b/src/beacon_chain.nim new file mode 100644 index 000000000..f8829570e --- /dev/null +++ b/src/beacon_chain.nim @@ -0,0 +1,6 @@ +# beacon_chain +# Copyright (c) 2018 Status Research & Development GmbH +# Licensed and distributed under either of +# * MIT license (license terms in the root directory or at http://opensource.org/licenses/MIT). +# * Apache v2 license (license terms in the root directory or at http://www.apache.org/licenses/LICENSE-2.0). +# at your option. This file may not be copied, modified, or distributed except according to those terms. \ No newline at end of file diff --git a/tests/all_tests.nim b/tests/all_tests.nim new file mode 100644 index 000000000..fc2f79e44 --- /dev/null +++ b/tests/all_tests.nim @@ -0,0 +1,16 @@ +# beacon_chain +# Copyright (c) 2018 Status Research & Development GmbH +# Licensed and distributed under either of +# * MIT license (license terms in the root directory or at http://opensource.org/licenses/MIT). +# * Apache v2 license (license terms in the root directory or at http://www.apache.org/licenses/LICENSE-2.0). +# at your option. This file may not be copied, modified, or distributed except according to those terms. + +import unittest, + ../src/beacon_chain + +suite "Your first test suite": + test "Your first test": + block: # independant block of subtest + discard + block: + discard