Skip to content

Commit 85e8e12

Browse files
abaillyabailly
committed
Initial drafting of voting layer
0 parents  commit 85e8e12

15 files changed

Lines changed: 552 additions & 0 deletions

‎.envrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
use nix

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/dist-newstyle/
2+
*~
3+
.direnv/
4+
.cabal.project.local
5+
events.csv
6+
node_modules
7+
/datasets/**/*.html
8+
*.out
9+
*.csv

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Revision history for hydra-sim
2+
3+
## 0.1.0.0 -- YYYY-mm-dd
4+
5+
* First version. Released on an unsuspecting world.

‎LICENSE‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Model and Simulations for Ouroboros Peras
2+
3+
This repository is intended to host more or less formal specifications, experiments, models for the Ouroboros Peras protocol.

‎Setup.hs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import Distribution.Simple
2+
3+
main = defaultMain

‎cabal.project‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
-- Custom repository for cardano haskell packages, see CONTRIBUTING.md
2+
repository cardano-haskell-packages
3+
url: https://input-output-hk.github.io/cardano-haskell-packages
4+
secure: True
5+
root-keys:
6+
3e0cce471cf09815f930210f7827266fd09045445d65923e6d0238a6cd15126f
7+
443abb7fb497a134c343faf52f0b659bd7999bc06b7f63fa76dc99d631f9bea1
8+
a86a1f6ce86c449c46666bda44268677abf29b5b2d2eb5ec7af903ec2f117a82
9+
bcec67e8e99cabfa7764d75ad9b158d72bfacf70ca1d0ec8bc6b4406d1bf8413
10+
c00aae8461a256275598500ea0e187588c35a5d5d7454fb57eac18d9edb86a56
11+
d4a35cd3121aa00d18544bb0ac01c3e1691d618f462c46129271bccf39f7e8ee
12+
13+
-- See CONTRIBUTING.md for information about when and how to update these.
14+
index-state:
15+
, hackage.haskell.org 2023-09-14T06:54:18Z
16+
, cardano-haskell-packages 2023-09-14T16:16:59Z
17+
18+
packages: .
19+
20+
-- Always show detailed output for tests
21+
tests: True
22+
test-show-details: direct

‎fourmolu.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
indentation: 2
2+
comma-style: leading # for lists, tuples etc. - can also be 'trailing'
3+
record-brace-space: false # rec {x = 1} vs. rec{x = 1}
4+
indent-wheres: false # 'false' means save space by only half-indenting the 'where' keyword
5+
diff-friendly-import-export: true # 'false' uses Ormolu-style lists
6+
respectful: true # don't be too opinionated about newlines etc.
7+
haddock-style: single-line # '--' vs. '{-'
8+
newlines-between-decls: 1 # number of newlines between top-level declarations

‎peras.cabal‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
cabal-version: 2.2
2+
name: peras
3+
version: 0.1.0.0
4+
synopsis: Simulations for the Peras Protocol
5+
-- description:
6+
license: Apache-2.0
7+
license-file: LICENSE
8+
author: IOG
9+
maintainer: engineering@iohk.io
10+
copyright: 2023 Input Output (Hong Kong) Ltd.
11+
-- category:
12+
build-type: Simple
13+
extra-source-files: CHANGELOG.md
14+
15+
common project-config
16+
default-language: Haskell2010
17+
default-extensions:
18+
BangPatterns
19+
BinaryLiterals
20+
ConstraintKinds
21+
DataKinds
22+
DefaultSignatures
23+
DeriveDataTypeable
24+
DeriveFoldable
25+
DeriveFunctor
26+
DeriveGeneric
27+
DeriveTraversable
28+
DoAndIfThenElse
29+
EmptyDataDecls
30+
ExistentialQuantification
31+
FlexibleContexts
32+
FlexibleInstances
33+
FunctionalDependencies
34+
GADTs
35+
InstanceSigs
36+
KindSignatures
37+
LambdaCase
38+
MultiParamTypeClasses
39+
MultiWayIf
40+
NamedFieldPuns
41+
NumericUnderscores
42+
OverloadedStrings
43+
PartialTypeSignatures
44+
PatternGuards
45+
RankNTypes
46+
ScopedTypeVariables
47+
StandaloneDeriving
48+
TupleSections
49+
TypeFamilies
50+
TypeSynonymInstances
51+
ViewPatterns
52+
ghc-options:
53+
-Wwarn
54+
-Wall
55+
-Wcompat
56+
-Widentities
57+
-Wincomplete-record-updates
58+
-Wincomplete-uni-patterns
59+
-Wpartial-fields
60+
-Wredundant-constraints
61+
-Wunused-packages
62+
-- TODO: check what deprecated functions should be replaced with
63+
-Wno-deprecations
64+
65+
library
66+
import: project-config
67+
hs-source-dirs: src
68+
exposed-modules:
69+
Peras.Block
70+
Peras.Chain
71+
Peras.Crypto
72+
Peras.Voting
73+
build-depends: ansi-terminal
74+
, base
75+
, bytestring
76+
, containers
77+
, contra-tracer
78+
, generic-lens
79+
, io-classes
80+
, io-sim
81+
, optparse-applicative
82+
, pretty-simple
83+
, quiet
84+
, random
85+
, safe
86+
, si-timers
87+
, text
88+
, time
89+
, transformers
90+
ghc-options:
91+
-haddock
92+
93+
test-suite tests
94+
import: project-config
95+
hs-source-dirs: test
96+
other-modules:
97+
main-is: Main.hs
98+
type: exitcode-stdio-1.0
99+
build-depends:
100+
base
101+
, hspec
102+
, peras -any
103+
, QuickCheck -any
104+
, io-sim -any
105+
, si-timers
106+
build-tool-depends:
107+
hspec-discover:hspec-discover
108+
ghc-options:
109+
-Wall
110+
-Wwarn
111+
-threaded
112+
-rtsopts

‎src/Peras/Block.hs‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{-# LANGUAGE DerivingStrategies #-}
2+
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3+
module Peras.Block where
4+
5+
import Data.Word (Word64)
6+
import Peras.Crypto (Hash, LeadershipProof, Signature, VerificationKey)
7+
import Data.Set (Set)
8+
import Data.ByteString (ByteString)
9+
10+
data Block = Block
11+
{ slotNumber :: Word64
12+
, creatorId :: PartyId
13+
, parentBlock :: Hash
14+
, includedVotes :: Set Hash
15+
, leadershipProof :: LeadershipProof
16+
, payload :: [Tx]
17+
, signature :: Signature
18+
}
19+
deriving stock (Eq, Show)
20+
21+
newtype Tx = Tx { tx :: ByteString }
22+
deriving newtype (Eq, Show)
23+
24+
newtype PartyId = PartyId {vkey :: VerificationKey}
25+
deriving newtype (Eq, Show, Ord)

0 commit comments

Comments
 (0)