Welcome

runWiki - build on Bitcoin

A token protocol for whatever you can dream up.

Welcome to runWiki

run.network's logo

This wiki is a community-driven platform where users can share and collaborate on information related to RUN (also known as RUN-on-Bitcoin) from run.network

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 not affiliated with the owners of RUN.

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

Getting started

for Run

You can install the run SDK, learn about creating jigs, or learn more about jigs.

You can also check the documentation or the tutorials

for this Wiki

Consult the Wiki's User Guide for information on using the wiki software.

If you wan to contribute to this Wiki, please refer to the contributing page.

You can also check out all the pages.

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 don't know if the documentation they currently host will remain online, and it will probably not get updated or maintained.

We believe our first step could be to port the official documentation to this wiki, 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 describes 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 platform 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.

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.