@credenza-web3/async-client v1.0.5

Credenza3 Async Client

Isomorphic Credenza API client for long running requests

Documentation

MAINNET

TESTNET

Installation

with npm

npm install ws // required for node js usage
npm install @credenza-web3/async-client

with yarn

yarn add ws // required for node js usage
yarn add @credenza-web3/async-client

with pnpm

pnpm install ws // required for node js usage
pnpm install @credenza-web3/async-client

or include a script tag

<script src="https://cdn.jsdelivr.net/npm/@credenza-web3/async-client/dist/async-client.umd.js"></script>

Usage

ES6

import { 
  connect, 
  disconnect, 
  request, 
  subscribe, 
  getSocket, 
  getConfig,
  getRequests,
  getSubscriptions, 
  ENVS 
} from '@credenza-web3/async-client'

CommonJS

const { 
  connect, 
  disconnect, 
  request, 
  subscribe, 
  getSocket, 
  getConfig,
  getRequests,
  getSubscriptions,
  ENVS 
} = require('@credenza-web3/async-client')

Browser

const { 
  connect, 
  disconnect, 
  request, 
  subscribe, 
  getSocket, 
  getConfig,
  getRequests,
  getSubscriptions,
  ENVS 
} = window.CredenzaAsyncClient

Connect

await connect({ 
  accessToken: string,    // credenza access token e.g. `Basic ${accessToken}`
  env?: string,           // value from ENVS constant Defaults to ENVS.MAIN
  debug?: boolean,        // defaults to false
  autoReconnect?: boolean // defaults to true
})

Make request

See Documentation for payload

const result = await request({
  channel: string  // e.g. 'deploySaleContract'
  payload: any // e.g. {contract: 'CredenzaERC1155Contract', chainId: '80001',ownerAddress: '0x...',},
})

Subscribe to channel

const unsubscribe = subscribe('channel/name', (data) => {
  console.log(data)
  unsubscribe() // if subscription is no longed needed
})

Get active socket connection

const socket = getSocket()

Get config

const config = getConfig()

Get requests

const requests = getRequests()

Get subscriptions

const subscriptions = getSubscriptions()

Disconnect

await disconnect()