The Pact Smart Contract Language
Clone or download
bts Merge pull request #353 from kadena-io/timeout
Use a timeout of one second for all z3 queries.
Latest commit 3ac9a6d Jan 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Merge pull request #337 from kadena-io/feat/56-namespaces Jan 5, 2019
examples Fix up repl tests to make sure `use` takes atoms instead of strings Dec 28, 2018
executables Close to working with slimmed down set of changes May 7, 2018
log added pact serve to command line Feb 9, 2017
pact-lang-api.js Privacy API first version done! May 3, 2017
src-ghc/Pact Merge pull request #337 from kadena-io/feat/56-namespaces Jan 5, 2019
src Use a timeout of one second for all z3 queries. Jan 10, 2019
tests Merge pull request #337 from kadena-io/feat/56-namespaces Jan 5, 2019
web Dep versions widened for both GHCJS and normal build; test passing Nov 5, 2017
.gitignore Nix gitignore (#352) Jan 9, 2019
.gitlab-ci.yml Oops, need dot slash Dec 14, 2018
.travis.yml .travis.yml: set cache.timeout to 900 Nov 14, 2018
.weeder.yaml Some cleanup from Weeder run and weeder config file Mar 14, 2018
CHANGELOG.md 2.6.1 ready Nov 21, 2018
HLint.hs Addressed some HLint warnings/err. Duplicates in hspec TBD. Jul 13, 2018
LICENSE simple command construction finished Feb 9, 2017
README.md Add shell.nix to make plain nix-shell do the right thing Dec 18, 2018
Setup.hs Pact open-source release Nov 13, 2016
appveyor.yml Add appveyor config. Feb 21, 2018
collectArtifacts.sh Add mac binary to artifacts Dec 14, 2018
config.yaml No caching in SQLite layer, txid in beginTx, tx validation Feb 13, 2017
default.nix Nix gitignore (#352) Jan 9, 2019
pact.cabal Support list typechecking Dec 9, 2018
repl.sh Pact open-source release Nov 13, 2016
shell.nix Add shell.nix to make plain nix-shell do the right thing Dec 18, 2018
stack-ghcjs.yaml Upgrade thyme for #6, document formats, 2.3.6 release prep Dec 13, 2017
stack-nix.yaml Update to latest reflex-platform with GHC 8.4 Nov 6, 2018
stack.yaml Updated aeson version to 1.4.2 Nov 26, 2018

README.md

The Pact Programming Language

Build Status

This is the source code repository for Pact, a language for developing smart contracts to run on a fast deterministic blockchain.

References

Pact Homepage

Pact Reference Docs

Pact Whitepaper

Quick Start: Browser

The easiest way to try Pact is in the browser.

Quick Start: Atom

To start writing smart contracts, the best way to go is to use the Atom editor and install language-pact using the package manager.

Installing Pact with Homebrew (OSX only)

You'll then need to install the Pact interpreter/REPL. On Mac, the easiest way to install pact is with Homebrew.

Make sure that Homebrew has been installed in your machine. Instructions for how to install it can be found here.

Once Homebrew is installed, run the following command to install pact:

brew install kadena-io/pact/pact

Installing Pact with Binary Distributions

Pact can also be installed by following the instructions below:

  • Install z3
  • Download the prebuilt binaries for your distribution. Or see Building for instructions on how to build Pact from the source code.
  • Once you've downloaded the binary, make sure that it is marked as executable by running chmod +x <executable-file>.
  • Put the binary somewhere in your PATH.

For installing pact on Linux distributions in the Arch family, refer to this package on the AUR.

Verifying Install

Test by issuing pact in a terminal. Try out some commands:

$ pact
pact> (+ 1 2)
3
pact> (+ "hello, " "world")
"hello, world"

There are examples in this source repository of working smart contracts which you can load into Atom to get started.

Quick Start: Pact REST API Server

Pact now features a full REST API HTTP server and SQLite database implementation, making blockchain application development painless and easy. The Pact server simulates a single-node blockchain environment, with the same API supported by the Kadena ScalableBFT blockchain.

To start the server, issue pact --serve CONFIG or pact -s CONFIG, where CONFIG is a valid config.yaml.

REST API Docs

The REST API is documented at http://pact-language.readthedocs.io/en/latest/pact-reference.html#rest-api.

Related Projects

Hosting static files.

The HTTP server will host any static files it finds in its working directory.

Config file format

The pact dev server (pact-serve) requires a configuration Yaml file (e.g. server.conf) to operate. The documentation for it is:

➜  pact git:(feat/dev-server) pact --serve --help
Config file is YAML format with the following properties:
port       - HTTP server port
persistDir - Directory for database files.
             If ommitted, runs in-memory only.
logDir     - Directory for HTTP logs
pragmas    - SQLite pragmas to use with persistence DBs
verbose    - [True|False] Provide extra logging information

Replay from disk.

When running pact-serve with persistence enabled, the server automatically replays from the database commands.sqlite in the persist dir. To prevent replay, simply delete this file before starting the server.

Building

Building Pact used to require a working Haskell Stack install . After which, building is as simple as 'stack build'.

To install for use with Atom and the command line, issue 'stack install' and then either add $HOME/.local/bin to your path, or symlink $HOME/.local/bin/pact somewhere in your PATH.

NOTE: We are currently transitioning to Nix build infrastructure. Stack builds still work right now, but you should start transitioning to Nix using the instructions below.

Building with Nix / NixOS

  1. Go to https://nixos.org/nix/, click "Get Nix", follow the instructions to install the Nix package manager.
  2. Edit $NIX_CONF_DIR/nix.conf.
    • Linux default: /etc/nix/nix.conf
  3. Set the substituters and trusted-public-keys lines as follows:
substituters = https://pact.cachix.org https://nixcache.reflex-frp.org https://cache.nixos.org/

trusted-public-keys = pact.cachix.org-1:cg1bsryGrHnQzqEp52NcHq4mBBL+R25XbR2Q/I/vQ8Y= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=

NOTE: In older versions of Nix, instead of substituters and trusted-public-keys, use binary-caches and binary-cache-public-keys respectively.

  1. If running Nix in multi-user mode (i.e. with a daemon), restart the Nix daemon.

On Mac:

sudo launchctl stop org.nixos.nix-daemon
sudo launchctl start org.nixos.nix-daemon

On Linux:

sudo systemctl restart nix-daemon.service
  1. Run nix-build from the project root.

Incremental Builds

Building with nix-build does a full rebuild every time, which is usually not what you want when developing. To do incremental builds, you need to enter a nix shell. To do that use the nix-shell command.

This puts you in a shell that has all the necessary dependencies installed. Once inside this shell you can build as normal with cabal using cabal build or cabal new-build.

You can also build with stack inside this shell as follows:

$ stack --stack-yaml stack-nix.yaml build

Hoogle Documentation

Nix has out-of-the-box Hoogle integration. It allows you to run a local Hoogle server with docs for all of the project dependencies. This is really nice for two reasons:

  1. You know you're getting correct docs for the exact versions of the packages you are depending on.

  2. You don't have to have an internet connection to access them.

To start the hoogle server, run this command from the project root directory.

nix-shell --run 'hoogle server --local'

This runs hoogle locally on port 8080. Running it this way, however, does not include haddocks for the pact (or whatever tho local project is). It only includes docs for the dependencies. To fix this, use the following command instead:

nix-shell -p 'with import ./. {}; ghc.ghcWithHoogle (p: [p.pact])' --run 'hoogle server --local'

To use the above command for other projects that use the .project function replace [p.pact] with a list of all the locally defined projects to include. For example: [p.backend p.common p.frontend] for a project that has those three separate local packages.

License

This code is distributed under the terms of the BSD3 license. See LICENSE for details.