Welcome

From RunWiki
Revision as of 22:25, 13 December 2022 by Zhell (talk | contribs)
Jump to: navigation, search

Welcome to RunCraft's RUN wiki

run.network's logo
run.network's logo

This wiki can be used by any developper that uses RUN from run.network

Please note that RunCraft is not affiliated with the owners of RUN but is an independant venture that is still in development.


Getting started

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

You can install the run SDK, check the documentation or the tutorials

What is RUN?

Run's own website describe it this way:

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

In summary, 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 tokens that can be used for pretty much anything, here are a few examples from RUN's homepage:

  • game objects
  • loyalty cards
  • handling permissions
  • tracing products on the blockchain
  • voting tokens
  • wrapped dollars

Here is how it looks, creating an Axe NFT that causes 9001 damage

<code class="language-javascript"><span class="token keyword">class</span> <span class="token class-name">Weapon</span> <span class="token keyword">extends</span> <span class="token class-name">Jig</span> <span class="token punctuation">{</span>
    <span class="token function">init</span><span class="token punctuation">(</span><span class="token parameter">damage</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
        <span class="token keyword">this</span><span class="token punctuation">.</span>damage <span class="token operator">=</span> damage
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token keyword">class</span> <span class="token class-name">Axe</span> <span class="token keyword">extends</span> <span class="token class-name">Weapon</span> <span class="token punctuation">{</span>
    <span class="token function">init</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
        <span class="token keyword">super</span><span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span><span class="token number">9001</span><span class="token punctuation">)</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token keyword">new</span> <span class="token class-name">Axe</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">instanceof</span> <span class="token class-name">Weapon</span></code>

What will this wiki be used for?

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.

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