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

feat(docs): Update terminology and fix links across documentation #131

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
6 changes: 3 additions & 3 deletions docs/Developers/Oracles/IntroductionOfPtOracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ hide_table_of_contents: true

# Introduction of PT Oracle

In Pendle system, $PT$ can be freely traded from and to $SY$ ultilizing our AMM. With the built-in TWAP oracle library, the geometric mean price of $PT$ in terms of SY or asset can be derived from our `PendleMarket` contracts fully on-chain. Please refer to the [StandardizedYield doc](../Contracts/StandardizedYield) for more details of SY & asset
In Pendle system, $PT$ can be freely traded from and to $SY$ utilizing our AMM. With the built-in TWAP oracle library, the geometric mean price of $PT$ in terms of SY or asset can be derived from our `PendleMarket` contracts fully on-chain. Please refer to the [StandardizedYield doc](../Contracts/StandardizedYield) for more details of SY & asset
## Oracle design

Pendle's oracle implementation is inspired from the idea of UniswapV3 Oracle (see [here](https://docs.uniswap.org/concepts/protocol/oracle)) with a slight difference in how we define the cumulative rate. In short, our oracle stores the cumulative logarithm of implied APY (the interest rate implied by $PT/asset$ pricing). From the cumulative logarithm of Implied APY, we can calculate the geometric mean of Implied APY, which will used to derive the mean $PT$ price.
Pendle's oracle implementation is inspired from the idea of UniswapV3 Oracle (see [here](https://docs.uniswap.org/concepts/protocol/oracle)) with a slight difference in how we define the cumulative rate. In short, our oracle stores the cumulative logarithm of implied APY (the interest rate implied by $PT/asset$ pricing). From the cumulative logarithm of Implied APY, we can calculate the geometric mean of Implied APY, which will be used to derive the mean $PT$ price.

In a way, the Pendle AMM contract has a built-in oracle of interest rate, which can used to derive $PT$ prices.
In a way, the Pendle AMM contract has a built-in oracle of interest rate, which can be used to derive $PT$ prices.
### Formulas

Our oracle storage is in the following form:
Expand Down
2 changes: 1 addition & 1 deletion docs/Developers/Oracles/LPAsCollateral.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This use case is similar to depositing a yield bearing asset like wstETH and bor
### 3. Oracle exploit:
* If the oracle for LP price is easily manipulated or exploited, LP price could inflate unnaturally (leading to an attack of using over-priced LP to borrow, and get away with free money leading to bad protocol debt after LP price drops sharply after), or drops sharply (leading to bad debt for the protocol)
* Assessment:
* Pendle's oracle for LP/asset builds on top of the PT/asset oracle. The PT/asset oracle is permissionless and built into the contract (no maintanance needed), hence liveness and correctness is not a concern.
* Pendle's oracle for LP/asset builds on top of the PT/asset oracle. The PT/asset oracle is permissionless and built into the contract (no maintenance needed), hence liveness and correctness is not a concern.
* The LP/asset oracle returns TWAP prices for any customisable duration (within 65536 blocks, which is ~9 days for Ethereum), hence is not susceptible to short term or within-a-block manipulation of prices if the TWAP duration used is sufficient.
* **Important note**:
* You should only use the current LP oracle is the `SY` contract doesn't have a callback function. If the `SY` contract has a callback function, it is technically possible for the oracle to return an incorrect LP price, if it's called inside a SY's callback function.
Expand Down
2 changes: 1 addition & 1 deletion docs/Developers/UncategorisedQuestions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
hide_table_of_contents: true
---
# Uncategorised questions
# Uncategorized questions

**This document is being iterated on rapidly due to incoming questions from partner protocols.** 
## Router
Expand Down
2 changes: 1 addition & 1 deletion docs/PrivacyPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Most of the services available on this platform are aimed at people aged 18 and

## Social Media

We maintain online presences on [Twitter](https://twitter.com/en/privacy), [Medium](https://policy.medium.com/medium-privacy-policy-f03bf92035c9), [Discord](https://discord.com/privacy), [Telegram](https://telegram.org/privacy) in order to be able to communicate with users active there and to inform them about our services there. When calling up the respective networks and platforms, the terms and conditions and data processing policies of their respective operators apply.
We maintain online presences on [X](https://x.com/en/privacy), [Medium](https://policy.medium.com/medium-privacy-policy-f03bf92035c9), [Discord](https://discord.com/privacy), [Telegram](https://telegram.org/privacy) in order to be able to communicate with users active there and to inform them about our services there. When calling up the respective networks and platforms, the terms and conditions and data processing policies of their respective operators apply.

## Obligation to provide data

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ const config = {
href: 'https://discord.gg/qshFxh6965/',
},
{
label: 'Twitter',
href: 'https://twitter.com/pendle_fi/',
label: 'X',
href: 'https://x.com/pendle_fi/',
},
{
label: 'Telegram',
Expand Down
4 changes: 2 additions & 2 deletions i18n/cn/docusaurus-theme-classic/footer.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"description": "The label of footer link with label=Discord linking to https://discord.gg/qshFxh6965/"
},
"link.item.label.Twitter": {
"message": "Twitter",
"description": "The label of footer link with label=Twitter linking to https://twitter.com/pendle_fi/"
"message": "X",
"description": "The label of footer link with label=X linking to https://x.com/pendle_fi/"
},
"link.item.label.Telegram": {
"message": "Telegram",
Expand Down
4 changes: 2 additions & 2 deletions src/theme/Footer/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ function Footer() {
<a href="https://discord.com/invite/EAujvncY2R" target="_blank">
Discord
</a>
<a href="https://twitter.com/pendle_fi/" target="_blank">
Twitter
<a href="https://x.com/pendle_fi/" target="_blank">
X (ex-Twitter)
</a>
<a href="https://t.me/pendlefinance/" target="_blank">
Telegram
Expand Down