Skip to content

All contract clients should include documentation stating that they can panic #1612

@leighmcculloch

Description

@leighmcculloch

All contract clients should include documentation stating that they can panic if the contract returns an error or panics itself.

And all contract client try_ functions should include documentation stating that they will not panic but return errors, even if the calling contract panics, the panic will be caught into an error.

This in part would address the issue raised in https://github.com/stellar/rs-soroban-sdk/issues/1611. The message will not say why the panic could occur, or discuss what errors are possible, but would just generically state a panic could occur.

cc @jsmaxi

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