js-conflux-sdk/api.md

----------
# Conflux

A sdk of conflux.


## Conflux.constructor



### Parameters

Name                    | Type                    | Required | Default                  | Description
------------------------|-------------------------|----------|--------------------------|---------------------------------------------------------------
options                 | object                  | false    |                          | Conflux and Provider constructor options.
options.url             | string                  | false    | ''                       | Url of provider to create.
options.defaultEpoch    | string,number           | false    | EpochNumber.LATEST_STATE | Default epochNumber.
options.defaultGasPrice | string,number,BigNumber | false    |                          | The default gas price in drip to use for transactions.
options.defaultGas      | string,number,BigNumber | false    |                          | The default maximum gas provided for a transaction (gasLimit).

### Return

`void`

### Example

```
> const Conflux = require('conflux-web');
> const cfx = new Conflux({url:'http://testnet-jsonrpc.conflux-chain.org:12537'});
```

```
> const cfx = new Conflux({
  url: 'http://localhost:8000',
  defaultGasPrice: 100,
  defaultGas: 100000,
  logger: console,
});
```

## Conflux.setProvider

Create and set `provider`.

### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|------------------------------
url     | string | true     |         | Url of provider to create.
options | object | false    |         | Provider constructor options.

### Return

`Object` 

### Example

```
> cfx.provider;
   HttpProvider {
     url: 'http://testnet-jsonrpc.conflux-chain.org:12537',
     timeout: 60000,
     ...
   }
> cfx.setProvider('http://localhost:8000');
> cfx.provider;
   HttpProvider {
     url: 'http://localhost:8000',
     timeout: 60000,
     ...
   }
```

## Conflux.Contract

A shout cut for `new Contract(cfx, options);`

### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|---------------------------
options | object | true     |         | See `Contract.constructor`

### Return

`Contract` 


## Conflux.close

close connection.

### Parameters

`void`

### Return

`void`

### Example

```
> cfx.close();
```

## Conflux.getGasPrice

Returns the current gas price oracle. The gas price is determined by the last few blocks median gas price.

### Parameters

`void`

### Return

`Promise.<BigNumber>` Gas price in drip.

### Example

```
> await cfx.getGasPrice();
   "0"
```

## Conflux.getEpochNumber

Returns the current epochNumber the client is on.

### Parameters

Name        | Type          | Required | Default | Description
------------|---------------|----------|---------|-----------------------------------------
epochNumber | string,number | false    |         | The end epochNumber to count balance of.

### Return

`Promise.<number>` EpochNumber

### Example

```
> await cfx.getEpochNumber();
   200109
```

## Conflux.getLogs

Gets past logs, matching the given options.

### Parameters

Name                | Type                  | Required | Default | Description
--------------------|-----------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
options             | object                | false    |         |
options.fromEpoch   | string,number         | false    |         | The number of the start block. (>=)
options.toEpoch     | string,number         | false    |         | The number of the stop block.(<=)
options.blockHashes | Array.<string>        | false    |         | The block hash list
options.address     | string,Array.<string> | false    |         | An address or a list of addresses to only get logs from particular account(s).
options.topics      | array                 | false    |         | An array of values which must each appear in the log entries. The order is important, if you want to leave topics out use null, e.g. [null, '0x12...']. You can also pass an array for each topic with options for that topic e.g. [null, ['option1', 'option2']]
options.limit       | number                | false    |         | Limit log number.

### Return

`Promise.<LogIterator>` Array of log objects.
- `string` address: Address this event originated from.
- `string[]` topics: An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the event.
- `string` data: The data containing non-indexed log parameter.
- `string` type: TODO
- `boolean` removed: TODO
- `number` epochNumber: The epochNumber this log was created in. null when still pending.
- `string` blockHash: Hash of the block this event was created in. null when it’s still pending.
- `string` transactionHash: Hash of the transaction this event was created in.
- `string` transactionIndex: Integer of the transaction’s index position the event was created in.
- `number` logIndex: Integer of the event index position in the block.
- `number` transactionLogIndex: Integer of the event index position in the transaction.

### Example

```
> await cfx.getLogs({
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      fromEpoch: 0,
      toEpoch: 'latest_mined',
      limit: 1,
      topics: [
        '0xb818399ffd68e821c34de8d5fbc5aeda8456fdb9296fc1b02bf6245ade7ebbd4',
        '0x0000000000000000000000001ead8630345121d19ee3604128e5dc54b36e8ea6'
      ]
    });

   [
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      blockHash: '0x701afee0ffc49aaebadf0e6618b6ec1715d31e7aa639e2e00dc8df10994e0283',
      data: '0x',
      epochNumber: 542556,
      logIndex: 0,
      removed: false,
      topics: [
        '0xb818399ffd68e821c34de8d5fbc5aeda8456fdb9296fc1b02bf6245ade7ebbd4',
        '0x0000000000000000000000001ead8630345121d19ee3604128e5dc54b36e8ea6'
      ],
      transactionHash: '0x5a301d2c342709d7de9da24bd096ab3754ea328b016d85ab3410d375616f5d0d',
      transactionIndex: 0,
      transactionLogIndex: 0,
      type: 'mined'
     },
   ]
```

```
> logIter = cfx.getLogs({
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      fromEpoch: 'latest_mined',
      limit: 2,
      })
> await logIter.next({threshold: 0.01, delta: 1000});
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      ...
   }
> await logIter.next();
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      ...
   }
> await logIter.next();
   undefined
```

```
> logIter = cfx.getLogs({
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      fromEpoch: 'latest_mined',
      limit: 2,
      })
> for await (const log of iter) {
       console.log(log);
     }
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      ...
   }
   ...
```

## Conflux.getBalance

Get the balance of an address at a given epochNumber.

### Parameters

Name        | Type          | Required | Default           | Description
------------|---------------|----------|-------------------|-----------------------------------------
address     | string        | true     |                   | The address to get the balance of.
epochNumber | string,number | false    | this.defaultEpoch | The end epochNumber to count balance of.

### Return

`Promise.<BigNumber>` Address balance number in drip.

### Example

```
> let balance = await cfx.getBalance("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b");
> balance;
   BigNumber { s: 1, e: 18, c: [ 17936, 36034970586632 ] }
> Drip.toCFX(balance).toString(10);
   1.793636034970586632
> balance = await cfx.getBalance("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b", 0);
> balance.toString(10);
   0
```

## Conflux.getTransactionCount

Get the numbers of transactions sent from this address.

### Parameters

Name        | Type          | Required | Default           | Description
------------|---------------|----------|-------------------|-----------------------------------------------------
address     | string        | true     |                   | The address to get the numbers of transactions from.
epochNumber | string,number | false    | this.defaultEpoch | The end epochNumber to count transaction of.

### Return

`Promise.<number>` 

### Example

```
> await cfx.getTransactionCount("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b");
   61
> await cfx.getTransactionCount("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b", 0);
   0
```

## Conflux.getBlockByEpochNumber

Get the epochNumber pivot block info.

### Parameters

Name        | Type          | Required | Default | Description
------------|---------------|----------|---------|--------------------------------------------------------------
epochNumber | string,number | true     |         | EpochNumber or string in ["latest_state", "latest_mined"]
detail      | boolean       | false    | false   | `true` return transaction object, `false` return TxHash array

### Return

`Promise.<(object|null)>` The block info (same as `getBlockByHash`).

### Example

```
> await cfx.getBlockByEpochNumber(449);
   {
     hash: '0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40',
     ...
   }
```

## Conflux.getBlocksByEpochNumber

Get block hash array of a epochNumber.

### Parameters

Name        | Type          | Required | Default | Description
------------|---------------|----------|---------|----------------------------------------------------------
epochNumber | string,number | true     |         | EpochNumber or string in ["latest_state", "latest_mined"]

### Return

`Promise.<Array.<string>>` Block hash array, last one is the pivot block hash of this epochNumber.

### Example

```
> await cfx.getBlocksByEpochNumber(0);
   ['0x2da120ad267319c181b12136f9e36be9fba59e0d818f6cc789f04ee937b4f593']
> await cfx.getBlocksByEpochNumber(449);
   [
   '0x3d8b71208f81fb823f4eec5eaf2b0ec6b1457d381615eff2fbe24605ea333c39',
   '0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40'
   ]
```

## Conflux.getBestBlockHash

> TODO

### Parameters

`void`

### Return

`Promise.<string>` 

### Example

```
> await cfx.getBestBlockHash();
   "0x43ddda130fff8539b9f3c431aa1b48e021b3744aacd224cbd4bcdb64373f3dd5"
```

## Conflux.getBlockByHash

Returns a block matching the block hash.

### Parameters

Name      | Type    | Required | Default | Description
----------|---------|----------|---------|--------------------------------------------------------------
blockHash | string  | true     |         | The hash of block to be get.
detail    | boolean | false    | false   | `true` return transaction object, `false` return TxHash array

### Return

`Promise.<(object|null)>` Block info object.
- `string` miner: The address of the beneficiary to whom the mining rewards were given.
- `string|null` hash: Hash of the block. `null` when its pending block.
- `string` parentHash: Hash of the parent block.
- `string[]` refereeHashes: Array of referee hashes.
- `number|null` epochNumber: The current block epochNumber in the client's view. `null` when it's not in best block's past set.
- `boolean|null` stable: If the block stable or not. `null` for pending stable.
- `string` nonce: Hash of the generated proof-of-work. `null` when its pending block.
- `number` gas: The maximum gas allowed in this block.
- `string` difficulty: Integer string of the difficulty for this block.
- `number` height: The block heights. `null` when its pending block.
- `number` size: Integer the size of this block in bytes.
- `number` blame: 0 if there's nothing to blame; k if the block is blaming on the state info of its k-th ancestor.
- `boolean` adaptive: If the block's weight adaptive or not.
- `number` timestamp: The unix timestamp for when the block was collated.
- `string` transactionsRoot: The hash of the transactions of the block.
- `string[]` transactions: Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
- `string` deferredLogsBloomHash: The hash of the deferred block's log bloom filter
- `string` deferredReceiptsRoot: The hash of the receipts of the block after deferred execution.
- `string` deferredStateRoot: The root of the final state trie of the block after deferred execution.
- `object` deferredStateRootWithAux: Information of deferred state root

### Example

```
> await cfx.getBlockByHash('0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40');
   {
    "miner": "0x0000000000000000000000000000000000000015",
    "hash": "0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40",
    "parentHash": "0xe75f82d86f51cdab5a2ed7b4e225c714d1fda7e0aa568c6b4618015ee6666506",
    "refereeHashes": [
      "0x3d8b71208f81fb823f4eec5eaf2b0ec6b1457d381615eff2fbe24605ea333c39"
    ],
    "epochNumber": 449,
    "stable": null,
    "nonce": 17364797680136698000,
    "gas": 3000000000,
    "difficulty": "20000000",
    "height": 449,
    "size": 384,
    "blame": 0,
    "adaptive": false,
    "timestamp": 1571150247,
    "transactionsRoot": "0x2b8f5e08ca12eb66ae89f40a6b52938222ce835f0b786cae0befdbbecd8b55e1"
    "transactions": [
      "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914"
    ],
    "deferredLogsBloomHash": "0xd397b3b043d87fcd6fad1291ff0bfd16401c274896d8c63a923727f077b8e0b5",
    "deferredReceiptsRoot": "0x522717233b96e0a03d85f02f8127aa0e23ef2e0865c95bb7ac577ee3754875e4",
    "deferredStateRoot": "0x39975f9bf46884e7c3c269577177af9a041c5e36a69ef2a4cf581f8a061fa911",
    "deferredStateRootWithAux": {
      "auxInfo": {
        "intermediateDeltaEpochId": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
        "previousSnapshotRoot": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"
      },
      "stateRoot": {
        "deltaRoot": "0x752a3f391da1a584812a9f50ec92542abda59c3cc0ad49741461471680cf1528",
        "intermediateDeltaRoot": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
        "snapshotRoot": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"
      }
    },
   }
```

```
> await cfx.getBlockByHash('0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40', true);
   {
    "hash": "0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40",
    "transactions": [
      {
        "blockHash": "0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40",
        "transactionIndex": 0,
        "hash": "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914",
        "nonce": 0,
        "from": "0xa70ddf9b9750c575db453eea6a041f4c8536785a",
        "to": "0x63f0a574987f6893e068a08a3fb0e63aec3785e6",
        "value": "1000000000000000000"
        "data": "0x",
        "gas": 21000,
        "gasPrice": "819",
        "status": 0,
        "contractCreated": null,
        "r": "0x88e43a02a653d5895ffa5495718a5bd772cb157776108c5c22cee9beff890650",
        "s": "0x24e3ba1bb0d11c8b1da8d969ecd0c5e2372326a3de71ba1231c876c0efb2c0a8",
        "v": 0,
      }
    ],
    ...
   }
```

## Conflux.getBlockByHashWithPivotAssumption

Get block by `blockHash` if pivot block of `epochNumber` is `pivotBlockHash`.

### Parameters

Name           | Type   | Required | Default | Description
---------------|--------|----------|---------|----------------------------------------------------------------
blockHash      | string | true     |         | Block hash which epochNumber expect to be `epochNumber`.
pivotBlockHash | string | true     |         | Block hash which expect to be the pivot block of `epochNumber`.
epochNumber    | number | true     |         | EpochNumber or string in ["latest_state", "latest_mined"]

### Return

`Promise.<object>` The block info (same as `getBlockByHash`).

### Example

```
> await cfx.getBlockByHashWithPivotAssumption(
'0x3d8b71208f81fb823f4eec5eaf2b0ec6b1457d381615eff2fbe24605ea333c39',
'0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40'
449,
);
   {
     hash: '0x3d8b71208f81fb823f4eec5eaf2b0ec6b1457d381615eff2fbe24605ea333c39',
     ...
   }
```

## Conflux.getTransactionByHash

Returns a transaction matching the given transaction hash.

### Parameters

Name   | Type   | Required | Default | Description
-------|--------|----------|---------|----------------------
txHash | string | true     |         | The transaction hash.

### Return

`Promise.<(object|null)>` Transaction info object
- `string` blockHash: Hash of the block where this transaction was in and got executed. `null` when its pending.
- `number` transactionIndex: Integer of the transactions index position in the block.
- `string` hash: Hash of the transaction.
- `number` nonce: The number of transactions made by the sender prior to this one.
- `string` from: Address of the sender.
- `string` to: Address of the receiver. null when its a contract creation transaction.
- `string` value: Value transferred in Drip.
- `string` data: The data send along with the transaction.
- `number` gas: Gas provided by the sender.
- `number` gasPrice: Gas price provided by the sender in Drip.
- `string` status: '0x0' successful execution; '0x1' exception happened but nonce still increased; '0x2' exception happened and nonce didn't increase.
- `string|null` contractCreated: The contract address created, if the transaction was a contract creation, otherwise null.
- `string` r: ECDSA signature r
- `string` s: ECDSA signature s
- `string` v: ECDSA recovery id

### Example

```
> await cfx.getTransactionByHash('0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914');
   {
      "blockHash": "0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40",
      "transactionIndex": 0,
      "hash": "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914",
      "nonce": 0,
      "from": "0xa70ddf9b9750c575db453eea6a041f4c8536785a",
      "to": "0x63f0a574987f6893e068a08a3fb0e63aec3785e6",
      "value": "1000000000000000000"
      "data": "0x",
      "gas": 21000,
      "gasPrice": "819",
      "status": 0,
      "contractCreated": null,
      "r": "0x88e43a02a653d5895ffa5495718a5bd772cb157776108c5c22cee9beff890650",
      "s": "0x24e3ba1bb0d11c8b1da8d969ecd0c5e2372326a3de71ba1231c876c0efb2c0a8",
      "v": 0,
    }
```

## Conflux.getTransactionReceipt

Returns the receipt of a transaction by transaction hash.

> Note: The receipt is not available for pending transactions and returns null.

### Parameters

Name   | Type   | Required | Default | Description
-------|--------|----------|---------|----------------------
txHash | string | true     |         | The transaction hash.

### Return

`Promise.<(object|null)>` - `number` outcomeStatus: `0`: the transaction was successful, `1`: EVM reverted the transaction.
- `string` stateRoot: The state root of transaction execution.
- `number` epochNumber: EpochNumber where this transaction was in.
- `string` blockHash: Hash of the block where this transaction was in.
- `string` transactionHash: Hash of the transaction.
- `number` index: Integer of the transactions index position in the block.
- `string` from: Address of the sender.
- `string` to: Address of the receiver. null when its a contract creation transaction.
- `string|null` contractCreated: The contract address created, if the transaction was a contract creation, otherwise null.
- `number` gasUsed: The amount of gas used by this specific transaction alone.
- `[object]` logs: Array of log objects, which this transaction generated.
- `[string]` logs[].address: The address of the contract executing at the point of the `LOG` operation.
- `[string]` logs[].topics: The topics associated with the `LOG` operation.
- `[string]` logs[].data: The data associated with the `LOG` operation.
- `string` logsBloom: Log bloom.

### Example

```
> await cfx.getTransactionReceipt('0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914');
   {
    "outcomeStatus": 0,
    "stateRoot": "0x3854f64be6c124dffd0ddca57270846f0f43a119ea681b4e5d022ade537d9f07",
    "epochNumber": 449,
    "blockHash": "0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40",
    "transactionHash": "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914"
    "index": 0,
    "from": "0xa70ddf9b9750c575db453eea6a041f4c8536785a",
    "to": "0x63f0a574987f6893e068a08a3fb0e63aec3785e6",
    "contractCreated": null,
    "gasUsed": 21000,
    "logs": [],
    "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
   }
```

## Conflux.sendTransaction

Creates new message call transaction or a contract creation, if the data field contains code.

> FIXME: rpc `cfx_sendTransaction` not implement yet.

> NOTE: if `from` options is a instance of `Account`, this methods will sign by account local and send by `cfx_sendRawTransaction`, else send by `cfx_sendTransaction`

### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|------------------------------
options | object | true     |         | See `Transaction.callOptions`

### Return

`Promise.<PendingTransaction>` The PendingTransaction object.

### Example

```
> // TODO call with address, need `cfx_sendTransaction`
```

```
> const account = cfx.wallet.add(KEY);
> await cfx.sendTransaction({
      from: account, // from account instance will sign by local.
      to: ADDRESS,
      value: Drip.fromCFX(0.023),
    });
   "0x459473cb019bb59b935abf5d6e76d66564aafa313efd3e337b4e1fa6bd022cc9"
```

```
> await cfx.sendTransaction({
      from: account,
      to: account, // to account instance
      value: Drip.fromCFX(0.03),
    }).get(); // send then get transaction by hash.
   {
    "blockHash": null,
    "transactionIndex": null,
    "hash": "0xf2b258b49d33dd22419526e168ebb79b822889cf8317ce1796e816cce79e49a2",
    "contractCreated": null,
    "data": "0x",
    "from": "0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "nonce": 111,
    "status": null,
    "to": "0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "value": "30000000000000000",
    ...
   }
```

```
> const promise = cfx.sendTransaction({ // Not await here, just get promise
      from: account1,
      to: ADDRESS1,
      value: Drip.fromCFX(0.007),
    });
> await promise; // transaction
   "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688"
> await promise.get(); // get transaction
   {
    "blockHash": null,
    "transactionIndex": null,
    "hash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    ...
   }
> await promise.mined(); // wait till transaction mined
   {
    "blockHash": "0xe9b22ce311003e26c7330ac54eea9f8afea0ffcd4905828f27c9e2c02f3a00f7",
    "transactionIndex": 0,
    "hash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    ...
   }
> await promise.executed(); // wait till transaction executed in right status. and return it's receipt.
   {
    "blockHash": "0xe9b22ce311003e26c7330ac54eea9f8afea0ffcd4905828f27c9e2c02f3a00f7",
    "index": 0,
    "transactionHash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    "outcomeStatus": 0,
    ...
   }
> await promise.confirmed(); // wait till transaction risk coefficient '<' threshold.
   {
    "blockHash": "0xe9b22ce311003e26c7330ac54eea9f8afea0ffcd4905828f27c9e2c02f3a00f7",
    "index": 0,
    "transactionHash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    "outcomeStatus": 0,
    ...
   }
```

## Conflux.sendRawTransaction

Signs a transaction. This account needs to be unlocked.

### Parameters

Name | Type          | Required | Default | Description
-----|---------------|----------|---------|------------------------
hex  | string,Buffer | true     |         | Raw transaction string.

### Return

`Promise.<PendingTransaction>` The PendingTransaction object. See `sendTransaction`

### Example

```
> await cfx.sendRawTransaction('0xf85f800382520894bbd9e9b...');
   "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914"
```

## Conflux.getCode

Get the code at a specific address.

### Parameters

Name        | Type          | Required | Default           | Description
------------|---------------|----------|-------------------|----------------------------------------------------------
address     | string        | true     |                   | The contract address to get the code from.
epochNumber | string,number | false    | this.defaultEpoch | EpochNumber or string in ["latest_state", "latest_mined"]

### Return

`Promise.<string>` Code hex string

### Example

```
> await cfx.getCode('0xb385b84f08161f92a195953b980c8939679e906a');
   "0x6080604052348015600f57600080fd5b506004361060325760003560e01c806306661abd1460375780638..."
```

## Conflux.call

Executes a message call transaction, which is directly executed in the VM of the node,
but never mined into the block chain.

### Parameters

Name        | Type          | Required | Default           | Description
------------|---------------|----------|-------------------|----------------------------------------
options     | object        | true     |                   | See `Transaction.callOptions`
epochNumber | string,number | false    | this.defaultEpoch | The end epochNumber to execute call of.

### Return

`Promise.<string>` Hex bytes the contract method return.


## Conflux.estimateGas

Executes a message call or transaction and returns the amount of the gas used.

### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|------------------------------
options | object | true     |         | See `Transaction.callOptions`

### Return

`Promise.<BigNumber>` The used gas for the simulated call/transaction.


----------
# contract.Contract

Contract with all its methods and events defined in its abi.


## Contract.constructor



### Parameters

Name            | Type    | Required | Default | Description
----------------|---------|----------|---------|-----------------------------------------------------------------------------------------------------
cfx             | Conflux | true     |         | Conflux instance.
options         | object  | true     |         |
options.abi     | array   | true     |         | The json interface for the contract to instantiate
options.address | string  | false    |         | The address of the smart contract to call, can be added later using `contract.address = '0x1234...'`
options.code    | string  | false    |         | The byte code of the contract, can be added later using `contract.constructor.code = '0x1234...'`

### Return

`object` 

### Example

```
> const contract = cfx.Contract({ abi, code });
> contract instanceof Contract;
   true
> contract.abi; // input abi
   [{type:'constructor', inputs:[...]}, ...]
> contract.constructor.code; // input code
   "0x6080604052600080..."
// deploy a contract by send constructor then wait and get contract address by `PendingTransaction.deployed` trick.
> await contract.constructor(100).sendTransaction({ from: account }).deployed();
   "0xc3ed1a06471be1d3bcd014051fbe078387ec0ad8"
```

```
> const contract = cfx.Contract({ abi, address });
> contract.address
   "0xc3ed1a06471be1d3bcd014051fbe078387ec0ad8"
> await contract.count(); // call a method without parameter, get decoded return value.
   BigNumber { _hex: '0x64' }
> await contract.inc(1); // call a method with parameters, get decoded return value.
   BigNumber { _hex: '0x65' }
> await contract.count().call({ from: account }); // call a method from a account.
   BigNumber { _hex: '0x64' }
> await contract.count().estimateGas();
   21655
> await contract.count().estimateGas({ from: ADDRESS, nonce: 68 }); // if from is a address string, nonce is required
   21655
// send transaction from account instance, then wait till confirmed, and get receipt.
> await contract.inc(1)
   .sendTransaction({ from: account1 })
   .confirmed({ threshold: 0.01, timeout: 30 * 1000 });
   {
     "blockHash": "0xba948c8925f6d7f14faf540c3b9e6d24d33c78168b2dd81a6021a50949d9f0d7",
     "index": 0,
     "transactionHash": "0x8a5f48c2de0f1bdacfe90443810ad650e4b327a0d19ce49a53faffb224883e42",
     "outcomeStatus": 0,
     ...
   }
> tx = await cfx.getTransactionByHash('0x8a5f48c2de0f1bdacfe90443810ad650e4b327a0d19ce49a53faffb224883e42');
> await contract.abi.decodeData(tx.data)
   {
     name: 'inc',
     params: [BigNumber{0x01}]
   }
> await contract.count(); // data in block chain changed by transaction.
   BigNumber { _hex: '0x65' }
> logs = await contract.SelfEvent(account1.address).getLogs()
   [
   {
      address: '0xc3ed1a06471be1d3bcd014051fbe078387ec0ad8',
      blockHash: '0xc8cb678891d4914aa66670e3ebd7a977bb3e38d2cdb1e2df4c0556cb2c4715a4',
      data: '0x000000000000000000000000000000000000000000000000000000000000000a',
      epochNumber: 545896,
      logIndex: 0,
      removed: false,
      topics: [
        '0xc4c01f6de493c58245fb681341f3a76bba9551ce81b11cbbb5d6d297844594df',
        '0x000000000000000000000000bbd9e9be525ab967e633bcdaeac8bd5723ed4d6b'
      ],
      transactionHash: '0x9100f4f84f711aa358e140197e9d2e5aab1f99751bc26a660d324a8282fc54d0',
      transactionIndex: 0,
      transactionLogIndex: 0,
      type: 'mined',
      params: [ '0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b', '10' ]
     }
   ]
> contract.abi.decodeLog(logs[0]);
   {
      name: "SelfEvent",
      params: [
        '0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b',
        BigNumber{0x64},
      ]
    }
```

----------
# provider.HttpProvider

Http protocol json rpc provider.


## HttpProvider.constructor



### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|-------------------------------
url     | string | true     |         | Full json rpc http url
options | object | false    |         | See `BaseProvider.constructor`

### Return

`HttpProvider` 

### Example

```
> const provider = new HttpProvider('http://testnet-jsonrpc.conflux-chain.org:12537', {logger: console});
```

## HttpProvider.call

Call a json rpc method with params

### Parameters

Name      | Type   | Required | Default | Description
----------|--------|----------|---------|------------------------
method    | string | true     |         | Json rpc method name.
...params | array  | false    |         | Json rpc method params.

### Return

`Promise.<*>` Json rpc method return value.

### Example

```
> await provider.call('cfx_epochNumber');
> await provider.call('cfx_getBlockByHash', blockHash);
```

----------
# Transaction




## Transaction.constructor

Signs a transaction. This account needs to be unlocked.

### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|-----------------------------
options | object | true     |         | See `Transaction.rawOptions`

### Return

`Transaction` 


## Transaction.hash

Getter of transaction hash include signature.

> Note: calculate every time.

### Parameters

`void`

### Return

`string,undefined` If transaction has r,s,v return hex string, else return undefined.


## Transaction.from

Getter of sender address.

> Note: calculate every time.

### Parameters

`void`

### Return

`string,undefined` If ECDSA recover success return address, else return undefined.


## Transaction.sign

Sign transaction and set 'r','s','v'.

### Parameters

Name       | Type   | Required | Default | Description
-----------|--------|----------|---------|------------------------
privateKey | string | true     |         | Private key hex string.

### Return

`void`


## Transaction.encode

Encode rlp.

### Parameters

Name             | Type    | Required | Default | Description
-----------------|---------|----------|---------|-----------------------------------------
includeSignature | boolean | false    | false   | Whether or not to include the signature.

### Return

`Buffer` 


## Transaction.serialize

Get the raw tx hex string.

### Parameters

`void`

### Return

`Buffer` 


## Transaction.sendOptions



### Parameters

Name             | Type                    | Required | Default | Description
-----------------|-------------------------|----------|---------|----------------------------------------------------------------------------------------------------
options          | object                  | true     |         |
options.from     | string                  | true     |         | The address the transaction is send from.
options.nonce    | string,number           | true     |         | This allows to overwrite your own pending transactions that use the same nonce.
options.gasPrice | string,number           | true     |         | The gasPrice used for each paid gas.
options.gas      | string,number           | true     |         | The gas provided for the transaction execution. It will return unused gas.
options.to       | string                  | false    |         | The address the transaction is directed to.
options.value    | string,number,BigNumber | false    |         | the value sent with this transaction
options.data     | string,Buffer           | false    | ''      | The compiled code of a contract OR the hash of the invoked method signature and encoded parameters.

### Return

`object` Formatted send transaction options object.


## Transaction.callOptions



### Parameters

Name             | Type                    | Required | Default | Description
-----------------|-------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------
options          | object                  | true     |         |
options.from     | string                  | false    |         | The address the transaction is sent from.
options.nonce    | string,number           | false    |         | The caller nonce (transaction count).
options.gasPrice | string,number           | false    |         | The gasPrice used for each paid gas.
options.gas      | string,number           | false    |         | The gas provided for the transaction execution. `call` consumes zero gas, but this parameter may be needed by some executions.
options.to       | string                  | true     |         | The address the transaction is directed to.
options.value    | string,number,BigNumber | false    |         | Integer of the value sent with this transaction.
options.data     | string,Buffer           | false    |         | Hash of the method signature and encoded parameters.

### Return

`object` Formatted call contract options object.


## Transaction.estimateOptions



### Parameters

Name             | Type                    | Required | Default | Description
-----------------|-------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------
options          | object                  | true     |         |
options.from     | string                  | false    |         | The address the transaction is sent from.
options.nonce    | string,number           | false    |         | The caller nonce (transaction count).
options.gasPrice | string,number           | false    |         | The gasPrice used for each paid gas.
options.gas      | string,number           | false    |         | The gas provided for the transaction execution. `call` consumes zero gas, but this parameter may be needed by some executions.
options.to       | string                  | false    |         | The address the transaction is directed to.
options.value    | string,number,BigNumber | false    |         | Integer of the value sent with this transaction.
options.data     | string,Buffer           | false    |         | Hash of the method signature and encoded parameters.

### Return

`object` Formatted call contract options object.


## Transaction.rawOptions



### Parameters

Name             | Type                    | Required | Default | Description
-----------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------
options          | object                  | true     |         |
options.nonce    | string,number           | true     |         | This allows to overwrite your own pending transactions that use the same nonce.
options.gasPrice | string,number,BigNumber | true     |         | The price of gas for this transaction in drip.
options.gas      | string,number           | true     |         | The amount of gas to use for the transaction (unused gas is refunded).
options.to       | string                  | false    |         | The destination address of the message, left undefined for a contract-creation transaction.
options.value    | string,number,BigNumber | false    | 0       | The value transferred for the transaction in drip, also the endowment if it’s a contract-creation transaction.
options.data     | string,Buffer           | false    | ''      | Either a ABI byte string containing the data of the function call on a contract, or in the case of a contract-creation transaction the initialisation code.
options.r        | string,Buffer           | false    |         | ECDSA signature r
options.s        | string,Buffer           | false    |         | ECDSA signature s
options.v        | string,number           | false    |         | ECDSA recovery id

### Return

`object` Formatted sign transaction options object.


----------
# utils.type



## type.EpochNumber.LATEST_STATE

The latest epochNumber where the latest block with an executed state in.
`string`


## type.EpochNumber.LATEST_MINED

The latest epochNumber where the latest mined block in.
`string`


## type.Hex

Hex formatter, trans value to hex string

### Parameters

Name  | Type                                     | Required | Default | Description
------|------------------------------------------|----------|---------|-----------------------------
value | string,number,Buffer,Date,BigNumber,null | true     |         | The value to gen hex string.

### Return

`string` Hex string.

### Example

```
> Hex(null)
 "0x"
> Hex(1) // also BigNumber
 "0x01"
> Hex('10') // from naked hex string
 "0x10"
> Hex('0x1') // pad prefix 0 auto
 "0x01"
> Hex(Buffer.from([1, 2]))
 "0x0102"
```

## type.Hex.isHex

Check if is hex string.

> Hex: /^0x([0-9a-f][0-9a-f])*$/

### Parameters

Name | Type   | Required | Default | Description
-----|--------|----------|---------|-------------------
hex  | string | true     |         | Value to be check.

### Return

`boolean` 

### Example

```
> Hex.isHex('0x')
 true
> Hex.isHex('0x01')
 true
> Hex.isHex('0x1')
 false
> Hex.isHex('01')
 false
```

## type.Hex.fromNumber

Get hex string from number.

### Parameters

Name  | Type                    | Required | Default | Description
------|-------------------------|----------|---------|------------
value | number,BigNumber,string | true     |         |

### Return

`string` 

### Example

```
> Hex.fromNumber('10')
 "0x0a"
> Hex('10')
 "0x10"
```

## type.Hex.toBuffer

Get `Buffer` by `Hex` string.

> NOTE: It's importance to only support `Hex` string, cause `Transaction.encode` will not check hex again.

### Parameters

Name | Type   | Required | Default | Description
-----|--------|----------|---------|----------------
hex  | string | true     |         | The hex string.

### Return

`Buffer` 

### Example

```
> Hex.toBuffer('0x0102')
 <Buffer 01 02>
```

## type.Hex.concat

Concat `Hex` string by order.

### Parameters

Name   | Type  | Required | Default | Description
-------|-------|----------|---------|--------------------
values | array | true     |         | Array of hex string

### Return

`string` 

### Example

```
> Hex.concat('0x01', '0x02', '0x0304')
 "0x01020304"
> Hex.concat()
 "0x"
```

## type.Address

Get and validate `Address` from value

### Parameters

Name  | Type                           | Required | Default | Description
------|--------------------------------|----------|---------|------------
value | string,number,Buffer,BigNumber | true     |         |

### Return

`string` 

### Example

```
> Address('0123456789012345678901234567890123456789')
 "0x0123456789012345678901234567890123456789"
```

## type.Hex32



### Parameters

Name  | Type                           | Required | Default | Description
------|--------------------------------|----------|---------|------------
value | string,number,Buffer,BigNumber | true     |         |

### Return

`string` 

### Example

```
> Hex32('0123456789012345678901234567890123456789012345678901234567890123')
 "0x0123456789012345678901234567890123456789012345678901234567890123"
```

## type.PrivateKey

Get and validate `PrivateKey` from value.

> same as `Hex32` in coincidence

### Parameters

Name  | Type                           | Required | Default | Description
------|--------------------------------|----------|---------|------------
value | string,number,Buffer,BigNumber | true     |         |

### Return

`string` 


## type.BlockHash

Get and validate `BlockHash` from value

> same as `Hex32` in coincidence

### Parameters

Name  | Type                           | Required | Default | Description
------|--------------------------------|----------|---------|------------
value | string,number,Buffer,BigNumber | true     |         |

### Return

`string` 


## type.TxHash

Get and validate `TxHash` from value

> same as `Hex32` in coincidence

### Parameters

Name  | Type                           | Required | Default | Description
------|--------------------------------|----------|---------|------------
value | string,number,Buffer,BigNumber | true     |         |

### Return

`string` 

### Example

```
> TxHash('0123456789012345678901234567890123456789012345678901234567890123')
 "0x0123456789012345678901234567890123456789012345678901234567890123"
```

## type.Drip



### Parameters

Name  | Type                           | Required | Default | Description
------|--------------------------------|----------|---------|------------
value | string,number,Buffer,BigNumber | true     |         |

### Return

`string` 

### Example

```
> Drip(1)
 "0x01"
```

```
> Drip.toGDrip(Drip.fromCFX(1));
 "1000000000"
```

## type.Drip.fromGDrip

Get Drip hex string by GDrip value.

> NOTE: Rounds towards nearest neighbour. If equidistant, rounds towards zero.

### Parameters

Name  | Type                    | Required | Default | Description
------|-------------------------|----------|---------|----------------
value | string,number,BigNumber | true     |         | Value in GDrip.

### Return

`string` Hex string in drip.

### Example

```
> Drip.fromGDrip(1)
 "0x3b9aca00"
> Drip.fromGDrip(0.1)
 "0x05f5e100"
```

## type.Drip.fromCFX

Get Drip hex string by CFX value.

> NOTE: Rounds towards nearest neighbour. If equidistant, rounds towards zero.

### Parameters

Name  | Type                    | Required | Default | Description
------|-------------------------|----------|---------|--------------
value | string,number,BigNumber | true     |         | Value in CFX.

### Return

`string` Hex string in drip.

### Example

```
> Drip.fromCFX(1)
 "0x0de0b6b3a7640000"
> Drip.fromCFX(0.1)
 "0x016345785d8a0000"
```

## type.Drip.toGDrip

Get `GDrip` from Drip.

### Parameters

Name  | Type                    | Required | Default | Description
------|-------------------------|----------|---------|------------
value | string,number,BigNumber | true     |         |

### Return

`BigNumber` 

### Example

```
> Drip.toGDrip(1e9)
 "1"
> Drip.toGDrip(Drip.fromCFX(1))
 "1000000000"
```

## type.Drip.toCFX

Get `CFX` from Drip.

### Parameters

Name  | Type                    | Required | Default | Description
------|-------------------------|----------|---------|------------
value | string,number,BigNumber | true     |         |

### Return

`BigNumber` 

### Example

```
> Drip.toCFX(1e18)
 "1"
> Drip.toCFX(Drip.fromGDrip(1e9))
 "1"
```

## type.EpochNumber

Get and validate `EpochNumber` from value

### Parameters

Name  | Type                           | Required | Default | Description
------|--------------------------------|----------|---------|------------
value | string,number,Buffer,BigNumber | true     |         |

### Return

`string` 

### Example

```
> EpochNumber(0)
 "0x00"
> EpochNumber('100')
 "0x64"
> EpochNumber('LATEST_STATE')
 "latest_state"
```

----------
# wallet.Account




## Account.constructor

Create a account by privateKey.

### Parameters

Name       | Type          | Required | Default | Description
-----------|---------------|----------|---------|------------
privateKey | string,Buffer | true     |         |

### Return

`Account` 


## Account.signTransaction

Sign a transaction.

### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|------------------
options | object | true     |         | See 'Transaction'

### Return

`Transaction` 


## Account.toString



### Parameters

`void`

### Return

`string` Account address as string.


----------
# wallet.Wallet

Contains an in memory wallet with multiple accounts.


## Wallet.constructor



### Parameters

Name | Type    | Required | Default | Description
-----|---------|----------|---------|------------
cfx  | Conflux | true     |         |

### Return

`Wallet` 


## Wallet.size

Get the number of account in wallet.
1 account have 1 address and 1 privateKey as key

### Parameters

`void`

### Return

`number` 


## Wallet.create

Create a random Account.

### Parameters

Name    | Type   | Required | Default | Description
--------|--------|----------|---------|-----------------
entropy | string | false    |         | Hex string seed.

### Return

`Account` 


## Wallet.get

Get a account in wallet by address or privateKey.

### Parameters

Name                | Type   | Required | Default | Description
--------------------|--------|----------|---------|------------
privateKeyOrAddress | string | true     |         | Hex string.

### Return

`Account` 


## Wallet.add

Add a account to wallet by privateKey.

### Parameters

Name       | Type          | Required | Default | Description
-----------|---------------|----------|---------|------------
privateKey | string,Buffer | true     |         |

### Return

`Account` 


## Wallet.remove

Remove a account in wallet by address or privateKey

### Parameters

Name                | Type   | Required | Default | Description
--------------------|--------|----------|---------|------------
privateKeyOrAddress | string | true     |         | Hex string.

### Return

`Account` 


## Wallet.clear

Clear all account in wallet.

### Parameters

`void`

### Return

`void`