1169: Add documentation data #7
Conversation
| const [walletAddress] = await pufferClient.requestAddresses(); | ||
| ``` | ||
|
|
||
| With the wallet address at hand, make the transacation. |
There was a problem hiding this comment.
Fix in next PR. Thanks for the catch.
| } from '@pufferfinance/puffer-sdk'; | ||
|
|
||
| // highlight-start | ||
| const walletClient = PufferClientHelpers.createWalletClient({ |
There was a problem hiding this comment.
we should enlist, or add a link to another doc of supported inputs here.
createWalletClient function definition would also be ideal.
There was a problem hiding this comment.
createWalletClient function definition would also be ideal.
The name overlaps with viem's function, so I thought it might be better to have it inside a class kind of like a namespace to avoid confusion.
Our function here gives a more simpler interface to create a wallet. Which is to use either RPC URLs or the JSON-RPC API (window.ethereum). It's possible with viem but it's not as much intuitive since it's a low-level library.
| ### 3. Interact with the Contract | ||
|
|
||
| ```ts | ||
| const { transact, estimate } = pufferClient.depositETH(walletAddress); |
There was a problem hiding this comment.
similar comment, somewhere we should document what depositETH returns, and what other functions can we call using pufferClient
There was a problem hiding this comment.
This is coming as part of the API reference documentation in the next PR.
| @@ -0,0 +1,40 @@ | |||
| --- | |||
There was a problem hiding this comment.
If we're going the guides route, there should be multiple examples.
There was a problem hiding this comment.
Right now, we only have the depositETH method which only does either a transaction or an estimate. Will add more once the SDK has more functionality.
No description provided.