Skip to content

Commit 64eea3d

Browse files
committed
Remove outdated link
1 parent 07cdd90 commit 64eea3d

File tree

3 files changed

+4
-14
lines changed

3 files changed

+4
-14
lines changed

book/build-your-staking-dapp/polygon/methods.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ To build a staking transaction, you will need to specify:
5353
- **slippageBps**: Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint automatically. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
5454
- **minSharesToMint**: Minimum validator shares to receive for slippage protection. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
5555

56-
> **Why is slippage required?** Polygon uses a share-based delegation model where the exchange rate between POL and validator shares fluctuates. The slippage parameter protects against unfavorable rate changes between transaction submission and execution. This is a requirement of the [ValidatorShare contract](https://docs.polygon.technology/pos/reference/contracts/delegation/) itself.
56+
> **Why is slippage required?** Polygon uses a share-based delegation model where the exchange rate between POL and validator shares fluctuates. The slippage parameter protects against unfavorable rate changes between transaction submission and execution. This is a requirement of the ValidatorShare contract itself.
57+
5758
- **referrer**: (Optional) Custom referrer string for tracking. Defaults to `'sdk-chorusone-staking'`.
5859

5960
### Example
@@ -104,7 +105,8 @@ To build an unstaking transaction, you need to specify:
104105
- **slippageBps**: Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn automatically. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
105106
- **maximumSharesToBurn**: Maximum validator shares willing to burn for slippage protection. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
106107

107-
> **Why is slippage required?** Polygon uses a share-based delegation model where the exchange rate between POL and validator shares fluctuates. The slippage parameter protects against unfavorable rate changes between transaction submission and execution. This is a requirement of the [ValidatorShare contract](https://docs.polygon.technology/pos/reference/contracts/delegation/) itself.
108+
> **Why is slippage required?** Polygon uses a share-based delegation model where the exchange rate between POL and validator shares fluctuates. The slippage parameter protects against unfavorable rate changes between transaction submission and execution. This is a requirement of the ValidatorShare contract itself.
109+
108110
- **referrer**: (Optional) Custom referrer string for tracking. Defaults to `'sdk-chorusone-staking'`.
109111

110112
### Example

book/docs/classes/polygon_src.PolygonStaker.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,6 @@ There is no default value. Providing neither or both will throw an error.
145145

146146
Returns a promise that resolves to a Polygon staking transaction
147147

148-
**`See`**
149-
150-
[Delegation via Validator Shares](https://docs.polygon.technology/pos/reference/contracts/delegation/) for details on Polygon's share-based delegation model.
151-
152148
___
153149

154150
## buildUnstakeTx
@@ -181,10 +177,6 @@ There is no default value. Providing neither or both will throw an error.
181177

182178
Returns a promise that resolves to a Polygon unstaking transaction
183179

184-
**`See`**
185-
186-
[Delegation via Validator Shares](https://docs.polygon.technology/pos/reference/contracts/delegation/) for details on Polygon's share-based delegation model.
187-
188180
___
189181

190182
## buildWithdrawTx

packages/polygon/src/staker.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,6 @@ export class PolygonStaker {
143143
* **Slippage requirement:** Exactly one of `slippageBps` or `minSharesToMint` must be provided.
144144
* There is no default value. Providing neither or both will throw an error.
145145
*
146-
* @see {@link https://docs.polygon.technology/pos/reference/contracts/delegation/ | Delegation via Validator Shares} for details on Polygon's share-based delegation model.
147-
*
148146
* @param params - Parameters for building the transaction
149147
* @param params.delegatorAddress - The delegator's Ethereum address
150148
* @param params.validatorShareAddress - The validator's ValidatorShare contract address
@@ -222,8 +220,6 @@ export class PolygonStaker {
222220
* **Slippage requirement:** Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided.
223221
* There is no default value. Providing neither or both will throw an error.
224222
*
225-
* @see {@link https://docs.polygon.technology/pos/reference/contracts/delegation/ | Delegation via Validator Shares} for details on Polygon's share-based delegation model.
226-
*
227223
* @param params - Parameters for building the transaction
228224
* @param params.delegatorAddress - The delegator's address
229225
* @param params.validatorShareAddress - The validator's ValidatorShare contract address

0 commit comments

Comments
 (0)