Migrate developer portal docs #427

calintje · 2024-10-29T16:55:21Z

Migrate developer portal docs

Revised documentation to include details on TE-based position NFTs
Restructured sections to accommodate the new TypeScript SDK documentation
Moved section on TokenExtensions under Account Architecture
Added a sidebar category, "More Resources", to provide access to resources relevant to both the new and legacy TypeScript SDK, including:
- Developer tools
- General documentation previously found under "Interacting with the Protocol"

wjthieme

Haven't looked at the Legacy SDK section yet. If you can confirm that is jus copy-pasta I can skip over it in the review

wjthieme · 2024-10-30T15:29:02Z

docs/whirlpool/docs/02-Architecture Overview/02-Price & Ticks.md

+
+A tick-spacing of 5 means that liquidity can be deposited into tick-index that are a multiple of 5. (ex. [...-10, -5, 0, 5, 10...]).
+
+Whirlpool supports a tick-spacing between 1 and 256, preferably a value that is a power of 2 for better compute-budget optimization. 


This is not enforced by the contract iirc. Might consider removing this

wjthieme · 2024-10-30T15:31:39Z

docs/whirlpool/docs/02-Architecture Overview/02-Price & Ticks.md

+A low tick-spacing pool undergoing a massive price movement may require multiple swap instructions to complete the price movement. Therefore, more volatile pairs that often has large price swings should look at higher tick-spacing to mitigate this pain point for their pool users.
+
+### 3. Account rent cost for users
+On Solana, accounting information requires account space. The more information a program hosts, the more rent is required to store. The larger the tick-spacing, the less ticks it needs for the program to keep track of liquidity across a set price range. Subsequently, the less money it takes to rent space on Solana.


"accounting information"? Maybe something like "On Solana, storing data on-chain requires account space" or idk that sounds weird too because it is saying the same thing.

To me, "accounting information" sounds like some bookkeeping stuff or something

Also on Solana maybe we can just change to on chain or something since we are not limited to solana anymore

wjthieme · 2024-10-30T15:34:27Z

docs/whirlpool/docs/02-Architecture Overview/03-Understanding Tick Arrays.md

+- Account Size - 10kb
+
+## Usage in Whirlpool Program Instructions
+When you interact with ticks on Whirlpool instructions, often you will need to derive the correct tick-array so the program can get access to the designated tick object.


What is the purpose of this paragraph? Feels like it is missing something. Maybe the explanation on how to derive said tick-array?

i.e. I how do I know which tick-array a certain tick index is in. But then again that is also explained already in the pragraph above

wjthieme · 2024-10-30T15:35:37Z

docs/whirlpool/docs/02-Architecture Overview/03-Understanding Tick Arrays.md

+When you interact with ticks on Whirlpool instructions, often you will need to derive the correct tick-array so the program can get access to the designated tick object.
+
+### Open Position
+A position opening up in a brand new tick/price area would need to initialize the tick-array prior to creating the position. This means the user who invoke that position would have to pay for the rent-exempt cost (tick-array accounts are 10kb).


This reads a little bit weird.

When a position is opened in a brand new tick/price area...

This means the user who opened that position would...

wjthieme · 2024-10-30T15:36:13Z

docs/whirlpool/docs/02-Architecture Overview/03-Understanding Tick Arrays.md

+### Open Position
+A position opening up in a brand new tick/price area would need to initialize the tick-array prior to creating the position. This means the user who invoke that position would have to pay for the rent-exempt cost (tick-array accounts are 10kb).
+
+Whirlpool owners can consider preemptively initializing tick-array ranges to avoid user surprises. Once the tick-array account is setup, it will never have to be reinitialized.


Maybe also add that it cannot be closed along with that it does not need to be reinitialized

wjthieme · 2024-10-30T16:32:16Z

docs/whirlpool/docs/05-More Resources/01-A Note for Rust Devs.mdx

@@ -0,0 +1,21 @@
+import DocCard from '@theme/DocCard';
+
+# A Note for Rust Developers


Is this page still necessary since we have rust SDKs now? Guess this is fine for now but can you create a ticket for this?

wjthieme · 2024-10-30T16:34:16Z

docs/whirlpool/docs/05-More Resources/04-API.mdx

+---
+sidebar-label: API
+---
+import DocCard from '@theme/DocCard';


Same as with the Rust SDK section. I guess this is fine for now but we should probably make this it's own section in the docs with public api v2? Can you create a ticket for this?

wjthieme · 2024-10-30T16:36:07Z

docs/whirlpool/docs/05-More Resources/08-Interact via CPI.mdx

@@ -0,0 +1,28 @@
+import DocCard from '@theme/DocCard';
+
+# Interact via CPI


We should probably remove this (or add it to Legacy SDK) in favor of orca_whirlpools_client from our rust sdk. Ticket?

wjthieme · 2024-10-30T16:38:38Z

docs/whirlpool/docusaurus.config.js

@@ -38,6 +41,16 @@ export default {
    ],
  ],

+  stylesheets: [
+    {
+      href: 'https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css',


Do we want to have a cdn link? Is it also in the rehype-katex package? If so we can reference that in node_modules. I see it has a checksum which would prevent any remote modification I guess so not strictly necessary

I can't seem to find it. I could copy the css code in docs/whirlpool/static/katex.min.css. What do you think?

wjthieme · 2024-10-30T16:39:00Z

docs/whirlpool/package.json

@@ -14,7 +14,9 @@
    "clsx": "^2.1.1",
    "prism-react-renderer": "^2.4.0",
    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "react-dom": "^18.3.1",
+    "rehype-katex": "7",


Better to specify full version. e.g. ^7.x.x

wjthieme

LGTM 🚀

wjthieme · 2024-10-31T13:09:34Z

docs/whirlpool/docs/02-Architecture Overview/07-TokenExtensions Support.md

-
-> ℹ️ Now Orca UI doesn't show whirlpools with TokenExtensions, so it is "contract level" support only at the moment.
-The only exception is PYUSD, which is supported in the UI.
+On May 28th, Whirlpool program has been upgraded to support TokenExtensions (aka Token-2022 program).


Maybe it still needs the year (2024). Same goes for the InterestBearing

wjthieme · 2024-10-31T13:12:35Z

docs/whirlpool/package.json

@@ -15,8 +15,8 @@
    "prism-react-renderer": "^2.4.0",
    "react": "^18.3.1",
    "react-dom": "^18.3.1",
-    "rehype-katex": "7",
-    "remark-math": "6"
+    "rehype-katex": "7.0.1",


I would do "^7.0.1" instead of just "7.0.1". I believe it signifies Any version that is backwards-compatible with this version

Co-authored-by: calintje <[email protected]>

…orca-so/whirlpools into calintje/migrate-developer-docs

yugure-orca · 2024-11-01T03:46:35Z

Sorry I know 01-Welcome.mdx is not updated in this PR.

The Whirlpools Program is also a program. It can create new data accounts if you instruct it to, and even set you as the owner of those accounts. Accounts that you can own include Splash Pools, Concentrated Liquidity Pools, and liquidity positions. For these accounts, you'll pay rent. But here's the good part: this is no ordinary rent—you get the full rent back if you decide to close the account! You only pay the transaction costs on the Solana network, which, as you may know, are very low. You can also instruct the program to swap tokens against one of the many liquidity pools that hold the tokens you'd like to trade.

I was a bit confused this part: and even set you as the owner of those accounts. .
If "those accounts" are Whirlpool, Position, TickArray ... accounts, its owner is Whirlpool Program.
User will be owner (not owner program) of token account and it means they own authority of position NFT, but account's owner program will be Whirlpool Program or Token Program.

I think the description of rent in this section is too early for beginners. The description of the TE based position NFT that rent comes back at this stage may make them confused. This is because Whirlpool and TickArray cannot be closed and they require more rent.

yugure-orca

Thanks for the migration!

yugure-orca · 2024-11-01T04:06:06Z

docs/whirlpool/docs/02-Architecture Overview/03-Understanding Tick Arrays.md

+### Swap
+Swap users will have to provide the series of tick-arrays that the swap will traverse across.
+
+The first tick-array in the sequence typically houses the Whirlpool's current tick index, though this is not always required. In some cases, such as with the new swap instruction, users can pass in up to six tick-arrays, with only three arrays being crossed during a swap. For example, the Whirlpools SDK preemptively provides the tick-array containing the current price, along with two arrays below and two above it, ensuring adequate coverage for different price ranges.


nit: How about moving In some cases, ... ensuring adequate coverage for different price ranges. to after The second and third tick ... tick-array public key..

In this sentence, I think we explain about "first tick-array". So current description flow looks the following to me.

first tick array

Sparse swap improvement

second and thirt tick array

yugure-orca · 2024-11-01T04:13:30Z

docs/whirlpool/docs/02-Architecture Overview/04-Tokenized Positions.md

+- Position tokens can be freely transferred. Whoever holds the token in their wallet has the authority to manage the position account, allowing them to increase or decrease liquidity, harvest fees, and close the position.
+
+## NFT Metadata
+Whirlpools utilizes the Token2022 program for position NFTs, leveraging the MetadataPointer and TokenMetadata extensions to eliminate the need for Metaplex metadata accounts and associated costs. Advanced users can also choose to exclude metadata entirely.


I think to eliminate ... associated costs part can be replaced with to make all rent refundable. 🙂
non-refundable rent is really pain for LPer 😢

yugure-orca · 2024-11-01T04:30:30Z

docs/whirlpool/docs/03-Whirlpools SDK/01-Environment Setup.md

@@ -32,7 +32,7 @@ Initialize the project as a TypeScript project:
 npx tsc --init
 ```

-## 3. Wallet Creation
+## 2. Wallet Creation

 You can create a wallet using `generateKeyPairSigner()` from the Solana SDK.


hmm, how about generating wallet.json and reading it.
This is why this wallet is not persistent and will be lost when the script completed.

I initially used wallet.json, but after review, switched to this simpler approach to keep the code concise. The conclusion was that persistent storage fits better in example projects, where configuration can be fully demonstrated. Let me know if you'd like changes—happy to adjust!

Updated with an example using createKeyPairSignerFromBytes()

yugure-orca · 2024-11-01T05:51:32Z

docs/whirlpool/docs/04-Legacy SDK/01-Basic Usage/01-Setup Whirlpool Context.md

+```
+
+```tsx
+const connection = new Connection(url, "singleGossip");


nit: commitment level "confirmed"

Migrate developer portal docs. Add minor updates.

56a182e

calintje requested review from yugure-orca, wjthieme and odcheung as code owners October 29, 2024 16:55

Fix build

07c37be

wjthieme reviewed Oct 30, 2024

View reviewed changes

Resolve comments

4532b1f

calintje requested a review from wjthieme October 31, 2024 12:17

wjthieme approved these changes Oct 31, 2024

View reviewed changes

calintje and others added 6 commits October 31, 2024 15:51

Add explainer on setWhirlpoolsConfig (#439)

e34cdc5

Co-authored-by: calintje <[email protected]>

Resolve comments

00e28b8

Merge branch 'main' into calintje/migrate-developer-docs

04933a7

Fix yarn.lock

50fa063

Merge branch 'calintje/migrate-developer-docs' of https://github.com/…

6729086

…orca-so/whirlpools into calintje/migrate-developer-docs

Fix yarn.lock

e7f67b4

yugure-orca approved these changes Nov 1, 2024

View reviewed changes

calintje added 5 commits November 1, 2024 10:49

Merge branch 'main' into calintje/migrate-developer-docs

242b7ad

Fix yarn.lock. Resolve comments

596b103

Resolve comment

81c304b

Resolve comments

2e4eb74

Update wallet creation example

65f9722

calintje merged commit 35689a9 into main Nov 1, 2024
5 checks passed

calintje deleted the calintje/migrate-developer-docs branch November 1, 2024 17:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate developer portal docs #427

Migrate developer portal docs #427

calintje commented Oct 29, 2024

wjthieme left a comment

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

wjthieme Oct 30, 2024

calintje Oct 31, 2024 •

edited

Loading

wjthieme Oct 30, 2024

wjthieme left a comment

wjthieme Oct 31, 2024

wjthieme Oct 31, 2024

yugure-orca commented Nov 1, 2024

yugure-orca left a comment

yugure-orca Nov 1, 2024

yugure-orca Nov 1, 2024 •

edited

Loading

yugure-orca Nov 1, 2024

calintje Nov 1, 2024

calintje Nov 1, 2024

yugure-orca Nov 1, 2024


		A tick-spacing of 5 means that liquidity can be deposited into tick-index that are a multiple of 5. (ex. [...-10, -5, 0, 5, 10...]).

		Whirlpool supports a tick-spacing between 1 and 256, preferably a value that is a power of 2 for better compute-budget optimization.

		@@ -0,0 +1,21 @@
		import DocCard from '@theme/DocCard';

		# A Note for Rust Developers

		@@ -0,0 +1,28 @@
		import DocCard from '@theme/DocCard';

		# Interact via CPI

Migrate developer portal docs #427

Migrate developer portal docs #427

Conversation

calintje commented Oct 29, 2024

wjthieme left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

calintje Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wjthieme left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yugure-orca commented Nov 1, 2024

yugure-orca left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yugure-orca Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

calintje Oct 31, 2024 •

edited

Loading

yugure-orca Nov 1, 2024 •

edited

Loading