deriveWalletNode.js,latest
Go to NPMDerives an EOA wallet using the address of the specified wallet and blockchain. If the target wallet already exists, its metadata will be updated with the provided metadata.
NOTE: This endpoint is only available for EVM-based wallets.
Parameters
input
object
Required
Parameters for deriving a wallet.
blockchain
string
Required
The blockchain network that the resource is to be created on or is currently on.
Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAMATICMATIC-AMOYOPOP-SEPOLIAUNIUNI-SEPOLIA
id
string
Required
The ID of the wallet to derive from.
metadata
object
Optional list of metadata fields to associate with the corresponding wallet. If count is specified, the amount of items in the array should match the count field.
name
string
Name or description associated with the wallet or walletSet.
refId
string
Reference or description used to identify the object.
xRequestId
string
Developer-provided parameter used to identify this request.
Responses
Example
1const response = await client.deriveWallet({
2 id: 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11',
3 blockchain: 'ETH',
4})
5console.log(response.data?.wallet)ResponseChoose an example
1{
2 "data": {
3 "wallet": {
4 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5 "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
6 "blockchain": "MATIC-AMOY",
7 "createDate": "2023-01-01T12:04:05Z",
8 "updateDate": "2023-01-01T12:04:05Z",
9 "custodyType": "DEVELOPER",
10 "name": "",
11 "refId": "custom_ref_id",
12 "state": "LIVE",
13 "userId": "ext_user_id_1",
14 "walletSetId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
15 "initialPublicKey": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w",
16 "accountType": "EOA"
17 }
18 }
19}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
