Skip to content

Commit

Permalink
Update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
klntsky committed Aug 10, 2022
1 parent dd0bf80 commit f5e37cc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 34 deletions.
2 changes: 1 addition & 1 deletion doc/runtime.md
Expand Up @@ -23,7 +23,7 @@ The services that are currently required are:
- This is required to query for datums, which Ogmios itself does not support
- This in turn requires a PostgreSQL DB
- [Our Haskell server](/server/README.md)
- We hope to deprecate this in the future, but we use it at the moment for certain Cardano libraries that have no Purescript analogue
- We hope to deprecate this in the future, but we use it at the moment to apply arguments to Plutus scripts, which is hard to implement on front-end.
- To build the server project, run the following from the repository root: `nix build -L .#ctl-server:exe:ctl-server`

### Using CTL's `runtime` overlay
Expand Down
35 changes: 2 additions & 33 deletions server/README.md
@@ -1,12 +1,12 @@
# ctl-server

This is a small Haskell project to provide services to the `cardano-transaction-lib` 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. For now we only use the server to apply arguments to Plutus scripts.

## Goals

We plan on supporting at least the following features:

- [x] Transaction fee estimation via `Cardano.Api`
- [x] ~~Transaction fee estimation via `Cardano.Api`~~
- [x] Plutus' `applyArguments` for applying `Data` arguments to scripts
- [x] ~~Obtaining the hash of scripts (e.g. `validatorHash`, etc...)~~

Expand Down Expand Up @@ -50,34 +50,3 @@ The server executable can be built with `nix build .#ctl-server:exe:ctl-server`
```javascript
"4d01000033222220051200120011"
```

## POST /fees

### Request:

- Supported content types are:

- `application/json;charset=utf-8`
- `application/json`

- The input should contain the intended number of witnesses and theCBOR of the tx (`application/json;charset=utf-8`, `application/json`):

```javascript
{"tx":"00","count":1}
```

### Response:

- Status code 200
- Headers: []

- Supported content types are:

- `application/json;charset=utf-8`
- `application/json`

- The `Fee` will be returned encoded as a JSON string (`application/json;charset=utf-8`, `application/json`):

```javascript
"160265"
```

0 comments on commit f5e37cc

Please sign in to comment.