Skip to content

Commit c64a301

Browse files
GoodforGodGoodforGod
committed
[2.0.0]
Javadoc improved
1 parent e6bee19 commit c64a301

File tree

17 files changed

+114
-108
lines changed

17 files changed

+114
-108
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=GoodforGod_java-etherscan-api&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=GoodforGod_java-etherscan-api)
77
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=GoodforGod_java-etherscan-api&metric=ncloc)](https://sonarcloud.io/dashboard?id=GoodforGod_java-etherscan-api)
88

9-
[Etherscan.io](https://etherscan.io/apis) Java API implementation.
9+
[Etherscan.io](https://docs.etherscan.io/) Java API implementation.
1010

11-
Library supports all available EtherScan *API* calls for all available *Ethereum Networks* for *etherscan.io*
11+
Library supports EtherScan *API* for all available *Ethereum Networks* for *etherscan.io*
1212

1313
## Dependency :rocket:
1414

‎src/main/java/io/goodforgod/api/etherscan/AccountAPI.java‎

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public interface AccountAPI {
2121
* @throws EtherScanException parent exception class
2222
*/
2323
@NotNull
24-
Balance balance(String address) throws EtherScanException;
24+
Balance balance(@NotNull String address) throws EtherScanException;
2525

2626
/**
2727
* ERC20 token balance for address
@@ -32,7 +32,7 @@ public interface AccountAPI {
3232
* @throws EtherScanException parent exception class
3333
*/
3434
@NotNull
35-
TokenBalance balance(String address, String contract) throws EtherScanException;
35+
TokenBalance balance(@NotNull String address, @NotNull String contract) throws EtherScanException;
3636

3737
/**
3838
* Maximum 20 address for single batch request If address MORE THAN 20, then there will be more than
@@ -43,7 +43,7 @@ public interface AccountAPI {
4343
* @throws EtherScanException parent exception class
4444
*/
4545
@NotNull
46-
List<Balance> balances(List<String> addresses) throws EtherScanException;
46+
List<Balance> balances(@NotNull List<String> addresses) throws EtherScanException;
4747

4848
/**
4949
* All txs for given address
@@ -55,13 +55,13 @@ public interface AccountAPI {
5555
* @throws EtherScanException parent exception class
5656
*/
5757
@NotNull
58-
List<Tx> txs(String address, long startBlock, long endBlock) throws EtherScanException;
58+
List<Tx> txs(@NotNull String address, long startBlock, long endBlock) throws EtherScanException;
5959

6060
@NotNull
61-
List<Tx> txs(String address, long startBlock) throws EtherScanException;
61+
List<Tx> txs(@NotNull String address, long startBlock) throws EtherScanException;
6262

6363
@NotNull
64-
List<Tx> txs(String address) throws EtherScanException;
64+
List<Tx> txs(@NotNull String address) throws EtherScanException;
6565

6666
/**
6767
* All internal txs for given address
@@ -73,13 +73,13 @@ public interface AccountAPI {
7373
* @throws EtherScanException parent exception class
7474
*/
7575
@NotNull
76-
List<TxInternal> txsInternal(String address, long startBlock, long endBlock) throws EtherScanException;
76+
List<TxInternal> txsInternal(@NotNull String address, long startBlock, long endBlock) throws EtherScanException;
7777

7878
@NotNull
79-
List<TxInternal> txsInternal(String address, long startBlock) throws EtherScanException;
79+
List<TxInternal> txsInternal(@NotNull String address, long startBlock) throws EtherScanException;
8080

8181
@NotNull
82-
List<TxInternal> txsInternal(String address) throws EtherScanException;
82+
List<TxInternal> txsInternal(@NotNull String address) throws EtherScanException;
8383

8484
/**
8585
* All internal tx for given transaction hash
@@ -89,7 +89,7 @@ public interface AccountAPI {
8989
* @throws EtherScanException parent exception class
9090
*/
9191
@NotNull
92-
List<TxInternal> txsInternalByHash(String txhash) throws EtherScanException;
92+
List<TxInternal> txsInternalByHash(@NotNull String txhash) throws EtherScanException;
9393

9494
/**
9595
* All ERC-20 token txs for given address
@@ -101,13 +101,13 @@ public interface AccountAPI {
101101
* @throws EtherScanException parent exception class
102102
*/
103103
@NotNull
104-
List<TxErc20> txsErc20(String address, long startBlock, long endBlock) throws EtherScanException;
104+
List<TxErc20> txsErc20(@NotNull String address, long startBlock, long endBlock) throws EtherScanException;
105105

106106
@NotNull
107-
List<TxErc20> txsErc20(String address, long startBlock) throws EtherScanException;
107+
List<TxErc20> txsErc20(@NotNull String address, long startBlock) throws EtherScanException;
108108

109109
@NotNull
110-
List<TxErc20> txsErc20(String address) throws EtherScanException;
110+
List<TxErc20> txsErc20(@NotNull String address) throws EtherScanException;
111111

112112
/**
113113
* All ERC-20 token txs for given address and contract address
@@ -120,13 +120,14 @@ public interface AccountAPI {
120120
* @throws EtherScanException parent exception class
121121
*/
122122
@NotNull
123-
List<TxErc20> txsErc20(String address, String contractAddress, long startBlock, long endBlock) throws EtherScanException;
123+
List<TxErc20> txsErc20(@NotNull String address, @NotNull String contractAddress, long startBlock, long endBlock)
124+
throws EtherScanException;
124125

125126
@NotNull
126-
List<TxErc20> txsErc20(String address, String contractAddress, long startBlock) throws EtherScanException;
127+
List<TxErc20> txsErc20(@NotNull String address, @NotNull String contractAddress, long startBlock) throws EtherScanException;
127128

128129
@NotNull
129-
List<TxErc20> txsErc20(String address, String contractAddress) throws EtherScanException;
130+
List<TxErc20> txsErc20(@NotNull String address, @NotNull String contractAddress) throws EtherScanException;
130131

131132
/**
132133
* All ERC-721 (NFT) token txs for given address
@@ -138,13 +139,13 @@ public interface AccountAPI {
138139
* @throws EtherScanException parent exception class
139140
*/
140141
@NotNull
141-
List<TxErc721> txsErc721(String address, long startBlock, long endBlock) throws EtherScanException;
142+
List<TxErc721> txsErc721(@NotNull String address, long startBlock, long endBlock) throws EtherScanException;
142143

143144
@NotNull
144-
List<TxErc721> txsErc721(String address, long startBlock) throws EtherScanException;
145+
List<TxErc721> txsErc721(@NotNull String address, long startBlock) throws EtherScanException;
145146

146147
@NotNull
147-
List<TxErc721> txsErc721(String address) throws EtherScanException;
148+
List<TxErc721> txsErc721(@NotNull String address) throws EtherScanException;
148149

149150
/**
150151
* All ERC-721 (NFT) token txs for given address
@@ -156,13 +157,14 @@ public interface AccountAPI {
156157
* @throws EtherScanException parent exception class
157158
*/
158159
@NotNull
159-
List<TxErc721> txsErc721(String address, String contractAddress, long startBlock, long endBlock) throws EtherScanException;
160+
List<TxErc721> txsErc721(@NotNull String address, @NotNull String contractAddress, long startBlock, long endBlock)
161+
throws EtherScanException;
160162

161163
@NotNull
162-
List<TxErc721> txsErc721(String address, String contractAddress, long startBlock) throws EtherScanException;
164+
List<TxErc721> txsErc721(@NotNull String address, @NotNull String contractAddress, long startBlock) throws EtherScanException;
163165

164166
@NotNull
165-
List<TxErc721> txsErc721(String address, String contractAddress) throws EtherScanException;
167+
List<TxErc721> txsErc721(@NotNull String address, @NotNull String contractAddress) throws EtherScanException;
166168

167169
/**
168170
* All ERC-721 (NFT) token txs for given address
@@ -174,13 +176,13 @@ public interface AccountAPI {
174176
* @throws EtherScanException parent exception class
175177
*/
176178
@NotNull
177-
List<TxErc1155> txsErc1155(String address, long startBlock, long endBlock) throws EtherScanException;
179+
List<TxErc1155> txsErc1155(@NotNull String address, long startBlock, long endBlock) throws EtherScanException;
178180

179181
@NotNull
180-
List<TxErc1155> txsErc1155(String address, long startBlock) throws EtherScanException;
182+
List<TxErc1155> txsErc1155(@NotNull String address, long startBlock) throws EtherScanException;
181183

182184
@NotNull
183-
List<TxErc1155> txsErc1155(String address) throws EtherScanException;
185+
List<TxErc1155> txsErc1155(@NotNull String address) throws EtherScanException;
184186

185187
/**
186188
* All ERC-721 (NFT) token txs for given address
@@ -192,13 +194,15 @@ public interface AccountAPI {
192194
* @throws EtherScanException parent exception class
193195
*/
194196
@NotNull
195-
List<TxErc1155> txsErc1155(String address, String contractAddress, long startBlock, long endBlock) throws EtherScanException;
197+
List<TxErc1155> txsErc1155(@NotNull String address, @NotNull String contractAddress, long startBlock, long endBlock)
198+
throws EtherScanException;
196199

197200
@NotNull
198-
List<TxErc1155> txsErc1155(String address, String contractAddress, long startBlock) throws EtherScanException;
201+
List<TxErc1155> txsErc1155(@NotNull String address, @NotNull String contractAddress, long startBlock)
202+
throws EtherScanException;
199203

200204
@NotNull
201-
List<TxErc1155> txsErc1155(String address, String contractAddress) throws EtherScanException;
205+
List<TxErc1155> txsErc1155(@NotNull String address, @NotNull String contractAddress) throws EtherScanException;
202206

203207
/**
204208
* All blocks mined by address
@@ -208,5 +212,5 @@ public interface AccountAPI {
208212
* @throws EtherScanException parent exception class
209213
*/
210214
@NotNull
211-
List<Block> blocksMined(String address) throws EtherScanException;
215+
List<Block> blocksMined(@NotNull String address) throws EtherScanException;
212216
}

0 commit comments

Comments
 (0)