Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

skynet-js

Package Overview
Dependencies
Maintainers
4
Versions
68
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

skynet-js

Sia Skynet Javascript Client

  • 4.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
4
Created
Source

skynet-js - Javascript Sia Skynet Client

Version Build Status Contributors License

A Javascript module that:

  • facilitates communication with Sia Skynet portals from the browser
  • handles logging into and using MySky
  • provides useful functionality for working with Skynet such as parsing out skylinks from URLs

Updating to v4 from v3

The latest stable major version is v4. There are many breaking changes from v3.

Please consult the update guide for help migrating your code.

Documentation

For documentation complete with examples, please see the Skynet SDK docs.

We also have an introduction workshop for building a web app on Skynet, and an example tutorial about creating your app without a Javascript framework.

How To Use skynet-js In Your Web Project

If you're thinking, "wait, how can I import() in the browser," then here is the answer:

While skynet-js is built with Node.js, you can easily compile it to one minified javascript file that is compatible with browsers.

Webpack will compile only the used functions (unused code will be removed automatically), so it is recommended to build your whole project in Node.js and compile it with webpack (click here for detailed tutorial):

cd your_project

npm install skynet-js

npm install webpack webpack-cli --save-dev

Update your package.json file.

remove - "main": "index.js",
add    - "private": true,

Create folders mkdir dist src. Make sure you have your javascript files in src and the main (entry) javascript is named index.js.

Compile with npx webpack! You will find the minified main.js in the dist folder.

Development

  1. Clone the repository
  2. Run yarn
  3. Run yarn prepare to install pre-commit hooks
  4. Run yarn test to run the tests

Also see our guide to contributing.

Requirements

We have some automated checks that must pass in order for code to be accepted. These include:

  • Type-checking and other code lints must pass.
  • Every function must have a complete JSDoc-style docstring.
  • 100% code coverage is enforced. Every statement and conditional branch must be tested.

Note that the 100% coverage requirement is a minimum. Just because a line of code is tested does not mean it is tested well, that is, with different values and combinations of values. Tests should be as thorough as possible, within reason.

Changelogs

Keywords

FAQs

Package last updated on 08 Jun 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc