Skip to content

Commit 6bdbd68

Browse files
authored
Correct typo in Docs (#945)
1 parent d014eac commit 6bdbd68

File tree

4 files changed

+13
-8
lines changed

4 files changed

+13
-8
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@orca-so/whirlpools-docs": patch
3+
---
4+
5+
Documentation update only. No release required.

docs/whirlpool/docs/02-Architecture Overview/01-Account Architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## WhirlpoolsConfig
88

9-
The owner of a Config account has the authority to define the many authorities over the pools that it owns (ex. default fees, collect protocol fees etc) . Whirlpools visible on the ORCA UI are all derived and controlled by a WhirlpoolsConfig account owned by the ORCA foundation. To learn more about managing pools, start [here](../03-SDKs/03-Whirlpool%20Management/01-Create%20Pool.mdx).
9+
The owner of a Config account has the authority to define the many authorities over the pools that it owns (ex. default fees, collect protocol fees etc.). Whirlpools visible on the ORCA UI are all derived and controlled by a WhirlpoolsConfig account owned by the ORCA foundation. To learn more about managing pools, start [here](../03-SDKs/03-Whirlpool%20Management/01-Create%20Pool.mdx).
1010

1111
Users and other protocols are free to deploy their own WhirlpoolsConfig account on our Whirlpool program to spawn their own set of liquidity pools.
1212

@@ -31,11 +31,11 @@ Users are able to perform position management and fee/reward collection operatio
3131

3232
## TickArray
3333

34-
To learn about TickArry, read [Understanding Tick Arrays](./03-Understanding%20Tick%20Arrays.md)
34+
To learn about TickArray, read [Understanding Tick Arrays](./03-Understanding%20Tick%20Arrays.md)
3535

3636
## Position
3737

38-
Positions represents a set of liquidity distributed on a price range within a single Whirlpool. To learn more, read [Tokenized Positions](./04-Tokenized%20Positions.md)
38+
Positions represent a set of liquidity distributed on a price range within a single Whirlpool. To learn more, read [Tokenized Positions](./04-Tokenized%20Positions.md)
3939

4040
## PositionBundle
4141

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ To clarify the context of accounts passed as `remaining_accounts`, the v2 instru
133133
#### Security notes
134134
- In solana, indirect re-entrance will be rejected. So transfer hook program cannot call Whirlpool program.
135135
- TransferHook program cannot modify transfer amount. It will be called AFTER token transfer processing.
136-
- Token-2022 program remove signer and writable flag of the source, destination and owner when calling the TransferHo[ok program even if they are passed as extra accounts. The source and destination are not updated and the owner's signature is not used unintentionally.
136+
- Token-2022 program remove signer and writable flag of the source, destination and owner when calling the TransferHook program even if they are passed as extra accounts. The source and destination are not updated and the owner's signature is not used unintentionally.
137137

138138
#### TokenBadge request
139139
The TransferHook extension is a relatively new feature in the ecosystem, and its use cases are still being explored.
@@ -149,4 +149,4 @@ While it’s still undecided which types of TransferHook tokens will be eligible
149149
- Extensions that block transactions based on the amount of tokens to be transferred are undesirable because they cause transactions to fail in ways that are surprising to pool users. On the other hand, failing transfers to sanctioned wallets according to some public standard will not obstruct pool usage for many users.
150150
- TransferHook must not request large numbers of accounts that would increase transaction size.
151151
- TransferHook should not attempt any token transfers (including WSOL and native SOL).
152-
- TransferHook should not attempt imposing any kind of additional fees.
152+
- TransferHook should not attempt imposing any kind of additional fees.

docs/whirlpool/docs/03-SDKs/01-Overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ What follows is an overview of our SDK suite, distinguishing between the various
1818
The High-Level SDKs are our top recommendation for anyone who wants to integrate with the Whirlpool Program. These SDKs abstract many of the underlying complexities, such as tick array management, and makes managing pools and positions, and executing swaps much simpler. It is suitable for developers who need efficient, high-level functionalities and want to minimize manual configuration and management.
1919

2020
- **Rust**: [orca_whirlpools](https://crates.io/crates/orca_whirlpools)
21-
- Compatible with Solana SDK versions `^1.18.0` but `<3.0.0`. By default, Cargo will install the latest version of Solana SDK `^v2`. This can cause dependcy issues when using older versions. To solve this you can apply a lockfile patch with the following command:
21+
- Compatible with Solana SDK versions `^1.18.0` but `<3.0.0`. By default, Cargo will install the latest version of Solana SDK `^v2`. This can cause dependency issues when using older versions. To solve this you can apply a lockfile patch with the following command:
2222
```bash
2323
cargo update solana-program:<current-version> --precise <required-version>
2424
```
@@ -35,7 +35,7 @@ The Core SDKs provide essential utilities for **math operations** and **quotes**
3535
- **Rust**: [orca_whirlpools_core](https://crates.io/crates/orca_whirlpools_core)
3636
- **TypeScript Kit**: [@orca-so/whirlpools-core](https://www.npmjs.com/package/@orca-so/whirlpools-core)
3737
- **TypeScript Legacy**: [@orca-so/whirlpools-sdk](https://www.npmjs.com/package/@orca-so/whirlpools-sdk)
38-
- The Legacy SDK has has separate utility classes for certain math operations such as `PoolUtil`, `TickUtil`, `TickArrayUtil`, and `SwapUtils`. For quotes, there are separate functions exported, such as `decreaseLiquidityQuoteByLiquidity`, `increaseLiquidityQuoteByInputToken`, `swapQuoteByInputToken`, `collectFeesQuote`, `collectRewardsQuote`, and more. Check out the reference docs in the navbor for more details.
38+
- The Legacy SDK has separate utility classes for certain math operations such as `PoolUtil`, `TickUtil`, `TickArrayUtil`, and `SwapUtils`. For quotes, there are separate functions exported, such as `decreaseLiquidityQuoteByLiquidity`, `increaseLiquidityQuoteByInputToken`, `swapQuoteByInputToken`, `collectFeesQuote`, `collectRewardsQuote`, and more. Check out the reference docs in the navbor for more details.
3939

4040
## 3. Low-Level SDKs
4141

@@ -46,7 +46,7 @@ This SDK provides direct program interactions and is designed for developers who
4646
```bash
4747
cargo update anchor:<current-version> --precise 0.29
4848
```
49-
- Compatible with `solana-program` versions `^1.18.0` but `<3.0.0`. By default, Cargo will install the latest version of Solana SDK `^v2`. This can cause dependcy issues when using older versions. To solve this you can apply a lockfile patch with the following command:
49+
- Compatible with `solana-program` versions `^1.18.0` but `<3.0.0`. By default, Cargo will install the latest version of Solana SDK `^v2`. This can cause dependency issues when using older versions. To solve this you can apply a lockfile patch with the following command:
5050
```bash
5151
cargo update solana-program:<current-version> --precise <required-version>
5252
```

0 commit comments

Comments
 (0)