Welcome

Learn to build on Bitcoin with a token protocol for whatever you can dream up.

Welcome to runWiki

run's original logo

This wiki is a community-driven platform where users can share and collaborate on information related to the RUN token protocol (also known as RUN-on-Bitcoin) which has been running on the Bitcoin protocol since 2019.

The goal of this Wiki is to provide a central repository of knowledge and resources for the RUN-on-Bitcoin community. We encourage all users to contribute their expertise and experiences to help grow and improve the wiki. It is hosted by RunCraft, which is an independant venture. The implementation of the Bitcoin protocol that we use in the examples provided is Bitcoin SV (BSV) for its low fees and onchain-data ecosystem, but the protocol could be adapted to work on any Bitcoin-like blockchain, including BTC.

This Wiki is created and maintained by a team of dedicated volunteers. If you have any questions or need assistance, please don't hesitate to contact us at runcraft.io

Getting started

install Run and use it

• install the run SDK and then learn about creating jigs
• check the tutorials or the documentation
• check all the wiki pages.

contribute to this Wiki

• refer to the contributing page

Why was this Wiki created?

This wiki is a community effort to have a community maintained documentation of the RUN protocol and library.

Since the original creators decided to leave the project, we have reuploaded and improved the documentation for the RUN library on this wiki.

Our goal is to port and improve the doc by cleverly leveraging wiki's ability to link pages to make it easier to search. If you want to help, check out the contributing page.

What's more, some members of the RUN community are already willing to build tools and to explore expanding the protocol, so this wiki is a place for them to share their efforts and collaborate in public.

What is RUN?

Run's website originally described it this way:

Imagine. Then, Build. A token protocol for whatever you can dream up.
jigs // interactive objects

RelayX's AMM is built based on RUN tokens

Run is a protocol and SDK to build apps and tokens on Bitcoin. Developers create applications using interactive objects, called jigs. Jigs allow you to build almost anything you can dream up: tokens, contracts, artwork, elections, games, digital pets, and more — all run on Bitcoin.

Run supports full object-oriented programming and arbitrary code today. It is secure and performant for real applications. These docs will help you get started!

In a more technical language, RUN is a Bitcoin based UTXO-enforced layer2 protocol similar to javascript that allows you to create interactive objects. It can allow you to create NFTs or blockchain tokens that can be used to build pretty much anything.

Copyrights notice: the RUN protocol was created by Brenton Gunning under the MIT license.

Examples of projects that have been built

Here are a few of the projects that have already been built using Run:

• game objects that users own and can resell
  
• NFTs for art, music and 3D
  
• DEXs and AMMs
  
• social media platforms
  
• Wrapped dollars (Stablecoins)
• voting tokens
• tracing products on the blockchain
  
• handling permissions
• loyalty cards

How it looks

Here is how some Run code looks. In this example we create an Axe NFT that causes 9001 damage. You can find other basic examples

class Weapon extends Jig {
    init(damage) {
        this.damage = damage
    }
}

class Axe extends Weapon {
    init() {
        super.init(9001)
    }
}

new Axe() instanceof Weapon  // is true

Feeling ready to get started ? then head over to the installation and setup.