Skip to content

TokenClient burn / burn_from functions do not document panic cases #1808

@jsmaxi

Description

@jsmaxi

The burn and burn_from functions in TokenClient lack documentation about when they will panic. I believe, these functions will panic and revert the tx if the account has insufficient balance, if authorization is missing, or if the amount is invalid (<=0).

Currently the documentation only describes the basic functionality but does not mention any panic/error conditions.

The same may apply to some other token client functions.

https://github.com/stellar/rs-soroban-sdk/blob/07384526b8b052905a27c145a9c972922739106f/soroban-sdk/src/token.rs

https://docs.rs/soroban-sdk/latest/soroban_sdk/token/struct.TokenClient.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions