Merge branch 'main' of github.com:txpipe/boros

docs/.gitignore

@@ -6,4 +6,6 @@
 
 # Ignore all .env files except .env.example
 .env*
-!.env.example
+!.env.example
+
+public/_pagefind

docs/Dockerfile

@@ -22,6 +22,7 @@ FROM dependencies-env
 COPY ./package.json ./pnpm-lock.yaml /app/
 COPY --from=production-dependencies-env /app/node_modules /app/node_modules
 COPY --from=build-env /app/.next /app/.next
+COPY --from=build-env /app/public /app/public
 WORKDIR /app
 EXPOSE 3000
 CMD ["pnpm", "start"]

docs/app/configuration/page.mdx

@@ -1,5 +1,5 @@
 ---
-title: Configuration - Boros
+title: Configuration
 sidebarTitle: Configuration
 asIndexPage: true
 ---
@@ -8,7 +8,93 @@ asIndexPage: true
 
 Boros uses a `config.toml` file to define some configuration parameters. At least one Cardano Node Peer is required and a U5C server.
 
-Use this [config.toml](https://github.com/txpipe/boros/blob/main/examples/config.toml) to create yours.
+## Schema
+
+Example `config.toml`
+
+```toml
+[storage]
+db_path = "boros.db"
+
+[server]
+listen_address="0.0.0.0:50052"
+
+[peer_manager]
+peers = [
+  "Node:3001",
+  "Node:3001",
+]
+
+[monitor]
+retry_slot_diff = 1000
+
+[u5c]
+uri = "https://mainnet.utxorpc-v0.demeter.run"
+
+# metadata is optional
+[u5c.metadata]
+"dmtr-api-key" = "your key"
+```
+
+### `storage` section
+
+The `storage` section defines the options to start the local database. This db saves the transaction that the user sends and controls the status.
+
+| property   | type    | example               |
+| ---------- | ------- | --------------------- |
+| db_path    | string  | "/etc/boros/local.db" |
+
+- `db_path`: path to create the boros db
+
+### `server` section
+
+The `server` section controls the options for the gRPC endpoint that can be used by clients.
+
+| property       | type   | example         |
+| -------------- | ------ | --------------- |
+| listen_address | string | "0.0.0.0:50051" |
+
+- `listen_address`: the local address (`IP:PORT`) to listen for incoming gRPC connections.
+
+### `peer_manager` section
+
+The `peer_manager` section defines the options that the peer manager uses to connect to the Cardano Node peer and to propagate the transactions.
+
+| property       | type   | example                      |
+| -------------- | ------ | ---------------------------- |
+| peers          | array  | [ "Node:3001", "Node:3001" ] |
+
+- `peers`: The peers address (`DNS or IP:PORT`) to connect to the Cardano Node and to propagate transactions.
+
+### `monitor` section
+
+The `monitor` section defines the options to control the monitor stage.
+
+| property        | type   | example |
+| --------------  | ------ | ------- |
+| retry_slot_diff | number | 1000    |
+
+- `retry_slot_diff`: The number of slot units used to determine when to retry a transaction. If (slot_current_block - slot_tx_sent) > retry_slot_diff, the transaction will be retried.
+
+### `u5c` section
+
+The `u5c` section defines the options for U5C to connect to chainsync.
+
+| property    | type   | example                                  |
+| ----------- | ------ | ---------------------------------------- |
+| uri         | string | "https://mainnet.utxorpc-v0.demeter.run" |
+
+- `uri`: The uri to connect to a U5C server.
+
+### `u5c.metadata` section
+
+The `u5c.metadata` section is optional and defines metadata for U5C connection, it's a hashmap key value.
+
+| property    | type   | example |
+| ----------- | ------ | ------- |
+| key         | string | "value" |
+
+- `key`: a string value.
 
 ## Tips
 

docs/app/design/adrs/001-pipeline/page.md

@@ -1,5 +1,5 @@
 ---
-title: Pipeline - Boros Docs
+title: Pipeline
 sidebarTitle: Pipeline
 ---
 

docs/app/design/adrs/002-entry-point/page.md

@@ -1,5 +1,5 @@
 ---
-title: Entry point - Boros Docs
+title: Entry point
 sidebarTitle: Entry point
 ---
 

docs/app/design/adrs/003-storage/page.md

@@ -1,5 +1,5 @@
 ---
-title: Storage - Boros Docs
+title: Storage
 sidebarTitle: Storage
 ---
 

docs/app/design/adrs/page.mdx

@@ -1,5 +1,5 @@
 ---
-title: Design Adrs - Boros Docs
+title: Design Adrs
 sidebarTitle: Adrs
 asIndexPage: true
 ---

docs/app/design/page.mdx

@@ -1,5 +1,5 @@
 ---
-title: Design - Boros
+title: Design
 sidebarTitle: Design
 asIndexPage: true
 ---

docs/app/installation/docker/page.mdx

@@ -1,5 +1,5 @@
 ---
-title: Docker - Boros
+title: Docker
 sidebarTitle: Docker
 asIndexPage: true
 ---

docs/app/installation/from_source/page.mdx

@@ -1,5 +1,5 @@
 ---
-title: From Source - Boros
+title: From Source
 sidebarTitle: From Source
 asIndexPage: true
 ---

docs/app/layout.tsx

@@ -6,6 +6,9 @@ import 'nextra-theme-docs/style.css';
 export const metadata = {
   // Define your metadata here
   // For more information on metadata API, see: https://nextjs.org/docs/app/building-your-application/optimizing/metadata
+  title: {
+    template: '%s - Boros',
+  },
 };
 
 const banner = (

docs/package.json

@@ -9,7 +9,8 @@
     "start": "next start",
     "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
     "lint:fix": "eslint . --fix",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postbuild": "pagefind --site .next/server/app --output-path public/_pagefind"
   },
   "keywords": [],
   "author": "",
@@ -32,6 +33,7 @@
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-react-hooks": "^5.1.0",
     "globals": "^15.14.0",
+    "pagefind": "^1.3.0",
     "typescript": "5.7.3"
   }
 }