Getting Started

Install Shipl-Meta in your dApp.

The Shipl SDK is an easy-to-embed web3 provider aimed to handle on-boarding for you and provide "etherless" transactions on the ethereum network. We’ve tried to keep things as simple/lightweight as possible.

This document is an implementation example for developers to understand end-user’s on-boarding flow through the Shipl SDK.

Installation

You can install Shipl via npm or load it into the browser

NPM Quick Start

npm install shipl

Then to instantiate the shipl object from the import:

const Shipl = require('shipl')
const shipl = new Shipl({ privateKey, network })

Browser Window Quick Start

For use directly in the browser you can reference the shipl distribution files from a number of places. They can be found in our npm package in the 'dist' folder or you can build them locally from this repo.

For a quick setup you may also request a remote copy from unpkg CDN as follows:

<!-- The most recent version -->
<script src="https://unpkg.com/shipl/dist/shipl.js"></script>
<!-- The most recent minified version -->
<script src="https://unpkg.com/shipl/dist/shipl.min.js"></script>
<!-- You can also fetch specific versions by specifying the version, files names may differ for past versions -->
<script src="https://unpkg.com/shipl@<version>/dist/shipl.js"></script>

To see all available dist files on unpkg, vist unpkg.com/shipl/dist

Then to instantiate the shipl object from the browser window object:

const Shipl = window.shipl
const shipl = new Shipl({ privateKey, network })