Merge pull request #1 from mlabs-haskell/dshuiski/hydra-sdk

PureScript Hydra SDK

Author: errfrom

.gitignore

@@ -1,4 +1,7 @@
 /node_modules
 /output/
+/result
 /.psa-stash
+/.psci_modules/
 /.spago/
+/.spago2nix/

.purs-repl

@@ -0,0 +1,6 @@
+import Prelude
+import HydraSdk.Extra.AppManager
+import HydraSdk.Lib
+import HydraSdk.NodeApi
+import HydraSdk.Process 
+import HydraSdk.Types

.tidyrc.json

@@ -0,0 +1,10 @@
+{
+  "importSort": "source",
+  "importWrap": "auto",
+  "indent": 2,
+  "operatorsFile": null,
+  "ribbon": 1,
+  "typeArrowPlacement": "first",
+  "unicode": "source",
+  "width": 95
+}

Makefile

@@ -0,0 +1,33 @@
+.PHONY: build, format, repl, docs
+
+ps-sources := $(shell fd --no-ignore-parent -epurs)
+nix-sources := $(shell fd --no-ignore-parent -enix --exclude='spago*')
+purs-args := "--stash --censor-lib --censor-codes=ImplicitImport,ImplicitQualifiedImport,ImplicitQualifiedImportReExport,UserDefinedWarning"
+
+system := $(shell uname -s)
+ifeq (${system},Linux)
+    open-in-browser := xdg-open
+else
+    open-in-browser := open
+endif
+
+requires-nix-shell:
+	@[ "$(IN_NIX_SHELL)" ] || \
+		( echo "The '$(MAKECMDGOALS)' target must be run from inside a nix shell, run 'nix develop' first." \
+				&& false \
+		)
+
+build: requires-nix-shell
+	spago build --purs-args ${purs-args}
+
+format: requires-nix-shell
+	@purs-tidy format-in-place ${ps-sources}
+	@nixpkgs-fmt ${nix-sources}
+	doctoc README.md --github --notitle
+
+repl: requires-nix-shell
+	spago repl
+
+docs:
+	nix build .#docs
+	${open-in-browser} result/generated-docs/html/index.html

README.md

@@ -0,0 +1,55 @@
+# purescript-hydra-sdk
+
+[Cardano Hydra](https://hydra.family/head-protocol/)
+SDK (Software Development Kit) for PureScript. This library offers
+various interfaces to facilitate rapid development of Hydra-based
+applications.
+
+**Table of Contents**
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Applications](#applications)
+- [Functionality](#functionality)
+- [Development Workflows](#development-workflows)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+### Applications
+
+Please refer to [hydra-auction-offchain](https://github.com/mlabs-haskell/hydra-auction-offchain)
+for a full-fledged example that utilizes this SDK.
+
+### Functionality
+
+The `HydraSdk.Process` module provides an interface for spinning up a hydra-node
+as a Node.js subprocess.
+
+The `HydraSdk.NodeApi` module exports functions for connecting to the Hydra Node
+WebSocket API and sending HTTP requests. The primary function provided by this
+module is `mkHydraNodeApiWebSocket`, which establishes a WebSocket connection to
+the hydra-node, attaches specified handlers for incoming messages, and returns a
+`HydraNodeApiWebSocket` record with type-safe actions for interacting with the
+Hydra Node API. It also allows to specify retry strategies for Hydra
+transactions that may be silently dropped by cardano-node, particularly for
+Close and Contest transactions.
+
+The `HydraSdk.Types` module re-exports various Hydra domain-specific types
+(such as `HydraHeadStatus` and `HydraNodeApi_InMessage`), along with other
+utility types (e.g., `HostPort` and `Network`) used by the components of this
+library.
+
+`HydraSdk.Extra.AppManager` provides an opinionated interface for managing
+multiple Hydra application instances, with each instance running a separate
+hydra-node process, as implemented in [hydra-auction-offchain](https://github.com/mlabs-haskell/hydra-auction-offchain).
+For more information, refer to the [AppManager README](src/Extra/README.md).
+
+### Development Workflows
+
+Before executing most of the commands listed below, first enter the Nix
+development shell by running `nix develop`.
+
+**Build the project** (requires Nix shell): `make build`  
+**Format code** (requires Nix shell): `make format`  
+**Build docs and open them in the browser**: `make docs`