UNPKG

@parity/light.js

Version:

A high-level reactive JS library optimized for light clients

169 lines (99 loc) 5.8 kB
# Functions <a id="accounts_"></a> ## accounts$ **accounts$**(options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`string`[]> *Defined in [rpc/eth.ts:39](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L39)* Observable which contains the array of all addresses managed by the light client. Calls eth\_accounts. **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | Options to pass to [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md). | **Returns:** `Observable`<`string`[]> * An Observable containing the list of public addresses. ___ <a id="balanceof_"></a> ## balanceOf$ **balanceOf$**(address: *[Address](_types_.md#address)*, options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`symbol` \| `BigNumber`> *Defined in [rpc/eth.ts:53](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L53)* Get the balance of a given account. Calls `eth_getBalance`. **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | address | [Address](_types_.md#address) | The account address to query the balance. | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | Options to pass to [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md). | **Returns:** `Observable`<`symbol` \| `BigNumber`> * An Observable containing the balance. ___ <a id="blocknumber_"></a> ## blockNumber$ **blockNumber$**(options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`BigNumber`> *Defined in [rpc/eth.ts:103](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L103)* Get the current block number. **Parameters:** | Name | Type | | ------ | ------ | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | **Returns:** `Observable`<`BigNumber`> * An Observable containing the block height. ___ <a id="chainid_"></a> ## chainId$ **chainId$**(options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`symbol` \| `BigNumber`> *Defined in [rpc/eth.ts:21](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L21)* Observable containing the EIP155 chain ID used for transaction signing. Calls `eth_chainId` **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | Options to pass to [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md). | **Returns:** `Observable`<`symbol` \| `BigNumber`> * An Observable containing the chain ID. ___ <a id="defaultaccount_"></a> ## defaultAccount$ **defaultAccount$**(options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`string`> *Defined in [rpc/eth.ts:90](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L90)* Get the default account managed by the light client. **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | Options to pass to [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md). | **Returns:** `Observable`<`string`> * An Observable containing the public address of the default account. ___ <a id="mybalance_"></a> ## myBalance$ **myBalance$**(options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`symbol` \| `BigNumber`> *Defined in [rpc/eth.ts:114](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L114)* Shorthand for fetching the current account's balance. **Parameters:** | Name | Type | | ------ | ------ | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | **Returns:** `Observable`<`symbol` \| `BigNumber`> ___ <a id="syncstatus_"></a> ## syncStatus$ **syncStatus$**(options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`false` \| `true` \| `object`> *Defined in [rpc/eth.ts:128](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L128)* Get the syncStatus state. **Parameters:** | Name | Type | | ------ | ------ | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | **Returns:** `Observable`<`false` \| `true` \| `object`> * An Observable containing the syncing state object, or false. ___ <a id="transactioncountof_"></a> ## transactionCountOf$ **transactionCountOf$**(address: *[Address](_types_.md#address)*, options?: *[RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md)*): `Observable`<`symbol` \| `BigNumber`> *Defined in [rpc/eth.ts:69](https://github.com/paritytech/js-libs/blob/66e2091/packages/light.js/src/rpc/eth.ts#L69)* Get the transaction count of a given account. Calls `eth_getTransactionCount` **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | address | [Address](_types_.md#address) | Address of the account whose transaction count we want to query. | | `Optional` options | [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md) | Options to pass to [RpcObservableOptions](../interfaces/_types_.rpcobservableoptions.md). | **Returns:** `Observable`<`symbol` \| `BigNumber`> * An Observable containing the transaction count. ___