Three0 JS SDK

This is a JS SDK is intended for browser based applications that need to interact with the Three0 Service Suite. It is not intended yet for Node.js applications. The SDK is currently in alpha stage development and is not yet ready for production use.

Initialization

npm i --save @three0dev/js-sdk

Usage

Import Three0 and prepare configuration

import { init } from '@three0dev/js-sdk'

const config = {
  "contractName": "myTestContract",
  "projectId": "myTestProject",
  "chainType": "NEAR_TESTNET"
}

Initialize SDK

React

React >=18

import React from 'react'
import { createRoot } from 'react-dom/client'
import App from './App'

init(config).then(() => {
  const container = document.querySelector('#root')
  const root = createRoot(container)
  root.render(<App />)
}).catch(console.error)

React <18

import React from 'react'
import { render } from 'react-dom'
import App from './App'

init(env.config)
  .then(() => {
    render(
      <App />,
      document.getElementById("root")
    );
}).catch(console.error)

Vue

import { createApp } from 'vue';
import App from './App.vue';

init(config)
  .then(() => {
    const app = createApp(App);
    app.use(store);
    app.use(router);
    app.mount('#app');
}).catch(console.error)

Angular

WIP

Vanilla

WIP: Pending Bug Fixes and CDN Compatibility

Services

Auth

import { Auth } from '@three0dev/js-sdk'

Auth.login():Promise<void>
- Logs into dApp using NEAR Wallet
- Creates new user on NEAR blockchain if user doesn't exist
Auth.logout():Promise<void>
- Logs out of dApp
Auth.isLoggedIn():boolean
- Returns true if user is logged in
Auth.getAccountId():string
- Returns user account ID

Database

import { Database } from 'three0-js-sdk'

DocStore:

const docstore = await Database.DocStore([address])

docstore.get(key:string):any
- Gets value from docstore
- Returns null if key doesn't exist
docstore.where(callback: Function):any[]
- Returns array of values that match callback function
- Ex: docstore.where(doc => doc.key === 'value')
docstore.set(key:string, value:Object):Promise<void>
- Sets value in docstore
docstore.add(value:Object):Promise<string>
- Adds value to docstore
- Returns key of added value
docstore.update(key:string, value:Object):Promise<void>
- Updates value in docstore
docstore.delete(key:string):Promise<void>
- Deletes value from docstore

KeyValue:

const keyvalue = await Database.KeyValue([address])

keyvalue.get(key:string):any
- Gets value from database
- Returns null if key doesn't exist
keyvalue.getAll():any[]
- Gets all values from database
keyvalue.set(key:string, value:any):Promise<void>
- Sets value in database
keyvalue.delete(key:string):Promise<void>
- Deletes value from database

Counter:

const counter = await Database.Counter([address])

counter.get():number
- Gets current value of counter
counter.increment(value:int):Promise<void>
- Increments counter by value
- Value must be >= 1

Eventlog

WIP - Will be released during beta version

Feed