@conio/web-sdk

@conio/web-sdk

This is the official Conio web sdk, designed to work on browser. Install this deps and use with some popular module bundler like webpack, parcel or rollup. The sdk help you to manage authentication flow, tokens and provide an easy way to interact with conio api.

Installation & Setup

npm i @conio/web-sdk or yarn add @conio/web-sdk

Requirements

• node >= 20
• yarn 1.x | npm >= 10.2.3

Usage

Create conio object:

import { Conio, ConioConfiguration } from '@conio/web-sdk'

const baseUrl = "https://api.example.endpoint"
const bitcoinNetwork = "TESTNET" // or "MAINNET"
const sdkScope = "B2C" // or "B2B"
const conio = new Conio({ baseUrl, sdkScope })

Helpers

conio object provides some interfaces:

...
const conio = new Conio(conf)
const { userService, walletService, exchangeService } = conio

• userService provide login() and getLegalAcceptances() and signUp()
• walletService provide activityList()
• tradingPriceService provide historicalPrices(), cryptoCurrenciesMetadata()

Development

We develop the library using jest with node as engine. To add new feature we create new test-case and develop the feature until the test become green (Yes is TDD approch). The development should use conventional commit. The process to release a new version can start with npm run release witch follow release-it flow and generate/edits CHANGELOG.md

• npm run build – bundle the library using microbundle. Follow the instruction of microbundle js in its homepage)
• npm run test-watch – develop a test in TDD approch
• npm run generate-client - using open-api generator installed globally, this command generare the client part based on openapi.yaml. This command is necessary to start development.
• npm run release - it run step-by-step release-it flow. Use right bumb proposed version.

Schema

Schema can be fetched at https://magellanov2.conio.com/_openapi or prod equivalent

Test

• userService test can fails since if test is runned long time ago, maybe it requires again email confrimation. So if test fials and the account receive a cofnrimation email, tap on confirmation button and then run test again