Skip to content

Commit

Permalink
Update keyring_exportAccount (#1556)
Browse files Browse the repository at this point in the history
* update keyring_exportAccount

* add space for admonition to make consistent with rest of docs

---------

Co-authored-by: Joan E <[email protected]>
  • Loading branch information
alexandratran and joaniefromtheblock authored Sep 18, 2024
1 parent 0cd1786 commit 96cc0f7
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions snaps/reference/keyring-api/account-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,16 @@ null

### `keyring_exportAccount`

Exports the private key of an account managed by the Snap.
A Snap might choose to not support this method.
Exports account data managed by the Snap.
This might include the public key, address, or derivation path.
The exact data exported depends on the Snap's implementation and security considerations.
A Snap might choose to not support this method or limit the data it exports.

:::warning

This method can export private keys or any other sensitive data.

:::

#### Parameters

Expand All @@ -124,9 +132,7 @@ An object containing:

#### Returns

An object containing:

- `privateKey`: `string` - The account's private key.
An object containing the account data.

#### Example

Expand Down

0 comments on commit 96cc0f7

Please sign in to comment.