WDK Utils Configuration

This package does not have constructor options or runtime configuration. This page shows how to install @tetherto/wdk-utils, import the helpers you need, and understand the published runtime surface.

Install the package

You can install @tetherto/wdk-utils from npm:

npm install @tetherto/wdk-utils

Import address validation helpers

You can import only the validators your flow needs from the package entrypoint:

import {
  validateBitcoinAddress,
  validateEVMAddress,
  validateLightningInvoice,
  validateLnurl,
  decodeLnurl,
  validateLightningAddress,
  validateSparkAddress,
  validateTronAddress,
  validateUmaAddress,
  resolveUmaUsername
} from '@tetherto/wdk-utils'

Import EIP-681 helpers

You can detect and parse token transfer requests using the EIP-681 helpers:

import {
  isEip681Request,
  parseEip681Request
} from '@tetherto/wdk-utils'

Import BIP-21 helpers

You can detect, parse, and encode Bitcoin payment URIs using the BIP-21 helpers:

import {
  encodeBip21Request,
  isBip21Request,
  parseBip21Request
} from '@tetherto/wdk-utils'

Import BOLT11 helpers

You can validate, decode, sign, and encode BOLT11 Lightning invoices from the package entrypoint:

import {
  decode as decodeBolt11,
  encode as encodeBolt11,
  getHashToSign,
  sign as signBolt11,
  validateLightningInvoice
} from '@tetherto/wdk-utils'

Runtime notes

• @tetherto/wdk-utils exports plain functions. There is no client object to initialize.
• The package publishes a default module entrypoint through index.js and a bare runtime entrypoint through bare.js.
• parseBip21Request() accepts bitcoin: URIs with a validated Bitcoin address and optional amount, label, and message parameters.
• encodeBip21Request() validates the Bitcoin address and amount before returning a bitcoin: URI.
• BIP-21 amounts are decimal BTC strings with up to eight decimal places and a maximum value of 21000000.
• BOLT11 helpers support invoices for bitcoin, testnet, regtest, and signet networks.
• decode() returns user-provided invoice descriptions when they are present. Sanitize descriptions before rendering them in HTML or storing them.
• decodeLnurl() returns the decoded URL string when parsing succeeds.
• parseEip681Request() currently supports transfer requests for the schemes implemented in the published runtime: ethereum, pol, matic, polygon, arbitrum, and plasma.
• parseEip681Request() accepts both uint256 and value query parameters for the amount field and normalizes the parsed amount into amountSmallest.

Examples

You can validate common wallet inputs before handing them to a module:

import {
  validateBitcoinAddress,
  validateLightningAddress,
  validateTronAddress,
  validateUmaAddress
} from '@tetherto/wdk-utils'

const btc = validateBitcoinAddress('bc1qu9yqnhc6wjj6s62s9x0shnl5l2r7gq5cudm94r7mvwv0uw4s7acq0hn9g6')
const lightning = validateLightningAddress('sprycomfort92@waletofsatoshi.com')
const tron = validateTronAddress('TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH')
const uma = validateUmaAddress('$you@uma.money')

You can decode BOLT11 invoice details before presenting a payment request:

import { decode as decodeBolt11 } from '@tetherto/wdk-utils'

const invoice = decodeBolt11(
  'lnbc1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdpl2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq8rkx3yf5tcsyz3d73gafnh3cax9rn449d9p5uxz9ezhhypd0elx87sjle52x86fux2ypatgddc6k63n7erqz25le42c4u4ecky03ylcqca784w'
)

You can parse and encode a BIP-21 Bitcoin payment request:

import { encodeBip21Request, parseBip21Request } from '@tetherto/wdk-utils'

const parsed = parseBip21Request(
  'bitcoin:1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH?amount=0.001&label=Coffee'
)

const encoded = encodeBip21Request({
  address: '1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH',
  amount: '0.001',
  label: 'Coffee'
})

You can parse a request-shaped EIP-681 transfer string into structured data:

import { parseEip681Request } from '@tetherto/wdk-utils'

const request = parseEip681Request(
  'pol:0xc2132D05D31c914a87C6611C10748AEb04B58e8F@137/transfer?address=0xA9e338082A061d657014c08e652D96B38639F22a&uint256=0.175309000e6'
)

Need Help?