# @cvbb/sdk

> Cobo Vault SDK

Latest version **2.0.0** (published 2021-03-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install @cvbb/sdk
pnpm add @cvbb/sdk
yarn add @cvbb/sdk
bun add @cvbb/sdk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-03-30 |
| First published | 2020-10-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 32.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | aaronisme |
| Maintainers | soralit |

## Links

- npm: https://www.npmjs.com/package/@cvbb/sdk
- Repository: https://github.com/CoboVault/cobo-vault-blockchain-base
- Homepage: https://github.com/CoboVault/cobo-vault-blockchain-base#readme
- Issues: https://github.com/CoboVault/cobo-vault-blockchain-base/issues
- npm.io page: https://npm.io/package/@cvbb/sdk

## Dependencies (11)

- [rxjs](https://npm.io/package/rxjs.md) ^6.6.3
- [react](https://npm.io/package/react.md) ^17.0.1
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.1
- [react-modal](https://npm.io/package/react-modal.md) ^3.12.1
- [qrcode.react](https://npm.io/package/qrcode.react.md) ^1.0.1
- [react-qr-reader](https://npm.io/package/react-qr-reader.md) ^2.2.1
- [@types/react-dom](https://npm.io/package/@types/react-dom.md) ^17.0.1
- [@cvbb/qr-protocol](https://npm.io/package/@cvbb/qr-protocol.md) ^2.0.4
- [@types/react-modal](https://npm.io/package/@types/react-modal.md) ^3.12.0
- [@types/qrcode.react](https://npm.io/package/@types/qrcode.react.md) ^1.0.1
- [@types/react-qr-reader](https://npm.io/package/@types/react-qr-reader.md) ^2.1.3

## Recent versions

- 2.0.0 (latest) — 2021-03-30
- 1.1.1 — 2021-03-24
- 1.1.0 — 2021-03-24
- 1.0.5 — 2021-03-22
- 1.0.4 — 2021-03-11
- 1.0.3 — 2021-03-05
- 1.0.2 — 2021-03-05
- 1.0.1 — 2021-03-05
- 0.1.8 — 2020-12-01
- 0.1.7 — 2020-11-12
- 0.1.6 — 2020-11-06
- 0.1.5 — 2020-11-06
- 0.1.4 — 2020-11-06
- 0.1.3 — 2020-10-16
- 0.1.2 — 2020-10-16
- … 1 more at https://npm.io/package/@cvbb/sdk/versions

## README

# `@cvbb/sdk`

`@cvbb/sdk` is library for helping developer to do integration with Cobo Vault.

the main purpose is to encode and decode data for QR Code usage.

currently we use UR to encode data. check this for detail info about [UR](https://github.com/CoboVault/Research/blob/master/papers/bcr-0005-ur.md)

## Usage

```
import sdk from '@cvbb/sdk';
const read = async () => {
    const result = await sdk.read();
}

const play = async () => {
    await sdk.play("any data string");
}

```

## API

| Name | Parameters                                      | result                                                                      | Description                                                                        |
| ---- | ----------------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| read |                                                 | Promise<{type: 'text' &#124; 'json' &#124; 'ur', data: string} &#124; null> | Open a modal and read qrcode with camera, will return null when click Close button |
| play | data: string, options?: {refreshSpeed?: number} | Promise<void>                                                               | Open a modal and display a dynamic qrcode, will resolve when click Finish button   |

---
_Source: https://npm.io/package/@cvbb/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._