Skip to the content
nullroute
Browse the docs

Running it

  1. Check the vector files have not changed since they were pinned. This needs no part of this repository's tooling:
    $ cd spec/vectors/signer-profile
    $ sha256sum -c SHA256SUMS
    
    On macOS use shasum -a 256 -c SHA256SUMS.
  2. Run the vectors against your adapter:
    $ node conformance/run.mjs path/to/your-adapter.mjs
    
    The runner makes the same check as step 1 before it runs anything, and refuses to continue if a file does not match.

Options:

Option Effect
--vectors <dir> Read vectors from another directory. It needs its own SHA256SUMS.
--only <file.json> Run one vector file.
--known-failures <file> Treat listed failures as known (see Known failures).
--verbose Print every case, not only those that did not pass.

For nullroute, make conformance builds the packages and runs its adapter with its known failures list. It takes a few seconds and needs no network and no Bitcoin node.

Rendered from conformance/README.md, the same bytes that ship with the code. SHA-256 d0c681a5e7b7f55bcc96ecd33bb0ab07dd944b4fe2bb50f640ee79a85db3917e