Skip to content

Update documentation with secure examples #540

@nkavian

Description

@nkavian

Problem

When reading this documentation, it causally uses PrivateKeys as if that's what's required.

For example, I've already had to explain to my team they can't copy and paste that example verbatim, and they need to use public keys.

Solution

First, the documentation should explicitly have a comment to tell developers that they should not have the privateKeys themselves, and this example is just for illustrative purposes to create and and use publicKeys.

Second, right after creating the privateKeys, create the publicKeys explicitly and show people they can use the publicKeys to create a threshold wallet.

Lastly, please help close this discussion (if it's untrue) or dramatically update your GitHub and GitBook (this and this) documentation (if it's true). That discussion creates some really frustrating stress if it's true.

Alternatives

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions