Skip to content

Commit 4174724

Browse files
minor verb change
1 parent 06cfdd6 commit 4174724

File tree

2 files changed

+94
-94
lines changed

2 files changed

+94
-94
lines changed

docs/_sidebar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
- [Getting Started](quick-start.md)
22
- [Examples](examples.md)
33
- Core Methods
4-
- [web3data](api.md?id=web3datafactoryconstructorapikey-options-blockchainid-)
5-
- [webSockets](api.md?id=new-websocketclient)
4+
- [Web3Data](api.md?id=web3datafactoryconstructorapikey-options-blockchainid-)
5+
- [Websockets](api.md?id=new-websocketclient)
66
- [RPC](api.md?id=web3datafactoryrpcmethod-params)
77
- Market Data Methods
88
- [market.getFeatures](api.md?id=getfeaturesfeatures-filteroptions)

docs/api.md

Lines changed: 92 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,26 @@ const metrics = await web3data.address.getMetrics('0x3f5ce5fbfe3e9af3971dd833d26
547547

548548

549549

550+
### src/bch.js
551+
552+
553+
#### new Bch() *private method*
554+
555+
Class for all Bitcoin Cash based methods.
556+
557+
558+
559+
560+
561+
562+
##### Returns
563+
564+
565+
- `Void`
566+
567+
568+
569+
550570
### src/block.js
551571

552572

@@ -884,12 +904,12 @@ Retrieves the blocks metrics & statistics. If no DateRange is specified, it will
884904

885905

886906

887-
### src/bch.js
907+
### src/btc.js
888908

889909

890-
#### new Bch() *private method*
910+
#### new Btc() *private method*
891911

892-
Class for all Bitcoin Cash based methods.
912+
Class for all Bitcoin based methods.
893913

894914

895915

@@ -980,26 +1000,6 @@ Class for all Bitcoin SV based methods.
9801000

9811001

9821002

983-
##### Returns
984-
985-
986-
- `Void`
987-
988-
989-
990-
991-
### src/btc.js
992-
993-
994-
#### new Btc() *private method*
995-
996-
Class for all Bitcoin based methods.
997-
998-
999-
1000-
1001-
1002-
10031003
##### Returns
10041004

10051005

@@ -1208,12 +1208,12 @@ const code = await web3data.contract.getCode('0x06012c8cf97bead5deae237070f9587f
12081208

12091209

12101210

1211-
### src/eth.js
1211+
### src/ltc.js
12121212

12131213

1214-
#### new Eth() *private method*
1214+
#### new Ltc() *private method*
12151215

1216-
Class for all Ethereum based methods.
1216+
Class for all Litecoin based methods.
12171217

12181218

12191219

@@ -1228,25 +1228,85 @@ Class for all Ethereum based methods.
12281228

12291229

12301230

1231-
### src/ltc.js
1231+
### src/signature.js
12321232

12331233

1234-
#### new Ltc() *private method*
1234+
#### new Signature()
1235+
1236+
Contains methods pertaining to the `/signatures` endpoint of Amberdata's API.
1237+
1238+
1239+
1240+
1241+
1242+
1243+
##### Returns
1244+
1245+
1246+
- `Void`
12351247

1236-
Class for all Litecoin based methods.
12371248

12381249

1250+
#### Signature.constructor(web3data)
1251+
1252+
Creates an instance of Signature.
1253+
1254+
1255+
1256+
1257+
##### Parameters
1258+
1259+
| Name | Type | Description | |
1260+
| ---- | ---- | ----------- | -------- |
1261+
| web3data | `object` | - The web3data instance. |   |
12391262

12401263

12411264

12421265

1266+
##### Examples
1267+
1268+
```javascript
1269+
new Signature(new Web3Data('API_KEY'))
1270+
```
1271+
1272+
12431273
##### Returns
12441274

12451275

12461276
- `Void`
12471277

12481278

12491279

1280+
#### Signature.getSignature(hash)
1281+
1282+
Retrieves detailed information about the specified signature hash.
1283+
1284+
1285+
1286+
1287+
##### Parameters
1288+
1289+
| Name | Type | Description | |
1290+
| ---- | ---- | ----------- | -------- |
1291+
| hash | `string` | - The (keccak 256) of the signature. |   |
1292+
1293+
1294+
1295+
1296+
##### Examples
1297+
1298+
```javascript
1299+
const signatureDetails = await web3data.signature.getSignature('0xe2f0a05a')
1300+
```
1301+
1302+
1303+
##### Returns
1304+
1305+
1306+
- `Promise.<Array>` Information pertaining to the specified signature hash.
1307+
1308+
1309+
12501310

12511311
### src/market.js
12521312

@@ -1664,47 +1724,17 @@ const batTokenAddress = web3data.market.getAssetAddresses('bat') const assetAddr
16641724

16651725

16661726

1667-
### src/signature.js
1668-
1669-
1670-
#### new Signature()
1671-
1672-
Contains methods pertaining to the `/signatures` endpoint of Amberdata's API.
1673-
1674-
1675-
1676-
1677-
1678-
1679-
##### Returns
1680-
1681-
1682-
- `Void`
1683-
1684-
1685-
1686-
#### Signature.constructor(web3data)
1687-
1688-
Creates an instance of Signature.
1689-
1727+
### src/eth.js
16901728

16911729

1730+
#### new Eth() *private method*
16921731

1693-
##### Parameters
1732+
Class for all Ethereum based methods.
16941733

1695-
| Name | Type | Description | |
1696-
| ---- | ---- | ----------- | -------- |
1697-
| web3data | `object` | - The web3data instance. |   |
16981734

16991735

17001736

17011737

1702-
##### Examples
1703-
1704-
```javascript
1705-
new Signature(new Web3Data('API_KEY'))
1706-
```
1707-
17081738

17091739
##### Returns
17101740

@@ -1713,36 +1743,6 @@ new Signature(new Web3Data('API_KEY'))
17131743

17141744

17151745

1716-
#### Signature.getSignature(hash)
1717-
1718-
Retrieves detailed information about the specified signature hash.
1719-
1720-
1721-
1722-
1723-
##### Parameters
1724-
1725-
| Name | Type | Description | |
1726-
| ---- | ---- | ----------- | -------- |
1727-
| hash | `string` | - The (keccak 256) of the signature. |   |
1728-
1729-
1730-
1731-
1732-
##### Examples
1733-
1734-
```javascript
1735-
const signatureDetails = await web3data.signature.getSignature('0xe2f0a05a')
1736-
```
1737-
1738-
1739-
##### Returns
1740-
1741-
1742-
- `Promise.<Array>` Information pertaining to the specified signature hash.
1743-
1744-
1745-
17461746

17471747
### src/token.js
17481748

0 commit comments

Comments
 (0)