Hive Multisig SDK
  • Welcome!
  • Quick Start
  • WebSocket flow
    • 1 - Users connect to the Websocket
    • 2 - User A requests a transaction
    • 3 - User B receives the signature request
    • 4 - User B signs the transaction
    • 5 - User B broadcasts the transaction
    • 6 - Users both receive a successful broadcast notification
  • API
  • Utils
    • Encode Transaction
    • Decode Transaction
  • Static helpers
    • Get/Reset HiveMultisig instance
    • Get Signers
    • Get Authorities
    • Validate Initiator
  • Demo
Powered by GitBook
On this page
  • Install the library
  • Create an Instance of Hive Mutisig SDK
  • Get Instance

Quick Start

Install the library

The best way to interact with our multisig API is to use our official SDK:

# Install via NPM
npm install --save hive-multisig-sdk
# Install via yarn
yarn add hive-multisig-sdk

Create an Instance of Hive Mutisig SDK

Simply create an instance, by passing the window element (used for Keychain calls), and if needed, some options :

const multisig = new HiveMultisig(window: Window,options?:MultisigOptions); 
Name
Description
Type

window

Window element

Window

options?.socketAddress

Websocket URL

string

options?.apiAddress

Multisig API URL

string

options?.clientAddress

RPC Client URL

string

Get Instance

To make sure you always use a single instance of HiveMultisig,you can make use of getInstance static method, using the same parameters.

const multisig = HiveMultisig.getInstance(window: Window,options?:MultisigOptions); 
PreviousWelcome!NextWebSocket flow

Last updated 1 year ago