Shadowgraph
TrendingAbout
Sign in

The-Blockchain-Company/zerepoch

Parrot

0

40 commits

updated Feb 10, 2023

See the code

README

Table of Contents

The Zerepoch Platform is an application development platform for developing distributed applications using the Bcc blockchain; and Simeon is a platform specifically for financial products, built on top of Zerepoch. For more information about the projects, see the [user-documentation].

This repository contains:

  • Zerepoch Platform

    • The implementation, specification, and mechanized metatheory of Zerepoch Core, the scripting language embedded in the Bcc ledger.

    • Zerepoch Tx, the compiler from Haskell to Zerepoch Core.

    • Libraries which implement the Zerepoch Application Framework, a framework for writing applications that work with Bcc.

    • A selection of end-to-end usecases written with the Zerepoch Application Framework

    • The Zerepoch Playground, a web-based playground for learning and writing basic Zerepoch Applications.

  • Simeon

    • The implementation of the Simeon domain-specific language.

    • Tools for working with Simeon, including static analysis.

    • A selection of examples using Simeon, including a number based on the ACTUS financial standard.

    • The Simeon Playground, a web-based playground for learning and writing Simeon Applications.

Important

The rest of this README is focussed on people who want to develop or contribute to the Platform.

For people who want to use the Platform, please consult the [user-documentation].

Important

DO NOT IGNORE THIS

If you want to use Nix with this project, make sure to set up the The Blockchain Co. binary cache. If you do not do this, you will end up building GHC, which takes several hours. If you find yourself building GHC, STOP and fix the cache.

Documentation

User documentation

The main documentation is located here.

Talks

Specifications and design

Academic papers

Working with the project

How to submit an issue

Issues can be filed in the GitHub Issue tracker.

However, note that this is pre-release software, so we will not usually be providing support.

How to develop and contribute to the project

See CONTRIBUTING, which describes our processes in more detail including development environments; and ARCHITECTURE, which describes the structure of the repository.

How to depend on the project from another Haskell project

None of our libraries are on Hackage, unfortunately (many of our dependencies aren’t either). So for the time being, you need to:

  1. Add zerepoch as a source-repository-package to your cabal.project.

  2. Copy the source-repository-package stanzas from our cabal.project to yours.

  3. Copy additional stanzas from our cabal.project as you need, e.g. you may need some of the allow-newer stanzas.

The zerepoch-starter project provides an example.

How to build the project’s artifacts

This section contains information about how to build the project’s artifacts for independent usage. For development work see How to develop and contribute to the project for more information.

Prerequisites

The Haskell libraries in the Zerepoch Platform are built with cabal and Nix. The other artifacts (docs etc.) are also most easily built with Nix.

Nix

Install Nix (recommended). following the instructions on the Nix website.

Make sure you have read and understood the cache warning. DO NOT IGNORE THIS.

See Nix for further advice on using Nix.

Non-Nix

You can build some of the Haskell packages without Nix, but this is not recommended and we don’t guarantee that these prerequisites are sufficient. If you use Nix, these tools are provided for you via shell.nix, and you do not need to install them yourself.

  • If you want to build our Haskell packages with cabal, then install it.

  • If you want to build our Haskell packages with stack, then install it.

  • If you want to build our Agda code, then install Agda and the standard library.

How to build the Haskell packages and other artifacts with Nix

Run nix build -f default.nix zerepoch.haskell.packages.zerepoch-core.components.library from the root to build the Zerepoch Core library.

See Which attributes to use to build different artifacts to find out what other attributes you can build.

How to build the Haskell packages with cabal

The Haskell packages can be built directly with cabal. We do this during development (see How to develop and contribute to the project). The best way is to do this is inside a nix-shell.

Note

For fresh development setups, you also need to run cabal update.

Run cabal build zerepoch-core from the root to build the Zerepoch Core library.

See the cabal project file to see the other packages that you can build with cabal.

Nix

How to set up the The Blockchain Co. binary caches

Adding the The Blockchain Co. binary cache to your Nix configuration will speed up builds a lot, since many things will have been built already by our CI.

If you find you are building packages that are not defined in this repository, or if the build seems to take a very long time then you may not have this set up properly.

To set up the cache:

  1. On non-NixOS, edit /etc/nix/nix.conf and add the following lines:

    substituters        = https://hydra.blockchain-company.io https://tbco.cachix.org https://cache.nixos.org/
trusted-public-keys = hydra.blockchain-company.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= tbco.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
    Note

    If you don’t have an /etc/nix/nix.conf or don’t want to edit it, you may add the nix.conf lines to ~/.config/nix/nix.conf instead. You must be a trusted user to do this.

  2. On NixOS, set the following NixOS options:

    nix = {
  binaryCaches          = [ "https://hydra.blockchain-company.io" "https://tbco.cachix.org" ];
  binaryCachePublicKeys = [ "hydra.blockchain-company.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ=" "tbco.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo=" ];
};

Nix on macOS

Nix on macOS can be a bit tricky. In particular, sandboxing is disabled by default, which can lead to strange failures.

These days it should be safe to turn on sandboxing on macOS with a few exceptions. Consider setting the following Nix settings, in the same way as in previous section:

sandbox = true
extra-sandbox-paths = /System/Library/Frameworks /System/Library/PrivateFrameworks /usr/lib /private/tmp /private/var/tmp /usr/bin/env

Which attributes to use to build different artifacts

default.nix defines a package set with attributes for all the artifacts you can build from this repository. These can be built using nix build. For example:

nix build -f default.nix docs.papers.eutxo
Example attributes

  • Project packages: defined inside zerepoch.haskell.packages

    • e.g. zerepoch.haskell.packages.zerepoch-core.components.library

  • Documents: defined inside docs

    • e.g. docs.zerepoch-core-spec

There are other attributes defined in default.nix.

Licensing

You are free to copy, modify, and distribute the Zerepoch Platform with under the terms of the Apache 2.0 license. See the LICENSE and NOTICE files for details.

blockcha
cardano-modified
plutus-modified
smart-contracts

Contributors

rmourey26

40 commits

Similar repos

CharlesMorgan007/quickcheck

0

input-output-hk/ghc-plinth-plutus-old

Plutus fork for ghc-plinth project

0

IntersectMBO/plutus-apps

The Plutus application platform

296

BlockstreamResearch/simplicity

Simplicity is a blockchain programming language designed as an alternative to Bitcoin script.

364

mlabs-haskell/awesome-plutus

75

marlowe-lang/marlowe-cardano

Marlowe smart contract language Cardano implementation

100

marlowe-lang/marlowe

Prototype implementation of domain-specific language for the design of smart-contracts over…

175

input-output-hk/cardano-ledger

The ledger implementation and specifications of the Cardano blockchain.

295

Languages

Parrot

26.0%

HTML

22.3%

Haskell

21.9%

Nix

11.2%

PureScript

8.0%

TeX

5.9%

Agda

2.7%

The-Blockchain-Company/zerepoch

Parrot

0

40 commits

updated Feb 10, 2023

See the code

README

Table of Contents

The Zerepoch Platform is an application development platform for developing distributed applications using the Bcc blockchain; and Simeon is a platform specifically for financial products, built on top of Zerepoch. For more information about the projects, see the [user-documentation].

This repository contains:

  • Zerepoch Platform

    • The implementation, specification, and mechanized metatheory of Zerepoch Core, the scripting language embedded in the Bcc ledger.

    • Zerepoch Tx, the compiler from Haskell to Zerepoch Core.

    • Libraries which implement the Zerepoch Application Framework, a framework for writing applications that work with Bcc.

    • A selection of end-to-end usecases written with the Zerepoch Application Framework

    • The Zerepoch Playground, a web-based playground for learning and writing basic Zerepoch Applications.

  • Simeon

    • The implementation of the Simeon domain-specific language.

    • Tools for working with Simeon, including static analysis.

    • A selection of examples using Simeon, including a number based on the ACTUS financial standard.

    • The Simeon Playground, a web-based playground for learning and writing Simeon Applications.

Important

The rest of this README is focussed on people who want to develop or contribute to the Platform.

For people who want to use the Platform, please consult the [user-documentation].

Important

DO NOT IGNORE THIS

If you want to use Nix with this project, make sure to set up the The Blockchain Co. binary cache. If you do not do this, you will end up building GHC, which takes several hours. If you find yourself building GHC, STOP and fix the cache.

Documentation

User documentation

The main documentation is located here.

Talks

Specifications and design

Academic papers

Working with the project

How to submit an issue

Issues can be filed in the GitHub Issue tracker.

However, note that this is pre-release software, so we will not usually be providing support.

How to develop and contribute to the project

See CONTRIBUTING, which describes our processes in more detail including development environments; and ARCHITECTURE, which describes the structure of the repository.

How to depend on the project from another Haskell project

None of our libraries are on Hackage, unfortunately (many of our dependencies aren’t either). So for the time being, you need to:

  1. Add zerepoch as a source-repository-package to your cabal.project.

  2. Copy the source-repository-package stanzas from our cabal.project to yours.

  3. Copy additional stanzas from our cabal.project as you need, e.g. you may need some of the allow-newer stanzas.

The zerepoch-starter project provides an example.

How to build the project’s artifacts

This section contains information about how to build the project’s artifacts for independent usage. For development work see How to develop and contribute to the project for more information.

Prerequisites

The Haskell libraries in the Zerepoch Platform are built with cabal and Nix. The other artifacts (docs etc.) are also most easily built with Nix.

Nix

Install Nix (recommended). following the instructions on the Nix website.

Make sure you have read and understood the cache warning. DO NOT IGNORE THIS.

See Nix for further advice on using Nix.

Non-Nix

You can build some of the Haskell packages without Nix, but this is not recommended and we don’t guarantee that these prerequisites are sufficient. If you use Nix, these tools are provided for you via shell.nix, and you do not need to install them yourself.

  • If you want to build our Haskell packages with cabal, then install it.

  • If you want to build our Haskell packages with stack, then install it.

  • If you want to build our Agda code, then install Agda and the standard library.

How to build the Haskell packages and other artifacts with Nix

Run nix build -f default.nix zerepoch.haskell.packages.zerepoch-core.components.library from the root to build the Zerepoch Core library.

See Which attributes to use to build different artifacts to find out what other attributes you can build.

How to build the Haskell packages with cabal

The Haskell packages can be built directly with cabal. We do this during development (see How to develop and contribute to the project). The best way is to do this is inside a nix-shell.

Note

For fresh development setups, you also need to run cabal update.

Run cabal build zerepoch-core from the root to build the Zerepoch Core library.

See the cabal project file to see the other packages that you can build with cabal.

Nix

How to set up the The Blockchain Co. binary caches

Adding the The Blockchain Co. binary cache to your Nix configuration will speed up builds a lot, since many things will have been built already by our CI.

If you find you are building packages that are not defined in this repository, or if the build seems to take a very long time then you may not have this set up properly.

To set up the cache:

  1. On non-NixOS, edit /etc/nix/nix.conf and add the following lines:

    substituters        = https://hydra.blockchain-company.io https://tbco.cachix.org https://cache.nixos.org/
trusted-public-keys = hydra.blockchain-company.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= tbco.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
    Note

    If you don’t have an /etc/nix/nix.conf or don’t want to edit it, you may add the nix.conf lines to ~/.config/nix/nix.conf instead. You must be a trusted user to do this.

  2. On NixOS, set the following NixOS options:

    nix = {
  binaryCaches          = [ "https://hydra.blockchain-company.io" "https://tbco.cachix.org" ];
  binaryCachePublicKeys = [ "hydra.blockchain-company.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ=" "tbco.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo=" ];
};

Nix on macOS

Nix on macOS can be a bit tricky. In particular, sandboxing is disabled by default, which can lead to strange failures.

These days it should be safe to turn on sandboxing on macOS with a few exceptions. Consider setting the following Nix settings, in the same way as in previous section:

sandbox = true
extra-sandbox-paths = /System/Library/Frameworks /System/Library/PrivateFrameworks /usr/lib /private/tmp /private/var/tmp /usr/bin/env

Which attributes to use to build different artifacts

default.nix defines a package set with attributes for all the artifacts you can build from this repository. These can be built using nix build. For example:

nix build -f default.nix docs.papers.eutxo
Example attributes

  • Project packages: defined inside zerepoch.haskell.packages

    • e.g. zerepoch.haskell.packages.zerepoch-core.components.library

  • Documents: defined inside docs

    • e.g. docs.zerepoch-core-spec

There are other attributes defined in default.nix.

Licensing

You are free to copy, modify, and distribute the Zerepoch Platform with under the terms of the Apache 2.0 license. See the LICENSE and NOTICE files for details.

blockcha
cardano-modified
plutus-modified
smart-contracts

Similar repos

CharlesMorgan007/quickcheck

0

input-output-hk/ghc-plinth-plutus-old

Plutus fork for ghc-plinth project

0

IntersectMBO/plutus-apps

The Plutus application platform

296

BlockstreamResearch/simplicity

Simplicity is a blockchain programming language designed as an alternative to Bitcoin script.

364

mlabs-haskell/awesome-plutus

75

marlowe-lang/marlowe-cardano

Marlowe smart contract language Cardano implementation

100

marlowe-lang/marlowe

Prototype implementation of domain-specific language for the design of smart-contracts over…

175

input-output-hk/cardano-ledger

The ledger implementation and specifications of the Cardano blockchain.

295

Contributors

rmourey26

40 commits

Languages

Parrot

26.0%

HTML

22.3%

Haskell

21.9%

Nix

11.2%

PureScript

8.0%

TeX

5.9%

Agda

2.7%