validateaddress

How to use it

// yarn add @tatumio/tatum

import { TatumSDK, BitcoinCash, Network } from '@tatumio/tatum'

const tatum = await TatumSDK.init<BitcoinCash>({network: Network.BITCOIN_CASH})

const result = await tatum.rpc.validateAddress("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa")

await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs

Overview

validateaddress is a method that enables users to verify if a given address is valid. This method provides important information about the address, such as its type and whether it's a spendable or watch-only address. It can be particularly useful in applications where address validation is necessary before performing transactions or when dealing with user-generated addresses to ensure their validity.

Parameters

The validateaddress method accepts one required parameter:

  • address (string, required): The address to be validated.

Return Object

The validateaddress method returns an object with the following fields:

  • isvalid (boolean): Indicates if the supplied address is valid.

  • address (string): The validated address.

  • scriptPubKey (string): The hex-encoded scriptPubKey generated by the address.

  • isscript (boolean): Indicates if the address is a script address (P2SH).

  • iswitness (boolean): Indicates if the address is a witness address (P2WPKH or P2WSH).

  • witness_version (numeric, optional): The version number of the witness program, if applicable.

  • witness_program (string, optional): The hex value of the witness program, if applicable.

  • isspendable (boolean): Indicates if the address is spendable (has the private key).

  • iswatchonly (boolean): Indicates if the address is watch-only (wallet has the public key but not the private key).

  • iscompressed (boolean, optional): Indicates if the associated public key is compressed.

  • account (string, optional): DEPRECATED. The account associated with the address, if any. Example:

JSON Examples

Request example:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "validateaddress",
  "params": [
    "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
  ]
}

Response example:

{
    "result": {
        "isvalid": true,
        "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "scriptPubKey": "76a91462e907b15cbf27d5425399ebf6f0fb50ebb88f1888ac",
        "isscript": false,
        "iswitness": false
    },
    "error": null,
    "id": 1
}

\

Last updated

ยฉ Tatum Technology, LLC