@q-dev/qdex-js-sdk/README

Typescript Library to interact with Q DEX Contracts

# Q Javascript SDK

## prepare

Install package as dependency

    npm install --save @q-dev/qdex-js-sdk

## using

Instantiation of ContractRegistry:
```javascript
const contractRegistry = new ContractRegistryInstance(web3)
```

Retrieving SDK version:
```javascript
import { Web3Adapter, Web3Factory, Web3 } from '@q-dev/q-js-sdk'
const web3 = Web3Factory.createFromMnemonic('your-rpc-Url', 'mnemonic')
const adapter = new Web3Adapter(web3)
const SDKVersion = adapter.SDK_VERSION
```

Obtaining of system-contracts instances:
```javascript
const validators = await contractRegistry.validators()
```

Read access:
```javascript
const longList = await validators.getLongList()
```

Write access:
```javascript
await validators.commitStake({from: 'user-address', value: 'amount-for-commit'})
```

### Full SDK api reference versions

* [latest](https://q-dev.gitlab.io/q-js-sdk/latest/)
* [devnet](https://q-dev.gitlab.io/q-js-sdk/devnet/)
* [testnet](https://q-dev.gitlab.io/q-js-sdk/testnet/)


## external documentations

* [System-contracts](https://q-dev.gitlab.io/system-contracts)
* [Web3](https://web3js.readthedocs.io/en/v1.5.2/)