# js-conflux-sdk

**Repository Path**: fgrass/js-conflux-sdk

## Basic Information

- **Project Name**: js-conflux-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-21
- **Last Updated**: 2021-06-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# js-conflux-sdk

[![npm](https://img.shields.io/npm/v/js-conflux-sdk.svg)](https://www.npmjs.com/package/js-conflux-sdk)
[![npm](https://img.shields.io/npm/dm/js-conflux-sdk.svg)](https://www.npmjs.com/package/js-conflux-sdk)

JavaScript Conflux Software Development Kit is a complete library for interacting with the Conflux Blockchain.

Features:
* Can be used in both browser and Node.js environment
* Connect to Conflux node over HTTP/Websocket JSON-RPC
* Meta-classes create JavaScript objects from any contract ABI
* Account utilities
* Type converter, sign and hash utilities
* Extensive [documentation](https://confluxnetwork.gitbook.io/js-conflux-sdk/)
* Builtin support for CRC20 and Internal Contracts

## Docs

* [Overview](docs/overview.md)
* [Complete document for sending transaction](docs/how_to_send_tx.md)
* [Interact with contract](docs/interact_with_contract.md)
* [SDK support for CIP37 address](docs/conflux_checksum_address.md)
* [API](docs/api/README.md)
* [Error handling](docs/error_handling.md)
* [Conflux Official document](https://developer.conflux-chain.org/docs/introduction/en/conflux_overview)
* [Conflux RPC endpoints](https://github.com/conflux-fans/conflux-rpc-endpoints)


## Quick Start

### Nodejs

```javascript
const { Conflux } = require('js-conflux-sdk');

const conflux = new Conflux({
  url: 'https://test.confluxrpc.com',
  networkId: 1,
  logger: console, // for debug
});
```

require deep nested file/dir

```javascript
const util = require('js-conflux-sdk/src/util');
```

### Frontend

#### umd

```javascript
import { Conflux } from 'js-conflux-sdk/dist/js-conflux-sdk.umd.min.js';
```

or if your bundler supports the [`browser` field](https://docs.npmjs.com/files/package.json#browser) in `package.json`

```javascript
import { Conflux } from 'js-conflux-sdk';
```

or

```markup
<script type="text/javascript" src="node_modules/js-conflux-sdk/dist/js-conflux-sdk.umd.min.js"></script>
<script type="text/javascript">
  const conflux = new window.Conflux.Conflux({
    url: 'https://test.confluxrpc.com',
    logger: console,
    networkId: 1,
  });
</script>
```

CDN links

* [`jsdelivr`](https://cdn.jsdelivr.net/npm/js-conflux-sdk/dist/js-conflux-sdk.umd.min.js)