Skip to content

Commit b136c15

Browse files
committed
Move cardano-db-tool to different package
1 parent 1cee465 commit b136c15

19 files changed

+335
-93
lines changed

Readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ The cardano-db-sync component consists of a set of components:
2323

2424
* `cardano-db` which defines common data types and functions used by any application that needs
2525
to interact with the data base from Haskell. In particular, it defines the database schema.
26+
* `cardano-db-tool` a tool used to manage the databases of cardano-db-sync (create
27+
and run migrations, validate and analyse)
2628
* `cardano-db-sync` which acts as a Cardano node, following the chain and inserting
2729
data from the chain into a PostgreSQL database.
2830
* `cardano-db-sync-extended` is a relatively simple extension to `cardano-db-sync` which maintains

cabal.project

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ packages:
55
cardano-db/test
66
cardano-db-sync
77
cardano-db-sync-extended
8+
cardano-db-tool
89

910
constraints:
1011
libsystemd-journal >= 1.4.4

cardano-db-tool/LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
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
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

cardano-db/app/cardano-db-tool.hs renamed to cardano-db-tool/app/cardano-db-tool.hs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
21
import Cardano.Db
3-
import Cardano.Db.App
2+
import Cardano.Db.Tool
43

54
import Cardano.Slotting.Slot (SlotNo (..))
65

76
import Control.Applicative (optional)
8-
9-
import Data.Monoid ((<>))
107
import Data.Word (Word64)
118

129
import Options.Applicative (Parser, ParserInfo, ParserPrefs)

cardano-db-tool/cardano-db-tool.cabal

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
cabal-version: >= 1.10
2+
3+
-- http://haskell.org/cabal/users-guide/
4+
5+
name: cardano-db-tool
6+
version: 7.1.0
7+
synopsis: Utilities to manage the cardano-db-sync databases.
8+
description: Utilities and executable, used to manage and validate the
9+
PostgreSQL db and the ledger database of the cardano-db-sync node
10+
homepage: https://github.com/input-output-hk/cardano-db-sync
11+
bug-reports: https://github.com/input-output-hk/cardano-db-sync/issues
12+
license: Apache-2.0
13+
license-file: LICENSE
14+
author: IOHK Engineering Team
15+
maintainer: [email protected]
16+
copyright: (c) 2019 IOHK
17+
category: Cryptocurrency
18+
build-type: Simple
19+
20+
library
21+
default-language: Haskell2010
22+
hs-source-dirs: src
23+
24+
ghc-options: -Wall
25+
-Wcompat
26+
-fwarn-redundant-constraints
27+
-fwarn-incomplete-patterns
28+
-fwarn-unused-imports
29+
-Wincomplete-record-updates
30+
-Wincomplete-uni-patterns
31+
32+
exposed-modules: Cardano.Db.Tool
33+
34+
other-modules: Cardano.Db.Tool.UtxoSet
35+
Cardano.Db.Tool.Validation
36+
Cardano.Db.Tool.Validate.BlockProperties
37+
Cardano.Db.Tool.Validate.BlockTxs
38+
Cardano.Db.Tool.Validate.EpochTable
39+
Cardano.Db.Tool.Validate.PoolOwner
40+
Cardano.Db.Tool.Validate.TotalSupply
41+
Cardano.Db.Tool.Validate.TxAccounting
42+
Cardano.Db.Tool.Validate.Util
43+
44+
build-depends: base >= 4.12 && < 4.15
45+
, bytestring
46+
, ansi-terminal
47+
, cardano-db
48+
, cardano-ledger
49+
, cardano-slotting
50+
, containers
51+
, esqueleto
52+
, extra
53+
, optparse-applicative
54+
, persistent
55+
, random
56+
, text
57+
, time
58+
, transformers
59+
, transformers-except
60+
61+
executable cardano-db-tool
62+
default-language: Haskell2010
63+
main-is: cardano-db-tool.hs
64+
main-is: cardano-db-tool.hs
65+
hs-source-dirs: app
66+
67+
ghc-options: -Wall
68+
-Wcompat
69+
-fwarn-redundant-constraints
70+
-fwarn-incomplete-patterns
71+
-fwarn-unused-imports
72+
-Wincomplete-record-updates
73+
-Wincomplete-uni-patterns
74+
75+
build-depends: base >= 4.12 && < 4.15
76+
, cardano-db
77+
, cardano-db-tool
78+
, cardano-slotting
79+
, optparse-applicative
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module Cardano.Db.Tool
2+
( module X
3+
) where
4+
5+
import Cardano.Db.Tool.UtxoSet as X
6+
import Cardano.Db.Tool.Validation as X

cardano-db/app/Cardano/Db/App/UtxoSet.hs renamed to cardano-db-tool/src/Cardano/Db/Tool/UtxoSet.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{-# LANGUAGE OverloadedStrings #-}
2-
module Cardano.Db.App.UtxoSet
2+
module Cardano.Db.Tool.UtxoSet
33
( utxoSetAtSlot
44
) where
55

cardano-db/app/Cardano/Db/App/Validate/BlockProperties.hs renamed to cardano-db-tool/src/Cardano/Db/Tool/Validate/BlockProperties.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
module Cardano.Db.App.Validate.BlockProperties
1+
module Cardano.Db.Tool.Validate.BlockProperties
22
( validateBlockProperties
33
) where
44

5-
import Cardano.Db.App.Validate.Util
5+
import Cardano.Db.Tool.Validate.Util
66

77
import Cardano.Db hiding (queryBlockTxCount)
88

cardano-db/app/Cardano/Db/App/Validate/BlockTxs.hs renamed to cardano-db-tool/src/Cardano/Db/Tool/Validate/BlockTxs.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
module Cardano.Db.App.Validate.BlockTxs
1+
module Cardano.Db.Tool.Validate.BlockTxs
22
( validateEpochBlockTxs
33
) where
44

5-
import Cardano.Db.App.Validate.Util
5+
import Cardano.Db.Tool.Validate.Util
66

77
import Cardano.Db hiding (queryBlockTxCount)
88

cardano-db/app/Cardano/Db/App/Validate/EpochTable.hs renamed to cardano-db-tool/src/Cardano/Db/Tool/Validate/EpochTable.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{-# LANGUAGE OverloadedStrings #-}
2-
module Cardano.Db.App.Validate.EpochTable
2+
module Cardano.Db.Tool.Validate.EpochTable
33
( validateEpochTable
44
) where
55

6-
import Cardano.Db.App.Validate.Util
6+
import Cardano.Db.Tool.Validate.Util
77

88
import Control.Monad (when)
99

cardano-db/app/Cardano/Db/App/Validate/PoolOwner.hs renamed to cardano-db-tool/src/Cardano/Db/Tool/Validate/PoolOwner.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
module Cardano.Db.App.Validate.PoolOwner
1+
module Cardano.Db.Tool.Validate.PoolOwner
22
( validateAllPoolsHaveOwners
33
) where
44

5-
import Cardano.Db.App.Validate.Util
5+
import Cardano.Db.Tool.Validate.Util
66

77
import Cardano.Db
88

cardano-db/app/Cardano/Db/App/Validate/TotalSupply.hs renamed to cardano-db-tool/src/Cardano/Db/Tool/Validate/TotalSupply.hs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{-# LANGUAGE StrictData #-}
2-
module Cardano.Db.App.Validate.TotalSupply
2+
module Cardano.Db.Tool.Validate.TotalSupply
33
( validateTotalSupplyDecreasing
44
) where
55

6-
import Cardano.Db.App.Validate.Util
6+
import Cardano.Db.Tool.Validate.Util
77

88
import Data.Word (Word64)
99

@@ -47,7 +47,7 @@ genTestParameters :: IO TestParams
4747
genTestParameters = do
4848
mlatest <- runDbNoLogging queryLatestBlockNo
4949
case mlatest of
50-
Nothing -> error "Cardano.Db.App.Validation: Empty database"
50+
Nothing -> error "Cardano.Db.Tool.Validation: Empty database"
5151
Just latest ->
5252
TestParams
5353
<$> randomRIO (1, latest - 1)

0 commit comments

Comments
 (0)