Skip to main content

Light Client

With the light client, browser users don't have to hold a full cache from the Warp SDK, which makes read queries extremely fast.

A remote rollup node must exist for the DB instance and the endpoint URL must be specified as rpc.

For Web Browsers​

Install​

yarn add weavedb-client

Instantiate WeaveDB​

import WeaveDB from "weavedb-client"

const db = new WeaveDB({
  contractTxId: WEAVEDB_CONTRACT_TX_ID,
  rpc: "http://xxx.yyy.zzz.aaa:8080" // rollup node URL
})

For NodeJS​

Install​

yarn add weavedb-node-client

Instantiate WeaveDB​

To access a remote node, you could set rpc field to something like example.com:8080.

const WeaveDB = require("weavedb-node-client")

const db = new WeaveDB({
  contractTxId: WEAVEDB_CONTRACT_TX_ID,
  rpc: "0.0.0.0:8080" // rollup node IP:port
})

It also works with remote secure ports such as example.com:443.

const WeaveDB = require("weavedb-node-client")

const db = new WeaveDB({
  contractTxId: WEAVEDB_CONTRACT_TX_ID,
  rpc: "example.com:443"
})

or

const WeaveDB = require("weavedb-node-client")

const db = new WeaveDB({
  contractTxId: WEAVEDB_CONTRACT_TX_ID,
  rpc: "example.com",
  secure: true, // optional
  cert: YOUR_CERT // optional
})