Enhance API Reference - Documentation improvements #410
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
frol
requested changes
Sep 30, 2024
| @@ -123,7 +123,7 @@ export class FungibleToken implements FungibleTokenCore, StorageManagement, Fung | |||
| // Get the unused amount from the `ft_on_transfer` call result. | |||
| let unused_amount: Balance; | |||
| try { | |||
| const promise_result = near.promiseResult(0).replace(/"*/g, ''); //TODO: why promiseResult returnes result with brackets? | |||
| const promise_result = near.promiseResult(0).replace(/"*/g, ''); //TODO: why promiseResult returns result with brackets? | |||
There was a problem hiding this comment.
FT standard defined the encoding for the input/outputs as JSON. Since JSON does not support big integers, the FT standard uses a string type to pass the unused_amount. It would be cleaner to use JSON.parse() instead of manually "parsing" quotes out.
There was a problem hiding this comment.
@frol, this is out of this PR's scope, would be better in a separate PR
Comment on lines
21
to
29
| * @call({}) | ||
| * ft_on_transfer({ sender_id, amount, msg }: { | ||
| sender_id: AccountId; | ||
| amount: number; | ||
| msg: String; | ||
| }): PromiseOrValue<number> { | ||
| return this.token.ft_on_transfer({ sender_id, amount, msg }); | ||
| }; | ||
| * } |
There was a problem hiding this comment.
Formatting is broken here, and in a few other places in the doc string examples. Please, fix them
Comment on lines
10
to
14
| * import { | ||
| FungibleTokenCore, | ||
| FungibleTokenResolver, | ||
| FungibleToken, | ||
| * } from "near-contract-standards/lib" |
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.
Pre-flight checklist
Motivation
Test Plan
Related issues/PRs