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/fix #3222

Merged
merged 3 commits into from
Oct 3, 2024
Merged

Docs/fix #3222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a06439
fixing terminology
Defi-Moses Oct 3, 2024
b40bc84
rfq-indexer-docs
Defi-Moses Oct 3, 2024
7dae54e
Update RFQ Indexer API Readme (#3221)
Defi-Moses Oct 3, 2024
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
4 changes: 2 additions & 2 deletions docs/bridge/docs/05-Contracts/05-CCTP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The canonical list is hosted within the SynapseCNS on [Github](https://github.co

# CCTP

Synapse CCTP contracts route through the [SynapseBridge](https://github.com/synapsecns/synapse-contracts/blob/ed93453430635e2d43704d5599d3318c43a23033/contracts/bridge/SynapseBridge.sol#L63-L118) contract to interact with [Circle CCTP contracts](https://developers.circle.com/stablecoins/docs/evm-smart-contracts) which mint and burn USDC across supported chains.
Synapse CCTP transactions primarily interact with the Synapse CCTP Router contract, which is responsible for routing transactions with the proper meta data to the Synapse CCTP contract on the relevant chain, which utilizes the base [Circle CCTP contracts](https://developers.circle.com/stablecoins/docs/evm-smart-contracts) to mint and burn USDC across supported chains.

**Address**: `0xd5a597d6e7ddf373a92c8f477daaa673b0902f48`\
**Synapse CCTP Router Address**: `0xd5a597d6e7ddf373a92c8f477daaa673b0902f48`\
**Contract**: [SynapseCCTP.sol](https://github.com/synapsecns/synapse-contracts/blob/master/contracts/cctp/SynapseCCTP.sol)

| Chain | Address |
Expand Down
4 changes: 2 additions & 2 deletions docs/bridge/docs/05-Contracts/06-RFQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ The canonical list is hosted within the SynapseCNS on [Github](https://github.co

# RFQ

RFQ contracts route through the [SynapseBridge](https://github.com/synapsecns/synapse-contracts/blob/ed93453430635e2d43704d5599d3318c43a23033/contracts/bridge/SynapseBridge.sol#L63-L118) contract.
RFQ transactions primarily interact with the Router Address, which is responsible for routing transactions with the proper meta data to the RFQ contract on the relevant chain.

**Source code**: [SynapseCNS (Github)](https://github.com/synapsecns/sanguine/tree/master/packages/contracts-rfq)\
**Generated docs**: [RFQ docs](https://vercel-rfq-docs.vercel.app/contracts/FastBridge.sol/contract.FastBridge.html)\
**Address**: `0x00cD000000003f7F682BE4813200893d4e690000`
**RFQ Router Address**: `0x00cD000000003f7F682BE4813200893d4e690000`

| Chain | Address |
| -------- | ------- |
Expand Down
14 changes: 14 additions & 0 deletions docs/bridge/docs/06-Services/06-RFQ-Indexer-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# RFQ Indexer API

The RFQ Indexer API is a service designed to provide access to indexed RFQ bridge event data. It offers crucial monitoring and operational capabilities, serving as a supplemental tool to existing relayer infrastructure. This API is particularly useful for tracking pending bridge transactions and identifying missing relays, proofs, or claims.

## API-docs

[`https://triumphant-magic-production.up.railway.app/api-docs/`](https://triumphant-magic-production.up.railway.app/api-docs/)

## Key Features
1. **Real-Time and Historical Data** Indexes from a specified start block up to real-time events.
2. **On-chain Tracing** Tracks all on-chain transactions and events, helping to debug.
4. **GraphQL API**: Provides a GraphQL/IQL endpoint for easy data querying.


2 changes: 2 additions & 0 deletions packages/rfq-indexer/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This API provides access to the indexed bridge event data.

To make requests, use: https://triumphant-magic-production.up.railway.app , and Swagger docs can be found [here](https://triumphant-magic-production.up.railway.app/api-docs)

## API Calls

1. GET /api/hello
Expand Down
Loading