Export Organizational Wallets
The Wallet Export feature allows you to retrieve the full private keys of your organizational wallets. This is a powerful feature designed for disaster recovery, auditing, and platform portability.
[!IMPORTANT] Owner Only Access: For security reasons, the extraction and export of organizational wallet private keys can ONLY be initiated by the Owner of the organization. API keys belonging to other members or system integrations are strictly barred from this operation.
Security Model Differences
The availability and mechanism of wallet exports depend entirely on your chosen MPC security model.
1. Trustless MPC
In Trustless MPC, Planbok nodes do not store your organization's entropy shards in a way that allows reconstruction without your real-time input.
- How it works: To export a private key, the Owner must provide the
encryptedOrganizationSecretwith theverifycontext. - Advantage: You maintain ultimate "sovereignty" over your assets. Even if our systems were offline, you could use your secret and our open-source recovery tools to reconstruct your keys.
2. Standard MPC
In Standard MPC, signing is simplified because entropy shards are stored within the secure MPC nodes.
- Export Constraint: Due to the simplified management of entropy in this mode, private key exports are currently disabled to prevent unauthorized extraction from stored shards. If you require key portability, you must select Trustless MPC during organization setup.
Quickstart: Exporting a Private Key
If your organization is in Trustless MPC mode, follow these steps to export a wallet's private key.
Step 1: Generate the Verification Secret
Use the Planbok encryption script with the verify context. This context is specifically reserved for high-sensitivity operations like key export.
Code
Step 2: Initiate Export from the Dashboard
Because this operation is extremely sensitive, it is not available via API keys. It must be initiated through the Planbok Dashboard by the Organization Owner.
Authentication: Owner Session (JWT)
Request Body:
Code
Step 3: Receive and Decode the Data
Once the request is validated:
- The Planbok system reconstructs the keys using your provided secret and the stored shards.
- A Base64 encoded payload is generated and sent directly to the Owner's registered email address.
- You must decode this payload to retrieve the CSV data containing your addresses and private keys.
Decoding via Script: You can use the decode-organization-private-keys-data.js script from our public repository:
Code
Manual Decoding: Alternatively, you can decode it via terminal:
Code
Best Practices
- Air-gapped Environments: Perform key exports on secure, air-gapped machines whenever possible.
- Ephemeral Secrets: The
encryptedOrganizationSecretexpires after 5 minutes. Generate it immediately before the export call. - Immediate Migration: Key export is typically used for migrating funds to cold storage. It is recommended to sweep the funds to a new address after a key has been exposed via export.