# byoa-sdk

> SDK for byoa functionality.

Latest version **1.0.0** (published 2022-02-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install byoa-sdk
pnpm add byoa-sdk
yarn add byoa-sdk
bun add byoa-sdk
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-02-18 |
| First published | 2022-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 9 |
| Unpacked size | 690.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | pagreczner |
| Maintainers | petepetepete |

## Links

- npm: https://www.npmjs.com/package/byoa-sdk
- Repository: https://github.com/web3-byoa/react-byoa-sdk
- Homepage: https://github.com/web3-byoa/react-byoa-sdk#readme
- Issues: https://github.com/web3-byoa/react-byoa-sdk/issues
- npm.io page: https://npm.io/package/byoa-sdk

## Dependencies (9)

- [web3](https://npm.io/package/web3.md) ^1.5.2
- [ethers](https://npm.io/package/ethers.md) ^5.4.5
- [starknet](https://npm.io/package/starknet.md) ^2.5.1
- [web3modal](https://npm.io/package/web3modal.md) ^1.9.4
- [@material-ui/lab](https://npm.io/package/@material-ui/lab.md) ^4.0.0-alpha.60
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.12.3
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.11.2
- [@argent/get-starknet](https://npm.io/package/@argent/get-starknet.md) ^2.1.1
- [@walletconnect/web3-provider](https://npm.io/package/@walletconnect/web3-provider.md) ^1.6.2

## Recent versions

- 1.0.0 (latest) — 2022-02-18

## README

# byoa-sdk

> SDK for byoa functionality.

[![NPM](https://img.shields.io/npm/v/byoa-sdk.svg)](https://www.npmjs.com/package/byoa-sdk) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save byoa-sdk
```

## Usage

```tsx
import React, { Component } from 'react'

import ByoaSDK from 'byoa-sdk'
import 'byoa-sdk/dist/index.css'

class Example extends Component {
  render() {
    return <ByoaSDK />
  }
}
```

## Example metadata json
```json
{
  "version": "v0.1 (alpha)",
  "name": "Starkle",
  "description": "Starkle is a clone of the popular game Wordle. In this version all the words are related to Starkware, Ethereum, Layer 2's and technology!",
  "image": "ipfs://QmWhKghp3M4cerbQEBVPDgJWudgyq7rAVYLSbcPznf9T8c",
  "implementationURIs": {
    "browser": "https://starkle-app.byoa.org"
  },
  "substrates": [
    "browser"
  ]
}
```

## Props
### `mode`
`mode`: `l1` or `l2`. Defaults to `l2`. Represents where you want to source wallet details from.

### `byoaContractDetails`
#### `address`
String representing the L1 address on Ethereum for the byoa app registry contract.
#### `network`
What network the L1 address resides on.

### `alchemyConfiguration`
#### `url`
Connection url to source data from alchemy and read from contracts.

### `infuraConfiguration`
#### `id`
For wallet connect configuration.

### `starknetConfiguration`
#### `address`
The address on StarkNet for the deployed L2 contract.
#### `network`
The testnet/mainnet of StarkNet for the deployed L2 contract.

### `toggleExpandedView`
`boolean` that `true` means if you click the app icon again it toggles expanded view. If `false` clicking the app icon again does not toggle the view.


## Running
```
# development of sdk
yarn start

# Run the example page
cd ./example
yarn start
```

## Building
```
yarn build
```


## License

MIT © [pagreczner](https://github.com/pagreczner)

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