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.

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

chore: update readme doc for mainstay #112

Merged
merged 1 commit into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions doc/MAINSTAY.md
Original file line number Diff line number Diff line change
@@ -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`
1 change: 1 addition & 0 deletions doc/MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good for now. What could be added is terminal output to explain verifyinclusionproof.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the terminal output in #125


The `civkit-cli` can send the following commands to the relay:
- `ping`: send a ping message
Expand Down
Loading