0.2.12 • Published 8 months ago

@samooth/explorer v0.2.12

Weekly downloads
-
License
Open BSV
Repository
github
Last release
8 months ago

Explorer JS Wrapper library for Bitcoin SV

Usage

const Explorer = require("@samooth/explorer")

const explorer = new Explorer("main")

or

import Explorer from "@samooth/explorer"

const explorer = new Explorer("main")

Endpoints

Currently there are 4 endpoints ( whatsonchain, bitails, electrumx, bsvdirect ) but extra endpoints can be added.

let explorer = new Explorer("main")

explorer.endpoints.push( myAPI: {
        main: "https://my.api.tld/",
        test: "https://my.api.tld/",
        headerKey: 'my-api-key'
    })

explorer.api='myAPI'

Methods

  • status()

  • chainInfo()

  • blockHash()

  • blockHeight()

  • blockList ( height, limit )

  • blockLatest ( hash )

  • blockTransactions ( hash )

  • txHash ( hash )

  • downloadTx ( hash )

  • downloadTxOut ( hash, index )

  • broadcast( txhex )

  • broadcastBinary ( txBuf)

  • getOutputData ( hash, outputIndex )

  • getOutputsData ( hash, fromIndex, toIndex )

  • merkleProof ( hash )

  • mempoolInfo ()

  • mempoolTxs ()

  • addressInfo ( address )

  • balance ( address )

  • history ( address )

  • utxos ( address )

  • detailScriptHash ( scriptHash )

  • balanceScriptHash ( scriptHash )

  • historyByScriptHash ( scriptHash )

  • utxosByScriptHash ( scriptHash )

  • search ( text )

Install


npm install @samooth/explorer

Sample Usage

const Explorer = require('@samooth/explorer')

let woc = new Explorer("main", { api: "woc" });
woc.status().then((status) => console.log("woc status:", status))

woc.blockLatest(10)
.then((blk)=>console.log("woc latest:",blk))

woc.blockList("000000000000000005bf29a3bff05d1cbf120d052bdbea6d6b8643eefd44be83")
.then((blk)=>console.log("woc blk list:",blk))


let bitails = new Explorer("main", { api: "bitails" });
bitails.status().then((status) => console.log("bitails status:", status))

Documentation

This library helps manage the following APIs:

Taal

Bitails

History

0.3.0

  • Upgrade to bsv2
  • Support for multiple endpoints
  • Support for binary broadcast

0.2.0

  • Support Cache, default is true. if you don't want cache, set option { enableCache: false }
  • Support ApiKey and rate limit to 3 requests/sec without apiKey.
  // with apiKey
  const explorer = new Explorer( 'testnet', { apiKey: 'your api key'}  )
  // without apiKey
  const explorer = new Explorer( 'testnet' )
  • Support JSDoc type check.

0.1.0

  • Initate, Support all API in document.

License

It is released under the terms of the Open BSV license.

0.2.12

8 months ago

0.2.9

8 months ago

0.2.11

8 months ago

0.2.10

8 months ago

0.2.7

10 months ago

0.2.8

10 months ago

0.2.5

10 months ago

0.2.4

10 months ago

0.3.0

1 year ago

0.2.1

1 year ago

0.2.0

1 year ago