npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ordjs/runestone

v1.6.0

Published

Ordinals runestone javascript implementation

Downloads

140

Readme

Ordinals runestone javascript implementation.

This implementation is based on ord 0.18.3 (ordinals runestone 0.0.8)

NPM version MIT License Stargazers

Contributors Issues Follow Twitter

Report Bug · Pull Request

Installation

$ npm install @ordjs/runestone

It will be pnpm/yarn add @ordjs/runestone if you use pnpm or yarn.

Usage

Runestone

Rune protocol messages, called runestones, are stored in Bitcoin transaction outputs.

Decipher Runestones

import { Runestone, Transaction } from '@ordjs/runestone';

// See https://mempool.space/tx/2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e
const tx: Transaction = {
  output: [{
    // // OP_RETURN OP_PUSHNUM_13 ...
    script_pubkey: '6a5d21020704b5e1d8e1c8eeb788a30705a02d039f3e01020680dc9afd2808c7e8430a64',
    value: 0,
  }],
};

const runestone = Runestone.decipher(tx);
// runestone.divisibility => 2
// runestone.premine => 11000000000
// runestone.symbol => ᚠ
// runestone.terms.amount => 100

Encipher Runestones

To deploy a new rune ticker, this will require a commitment in an input script.

import { Runestone, Etching, SpacedRune, Terms } from '@ordjs/runestone';

const etching = new Etching(SpacedRune.fromString('HI•JEASON'));
etching.terms = new Terms(69n, 420n);
etching.divisibility = 0;
etching.premine = 0n;
etching.symbol = '$';

const runestone = new Runestone();
runestone.etching = etching;

console.log(runestone.encipher());
// 6a5d16020704b7fcb396fa0101000302052406000a4508a403
// send runestone.encipher() to the blockchain

To mint UNCOMMON•GOODS:

import { Runestone, RuneId } from '@ordjs/runestone';

const runestone = new Runestone();
runestone.mint = new RuneId(1n, 0);

console.log(runestone.encipher());
// 6a5d0414011400
// send runestone.encipher() to the blockchain

Transfer 10 UNCOMMON•GOODS to output 1:

import { Runestone, Edict, RuneId } from '@ordjs/runestone';

const edict = new Edict(new RuneId(1n, 0), 10n, 1);
const runestone = new Runestone();
runestone.edicts = [edict];

console.log(runestone.encipher());
// 6a5d050001000a01
// send runestone.encipher() to the blockchain

Use in Browser

We provide the output format of ESM bundles for easy use in browsers directly:

<script type="module">
  import { Runestone } from 'https://esm.sh/@ordjs/runestone/bundle';

  const rs = Runestone.decipher({...});
  console.log(JSON.stringify(rs));
</script>

For more usage, please refer to the examples directory.

License

MIT