-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
title: Mafoc | ||
logo: https://captainhaskell.ee/mafoc/img/mafoc-logo.svg | ||
description: The Cardano Indexer Framework with many predefined ones included. | ||
repository: https://github.com/eyeinsky/mafoc/ | ||
features: | ||
- containers | ||
settings: | ||
template: plutus | ||
size: small | ||
author: | ||
name: Captain Haskell | ||
website: https://captainhaskell.ee/mafoc/ | ||
social: | ||
twitter: Mafoc_Cardano | ||
discord: bgUE4csP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Mafoc | ||
|
||
Mafoc is a chain indexer written in haskell. | ||
|
||
Though it's library to build new indexers with, it also has a [quite a | ||
few of them built | ||
in](https://captainhaskell.ee/mafoc/docs/category/indexers). Some of | ||
thes output JSON directly (`addressbalance` and `deposit` can be used | ||
to monitor activity on an address), while others write to sqlite | ||
database. | ||
|
||
Indexers are easiest run with docker, e.g: | ||
``` | ||
docker run --rm -it markus77/mafoc deposit "$CARDANO_NODE_SOCKET_PATH" \ | ||
--address addr1.. \ | ||
--address addr1.. | ||
``` | ||
|
||
To build Mafoc locally, one would need to do it in nix (be sure to use | ||
[nix | ||
cache](https://github.com/input-output-hk/cardano-ledger#nix-cache)): | ||
```bash | ||
nix develop | ||
cabal build mafoc:exe:mafoc | ||
``` | ||
|
||
|
||
|
||
## Environment | ||
|
||
Mafoc needs access to a Cardano Node, which you can run locally, or | ||
use the common instance provided by | ||
[Demeter.run](https://demeter.run), which also provides the socket | ||
path environment variable used above. |