diff --git a/NOTICE b/NOTICE deleted file mode 100644 index f1f56f0..0000000 --- a/NOTICE +++ /dev/null @@ -1,14 +0,0 @@ -Copyright 2023 Input Output Global Ltd. - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - diff --git a/cabal.project b/cabal.project index e6788c6..726226e 100644 --- a/cabal.project +++ b/cabal.project @@ -22,11 +22,12 @@ source-repository-package tag: d55c4efb896273dc39d4bdc4fc83ec361de55f73 --sha256: sha256-LziIjrdjMA8dVPKMwKskLyjlnx5HhpDwTjC9sek5Bfo= subdir: - hydra-prelude hydra-cardano-api + hydra-chain-observer + hydra-cluster + hydra-node hydra-plutus hydra-plutus-extras + hydra-prelude hydra-test-utils hydra-tx - hydra-node - hydra-cluster diff --git a/hydra-explorer/LICENSE b/hydra-explorer/LICENSE new file mode 100644 index 0000000..b6ddde7 --- /dev/null +++ b/hydra-explorer/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2021-2022] [IOG] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/hydra-explorer/hydra-explorer.cabal b/hydra-explorer/hydra-explorer.cabal index ab3fe07..48065d9 100644 --- a/hydra-explorer/hydra-explorer.cabal +++ b/hydra-explorer/hydra-explorer.cabal @@ -7,7 +7,6 @@ copyright: 2023 IOG license: Apache-2.0 license-files: LICENSE - NOTICE source-repository head type: git @@ -47,6 +46,7 @@ library , base , hydra-cardano-api , hydra-chain-observer + , hydra-tx , hydra-node , hydra-prelude , io-classes diff --git a/hydra-explorer/src/Hydra/Explorer.hs b/hydra-explorer/src/Hydra/Explorer.hs index 89843fb..e3a57c5 100644 --- a/hydra-explorer/src/Hydra/Explorer.hs +++ b/hydra-explorer/src/Hydra/Explorer.hs @@ -5,9 +5,9 @@ import Hydra.Prelude import Control.Concurrent.Class.MonadSTM (modifyTVar', newTVarIO, readTVarIO) import Hydra.API.APIServerLog (APIServerLog (..), Method (..), PathInfo (..)) -import Hydra.ChainObserver (ChainObservation) +import Hydra.ChainObserver.NodeClient (ChainObservation) import Hydra.Explorer.ExplorerState (ExplorerState (..), HeadState, TickState, aggregateHeadObservations, initialTickState) -import Hydra.Explorer.Options (Options (..), toArgStartChainFrom) +import Hydra.Explorer.Options (BlockfrostOptions (..), DirectOptions (..), Options (..), toArgProjectPath, toArgStartChainFrom) import Hydra.Logging (Tracer, Verbosity (..), traceWith, withTracer) import Hydra.Options qualified as Options import Network.Wai (Middleware, Request (..)) @@ -84,25 +84,30 @@ run opts = do (getExplorerState, modifyExplorerState) <- createExplorerState let chainObserverArgs = - Options.toArgNodeSocket nodeSocket - <> Options.toArgNetworkId networkId - <> toArgStartChainFrom startChainFrom + case opts of + DirectOpts DirectOptions{networkId, nodeSocket, startChainFrom} -> + ["direct"] + <> Options.toArgNodeSocket nodeSocket + <> Options.toArgNetworkId networkId + <> toArgStartChainFrom startChainFrom + BlockfrostOpts BlockfrostOptions{projectPath, startChainFrom} -> + ["blockfrost"] + <> toArgProjectPath projectPath + <> toArgStartChainFrom startChainFrom race_ ( withArgs chainObserverArgs $ Hydra.ChainObserver.main (observerHandler modifyExplorerState) ) (Warp.runSettings (settings tracer) (httpApp tracer getExplorerState)) where + portToBind = + case opts of + DirectOpts DirectOptions{port} -> port + BlockfrostOpts BlockfrostOptions{port} -> port + settings tracer = Warp.defaultSettings - & Warp.setPort (fromIntegral port) + & Warp.setPort (fromIntegral portToBind) & Warp.setHost "0.0.0.0" - & Warp.setBeforeMainLoop (traceWith tracer $ APIServerStarted port) + & Warp.setBeforeMainLoop (traceWith tracer $ APIServerStarted portToBind) & Warp.setOnException (\_ e -> traceWith tracer $ APIConnectionError{reason = show e}) - - Options - { networkId - , port - , nodeSocket - , startChainFrom - } = opts diff --git a/hydra-explorer/src/Hydra/Explorer/ExplorerState.hs b/hydra-explorer/src/Hydra/Explorer/ExplorerState.hs index 520fad5..e73163b 100644 --- a/hydra-explorer/src/Hydra/Explorer/ExplorerState.hs +++ b/hydra-explorer/src/Hydra/Explorer/ExplorerState.hs @@ -2,19 +2,20 @@ module Hydra.Explorer.ExplorerState where import Hydra.Prelude -import Hydra.HeadId (HeadId (..), HeadSeed) +import Hydra.Tx.HeadId (HeadId (..), HeadSeed) import Data.Aeson (Value (..)) import Hydra.Cardano.Api (BlockNo, ChainPoint (..), TxIn, UTxO) -import Hydra.Chain (HeadParameters (..), OnChainTx (..)) +import Hydra.Chain (OnChainTx (..)) import Hydra.Chain.Direct.Tx ( headSeedToTxIn, ) -import Hydra.ChainObserver (ChainObservation (..)) -import Hydra.ContestationPeriod (ContestationPeriod, toNominalDiffTime) -import Hydra.OnChainId (OnChainId) -import Hydra.Party (Party) -import Hydra.Snapshot (SnapshotNumber (..)) +import Hydra.ChainObserver.NodeClient (ChainObservation (..)) +import Hydra.Tx.ContestationPeriod (ContestationPeriod, toNominalDiffTime) +import Hydra.Tx.HeadParameters (HeadParameters (..)) +import Hydra.Tx.OnChainId (OnChainId) +import Hydra.Tx.Party (Party) +import Hydra.Tx.Snapshot (SnapshotNumber (..)) data HeadMember = HeadMember { party :: Party @@ -225,6 +226,94 @@ aggregateCollectComObservation headId point blockNo currentHeads = , blockNo = blockNo } +aggregateDepositObservation :: HeadId -> ChainPoint -> BlockNo -> [HeadState] -> [HeadState] +aggregateDepositObservation headId point blockNo currentHeads = + case findHeadState headId currentHeads of + Just headState -> + let newHeadState = headState{status = Open} + in replaceHeadState newHeadState currentHeads + Nothing -> currentHeads <> [newUnknownHeadState] + where + newUnknownHeadState = + HeadState + { headId + , seedTxIn = Unknown + , status = Open + , contestationPeriod = Unknown + , members = Unknown + , contestations = Seen 0 + , snapshotNumber = Seen 0 + , contestationDeadline = Unknown + , point = point + , blockNo = blockNo + } + +aggregateRecoverObservation :: HeadId -> ChainPoint -> BlockNo -> [HeadState] -> [HeadState] +aggregateRecoverObservation headId point blockNo currentHeads = + case findHeadState headId currentHeads of + Just headState -> + let newHeadState = headState{status = Open} + in replaceHeadState newHeadState currentHeads + Nothing -> currentHeads <> [newUnknownHeadState] + where + newUnknownHeadState = + HeadState + { headId + , seedTxIn = Unknown + , status = Open + , contestationPeriod = Unknown + , members = Unknown + , contestations = Seen 0 + , snapshotNumber = Seen 0 + , contestationDeadline = Unknown + , point = point + , blockNo = blockNo + } + +aggregateIncrementObservation :: HeadId -> ChainPoint -> BlockNo -> [HeadState] -> [HeadState] +aggregateIncrementObservation headId point blockNo currentHeads = + case findHeadState headId currentHeads of + Just headState -> + let newHeadState = headState{status = Open} + in replaceHeadState newHeadState currentHeads + Nothing -> currentHeads <> [newUnknownHeadState] + where + newUnknownHeadState = + HeadState + { headId + , seedTxIn = Unknown + , status = Open + , contestationPeriod = Unknown + , members = Unknown + , contestations = Seen 0 + , snapshotNumber = Seen 0 + , contestationDeadline = Unknown + , point = point + , blockNo = blockNo + } + +aggregateDecrementObservation :: HeadId -> ChainPoint -> BlockNo -> [HeadState] -> [HeadState] +aggregateDecrementObservation headId point blockNo currentHeads = + case findHeadState headId currentHeads of + Just headState -> + let newHeadState = headState{status = Open} + in replaceHeadState newHeadState currentHeads + Nothing -> currentHeads <> [newUnknownHeadState] + where + newUnknownHeadState = + HeadState + { headId + , seedTxIn = Unknown + , status = Open + , contestationPeriod = Unknown + , members = Unknown + , contestations = Seen 0 + , snapshotNumber = Seen 0 + , contestationDeadline = Unknown + , point = point + , blockNo = blockNo + } + aggregateCloseObservation :: HeadId -> ChainPoint -> BlockNo -> SnapshotNumber -> UTCTime -> [HeadState] -> [HeadState] aggregateCloseObservation headId point blockNo (UnsafeSnapshotNumber sn) contestationDeadline currentHeads = case findHeadState headId currentHeads of @@ -341,6 +430,26 @@ aggregateHeadObservations observations explorerState = { heads = aggregateCollectComObservation headId point blockNo heads , tick = TickState point blockNo } + HeadObservation{point, blockNo, onChainTx = OnDepositTx{headId}} -> + ExplorerState + { heads = aggregateDepositObservation headId point blockNo heads + , tick = TickState point blockNo + } + HeadObservation{point, blockNo, onChainTx = OnRecoverTx{headId}} -> + ExplorerState + { heads = aggregateRecoverObservation headId point blockNo heads + , tick = TickState point blockNo + } + HeadObservation{point, blockNo, onChainTx = OnIncrementTx{headId}} -> + ExplorerState + { heads = aggregateIncrementObservation headId point blockNo heads + , tick = TickState point blockNo + } + HeadObservation{point, blockNo, onChainTx = OnDecrementTx{headId}} -> + ExplorerState + { heads = aggregateDecrementObservation headId point blockNo heads + , tick = TickState point blockNo + } HeadObservation{point, blockNo, onChainTx = OnCloseTx{headId, snapshotNumber, contestationDeadline}} -> ExplorerState { heads = aggregateCloseObservation headId point blockNo snapshotNumber contestationDeadline heads diff --git a/hydra-explorer/src/Hydra/Explorer/Options.hs b/hydra-explorer/src/Hydra/Explorer/Options.hs index aa8c3f0..c59aaa1 100644 --- a/hydra-explorer/src/Hydra/Explorer/Options.hs +++ b/hydra-explorer/src/Hydra/Explorer/Options.hs @@ -3,17 +3,33 @@ module Hydra.Explorer.Options where import Hydra.Prelude import Hydra.Cardano.Api (ChainPoint (..), NetworkId, SlotNo (..), SocketPath, serialiseToRawBytesHexText) -import Hydra.Network (PortNumber) +import Hydra.ChainObserver.Options (projectPathParser) +import Hydra.Network (PortNumber, readPort) import Hydra.Options ( - apiPortParser, networkIdParser, nodeSocketParser, startChainFromParser, ) -import Options.Applicative (Parser, ParserInfo, fullDesc, header, helper, info, progDesc) +import Options.Applicative ( + Parser, + ParserInfo, + command, + fullDesc, + header, + help, + helper, + hsubparser, + info, + long, + maybeReader, + metavar, + option, + progDesc, + showDefault, + value, + ) -type Options :: Type -data Options = Options +data DirectOptions = DirectOptions { networkId :: NetworkId , port :: PortNumber , nodeSocket :: SocketPath @@ -21,18 +37,65 @@ data Options = Options } deriving stock (Show, Eq) -optionsParser :: Parser Options -optionsParser = - Options - <$> networkIdParser - <*> apiPortParser - <*> nodeSocketParser - <*> optional startChainFromParser +data BlockfrostOptions = BlockfrostOptions + { port :: PortNumber + , projectPath :: FilePath + , startChainFrom :: Maybe ChainPoint + } + deriving stock (Show, Eq) + +data Options = DirectOpts DirectOptions | BlockfrostOpts BlockfrostOptions + deriving stock (Show, Eq) + +apiPortParser :: Parser PortNumber +apiPortParser = + option + (maybeReader readPort) + ( long "api-port" + <> value 9090 + <> showDefault + <> metavar "PORT" + <> help "Listen port for incoming client API connections." + ) + +directOptionsParser :: Parser Options +directOptionsParser = + DirectOpts + <$> ( DirectOptions + <$> networkIdParser + <*> apiPortParser + <*> nodeSocketParser + <*> optional startChainFromParser + ) + +blockfrostOptionsParser :: Parser Options +blockfrostOptionsParser = + BlockfrostOpts + <$> ( BlockfrostOptions + <$> apiPortParser + <*> projectPathParser + <*> optional startChainFromParser + ) + +directOptionsInfo :: ParserInfo Options +directOptionsInfo = + info + directOptionsParser + (progDesc "Direct Mode") + +blockfrostOptionsInfo :: ParserInfo Options +blockfrostOptionsInfo = + info + blockfrostOptionsParser + (progDesc "Blockfrost Mode") hydraExplorerOptions :: ParserInfo Options hydraExplorerOptions = info - ( optionsParser + ( hsubparser + ( command "direct" directOptionsInfo + <> command "blockfrost" blockfrostOptionsInfo + ) <**> helper ) ( fullDesc @@ -49,3 +112,6 @@ toArgStartChainFrom = \case in ["--start-chain-from", show slotNo <> "." <> headerHashBase16] Nothing -> [] + +toArgProjectPath :: FilePath -> [String] +toArgProjectPath projectPath = ["--project-path", projectPath]