Merge pull request #159 from mkflow27/main

`userData` clarification for joins & exits
balancer · Oct 25, 2023 · 8807731 · 8807731 · vercel · Oct 25, 2023
2 parents 15813e3 + 1d9e766
commit 8807731
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/reference/joins-and-exits/pool-exits.md b/docs/reference/joins-and-exits/pool-exits.md
@@ -52,6 +52,9 @@ Let's say that you want to allow a 1% slippage. After computing how many tokens
 ### `userData`
 
 userData is a highly versatile field; as such, it needs to be encoded for its specific use case. For exits, userData encodes a `ExitKind` to tell the pool what style of exit you're performing. Since pool types are customizable, not every pool necessarily uses the same `ExitKind`, so it's important to keep track of what each pool type can handle.
+::: info 
+When encoding `userData` for pools that include their own BPT as part of the pool's tokens, the BPT are not included in the `userData`.
+:::
 
 #### WeightedPool ExitKinds
 

diff --git a/docs/reference/joins-and-exits/pool-joins.md b/docs/reference/joins-and-exits/pool-joins.md
@@ -52,6 +52,9 @@ Let's say that you want to allow a 1% slippage. After computing how many tokens
 ### `userData`
 
 userData is a highly versatile field; as such, it needs to be encoded for its specific use case. For joins, userData encodes a `JoinKind` to tell the pool what style of join you're performing. Not every pool uses every `JoinKind`, so it's important to keep track of what each pool type can handle.
+::: info 
+When encoding `userData` for pools that include their own BPT as part of the pool's tokens, the BPT are not included in the `userData`, except for `INIT` joins where they need to be included.
+:::
 
 #### WeightedPool JoinKinds