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

SIN relabels + typos #3429

Merged
merged 1 commit into from
Dec 2, 2024
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
2 changes: 1 addition & 1 deletion docs/bridge/docs/03-RFQ/10-Quoting/Quoter API/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ sidebar_label: Quoter API

:::info

This guide is intended for builders who are integrating a quoter or frontend with the Synapse RFQ system.
This guide is intended for builders who are integrating a quoter or frontend with the Synapse Intent Network (SIN) system.

If you are interested in running a relayer, please also see [Relaying] and [Canonical Relayer](/docs/RFQ/CanonicalRelayer/) .

Expand Down
4 changes: 2 additions & 2 deletions docs/bridge/docs/03-RFQ/10-Quoting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ title: Quoting
[Canceler]: /docs/RFQ/#entities


The Synapse RFQ systems allows [Quoter] entities (aka market makers / solvers / relayers) to post quotes via an off-chain [Quoter API]. These quotes are matched to `User` bridge inputs to achieve the optimal parameters (eg: the best price) for the [User]'s bridge transaction.
The Synapse Intent Network (SIN) systems allows [Quoter] entities (aka market makers / solvers / relayers) to post quotes via an off-chain [Quoter API]. These quotes are matched to `User` bridge inputs to achieve the optimal parameters (eg: the best price) for the [User]'s bridge transaction.

There are two types of quoting methods supported by the Synapse RFQ system:
There are two types of quoting methods supported by the Synapse Intent Network (SIN) system:

## [Passive Quoting](/docs/RFQ/Quoting/Quoter%20API/#passive-quotes)

Expand Down
4 changes: 2 additions & 2 deletions docs/bridge/docs/03-RFQ/15-Bridging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ title: Bridging

Once a quote has been obtained via [Quoting], the details of the quote can be used to construct a bridge transaction for the user to sign and submit to the origin chain.

Bridges through Synapse RFQ utilize the [Synapse Router](/docs/Routers/Synapse-Router/) - Refer to those docs for more detail.
Bridges through Synapse Intent Network (SIN) utilize the [Synapse Router](/docs/Routers/Synapse-Router/) - Refer to those docs for more detail.


:::info
If you are interested in integrating with Synapse RFQ Bridging, refer to the [Synapse Bridge SDK](/docs/Bridge/SDK).
If you are interested in integrating with Synapse Intent Network (SIN) Bridging, refer to the [Synapse Bridge SDK](/docs/Bridge/SDK).

Alternatively, you can explore the [Bridge REST API](https://api.synapseprotocol.com/api-docs/).

Expand Down
2 changes: 1 addition & 1 deletion docs/bridge/docs/03-RFQ/20-Relaying/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ title: Relaying

# Relaying

In the Synapse RFQ System, Relayers fulfill the intent of [User] [bridge] transactions by providing the liquidity and executing the [relay] transaction on the destination chain .
In the Synapse Intent Network (SIN) System, Relayers fulfill the intent of [User] [bridge] transactions by providing the liquidity and executing the [relay] transaction on the destination chain .

:::info

Expand Down
2 changes: 1 addition & 1 deletion docs/bridge/docs/03-RFQ/20-Relaying/riskFactors.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ title: Risk Factors

As is the case with many cross-chain systems, there are inherent risks involved with providing liquidity as a [Relayer].

Although the system is designed to minimize these risks, it is ultimately the sole responsibility and liability of the [Relayer] to fully understand and manage the risks involved with participating as a [Relayer] in the Synapse RFQ system.
Although the system is designed to minimize these risks, it is ultimately the sole responsibility and liability of the [Relayer] to fully understand and manage the risks involved with participating as a [Relayer] in the Synapse Intent Network (SIN) system.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/bridge/docs/03-RFQ/30-Proving/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ As of FastBridgeV2, it is possible to batch many [prove] transactions together w

## Next steps

Following the [prove] transation, a [Dispute Period] begins - after which the [Relayer] may proceed to [Claiming]
Following the [prove] transaction, a [Dispute Period] begins - after which the [Relayer] may proceed to [Claiming]

Although disputes are unlikely, monitoring should occur during the [Dispute Period] to verify there are no issues.
2 changes: 1 addition & 1 deletion docs/bridge/docs/03-RFQ/40-Claiming/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ As of FastBridgeV2, it is possible to batch many [claim] transactions together w

## Next steps

Following the [claim] transation, the bridge deposit funds have been reimbursed to the [Relayer] and are ready to be used for another relay. The bridge cycle is fully complete.
Following the [claim] transaction, the bridge deposit funds have been reimbursed to the [Relayer] and are ready to be used for another relay. The bridge cycle is fully complete.
4 changes: 2 additions & 2 deletions docs/bridge/docs/03-RFQ/60-Security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ title: Security
[Canceler]: /docs/RFQ/#entities


Synapse RFQ is an optimistic cross-chain system. This means that any ambiguous actions in the system are assumed to be accurate and honest by default unless they are challenged/disputed within a short timeframe.
Synapse Intent Network (SIN) is an optimistic cross-chain system. This means that any ambiguous actions in the system are assumed to be accurate and honest by default unless they are challenged/disputed within a short timeframe.


### Proofs
Expand All @@ -49,7 +49,7 @@ Each [prove] transaction sets the [proof] data for the bridge and initiates a di

After a [prove] transaction is posted and the [proof] data is set, a window of time called the [Dispute Period](https://rfq-contracts.synapseprotocol.com/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) begins.

During this time, the prove/proof is eligible to be dispuated by [Guard] entities.
During this time, the prove/proof is eligible to be disputed by [Guard] entities.

After the [Dispute Period](https://rfq-contracts.synapseprotocol.com/contracts/FastBridgeV2.sol/contract.FastBridgeV2.html#dispute_period) has passed without any disputes, the funds in escrow from the original bridge transaction can be released via a [claim] transaction, which will reimburse the rightful [Relayer].

Expand Down
4 changes: 2 additions & 2 deletions docs/bridge/docs/03-RFQ/70-CanonicalRelayer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ sidebar_label: Canonical Relayer
[Guard]: /docs/RFQ/#entities
[Canceler]: /docs/RFQ/#entities

# Canonical RFQ Relayer
# Canonical Relayer

:::info

Expand All @@ -44,7 +44,7 @@ If you are interested in participating as a Relayer, contact us.

:::

The Canonical RFQ Relayer is the official relayer app built and operated by Synapse which performs all necessary automated functions that are necessary for a Relayer participating in the Synapse RFQ network.
The Canonical Relayer is the official relayer app built and operated by Synapse which performs all necessary automated functions that are necessary for a Relayer participating in the Synapse Intent Network (SIN) network.

These functions include:

Expand Down
8 changes: 4 additions & 4 deletions docs/bridge/docs/03-RFQ/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import { RFQFlow } from '@site/src/components/RFQFlow'

# Synapse Intent Network

Synapse Intent Network is an RFQ (Request-For-Quote) based <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual execution of the actions is then performed on the user's behalf by third parties known as solvers/relayers.">intent</abbr> centric bridging system that connects bridging users to a network of relayers.
Synapse Intent Network (SIN) is an RFQ (Request-For-Quote) based <abbr title="'Intent' refers to a user authorizing specific actions that they want to achieve, typically in very simple terms, such as a bridge or swap. Actual execution of the actions is then performed on the user's behalf by third parties known as solvers/relayers.">intent</abbr> centric bridging system that connects bridging users to a network of relayers.

These relayers compete to provide the optimal bridge execution (eg: the best price) for the user's specific request.

Expand Down Expand Up @@ -122,14 +122,14 @@ These relayers compete to provide the optimal bridge execution (eg: the best pri
<blockquote>
Validates proofs during the [Dispute Period] and submits [dispute] transactions for any discrepancies found.
<div></div>
Currently, Synapse itself is the sole Guard operator of the Synapse RFQ system.
Currently, Synapse itself is the sole Guard operator of the Synapse Intent Network (SIN) system.
</blockquote><br />

<b>Cancelers</b> <span style={{color: 'darkgray'}}><i>(Permissioned Role)</i></span>
<blockquote>
Able to manually pre-emptively cancel bridge requests which have been deposited, have not yet been relayed, and are past their relay deadline.
<div></div>
Currently, Synapse itself is the sole Canceler operator of the Synapse RFQ system.
Currently, Synapse itself is the sole Canceler operator of the Synapse Intent Network (SIN) system.
<div></div>
<span style={{color: 'darkgray', fontSize: '0.9em'}}><i>Note: Incomplete bridge requests can also be canceled permissionlessly (without any involvement from a Canceler) after a longer cancellation window has passed.</i></span>
</blockquote>
Expand Down Expand Up @@ -206,5 +206,5 @@ If any discrepancies are found, the guards will [dispute] the proof
<blockquote>
Once the [Dispute Period] has passed without incident, a [claim] transaction can be executed by the [Relayer] on the origin chain.

This wil release the deposit funds from escrow and deliver them to the rightful [Relayer] as a reimbursement for the liquidity they provided on the [relay].
This willrelease the deposit funds from escrow and deliver them to the rightful [Relayer] as a reimbursement for the liquidity they provided on the [relay].
</blockquote>
Loading