Change repo license to MIT, rename cardano-browser-tx -> ctl

Author: adamczykm

LICENSE

@@ -1,15 +1,9 @@
-ISC License
+MIT License
 
 Copyright (c) 2022 MLabs Ltd.
 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -26,7 +26,7 @@ run-testnet-ogmios:
 		--node-config "$$CARDANO_NODE_CONFIG"
 
 run-haskell-server:
-	nix run -L .#cardano-browser-tx-server:exe:cardano-browser-tx-server
+	nix run -L .#cardano-trasaction-lib-server:exe:cardano-trasaction-lib-server
 
 run-datum-cache-postgres:
 	docker run -d --rm \

README.md

@@ -1,9 +1,9 @@
-# Cardano Browser Tx
+# Cardano Transaction Lib
 [![Hercules-ci][Herc badge]][Herc link]
 [![Cachix Cache][Cachix badge]][Cachix link]
 
 [Herc badge]: https://img.shields.io/badge/ci--by--hercules-green.svg
-[Herc link]: https://hercules-ci.com/github/Plutonomicon/cardano-browser-tx
+[Herc link]: https://hercules-ci.com/github/Plutonomicon/cardano-transaction-lib
 [Cachix badge]: https://img.shields.io/badge/cachix-public_plutonomicon-blue.svg
 [Cachix link]: https://public-plutonomicon.cachix.org
 

flake.nix

@@ -185,7 +185,7 @@
       apps = perSystem (system: {
         inherit
           (self.hsFlake.${system}.apps)
-          "cardano-browser-tx-server:exe:cardano-browser-tx-server";
+          "cardano-trasaction-lib-server:exe:cardano-trasaction-lib-server";
       });
 
       defaultPackage = perSystem (system: (psProjectFor system).defaultPackage);

nix/default.nix

@@ -33,11 +33,11 @@ let
     (modules { }).shell.nodeDependencies;
 in
 {
-  defaultPackage = self.packages.${system}.cardano-browser-tx;
+  defaultPackage = self.packages.${system}.cardano-transaction-lib;
 
   packages = {
-    cardano-browser-tx = ps-lib.buildPursProject {
-      name = "cardano-browser-tx";
+    cardano-transaction-lib = ps-lib.buildPursProject {
+      name = "cardano-transaction-lib";
       inherit src;
     };
   };
@@ -46,8 +46,8 @@ in
   # Since we depend on two haskell.nix projects, `nix flake check`
   # is currently broken because of IFD issues
   checks = {
-    cardano-browser-tx = ps-lib.runPursTest {
-      name = "cardano-browser-tx";
+    cardano-transaction-lib = ps-lib.runPursTest {
+      name = "cardano-transaction-lib";
       subdir = builtins.toString src;
       inherit src;
     };

server/README.md

@@ -1,6 +1,6 @@
-# cardano-browser-tx-server
+# cardano-trasaction-lib-server
 
-This is a small Haskell project to provide services to the `cardano-browser-tx` frontend that cannot be achieved using Purescript
+This is a small Haskell project to provide services to the `cardano-transaction-lib` frontend that cannot be achieved using Purescript
 
 ## Goals
 
@@ -14,7 +14,7 @@ We plan on supporting at least the following features:
 
 Run `nix develop .#hsDevShell` (or equivalently `nix develop .#package.x86_64-{linux|darwin}`; NB: not currently tested on macOS) in the repository root (i.e. up one level from `server`). This will place you in a development shell with `cabal`, `hoogle`, `haskell-language-server`, etc...
 
-The server executable can be built with `nix build .#cardano-browser-tx-server:exe:cardano-browser-tx-server` and run with `./result/bin/cardano-browser-tx-server`. `cabal` can also be used once in the development shell. The server will run on port 8081. You can optionally pass the `--port`/`-p` flag to explicitly choose a port to run on
+The server executable can be built with `nix build .#cardano-trasaction-lib-server:exe:cardano-trasaction-lib-server` and run with `./result/bin/cardano-trasaction-lib-server`. `cabal` can also be used once in the development shell. The server will run on port 8081. You can optionally pass the `--port`/`-p` flag to explicitly choose a port to run on
 
 ---
 

server/cardano-browser-tx-server.cabal

@@ -1,5 +1,5 @@
 cabal-version: 2.4
-name:          cardano-browser-tx-server
+name:          cardano-trasaction-lib-server
 version:       0.1.0.0
 author:        mlabs
 build-type:    Simple
@@ -76,11 +76,11 @@ library
   exposed-modules:
     Api
     Api.Handlers
-    Paths_cardano_browser_tx_server
+    Paths_cardano_transaction_lib_server
     Types
     Utils
 
-executable cardano-browser-tx-server
+executable cardano-trasaction-lib-server
   import:           common-language
   import:           common-options
   ghc-options:      -threaded -rtsopts
@@ -89,7 +89,7 @@ executable cardano-browser-tx-server
   main-is:          Main.hs
   build-depends:
     , base
-    , cardano-browser-tx-server
+    , cardano-trasaction-lib-server
     , http-types
     , optparse-applicative
     , wai
@@ -106,7 +106,7 @@ test-suite test
   build-depends:
     , base
     , bytestring
-    , cardano-browser-tx-server
+    , cardano-trasaction-lib-server
     , hspec
     , hspec-core
     , http-client

server/nix/default.nix

@@ -9,7 +9,7 @@
 pkgs.haskell-nix.cabalProject {
   inherit src;
 
-  name = "cardano-browser-tx-server";
+  name = "cardano-trasaction-lib-server";
 
   compiler-nix-name = "ghc8107";
 

server/src/Types.hs

@@ -49,7 +49,7 @@ import Data.Text qualified as Text
 import Data.Text.Encoding qualified as Text.Encoding
 import GHC.Generics (Generic)
 import Network.Wai.Handler.Warp (Port)
-import Paths_cardano_browser_tx_server (getDataFileName)
+import Paths_cardano_transaction_lib_server (getDataFileName)
 import Plutus.V1.Ledger.Api qualified as Ledger
 import Plutus.V1.Ledger.Scripts qualified as Ledger.Scripts
 import Servant (FromHttpApiData, QueryParam', Required, ToHttpApiData)

server/test/Main.hs

@@ -72,7 +72,7 @@ applyArgsSpec = around withTestApp $ do
       result `shouldBe` Right (AppliedScript unappliedScriptFixture)
 
     -- FIXME
-    -- See: https://github.com/Plutonomicon/cardano-browser-tx/issues/189
+    -- See: https://github.com/Plutonomicon/cardano-transaction-lib/issues/189
     --
     -- This is returning a different applied script than the test fixtures. The
     -- fixtures were obtained with Plutus using `applyCode` (not `applyArguments`
@@ -101,7 +101,7 @@ feeEstimateSpec = around withTestApp $ do
         runClientM' (clientEnv port) $
           estimateTxFees (WitnessCount 1) cborTxFixture
       -- This is probably incorrect. See:
-      -- https://github.com/Plutonomicon/cardano-browser-tx/issues/123
+      -- https://github.com/Plutonomicon/cardano-transaction-lib/issues/123
       result `shouldBe` Right (Fee 168449)
 
     it "catches invalid hex strings" $ \port -> do

src/Contract/Transaction.purs

@@ -51,7 +51,7 @@ import ReindexRedeemers (reindexSpentScriptRedeemers) as ReindexRedeemers
 import ReindexRedeemers
   ( ReindexErrors(CannotGetTxOutRefIndexForRedeemer)
   ) as ReindexRedeemersExport
-import TxOutput -- Could potentially trim this down, -- FIX ME: https://github.com/Plutonomicon/cardano-browser-tx/issues/200
+import TxOutput -- Could potentially trim this down, -- FIX ME: https://github.com/Plutonomicon/cardano-transaction-lib/issues/200
   ( ogmiosTxOutToScriptOutput
   , ogmiosTxOutToTransactionOutput
   , scriptOutputToOgmiosTxOut
@@ -63,7 +63,7 @@ import TxOutput -- Could potentially trim this down, -- FIX ME: https://github.c
   ) as TxOutput
 import Types.ByteArray (ByteArray)
 import Types.Datum (Datum)
-import Types.JsonWsp (OgmiosTxOut, OgmiosTxOutRef) as JsonWsp -- FIX ME: https://github.com/Plutonomicon/cardano-browser-tx/issues/200
+import Types.JsonWsp (OgmiosTxOut, OgmiosTxOutRef) as JsonWsp -- FIX ME: https://github.com/Plutonomicon/cardano-transaction-lib/issues/200
 import Types.ScriptLookups (UnattachedUnbalancedTx(UnattachedUnbalancedTx))
 import Types.ScriptLookups
   ( MkUnbalancedTxError(..) -- A lot errors so will refrain from explicit names.

src/QueryM.purs

@@ -452,7 +452,7 @@ calculateMinFee tx@(Transaction { body: Transaction.TxBody body }) = do
   -- FIXME
   -- Add some "padding" to the fees so the transaction will submit
   -- The server is calculating fees that are too low
-  -- See https://github.com/Plutonomicon/cardano-browser-tx/issues/123
+  -- See https://github.com/Plutonomicon/cardano-transaction-lib/issues/123
   coinFromEstimate :: FeeEstimate -> Coin
   coinFromEstimate = Coin <<< ((+) (BigInt.fromInt 500000)) <<< unwrap
 

src/Serialization/Address.purs

@@ -191,7 +191,7 @@ instance Eq Address where
 instance Ord Address where
   compare = compare `on` addressBytes
 
--- FIX ME: https://github.com/Plutonomicon/cardano-browser-tx/issues/193
+-- FIX ME: https://github.com/Plutonomicon/cardano-transaction-lib/issues/193
 -- Plutus uses `PlutusTx.makeIsDataIndexed ''Address [('Address,0)]` on their
 -- record, I'm not sure if this will become an issue given our foreign
 -- representation.

src/TxOutput.purs

@@ -57,7 +57,7 @@ transactionInputToTxOutRef
 
 -- https://ogmios.dev/ogmios.wsp.json see "datum", potential FIX ME: it says
 -- base64 but the  example provided looks like a hexadecimal so use
--- hexToByteArray for now. https://github.com/Plutonomicon/cardano-browser-tx/issues/78
+-- hexToByteArray for now. https://github.com/Plutonomicon/cardano-transaction-lib/issues/78
 -- | Converts an Ogmios transaction output to (internal) `TransactionOutput`
 ogmiosTxOutToTransactionOutput
   :: JsonWsp.OgmiosTxOut -> Maybe Transaction.TransactionOutput
@@ -155,4 +155,4 @@ utxoIndexToUtxo
   :: NetworkId
   -> Map Transaction.TransactionInput UTx.ScriptOutput
   -> Transaction.Utxo
-utxoIndexToUtxo networkId = map (scriptOutputToTransactionOutput networkId)
+utxoIndexToUtxo networkId = map (scriptOutputToTransactionOutput networkId)

src/Types/Interval.purs

@@ -459,6 +459,6 @@ posixTimeToEnclosingSlot (SlotConfig { slotLength, slotZeroTime }) (POSIXTime t)
   in
     Slot <$> bigIntToUInt slotsPassed
 
--- TO DO: https://github.com/Plutonomicon/cardano-browser-tx/issues/169
+-- TO DO: https://github.com/Plutonomicon/cardano-transaction-lib/issues/169
 -- -- | Get the current slot number
 -- currentSlot :: SlotConfig -> Effect Slot

src/Types/ScriptLookups.purs

@@ -260,14 +260,14 @@ typedValidatorLookupsM
   :: forall (a :: Type). TypedValidator a -> Maybe (ScriptLookups a)
 typedValidatorLookupsM = pure <<< typedValidatorLookups
 
--- FIX ME: https://github.com/Plutonomicon/cardano-browser-tx/issues/200
+-- FIX ME: https://github.com/Plutonomicon/cardano-transaction-lib/issues/200
 -- | A script lookups value that uses the map of unspent outputs to resolve
 -- | input constraints.
 unspentOutputs
   :: forall (a :: Type). Map TxOutRef TransactionOutput -> ScriptLookups a
 unspentOutputs mp = over ScriptLookups _ { txOutputs = mp } mempty
 
--- FIX ME: https://github.com/Plutonomicon/cardano-browser-tx/issues/200
+-- FIX ME: https://github.com/Plutonomicon/cardano-transaction-lib/issues/200
 -- | Same as `unspentOutputs` but in `Maybe` context for convenience. This
 -- | should not fail.
 unspentOutputsM
@@ -459,7 +459,7 @@ type ConstraintsM (a :: Type) (b :: Type) =
 -- use the type alias because they need to be fully applied so this is perhaps
 -- more readable.
 -- Fix me: add execution units from Ogmios where this function should be
--- inside QueryM https://github.com/Plutonomicon/cardano-browser-tx/issues/174
+-- inside QueryM https://github.com/Plutonomicon/cardano-transaction-lib/issues/174
 -- | Resolve some `TxConstraints` by modifying the `UnbalancedTx` in the
 -- | `ConstraintProcessingState`
 processLookupsAndConstraints
@@ -1010,7 +1010,7 @@ processConstraint mpsMap osMap = do
   where
   -- The follow hardcoded before calling Ogmios to calculate execution
   -- unit. Calling Ogmios is an outstanding issue:
-  -- https://github.com/Plutonomicon/cardano-browser-tx/issues/174
+  -- https://github.com/Plutonomicon/cardano-transaction-lib/issues/174
   scriptExUnits :: ExUnits
   scriptExUnits = { mem: fromInt 2000000, steps: fromInt 1000000000 }
 

src/Types/TxConstraints.purs

@@ -178,7 +178,7 @@ mustBeSignedBy = singleton <<< MustBeSignedBy
 mustIncludeDatum :: forall (i :: Type) (o :: Type). Datum -> TxConstraints i o
 mustIncludeDatum = singleton <<< MustIncludeDatum
 
--- FIX ME: https://github.com/Plutonomicon/cardano-browser-tx/issues/200
+-- FIX ME: https://github.com/Plutonomicon/cardano-transaction-lib/issues/200
 -- | Lock the value to the script currently being validated
 mustPayToTheScript
   :: forall (i :: Type) (o :: Type)

src/Types/TypedValidator.purs

@@ -144,7 +144,7 @@ forwardingMintingPolicy = _.forwardingMPS <<< unwrap
 
 -- We have a few functions, I'm not sure if we even need these for off chain
 -- code:
--- -- Broken, see below (we need some notion of `applyCode`) https://github.com/Plutonomicon/cardano-browser-tx/issues/24
+-- -- Broken, see below (we need some notion of `applyCode`) https://github.com/Plutonomicon/cardano-transaction-lib/issues/24
 -- -- | Make a `TypedValidator` (with no type constraints) from an untyped
 -- -- |`Validator` script.
 -- unsafeMkTypedValidator :: Scripts.Validator -> Maybe (TypedValidator Any)
@@ -163,4 +163,4 @@ forwardingMintingPolicy = _.forwardingMPS <<< unwrap
 -- --  mkTypedValidatorParam requires some notion
 -- -- of compiled code and `applyCode` also
 -- mkForwardingMintingPolicy :: ValidatorHash -> MintingPolicy
--- mkForwardingMintingPolicy = undefined
+-- mkForwardingMintingPolicy = undefined

src/Types/Value.purs

@@ -387,7 +387,7 @@ instance Split Value where
     bimap (flip Value mempty) (flip Value mempty) (split coin)
       <> bimap (Value mempty) (Value mempty) (split nonAdaAsset)
 
--- FIX ME: https://github.com/Plutonomicon/cardano-browser-tx/issues/193
+-- FIX ME: https://github.com/Plutonomicon/cardano-transaction-lib/issues/193
 -- Because our `Value` is different to Plutus, I wonder if this will become an
 -- issue.
 instance FromData Value where
@@ -477,7 +477,7 @@ unionNonAda (NonAdaAsset l) (NonAdaAsset r) =
   in
     unBoth <$> combined
 
--- Don't export to `Contract` due to https://github.com/Plutonomicon/cardano-browser-tx/issues/193
+-- Don't export to `Contract` due to https://github.com/Plutonomicon/cardano-transaction-lib/issues/193
 -- | Same as `unionWith` but specifically for `NonAdaAsset`
 unionWithNonAda
   :: (BigInt -> BigInt -> BigInt)

webpack.config.js

@@ -106,7 +106,7 @@ module.exports = {
       debug: true,
     }),
     new HtmlWebpackPlugin({
-      title: "cardano-browser-tx-examples",
+      title: "cardano-transaction-lib-examples",
       template: "./examples/index.html",
       inject: false, // See stackoverflow.com/a/38292765/3067181
     }),