From eb493fba0b1c41339c60b0366681a467468be65d Mon Sep 17 00:00:00 2001 From: DhananjayPurohit Date: Mon, 18 Dec 2023 14:04:49 +0530 Subject: [PATCH] chore: update readme doc for mainstay --- doc/MAINSTAY.md | 21 +++++++++++++++++++++ doc/MANUAL.md | 1 + 2 files changed, 22 insertions(+) create mode 100644 doc/MAINSTAY.md diff --git a/doc/MAINSTAY.md b/doc/MAINSTAY.md new file mode 100644 index 0000000..1a3d389 --- /dev/null +++ b/doc/MAINSTAY.md @@ -0,0 +1,21 @@ +# Mainstay integration + +All events undergo hash conversion, leading to the creation of a cumulative hash. This cumulative hash is then forwarded for commitment to the Mainstay proof-of-publication service for attestation. + +The Mainstay service can be accessed through an HTTP interface or via a SOCKS5 Tor proxy. The service is operational and backed by a valid token_id for verification purposes. Funding, conducted through an LN payment, is executed in advance and separately from the subscription process (i.e., the token_id has already been processed). Mainstay proofs are stored and accessible, but the verification against bitcoind and staychain is conducted independently. + +## Configuration + +The node is configured with essential parameters, including the Mainstay server URL, slot index (position), authentication token, base public key, and chain code: + +``` +pub struct Mainstay { + pub url: String, + pub position: i32, + pub token: String, + pub base_pubkey: String, + pub chain_code: String, +} +``` + +This can be added to `/src/config.rs` diff --git a/doc/MANUAL.md b/doc/MANUAL.md index 45c137c..3e60999 100644 --- a/doc/MANUAL.md +++ b/doc/MANUAL.md @@ -21,6 +21,7 @@ The sample can send the following requests to the relay: - `opensubscription subscriptionid kinds since until`: open a subscription to the relay - `closesubscription subscriptionid`: close a subscription to the relay - `submitcredentialproof merkle_block`: submit a staking credential proof to the relay +- `verifyinclusionproof`: verify the inclusion proof The `civkit-cli` can send the following commands to the relay: - `ping`: send a ping message