Skip to content

Commit

Permalink
Squashed 'Synthetix-Gitbook-v3/' changes from fd79e4f..911ff68
Browse files Browse the repository at this point in the history
911ff68 GITBOOK-179: No subject
c082290 GITBOOK-177: No subject
d002b0c GITBOOK-176: No subject
e0c575d GITBOOK-175: Perps V3 FAQ Addition
7a46dcf GITBOOK-174: No subject
dea696e GITBOOK-173: No subject
04155ef GITBOOK-172: No subject
c324811 GITBOOK-171: No subject
6be2ce6 GITBOOK-170: No subject
7326fb0 GITBOOK-169: No subject
d1f9b36 GITBOOK-168: No subject
ae0a4a0 GITBOOK-167: No subject
5390d03 GITBOOK-166: No subject
aeb63bc GITBOOK-165: No subject
a77cec5 GITBOOK-164: No subject
9ed1b3d GITBOOK-162: No subject
c242c59 Update ABIs and addresses (#21)
eb62099 GITBOOK-161: change request with no subject merged in GitBook
aaa18ba GITBOOK-160: change request with no subject merged in GitBook
3fd4d8b GITBOOK-159: change request with no subject merged in GitBook
7974f74 GITBOOK-158: change request with no subject merged in GitBook
35c2bcd GITBOOK-157: change request with no subject merged in GitBook
3014936 GITBOOK-156: change request with no subject merged in GitBook
a02878c GITBOOK-155: change request with no subject merged in GitBook
7d49b07 GITBOOK-154: change request with no subject merged in GitBook
5d22800 GITBOOK-153: change request with no subject merged in GitBook
9e46119 GITBOOK-152: change request with no subject merged in GitBook
5371ecc GITBOOK-151: change request with no subject merged in GitBook
884d6cd GITBOOK-150: change request with no subject merged in GitBook
da39632 GITBOOK-149: change request with no subject merged in GitBook
e28a62e GITBOOK-148: change request with no subject merged in GitBook
420e940 GITBOOK-147: change request with no subject merged in GitBook
562a25f GITBOOK-146: change request with no subject merged in GitBook
05176c5 GITBOOK-145: add Perps V3 docs
cf038b5 GITBOOK-144: add perp sandbox
e309a17 GITBOOK-143: add faq question
1b1bea9 GITBOOK-142: fix
2e08809 GITBOOK-141: v3 cross chain FAQ
5921dff Update ABIs and addresses (#20)
fdb8cf1 GITBOOK-140: change request with no subject merged in GitBook
59118f1 GITBOOK-139: add reward dist example
d711b6d GITBOOK-138: change request with no subject merged in GitBook
2d32191 Update ABIs and addresses (#19)
97f4b19 GITBOOK-136: change request with no subject merged in GitBook
d988895 rename method (#18)
1261614 GITBOOK-135: faq addition
cc389ee GITBOOK-134: faq addition
934c146 Update ABIs and addresses (#17)
143783c Update ABIs and addresses (#15)
470a079 Update ABIs and addresses (#14)
e5f0399 Update ABIs and addresses (#12)
e5ba45d GITBOOK-133: change request with no subject merged in GitBook
3b5b50b GITBOOK-132: update Dev progress
5b9142e GITBOOK-131: change request with no subject merged in GitBook
8864ad1 GITBOOK-130: addition to FAQ
5d8653c GITBOOK-129: expand Dev FAQ
f5763d1 GITBOOK-128: add FAQ and reorg Market pages
8d78796 rename method (#9)
8234627 GITBOOK-127: change request with no subject merged in GitBook
46a8524 GITBOOK-126: change request with no subject merged in GitBook
43510c8 GITBOOK-125: change request with no subject merged in GitBook
2bd8c9a GITBOOK-124: V3 FAQ

git-subtree-dir: Synthetix-Gitbook-v3
git-subtree-split: 911ff68d6bda031ef88ae3f24be13632c35e0c98
  • Loading branch information
asolovov committed Nov 22, 2023
1 parent f1267a3 commit 77d697d
Show file tree
Hide file tree
Showing 74 changed files with 49,777 additions and 275 deletions.
11 changes: 10 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

* [Overview](README.md)
* [Development progress](development-progress.md)
* [V3 Frequently Asked Questions (FAQ)](v3-frequently-asked-questions-faq.md)

## For Liquidity Providers

Expand All @@ -24,7 +25,8 @@
## For Derivatives Market Builders

* [Build on v3](for-derivatives-market-builders/build-on-v3.md)
* [Integrating Synthetix](for-derivatives-market-builders/integrating-synthetix.md)
* [Build on v3 FAQ](for-derivatives-market-builders/build-on-v3-faq.md)
* [Operating a Market](for-derivatives-market-builders/integrating-synthetix.md)
* [Registering a Market](for-derivatives-market-builders/registering-a-market.md)

## For Traders
Expand All @@ -37,6 +39,13 @@
* [Synthetix Governance](for-governance-participants/synthetix-governance.md)
* [Elections](for-governance-participants/elections.md)

## FOR PERP INTEGRATORS

* [Perps V3](for-perp-integrators/perps-v3.md)
* [Sandbox with Perps](for-perp-integrators/sandbox-with-perps.md)
* [Base Andromeda](for-perp-integrators/base-andromeda.md)
* [Perps V3 Keeper](for-perp-integrators/perps-v3-keeper.md)

## For Developers

* [Quick Start](for-developers/quick-start.md)
Expand Down
2 changes: 1 addition & 1 deletion development-progress.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Progress of major v3 milestones

# Development progress

<table><thead><tr><th width="234">Component</th><th width="150.33333333333331">Status</th><th>Notes / further reading</th></tr></thead><tbody><tr><td>Core system</td><td>✅ on mainnet</td><td><a href="https://blog.synthetix.io/synthetix-v3-is-on-mainnet/">V3 is on mainnet</a></td></tr><tr><td>v3 stablecoin</td><td>✅ on mainnet</td><td><a data-mention href="for-developers/addresses-+-abis.md">addresses-+-abis.md</a></td></tr><tr><td>Pools</td><td>✅ on mainnet</td><td><a data-mention href="for-liquidity-pool-managers/creating-and-configuring-pools.md">creating-and-configuring-pools.md</a></td></tr><tr><td>Market interface</td><td>✅ on mainnet</td><td><a data-mention href="for-derivatives-market-builders/registering-a-market.md">registering-a-market.md</a></td></tr><tr><td>Spot Market</td><td>✅ on mainnet</td><td><a href="https://blog.synthetix.io/spot-market-v3-alpha-release/">Spot Market Alpha release</a></td></tr><tr><td>Teleporter</td><td>✅ on mainnet</td><td><a href="https://blog.synthetix.io/synthetix-launches-teleporters-with-chainlinks-ccip/">Synthetix launches Teleporters</a></td></tr><tr><td>Crosschain Synthesis</td><td>🚧 in progress</td><td><a href="https://sips.synthetix.io/sips/sip-312/">SIP-312: Cross-chain Pool Synthesis</a></td></tr><tr><td>Perps v3 Market</td><td>🚧 in progress</td><td></td></tr><tr><td>Non-SNX collateral</td><td>❌ not enabled</td><td>Governance could enable as per <a href="https://sips.synthetix.io/sips/sip-302/">SIP-302</a> </td></tr><tr><td>Permissionless Pools</td><td>❌ not enabled</td><td>Governance could enable as per <a href="https://sips.synthetix.io/sips/sip-310/">SIP-310</a></td></tr><tr><td>Permissionless Markets</td><td>❌ not enabled</td><td>Governance could enable as per <a href="https://sips.synthetix.io/sips/sip-310/">SIP-310</a></td></tr></tbody></table>
<table><thead><tr><th width="234">Component</th><th width="150.33333333333331">Status</th><th>Notes / further reading</th></tr></thead><tbody><tr><td>Core system</td><td>✅ on mainnet</td><td><a href="https://blog.synthetix.io/synthetix-v3-is-on-mainnet/">V3 is on mainnet</a></td></tr><tr><td>v3 stablecoin</td><td>✅ on mainnet</td><td><a data-mention href="for-developers/addresses-+-abis.md">addresses-+-abis.md</a></td></tr><tr><td>Pools</td><td>✅ on mainnet</td><td><a data-mention href="for-liquidity-pool-managers/creating-and-configuring-pools.md">creating-and-configuring-pools.md</a></td></tr><tr><td>Market interface</td><td>✅ on mainnet</td><td><a data-mention href="for-derivatives-market-builders/registering-a-market.md">registering-a-market.md</a></td></tr><tr><td>Spot Market</td><td>✅ on mainnet</td><td><a href="https://blog.synthetix.io/spot-market-v3-alpha-release/">Spot Market Alpha release</a></td></tr><tr><td>Teleporter</td><td>✅ on mainnet</td><td><a href="https://blog.synthetix.io/synthetix-launches-teleporters-with-chainlinks-ccip/">Synthetix launches Teleporters</a></td></tr><tr><td>Perps v3 Market</td><td>🚧 in progress</td><td><a href="https://sips.synthetix.io/sips/sip-337/">SIP-337: Perps V3</a></td></tr><tr><td>Launch on new chain</td><td>🚧 in progress</td><td><a href="https://sips.synthetix.io/sips/sip-336/">SIP-336: Deploy Synthetix V3 Core on Base</a></td></tr><tr><td>Non-SNX collateral</td><td>🚧 in progress</td><td><a href="https://github.com/Synthetixio/SIPs/blob/master/content/sips/sip-348.md">SIP-348: Enable USDC for Andromeda on Base </a> </td></tr><tr><td>Crosschain Synthesis</td><td>🚧 in progress</td><td><a href="https://sips.synthetix.io/sips/sip-312/">SIP-312: Cross-chain Pool Synthesis</a></td></tr><tr><td>V2 to V3 Migration</td><td>🚧 in progress</td><td><a href="https://github.com/Synthetixio/SIPs/blob/master/content/sips/sip-306.md">SIP-306: V3 Migration</a><br><a href="https://sips.synthetix.io/sips/sip-323/">SIP-323: Adopt "s" prefix for Synthetix V3 asset tickers</a></td></tr><tr><td>Permissionless Pools</td><td>❌ not enabled</td><td>Governance could enable as per <a href="https://sips.synthetix.io/sips/sip-310/">SIP-310</a></td></tr><tr><td>Permissionless Markets</td><td>❌ not enabled</td><td>Governance could enable as per <a href="https://sips.synthetix.io/sips/sip-310/">SIP-310</a></td></tr></tbody></table>

{% embed url="https://mirror.xyz/cavalier.eth/nOTmVQcole7f0mnqhF93PHO2qbCMm1Y0JAAdiYX9tjU" %}
Further reading on the milestones for v3
Expand Down
30 changes: 30 additions & 0 deletions for-derivatives-market-builders/build-on-v3-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
description: Considerations for creating new products on v3
---

# Build on v3 FAQ

> What all is needed to do this?
[#playbook-for-building-on-v3](build-on-v3.md#playbook-for-building-on-v3 "mention")

> Is a new Pool required?&#x20;
Not necessarily, because existing Pools could choose to delegate some of their collateral to your Market, but you need to convince the Pool owners to do so.

> Is a new Market required?&#x20;
Usually yes. Your Market is what draws on liquidity delegated to it, by existing Pools (or your own Pool if you create one). A profitable Market deposits earnings (and potentially rewards) to the Pools providing liquidity.

> Can a Market swap snxUSD for another assets? (eg WETH)
A Market must conform to the [IMarket](registering-a-market.md) interface, which means it can only deposit/withdraw snxUSD to/from Pools, but is free to interact with the wider defi ecosystem in any reasonable way.

> Can a Market accept another asset directly? (eg WETH)&#x20;
See above

> Can the Market owner impose a fee that incentivizes them?
Market owners are free to decide how their Markets function. Ultimately Markets are judged and compared on their performance (withdrawals and deposits to Pools) over time.

11 changes: 11 additions & 0 deletions for-derivatives-market-builders/build-on-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ An outline of v3, its components and possibilities
The case for building on Synthetix v3
{% endembed %}

{% embed url="https://t.me/+Jwf641J8a6M1ZTI1" %}
Telegram group for integrator discussions
{% endembed %}

## Why build on v3

Synthetix v3 solves the cold-start and scaling liquidity problems for derivate protocols, with more than $500m of liquidity waiting for new markets. Synthetix is an endlessly composable and configurable liquidity layer; backing derivative Markets, so they can scale faster, and LPs can accrue more fees.
Expand Down Expand Up @@ -48,6 +52,13 @@ Your high performing Market will be attractive to other Pools and Synthetix LPs.
* Want to create a novel derivatives product? You could create a v3 Market, then request one of the existing Pools to delegate your Market some collateral, or create a Pool.
* Want to control your own liquidity? You could propose to create a new Pool, and offer additional token incentives to Liquidity Providers with the Rewards Manager.&#x20;

## Next steps

1. Join the integrator telegram group to ask questions&#x20;
2. Follow [Synthetix Integrators](https://twitter.com/i/lists/1677086706246520832) list on X

{% embed url="https://t.me/+Jwf641J8a6M1ZTI1" %}

## Notes

* See [development-progress.md](../development-progress.md "mention") for more details on enabled collateral and other milestones.
8 changes: 1 addition & 7 deletions for-derivatives-market-builders/integrating-synthetix.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
# Integrating Synthetix

Derivatives market implementations can be [registered](registering-a-market.md) with the Synthetix protocol if they conform to the `IMarket` interface. This consists of just three functions:

* `function name(uint128 marketId) external view returns (string memory);` - A function which should return a human-readable name for the given market.
* `function reportedDebt(uint129 marketId) external view returns (uint);` - A function which should return the total value of debt issued by the market (to be collateralized by the assets in the pools backing it), denominated with 18 decimals places.
* `function minimumCredit(uint128 marketId) external view returns (uint);` - A function which returns the amount of credit under which pools cannot rescind credit delegated to the market. This value is dollar-denominated, with 18 decimals places. If the market implementation does not intend to lock collateral, this function can just `return 0;`. **Note that the amount of credit available to a market may still fall below this amount due to price action of the collateral backing it.**
# Operating a Market

## Managing Credit & Debt[](https://snx-v3-docs.vercel.app/pools-markets/integrating-markets#managing-credit--debt) <a href="#managing-credit--debt" id="managing-credit--debt"></a>

Expand Down
6 changes: 6 additions & 0 deletions for-derivatives-market-builders/registering-a-market.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,9 @@ Markets can be integrated with the Synthetix protocol to access credit capacity
Before a market can interact with the protocol, it must be registered using the `registerMarket` function. This function accepts the address of a market, which will be able to integrate with Synthetix (to perform actions like depositing and withdrawing snxUSD) using the ID returned by the function.

Markets cannot be registered unless they conform to the `IMarket` interface. See [Integrating Synthetix](integrating-synthetix.md) for more information on the functions that must be implemented.

Derivatives market implementations can be [registered](registering-a-market.md) with the Synthetix protocol if they conform to the `IMarket` interface. This consists of just three functions:

* `function name(uint128 marketId) external view returns (string memory);` - A function which should return a human-readable name for the given market.
* `function reportedDebt(uint129 marketId) external view returns (uint);` - A function which should return the total value of debt issued by the market (to be collateralized by the assets in the pools backing it), denominated with 18 decimals places.
* `function minimumCredit(uint128 marketId) external view returns (uint);` - A function which returns the amount of credit under which pools cannot rescind credit delegated to the market. This value is dollar-denominated, with 18 decimals places. If the market implementation does not intend to lock collateral, this function can just `return 0;`. **Note that the amount of credit available to a market may still fall below this amount due to price action of the collateral backing it.**
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"address": "0x12aE0D5CD26f212bFE242DA78139d463019f7a73",
"address": "0x47b8f4EC2D0ef7ADfa97927A597d2C73B3A7e81d",
"abi": [
{
"inputs": [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"address": "0x1b791d05E437C78039424749243F5A79E747525e",
"address": "0x6fBe7F0f515C2126638aAF60a351a98b27f62925",
"abi": [
{
"inputs": [
Expand Down
Loading

0 comments on commit 77d697d

Please sign in to comment.