Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: screenshot and logo #274

Merged
merged 1 commit into from
Nov 20, 2024
Merged

docs: screenshot and logo #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/assets/tx-submit-api-20241120.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/tx-submit-api-logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# tx-submit-api

Cardano Transaction Submission API
<div align="center">
<img src="./.github/assets/tx-submit-api-logo.png" alt="Tx Submit API" width="640">
</div>

Transaction Submission API for Cardano

A simple HTTP API which accepts a CBOR encoded Cardano transaction as a
payload body and submits it to a Cardano full node using the Ouroboros
Expand Down Expand Up @@ -135,6 +139,17 @@ curl -X POST \
http://localhost:8090/api/submit/tx
```

### Metrics UI

There is a metrics web user interface running on the service's API port.

Connect to [http://localhost:8090/ui/](http://localhost:8090/ui/) with your
browser to view it.

<div align="center">
<img src="./.github/assets/tx-submit-api-20241120.png" alt="Tx Submit API" width="640">
</div>

## Development

There is a Makefile to provide some simple helpers.
Expand Down
Loading