Installing the run sdk

From RunWiki
Revision as of 01:47, 14 December 2022 by Zhell (talk | contribs)
Jump to: navigation, search

The easiest way to get the latest version is to run

npm install run-sdk

 Another solution is to download the SDK as a zip file from https://run.network/. When writing this the latest version is version 0.6.37.

Getting Started

(note the following section was originally a simple copy/paste from the official doc)

TODO we must add the piece of JS code, but the formatter is broken for now

Installation

If you're new to Run, let the tutorial series guide your journey to get acquainted. You can write code without installing anything. The web browser Console will be your playground.

The details written here in the Docs have example code in the sidebar on the right-hand side. Anything you read in paragraphs, you can preview in-action over there.

Run works everywhere including all major browsers, on desktop and mobile, as well as Node.js 10+ on servers. The Run SDK is written in JavaScript ES6 and uses the bsv library to build and sign transactions. To get started:

  • For a webpage: Add bsv.browser.min.js and run.browser.min.js to the <head> tag.
  • For Node.js: Run npm install run-sdk to install both the run and bsv libraries

And that's it. All your code and jigs will be saved on-chain and Run will use public APIs to interact with the Bitcoin network. You don't need to deploy any servers to use Run. All the logic works client-side.