Skip to content

Commit f4ef1ce

Browse files
taylorjdawsontaylorjdawson
committed
doc(transactions) Merge master
2 parents 7018afd + afab3e3 commit f4ef1ce

20 files changed

+9600
-941
lines changed

‎dist/web3data.min.js‎

Lines changed: 7 additions & 472 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/web3data.min.js.map‎

Lines changed: 20 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/web3data.min.map‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/api.md‎

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [web3data-js](https://github.com/web3data/web3data-js#readme) *0.5.14*
1+
# [web3data-js](https://github.com/web3data/web3data-js#readme) *0.5.15*
22

33
> A javascript wrapper for accessing amberdata's public API.
44
@@ -533,6 +533,44 @@ Retrieves all token transfers involving the specified address.
533533

534534

535535

536+
### src/block.js
537+
538+
539+
540+
#### getBlock(id, filterOptions)
541+
542+
543+
Retrieves the blocks specified by its id (number or hash).
544+
545+
546+
547+
548+
##### Parameters
549+
550+
| Name | Type | Description | |
551+
| ---- | ---- | ----------- | -------- |
552+
| id | | The number or hash of the block for which to retrieve block information. |   |
553+
| filterOptions | | |   |
554+
555+
556+
557+
558+
##### Examples
559+
560+
```javascript
561+
562+
```
563+
564+
565+
##### Returns
566+
567+
568+
-
569+
570+
571+
572+
573+
536574
### src/market.js
537575

538576

@@ -1322,6 +1360,39 @@ the appropriate parameter(s) where applicable.
13221360

13231361

13241362

1363+
#### uuid(data)
1364+
1365+
1366+
Generates a uuid see [this gist]() for more details.
1367+
1368+
1369+
1370+
1371+
##### Parameters
1372+
1373+
| Name | Type | Description | |
1374+
| ---- | ---- | ----------- | -------- |
1375+
| data | | |   |
1376+
1377+
1378+
1379+
1380+
##### Examples
1381+
1382+
```javascript
1383+
1384+
```
1385+
1386+
1387+
##### Returns
1388+
1389+
1390+
- `Void`
1391+
1392+
1393+
1394+
1395+
13251396
### src/web3data.js
13261397

13271398

‎docs/index.html‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,26 @@
1414
.app-sub-sidebar li:before {
1515
display: none;
1616
}
17+
summary {
18+
outline: none;
19+
}
20+
21+
summary::-webkit-details-marker {
22+
display: none
23+
}
24+
25+
summary:after {
26+
content: "➕";
27+
color: #222222;
28+
font-size: 10px;
29+
font-weight: 800;
30+
margin-left: 2px;
31+
width: 30px;
32+
}
33+
34+
details[open] > summary:after {
35+
content: "➖";
36+
}
1737
</style>
1838
</head>
1939
<body>

‎docs/quick-start.md‎

Lines changed: 77 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,90 @@ requests via web3data.js.
2828

2929
You can find the full [list of blockchain IDs](https://docs.amberdata.io/reference#blockchain-ids) in our docs.
3030

31-
## Blockchains
31+
## Blockchains/Networks
3232
It's possible to the namespace convention to specify which blockchain to use when making requests.
3333
This makes it easier to switch between blockchains as Web3data will automatically set the correct headers under
3434
the hood.
3535

36+
### Ethereum
37+
38+
**Namespace**: `.eth`
39+
40+
##### Example:
3641
```javascript
37-
// Ethereum
38-
web3data.eth.address.getBalance()
42+
web3data.eth.address.getBalance('0x734Ac651Dd95a339c633cdEd410228515F97fAfF')
43+
```
44+
45+
### Bitcoin
46+
47+
**Namespace**: `.btc`
48+
49+
<details><summary><b>Supported Methods </b></summary>
50+
51+
<table style="width:100%">
52+
<tr>
53+
<th>address</th>
54+
<th>block</th>
55+
<th>transaction</th>
56+
</tr>
57+
<tr>
58+
<td>getAllAddresses</td>
59+
<td>getBlocks</td>
60+
<td>getTransactions</td>
61+
</tr>
62+
<tr>
63+
<td>getInformation</td>
64+
<td>getBlock</td>
65+
<td>getTransaction</td>
66+
</tr>
67+
<tr>
68+
<td>getMetadata</td>
69+
<td>getBlockNumber</td>
70+
<td>getPendingTransactions</td>
71+
</tr>
72+
<tr>
73+
<td>getTransactions</td>
74+
<td>getTransactions</td>
75+
</tr>
76+
<tr>
77+
<td>getPendingTransactions</td>
78+
<td>getTransactionFromBlock</td>
79+
</tr>
80+
<tr>
81+
<td>getBalance</td>
82+
<td>getMetrics</td>
83+
</tr>
84+
<tr>
85+
<td>getLatestBalance</td>
86+
</tr>
87+
<tr>
88+
<td>getHistoricalBalance</td>
89+
</tr>
90+
<tr>
91+
<td>getMultipleBalances</td>
92+
</tr>
93+
<tr>
94+
<td>getBalancesBatch</td>
95+
</tr>
96+
<tr>
97+
<td>getMetrics</td>
98+
</tr>
99+
</table>
100+
</details>
39101

40-
// Bitcoin
41-
web3data.btc.address.getBalance()
102+
##### Example:
103+
```javascript
104+
web3data.btc.address.getBalance('1MUz4VMYui5qY1mxUiG8BQ1Luv6tqkvaiL')
42105
```
43106

44-
Note: When using the namespaced methods the blockchain Id set during instantiation will be ignored.
107+
### Litecoin
45108

109+
**Namespace**: `.ltc`
46110

111+
112+
##### Example:
113+
```javascript
114+
web3data.ltc.address.getBalance('LZo1qx6S5JEVh43KahTFBdvnkVFeQCz9Ze')
115+
```
116+
117+
Note: When using the namespaced methods the blockchain Id set during instantiation will be ignored.

0 commit comments

Comments
 (0)