DRAFT: TS SDK VC docs #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dovgopoly
reviewed
Dec 17, 2024
| --- | ||
|
|
||
| import { Callout, Steps, Tabs } from 'nextra/components' | ||
| import Link from 'next/link' |
There was a problem hiding this comment.
Do you need these imports (except Callout)?
| const userVeiledBalance = await aptos.veiledCoin.getBalance({ accountAddress: user.accountAddress, tokenAddress: TOKEN_ADDRESS }); | ||
| ``` | ||
|
|
||
| This method returns you user's [`pending` and `actual`](/en/build/smart-contracts/veiled-coin#veiled-coin-store) veiled balances, to [decrypt](/en/build/smart-contracts/veiled-coin#encryption-and-decryption) them, you can use `VeiledAmount` class |
There was a problem hiding this comment.
Can we rename VeiledAmount to VeiledBalace for consistency?
| return { | ||
| pending: { | ||
| amount: veiledAmountPending.amount, | ||
| amountChunked: veiledAmountPending.amountChunked, |
There was a problem hiding this comment.
Please, leave small comments here what are amountChunked and amountEncrypted
| And you can do that, by using `aptos.veiledCoin.rolloverPendingBalance`. | ||
|
|
||
| <Callout type="warning"> | ||
| Important note, that user's actual balance need to be [normalized](/en/build/smart-contracts/veiled-coin#normalization) before `rollover` operation. |
There was a problem hiding this comment.
The contract will revert if you try to normalize the normalized balance.
|
|
||
| Usually you don't need to explicit call [normalization](/en/build/smart-contracts/veiled-coin#normalization-1) | ||
|
|
||
| But in case you want to: |
There was a problem hiding this comment.
"In case you want to" -
The explicit normalization is needed only before the rollover. So, maybe we can move this to the rollover section?
| const txReceipt = await aptos.waitForTransaction({ transactionHash: txResponse.hash }); | ||
| ``` | ||
|
|
||
| ### Recovery |
There was a problem hiding this comment.
Let's call it key rotation, "recovery" term is not obvious here.
|
|
||
| --- | ||
|
|
||
| ### Some useful functions |
Co-authored-by: dovgopoly <[email protected]>
Co-authored-by: dovgopoly <[email protected]>
Co-authored-by: dovgopoly <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist
pnpm spellcheck?pnpm fmt?pnpm lint?