Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
albertodvp committed Jun 3, 2024
1 parent 43b344c commit 497a53c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A collection of libraries that are helpful for building Cardano apps with Haskel
* `convex-wallet`: Minimal wallet implementation
* `convex-coin-selection`: Coin selection and transaction balancing
* `convex-mockchain`: Minimal mockchain for tests

* `convex-optics`: Some optics for plutus-ledger-api and cardano-api
The API documentation (Haddocks) is published [here](https://j-mueller.github.io/sc-tools/)

### Dependencies
Expand All @@ -27,7 +27,7 @@ Support for `ghc-8.10.7` and `cardano-node-1.35.4` will be maintained for a litt

We use the `TxBodyContent BuildTx BabbageEra` type from `cardano-api` as the basic type for building transactions. The `MonadBuildTx` class from `Convex.BuildTx` is essentially a writer for `TxBodyContent` modifications. `Convex.BuildTx` defines a number of helper functions for common tasks such as spending and creating Plutus script outputs, minting native assets, setting collateral, etc.

To `Convex.CardanoApi.Lenses` defines some lenses for adding content to transaction bodies. These can be used together with `MonadBuildTx.addBtx`.
`Convex.CardanoApi.Lenses` defines some lenses for adding content to transaction bodies. These can be used together with `MonadBuildTx.addBtx`.

```haskell
import qualified Cardano.API.Shelley as C
Expand Down Expand Up @@ -146,4 +146,4 @@ There aren't a lot of tests right now, but I have used this code for real DeFi t

## Contributing

Bug reports, pull requests and other contributions are welcome!
Bug reports, pull requests and other contributions are welcome!
9 changes: 4 additions & 5 deletions cabal.project
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ documentation: true

source-repository-package
type: git
-- This fork should be changed with the Plutonomicon staging branch as soon as
-- this PR is merged: https://github.com/Plutonomicon/plutarch-plutus/pull/672
-- This fork should be changed with the Plutonomicon/plutarch-plutus staging branch as soon as
-- this PR is merged: https://github.com/Plutonomicon/plutarch-plutus/pull/677
location: https://github.com/albertodvp/plutarch-plutus
tag: 1b2b5fb684e69e3d12319608278c1f6dea6e12af
subdir:
Expand All @@ -38,9 +38,8 @@ source-repository-package

source-repository-package
type: git
-- This fork branch should be changed with some official branch in
-- input-output-hk/xsy-liqwid-libs as soons as the git workflow
-- is established there
-- This fork should be changed with the input-output-hk/xsy-liqwid-libs main branch as soon as
-- this PR is merged: https://github.com/input-output-hk/xsy-liqwid-libs/pull/7
location: https://github.com/albertodvp/xsy-liqwid-libs
tag: 26b37079439445b815b4bce86d80cf5dbf971f60
subdir:
Expand Down

0 comments on commit 497a53c

Please sign in to comment.