Library Packages
Address
A comprehensive suite of Address querying, monitoring and formatting utilities.
Data Schema
Here is the full data schema for a NEXA.js Address.
{
type: String
prefix: String
hash: String
balance: BigInt
received: BigInt
sent: BigInt
unconfirmed: BigInt
transactions: String[]
createdAt: Integer
updatedAt: Integer
}
NOTE: All
BigInt
amounts are measured in satoshis (ie. 0.01 NEX).
Prefix
The prefix
can be either nexa:
or nexatest:
for Mainnet and Testnet respectively.
Type
The Address type
can be one of:
- P2PKH
- SCRIPT
- TEMPLATE
- GROUP
(Public Key) Hash
This is the public key hash for the Address.
Balance
This is the current "confirmed" NEXA balance.
Received
The total amount of NEXA received by this Address.
Sent
The total amount of NEXA sent from this Address.
Unconfirmed
This is the current "unconfirmed" NEXA balance.
Transactions
A list of all txidem(s) associated with this Address.
Created At
The timestamp of the first block confirmation for this Address.
Updated At
The timestamp of the most recent transaction associated with this Address.
Address Methods
encodeAddress(string|array)
Creates a Base58-encoded Nexa address.
decodeAddress(string|array)
Disassembles a Base58-encoded Nexa address.
getAddress(string|array)
Retrieve the latest on-chain data about an Address.
see Address Details above
watchAddress(string|array)
Allows you to monitor ALL on-chain activity for an Address.
Option #1: Import from a (Package) Method
NOTE: This is the recommended option.
import { watchAddress } from '@nexajs/address'
const myAddress = 'nexa:nqtsq5g5ynxl8rwp5pzh47muagnn795pckdgtjrtatyzv2p5'
const myHandler = (updatedInfo) => {
console.log(updatedInfo)
}
const cleanup = watchAddress(myAddress, myHandler)
// cleanup() // Execute to cancel (and cleanup) an Address subscription.
Option #2: Import from the Core Library
import Nexa from 'nexajs'
const myAddresses = [
'nexa:nqtsq5g5ynxl8rwp5pzh47muagnn795pckdgtjrtatyzv2p5',
'nexa:nqtsq5g5lsgc2yns89kjp2ws4u7wk2d3lvzjznt3v8k2td59',
]
const cleanup = Nexa.watchAddress(myAddresses, myHandler)
// cleanup() // Execute to cancel (and cleanup) an Address subscription.
Setting a Custom Configuration
/* Set advanced parameters. */
const params = {
address: [
'nexa:nqtsq5g5ynxl8rwp5pzh47muagnn795pckdgtjrtatyzv2p5',
'nexa:nqtsq5g5lsgc2yns89kjp2ws4u7wk2d3lvzjznt3v8k2td59',
'nexa:nqtsq5g54v4772je5xq2z2t2aqgmaayavn44ttz5qd8cmfy2',
],
handler: myHandler, // (optional) Set your notifications handler in your parameters.
conn: {
provider: [
{
type: 'rostrum',
src: 'rostrum.myawesomeproject.com:20004',
},
{
type: 'graphql',
src: 'https://myawesomeproject.com/graphql',
},
],
threshold: 1,
timeout: 5000,
},
}
const cleanup = watchAddress(params)
// cleanup() // Execute to cancel (and cleanup) an Address subscription.