On this page

  2. Komodo Defi Framework
  3. Api
  4. V20
  5. Wallet
  6. delete_wallet
latest contributor to this doc

Last Edit:

@gcharang↗

Delete Wallet

API-v2delete_wallet

delete_wallet

Securely deletes a wallet. The wallet must not be the currently active wallet. This action is irreversible.

Request Parameters

Parameter* = requiredTypeDescription
password*
string
The password of the wallet.
wallet_name*
string
The name of the wallet to delete.

Response Parameters

The response for a successful request is null.

📌 Examples

Request (Successful Deletion)

Delete Wallet

POST
delete_wallet
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "delete_wallet",
  "mmrpc": "2.0",
  "params": {
    "wallet_name": "wallet-to-delete",
    "password": "pass1"
  }
}

Response (Success)

{
  "mmrpc": "2.0",
  "result": null,
  "id": 0
}

Error Types

Parameter* = requiredTypeDescription
CannotDeleteActiveWallet
string
Optional. An attempt was made to delete the currently active wallet.
InternalError
string
Optional. An internal server error occurred.
InvalidPassword
string
Optional. The provided password is incorrect.
InvalidRequest
string
Optional. The request is malformed or missing required parameters.
WalletNotFound
string
Optional. The specified wallet_name was not found.
WalletsStorageError
string
Optional. A storage-related error occurred while accessing wallet data.

Error Response (Wallet Not Found)

{
    "mmrpc": "2.0",
    "error": "Wallet 'non-existent-wallet' not found.",
    "error_path": "mm2_main:lp_wallet:665",
    "error_trace": "mm2_main:lp_wallet:665",
    "error_type": "WalletNotFound",
    "error_data": "Wallet 'non-existent-wallet' not found.",
    "id": 0
}

Error Response (Invalid Password)

{
    "mmrpc": "2.0",
    "error": "Invalid password",
    "error_path": "mm2_main:lp_wallet:665",
    "error_trace": "mm2_main:lp_wallet:665",
    "error_type": "InvalidPassword",
    "error_data": "Invalid password",
    "id": 0
}

Error Response (Cannot Delete Active Wallet)

{
    "mmrpc": "2.0",
    "error": "Cannot delete wallet 'active-wallet' as it is currently active.",
    "error_path": "mm2_main:lp_wallet:658",
    "error_trace": "mm2_main:lp_wallet:658",
    "error_type": "CannotDeleteActiveWallet",
    "error_data": "Cannot delete wallet 'active-wallet' as it is currently active.",
    "id": 0
}