Skip to content

Latest commit

 

History

History
89 lines (75 loc) · 2.39 KB

README.md

File metadata and controls

89 lines (75 loc) · 2.39 KB
Raw

Raresats

Abstract

We provide a tool to find and extract rare sats in a wallet. We currently support the following rare and exotic types:

  • Rodarmor rarity:
    • uncommon
    • rare
    • epic
    • legendary
    • mythic
  • Exotic sats:
    • black
    • alpha
    • omega
    • nakamoto
    • palindrome
    • first tx
    • block 9
    • block 78
    • vintage
    • pizza

Installation

The tool is available as a npm package (soon). You can install it with the following command:

git clone https://github.com/SATO-Technologies/raresats.git
cd raresats
npm install --global .

Usage

The tool can be used as a CLI or as a library. The CLI is available with the raresats command and the library is available with the raresats package.

Find

CLI

raresats find -a <address> -s uncommon rare epic legendary
raresats find -u <utxo> -s black alpha omega

Options:

  • --ordurl <url>: the url of the ord instance used to fetch ranges (default: http://127.0.0.1:4001). This instance MUST run the JSON-RPC API.
  • --mempoolurl <url>: the url of the mempool instance used to fetch utxos (default: https://mempool.space)
  • -s <satributes>: the satributes to search for (default: all) separated by a space.

Library:

const raresats = require('raresats');
const res = raresats.find({
  address: 'bc1p...',
  // utxo: 'txid:vout',
  satributes: ['uncommon', 'rare', 'epic', 'legendary'],
  // ordURL = "http://127.0.0.1:4001",
  // mempoolURL = "https://mempool.space",
});
console.log(res);

Extract

CLI

raresats extract -a <address> -s uncommon rare epic legendary -f <feeFundingUTXO>
raresats extract -u <utxo> -s black alpha omega -f <feeUtxos>

Options:

  • --ordurl <url>: the url of the ord instance used to fetch ranges (default: http://127.0.0.1:4001). This instance MUST run the JSON-RPC API.
  • --mempoolurl <url>: the url of the mempool instance used to fetch utxos (default: https://mempool.space)
  • -s <satributes>: the satributes to extract (default: all) separated by a space.
  • -f <feeUtxos>: the utxos to use to fund the fee.

Library:

const raresats = require('raresats');
const res = raresats.extract({
  address: 'bc1p...',
  // utxo: 'txid:vout',
  satributes: ['uncommon', 'rare', 'epic', 'legendary'],
  // ordURL = "http://127.0.0.1:4001",
  // mempoolURL = "https://mempool.space",
  feeUtxos: ['txid1:vout1', 'txid2:vout2'],
});
console.log(res);