Merge pull request #100 from tqtezos/gromak/1.2.0

[Chore] 1.2.0 release
tqtezos · Aug 27, 2020 · 7a64ec9 · 7a64ec9
2 parents ff1aa17 + b72df1e
commit 7a64ec9
Show file tree

Hide file tree

Showing 55 changed files with 80 additions and 68 deletions.
diff --git a/.buildkite/check-trailing-whitespace.sh b/.buildkite/check-trailing-whitespace.sh
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 #!/usr/bin/env bash
 files=$(git ls-files -- . | xargs grep --files-with-matches --binary-files=without-match '[[:blank:]]$')

diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 env:

diff --git a/.editorconfig b/.editorconfig
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 # top-most EditorConfig file

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 .DS_Store
 .stack-work/

diff --git a/.reuse/dep5 b/.reuse/dep5
@@ -1,7 +1,7 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 
 Files: .github/* nix/sources.json
-Copyright: 2020 tqtezos
+Copyright: 2020 TQ Tezos
 License: MIT
 
 Files: nix/sources.nix

diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,11 +1,19 @@
 <!--
-SPDX-FileCopyrightText: 2020 tqtezos
+SPDX-FileCopyrightText: 2020 TQ Tezos
 SPDX-License-Identifier: MIT
 -->
 # Changelog for stablecoin
 
-## Unreleased
+## 1.2.0
 
+Operations on the contract got cheaper in this release:
+
+* [#96](https://github.com/tqtezos/stablecoin/pull/96)
+  Metadata was moved into a separate contract.
+* [#95](https://github.com/tqtezos/stablecoin/pull/95)
+  Maximal number of minters is limited, they are stored in strict `map`.
+* [#89](https://github.com/tqtezos/stablecoin/pull/89)
+  Prune 0 balance accounts from the storage.
 * [#85](https://github.com/tqtezos/stablecoin/pull/92)
   Removed `permissions_descriptor` entrypoint.
   Removed 'total_supply' from storage.

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 tqtezos
+Copyright (c) 2020 TQ Tezos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 tqtezos
+Copyright (c) 2020 TQ Tezos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 .PHONY: all build-ligo build-haskell optimize-ligo test test-dumb-term test-hide-successes nettest clean

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2020 tqtezos
+SPDX-FileCopyrightText: 2020 TQ Tezos
 SPDX-License-Identifier: MIT
 -->
 
@@ -13,21 +13,22 @@ The contract is implemented in the [LIGO language](https://ligolang.org/).
 See the [`ligo/`](ligo/) folder.
 Contract specification is [available](/docs/specification.md).
 
+## Stablecoin client
+
+We have a `stablecoin-client` executable that allows deploying and interacting with the stablecoin contract.
+You can download it as a static Linux binary from GitHub [releases](https://github.com/tqtezos/stablecoin/releases).
+Please refer to the [`haskell/`](/haskell/) directory for details.
+
 ## Haskell bindings
 
 Apart from LIGO implementation of the contract we have [a Haskell library](haskell/) with data types corresponding to this contract.
 It is based on the [morley framework](https://gitlab.com/morley-framework/morley).
 It allows us to use features of `morley` (such as testing engine) with this contract.
 
-## Stablecoin client
-
-We have a `stablecoin-client` executable that allows deploying and interacting with the stablecoin contract.
-Please refer to the [`haskell/`] directory for details.
-
 ## Tests
 
 Tests are implemented in the same Haskell package.
-Please refer to the [`haskell/`] directory for details.
+Please refer to the [`haskell/`](/haskell/) directory for details.
 
 ## Issue Tracker
 

diff --git a/default.nix b/default.nix
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 { sources ? import ./nix/sources.nix

diff --git a/docs/code-style.md b/docs/code-style.md
@@ -1,5 +1,5 @@
 <!--
- - SPDX-FileCopyrightText: 2020 tqtezos
+ - SPDX-FileCopyrightText: 2020 TQ Tezos
  -
  - SPDX-License-Identifier: MIT
  -->

diff --git a/docs/specification.md b/docs/specification.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2020 tqtezos
+SPDX-FileCopyrightText: 2020 TQ Tezos
 SPDX-License-Identifier: MIT
 -->
 

diff --git a/haskell/.weeder.yaml b/haskell/.weeder.yaml
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 - package:
   - name: stablecoin

diff --git a/haskell/ChangeLog.md b/haskell/ChangeLog.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2020 tqtezos
+SPDX-FileCopyrightText: 2020 TQ Tezos
 SPDX-License-Identifier: MIT
 -->
 # Changelog for Stablecoin Haskell

diff --git a/haskell/LICENSE b/haskell/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 tqtezos
+Copyright (c) 2020 TQ Tezos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/haskell/Makefile b/haskell/Makefile
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 .PHONY: build test test-dumb-term test-hide-successes nettest haddock haddock-no-deps stylish lint clean all

diff --git a/haskell/README.md b/haskell/README.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2020 tqtezos
+SPDX-FileCopyrightText: 2020 TQ Tezos
 SPDX-License-Identifier: MIT
 -->
 
@@ -10,12 +10,15 @@ This folder contains:
 1. a Haskell library to interact with the stablecoin contract (basically Haskell bindings) and tests for it.
 2. a `stablecoin-client` executable to deploy and interact with the stablecoin contract.
 
-## Build Instructions
+## Install Instructions
+
+You can download static `stablecoin-client` binary for Linux from GitHub [releases](https://github.com/tqtezos/stablecoin/releases).
+Alternatively, you can build this package from sources.
 
 You need [Stack](http://haskellstack.org/) to build this package.
 
 To build the library and the executable:
-1. Copy the stablecoin contract to `test/resources/stablecoin.tz` and then run `stack build`.
+1. Copy or symlink the stablecoin and metadata contracts to `test/resources/` and then run `stack build`.
 2. Or, alternatively, run `make build`.
 
 Run `stack install` to install the `stablecoin-client` globally.
@@ -30,6 +33,6 @@ Otherwise, run `stack run stablecoin-client -- --help`.
 
 ## Tests
 
-Tests require the stablecoin contract to be in `test/resources/stablecoin.tz`.
-After you put it there you can do `stack test` to run tests.
+Tests require the stablecoin and metadata contracts to be in `test/resources/`.
+After you put them there you can do `stack test` to run tests.
 We have a [`Makefile`](Makefile) that automates this process, so you can run `make test`.
diff --git a/haskell/client/Main.hs b/haskell/client/Main.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Main

diff --git a/haskell/hpack/definitions.yaml b/haskell/hpack/definitions.yaml
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 # This file defines sensible defaults but does not actually apply
@@ -9,7 +9,7 @@ _definitions:
     - &meta
         author:              Serokell, TQ Tezos
         maintainer:          Serokell <[email protected]>
-        copyright:           2020 tqtezos
+        copyright:           2020 TQ Tezos
         license:             MIT
         license-file:        LICENSE
         git:                 [email protected]:tqtezos/stablecoin.git

diff --git a/haskell/hpack/module.yaml b/haskell/hpack/module.yaml
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 # Include this file in your module's `package.yaml` to set sensible defaults

diff --git a/haskell/nettest/Main.hs b/haskell/nettest/Main.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 module Main
   ( main

diff --git a/haskell/nettest/Nettest.hs b/haskell/nettest/Nettest.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Nettest

diff --git a/haskell/nettest/StablecoinClientTest.hs b/haskell/nettest/StablecoinClientTest.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 {-# LANGUAGE OverloadedLists #-}

diff --git a/haskell/package.yaml b/haskell/package.yaml
@@ -1,10 +1,10 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 <<: !include "./hpack/module.yaml"
 
 name:                stablecoin
-version:             1.1.0
+version:             1.2.0
 
 extra-source-files:
 - README.md

diff --git a/haskell/src/Indigo/Contracts/Transferlist/External.hs b/haskell/src/Indigo/Contracts/Transferlist/External.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 -- | This a dummy file that resembles lorentz-contract-transferlist parameter needed for origination.

diff --git a/haskell/src/Lorentz/Contracts/Spec/FA2Interface.hs b/haskell/src/Lorentz/Contracts/Spec/FA2Interface.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 {-# OPTIONS_GHC -Wno-orphans #-}

diff --git a/haskell/src/Lorentz/Contracts/Stablecoin.hs b/haskell/src/Lorentz/Contracts/Stablecoin.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Lorentz.Contracts.Stablecoin

diff --git a/haskell/src/Stablecoin/Client.hs b/haskell/src/Stablecoin/Client.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin.Client

diff --git a/haskell/src/Stablecoin/Client/Cleveland.hs b/haskell/src/Stablecoin/Client/Cleveland.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin.Client.Cleveland

diff --git a/haskell/src/Stablecoin/Client/Cleveland/Caps.hs b/haskell/src/Stablecoin/Client/Cleveland/Caps.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 {-# LANGUAGE InstanceSigs #-}

diff --git a/haskell/src/Stablecoin/Client/Cleveland/IO.hs b/haskell/src/Stablecoin/Client/Cleveland/IO.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin.Client.Cleveland.IO

diff --git a/haskell/src/Stablecoin/Client/Cleveland/StablecoinImpl.hs b/haskell/src/Stablecoin/Client/Cleveland/StablecoinImpl.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin.Client.Cleveland.StablecoinImpl

diff --git a/haskell/src/Stablecoin/Client/Contract.hs b/haskell/src/Stablecoin/Client/Contract.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin.Client.Contract

diff --git a/haskell/src/Stablecoin/Client/Impl.hs b/haskell/src/Stablecoin/Client/Impl.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin.Client.Impl

diff --git a/haskell/src/Stablecoin/Client/Main.hs b/haskell/src/Stablecoin/Client/Main.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin.Client.Main

diff --git a/haskell/src/Stablecoin/Client/Parser.hs b/haskell/src/Stablecoin/Client/Parser.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 {-# LANGUAGE ApplicativeDo #-}

diff --git a/haskell/stack.yaml b/haskell/stack.yaml
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 # To update hackage and stackage indexes used by CI run:

diff --git a/haskell/stack.yaml.lock.license b/haskell/stack.yaml.lock.license
@@ -1,2 +1,2 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
diff --git a/haskell/test-common/Lorentz/Contracts/Test/Common.hs b/haskell/test-common/Lorentz/Contracts/Test/Common.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 -- | Test commons for stablecoin test suite

diff --git a/haskell/test/Lorentz/Contracts/Test/FA2.hs b/haskell/test/Lorentz/Contracts/Test/FA2.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 -- | Tests for FA2 interface.

diff --git a/haskell/test/Lorentz/Contracts/Test/Management.hs b/haskell/test/Lorentz/Contracts/Test/Management.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 -- | Tests for management entrypoints of stablecoin smart-contract

diff --git a/haskell/test/Main.hs b/haskell/test/Main.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Main

diff --git a/haskell/test/SMT.hs b/haskell/test/SMT.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 {-# OPTIONS_GHC -Wno-orphans #-}
 {-# OPTIONS_GHC -Wno-deprecations #-}

diff --git a/haskell/test/Stablecoin.hs b/haskell/test/Stablecoin.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 module Stablecoin

diff --git a/haskell/test/Tree.hs b/haskell/test/Tree.hs
@@ -1,4 +1,4 @@
--- SPDX-FileCopyrightText: 2020 tqtezos
+-- SPDX-FileCopyrightText: 2020 TQ Tezos
 -- SPDX-License-Identifier: MIT
 
 {-# OPTIONS_GHC -F -pgmF tasty-discover -optF --tree-display -optF --generated-module -optF Tree #-}
diff --git a/ligo/Makefile b/ligo/Makefile
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2020 tqtezos
+# SPDX-FileCopyrightText: 2020 TQ Tezos
 # SPDX-License-Identifier: MIT
 
 # Ligo executable

diff --git a/ligo/README.md b/ligo/README.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2020 tqtezos
+SPDX-FileCopyrightText: 2020 TQ Tezos
 SPDX-License-Identifier: MIT
 -->
 # stablecoin LIGO implementation

diff --git a/ligo/stablecoin/actions.ligo b/ligo/stablecoin/actions.ligo
@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2020 tqtezos
+// SPDX-FileCopyrightText: 2020 TQ Tezos
 // SPDX-License-Identifier: MIT
 
 (*