Skip to content

Commit 08bff57

Browse files
Update descriptions for snap entropy methods (#1945)
1 parent 627de49 commit 08bff57

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

snaps/reference/snaps-api.md

+22-7
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,14 @@ You're managing the user's keys and assets on their behalf.
103103
Their safety is your responsibility.
104104
:::
105105

106-
Gets the [SLIP-10](https://github.com/satoshilabs/slips/blob/master/slip-0010.md) key for the `path`
107-
and `curve` specified by the method name.
106+
Enables you to [manage users' non-EVM accounts](../features/non-evm-networks.md) by deriving
107+
the [SLIP-10](https://github.com/satoshilabs/slips/blob/master/slip-0010.md) keys
108+
specified by the `path` and `curve` parameters.
109+
The keys are derived using the entropy from the user's Secret Recovery Phrase.
110+
111+
If the keys you want to derive conform to the [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) structure,
112+
use [`snap_getBip44Entropy`](#snap_getbip44entropy) instead.
113+
Otherwise, use this method.
108114

109115
This method is designed to be used with the
110116
[`@metamask/key-tree`](https://npmjs.com/package/@metamask/key-tree) module.
@@ -252,10 +258,19 @@ You're managing the user's keys and assets on their behalf.
252258
Their safety is your responsibility.
253259
:::
254260

255-
Gets the [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) `coin_type` key
256-
for the `coin_type` number specified by the method name.
261+
Enables you to [manage users' non-EVM accounts](../features/non-evm-networks.md) by deriving
262+
the [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) keys
263+
specified by the `coinType` parameter.
264+
The keys are derived using the entropy from the user's Secret Recovery Phrase.
265+
266+
If the keys you want to derive don't conform to the BIP-44 structure, use
267+
[`snap_getBip32Entropy`](#snap_getbip32entropy) instead.
268+
269+
:::note
257270
See [SLIP-44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md) for the list of
258-
available protocols and their `coin_type` values.
271+
available protocols and their coin types.
272+
To register a new coin type, create a pull request on SLIP-44.
273+
:::
259274

260275
This method is designed to be used with the
261276
[`@metamask/key-tree`](https://npmjs.com/package/@metamask/key-tree) module.
@@ -268,9 +283,9 @@ derive an address for the relevant protocol or sign a transaction for the user.
268283

269284
An object containing `coinType`, the BIP-44 coin type to get the entropy for.
270285

271-
:::caution
286+
:::note
272287
Coin type 60 is reserved for MetaMask externally owned accounts and blocked for Snaps.
273-
If you wish to connect to MetaMask accounts in a Snap, use
288+
To connect to MetaMask accounts in a Snap, use
274289
[`endowment:ethereum-provider`](../reference/permissions.md#endowmentethereum-provider) and
275290
[`eth_requestAccounts`](/wallet/reference/json-rpc-methods/eth_requestaccounts).
276291
:::

0 commit comments

Comments
 (0)