adamant-api / coins/btc / btc

Variable: btc

const btc: {
  isValidAddress: (address) => boolean;
  keys: (passphrase) => UtxoWalletKeys;
  metadata: {
     createCoin: boolean;
     cryptoTransferDecimals: number;
     decimals: number;
     defaultOrdinalLevel: number;
     defaultVisibility: boolean;
     explorer: string;
     explorerAddress: string;
     explorerTx: string;
     name: string;
     regexAddress: string;
     status: string;
     symbol: string;
     type: string;
     website: string;
  };
};

Defined in: src/coins/btc.ts:22

Deterministic Bitcoin wallet derivation and address validation helpers.

Type Declaration

isValidAddress

isValidAddress: (address) => boolean;

Parameters

Parameter	Type
address	string

Returns

boolean

keys

keys: (passphrase) => UtxoWalletKeys;

Parameters

Parameter	Type
passphrase	string

Returns

UtxoWalletKeys

metadata

metadata: {
  createCoin: boolean;
  cryptoTransferDecimals: number;
  decimals: number;
  defaultOrdinalLevel: number;
  defaultVisibility: boolean;
  explorer: string;
  explorerAddress: string;
  explorerTx: string;
  name: string;
  regexAddress: string;
  status: string;
  symbol: string;
  type: string;
  website: string;
} = coinMetadata.BTC;

metadata.createCoin

createCoin: boolean = true;

metadata.cryptoTransferDecimals

cryptoTransferDecimals: number = 8;

metadata.decimals

decimals: number = 8;

metadata.defaultOrdinalLevel

defaultOrdinalLevel: number = 10;

metadata.defaultVisibility

defaultVisibility: boolean = true;

metadata.explorer

explorer: string = "https://bitcoinexplorer.org";

metadata.explorerAddress

explorerAddress: string = "https://bitcoinexplorer.org/address/${ID}";

metadata.explorerTx

explorerTx: string = "https://bitcoinexplorer.org/tx/${ID}";

metadata.name

name: string = "Bitcoin";

metadata.regexAddress

regexAddress: string = "^bc1[a-zA-Z0-9]{39,59}$|^[13][1-9A-HJ-NP-Za-km-z]{25,34}$";

metadata.status

status: string = "active";

metadata.symbol

symbol: string = "BTC";

metadata.type

type: string = "coin";

metadata.website

website: string = "https://bitcoin.org";