Skip to content
This repository was archived by the owner on Jun 7, 2023. It is now read-only.

Commit 2cbc93a

Browse files
kwek20kwek20
authored
Merge pull request #159 from iotaledger/dev
Merged 1.0.0-beta5 into master
2 parents a2a7bc0 + f369743 commit 2cbc93a

File tree

275 files changed

+15311
-1261
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

275 files changed

+15311
-1261
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ tomcat.*
99
.classpath
1010
.project
1111
*.class
12+
settings.xml

‎README.md

Lines changed: 126 additions & 202 deletions
Large diffs are not rendered by default.

‎client.store

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"LXQHWNY9CQOHPNMKFJFIJHGEPAENAOVFRDIBF99PPHDTWJDCGHLYETXT9NPUVSNKT9XDTDYNJKJCPQMZC":{"keyIndex":4,"depositRequests":{"1":{"timeOut":0,"multiUse":false,"expectedAmount":5}},"pendingTransfers":{}}}

‎docs/iota-java/reference/addNeighbors.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
# [addNeighbors](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPICore.java#L167)
3+
[AddNeighborsResponse](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/dto/response/AddNeighborsResponse.java) addNeighbors(String[] uris)
4+
5+
Add a list of neighbors to the node.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| uris | String[] | Required | The list of URI elements. |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
17+
## Exceptions
18+
| Exceptions | Description |
19+
|:---------------|:--------|
20+
| [ArgumentException](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/error/ArgumentException.java) | |
21+
22+
23+
## Example
24+
25+
```Java
26+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
27+
28+
try {
29+
AddNeighborsResponse response = iotaAPI.addNeighbors(["udp://8.8.8.8:14265", "udp://8.8.8.8:14265"]);
30+
} catch (ArgumentException e) {
31+
// Handle error
32+
e.printStackTrace();
33+
}
34+
```

‎docs/iota-java/reference/addRemainder.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
# [addRemainder](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPI.java#L1299)
3+
List<String> addRemainder(String seed, int security, List<[Input](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Input.java)> inputs, [Bundle](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Bundle.java) bundle, String tag, long totalValue, String remainderAddress, List<String> signatureFragments)
4+
5+
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| seed | String | Required | Tryte-encoded seed. |
12+
| security | int | Required | The security level of private key / seed. |
13+
| inputs | List<[Input](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Input.java)> | Required | List of inputs used for funding the transfer. |
14+
| bundle | [Bundle](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Bundle.java) | Required | To be populated. |
15+
| tag | String | Required | The tag. |
16+
| totalValue | long | Required | The total value. |
17+
| remainderAddress | String | Required | If defined, this address will be used for sending the remainder value (of the inputs) to. |
18+
| signatureFragments | List<String> | Required | The signature fragments. |
19+
20+
## Output
21+
| Return type | Description |
22+
|--|--|
23+
24+
## Exceptions
25+
| Exceptions | Description |
26+
|:---------------|:--------|
27+
| [ArgumentException](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/error/ArgumentException.java) | is thrown when an invalid argument is provided. |
28+
| IllegalStateException | is thrown when a transfer fails because their is not enough balance to perform the transfer. |
29+
30+
31+
## Example
32+
33+
```Java
34+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
35+
36+
try {
37+
List response = iotaAPI.addRemainder("AYJZVRRTSOYEYTZFIYUHRRIZYLRPFANPSUVJLWWZEAPHGTYAWZUSGDQVMCGBNBRUADYKFAH9SQHZTWAVX", "971", ["inputs", "inputs"], "bundle", "9VTDKZZXPCVOXYRQXTBGHUIAOBX9BLCKKWYIUGMRRIHZWGOZHRFCFEPUVXJQAZPIKPILVHOLBAAKMNVFX", "totalvalue", "OXCBNAGRJGGNBQRVNOXWXBUSJVJFNLLAV9NGBIGVBKKIAFTNPLLWHOEIYHWTJRXNYAVWADOKCA9FCYVVDTGSJXZ9LNITEYOJKVYDICMYU9CXTMJNAZNREKV9TMTPRUSOIZV9NFVOYBRVLYYPUFXZASTMXRWXVTAFMW", ["TLRSOFSKXIDJCUESREXRVL9ZFUROUDFCTIUYXCQCUKLNRFQFHSFDXPEGNGPYFGYRNWHQAEHTGRMHVZKNI", "PLQUYNPORYJDZLOTEGWVOEXNEKRVCXBBLHNYUDLNUGPIXGUSKCKINXIWXOY9BS9QJOTOMRBIKPLQBPARK"]);
38+
} catch (ArgumentException e) {
39+
// Handle error
40+
e.printStackTrace();
41+
}
42+
```

‎docs/iota-java/reference/attachToTangle.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
# [attachToTangle](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPICore.java#L427)
3+
[GetAttachToTangleResponse](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/dto/response/GetAttachToTangleResponse.java) attachToTangle(String trunkTransaction, String branchTransaction, Integer minWeightMagnitude, String[] trytes)
4+
5+
Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| trunkTransaction | String | Required | The trunk transaction to approve. |
12+
| branchTransaction | String | Required | The branch transaction to approve. |
13+
| minWeightMagnitude | Integer | Required | The Proof of Work intensity. |
14+
| trytes | String[] | Required | A List of trytes (raw transaction data) to attach to the tangle. |
15+
16+
## Output
17+
| Return type | Description |
18+
|--|--|
19+
20+
21+
22+
## Example
23+
24+
```Java
25+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
26+
27+
try {
28+
GetAttachToTangleResponse response = iotaAPI.attachToTangle("QTIGDMUKDLSVQEUISWEKRHKQMOEWTHOXMQP9WMPSFWOVAIW9BIIKYTOMEAXZWLAPILUQIJWXHWSDFQVCM", "9VFGKCQSSNCBQKNWESGSXFKCMDOJWBBYDPRKXZYBYGSDLRBZMFZWXKJGRQHXMZPXVXUPRTIBKERWBUEMV", "18", ["GTRSCGYWXGAOILFPWTMZUTFKGBDVFLHYRPOFFNX9DTZXENM9WXOKX9HCIYSEONOINLPLYECCGPQGXSPTKYFFTZNHAOVLWCRAMVNHRBTOLTLQFNFWNSW9OBP9QMLXAFEIYLGMGEUCZI9PZHVEQFDACEBPWOFDQZSCLH", "PETTNFNWUNEVFJYIMAQZACBEXCTARWHVVFULTECBCQNHTGFTML9FSGARJHHIPVFAONTCGYCCPAWQFPG9OXSYBDOHKIPPEYSIVSMPPGKWXCRTXURWCI9JNNVZUTGMTVEKEXJQXGCCJXK9QOXVOLIRWJUFOJYIGUOTYY"]);
29+
} catch (ArgumentException e) {
30+
// Handle error
31+
e.printStackTrace();
32+
}
33+
```

‎docs/iota-java/reference/broadcastTransactions.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
# [broadcastTransactions](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPICore.java#L480)
3+
[BroadcastTransactionsResponse](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/dto/response/BroadcastTransactionsResponse.java) broadcastTransactions(String[] trytes)
4+
5+
Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by attachToTangle.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| trytes | String[] | Required | The list of raw data of transactions to be rebroadcast. |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
17+
18+
19+
## Example
20+
21+
```Java
22+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
23+
24+
try {
25+
BroadcastTransactionsResponse response = iotaAPI.broadcastTransactions(["LFXSPUUZXQDWFX9SKVPGVPCJY9XCVQMNTPXKNEFORU9ULZZLPDKJT9JEZKJTNEKEZPZHGPJDXOGXMHUNYIABJHFZXIZWWWYYOHMCQSRROZAKYVBJ9MYAMVWLNZQLLRNGWHFVRYTUCMRFQEBQ9ZFPFCN9XQDNPWSKOW", "YSDONKTDLFWBURVTDBNDCPCNDWZNSUIUR9EMSUOLRVGFDZUNOLJTEQLJURY99BWOABZYTITQH9NBUJVLMBCWQB9AGWJEUR9A9CSVVKQTFRWOQQY9RUBUQQHOZVBLS9BCCOZEIRSAIEUCKEQKFGBQMLXHTQZTSJA9WM"]);
26+
} catch (ArgumentException e) {
27+
// Handle error
28+
e.printStackTrace();
29+
}
30+
```

‎docs/iota-java/reference/bundlesFromAddresses.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
# [bundlesFromAddresses](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPI.java#L235)
3+
[Bundle[]](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Bundle.java) bundlesFromAddresses(String[] addresses, Boolean inclusionStates)
4+
5+
Internal function to get the formatted bundles of a list of addresses.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| addresses | String[] | Required | List of addresses. |
12+
| inclusionStates | Boolean | Required | If `true`, it gets the inclusion states of the transfers. |
13+
14+
## Output
15+
| Return type | Description |
16+
|--|--|
17+
| [Bundle[]](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Bundle.java) | A Transaction objects. |
18+
19+
## Exceptions
20+
| Exceptions | Description |
21+
|:---------------|:--------|
22+
| [ArgumentException](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/error/ArgumentException.java) | is thrown when the specified input is not valid. |
23+
24+
25+
## Example
26+
27+
```Java
28+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
29+
30+
try {
31+
Bundle response = iotaAPI.bundlesFromAddresses(["QDMOERAXIV9JRI9XRZRAXBFOHPKNOZ9GLHQYAAMLTTUMSQBKTULNJKFGEGFBSKXMYNRURORWFYBXPDRHVPLNWXVUFYTAFVRZDHGOWOGINSLJOANIMKIOFGRASDNTKBGHZPW9GKNZLHAXAFRZDUYPZTXSLIKVZZKXBY", "WGZXFIBKKBAUJAMCPVDGXHBAHPJDWQSHJCBYJSCERWQHNDHUKFVVMYXCPXSSMIDOIAVRWZZOOODE9CWTDOGFWTWVNZUBEPMICJXWXPUZADBWCPKDGMYLRVFTXTDVKOZEIBPMUQSHVNMASDRC9TNLVTWWHXXTVEYAPO"], "false");
32+
} catch (ArgumentException e) {
33+
// Handle error
34+
e.printStackTrace();
35+
}
36+
```

‎docs/iota-java/reference/checkConsistency.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# [checkConsistency](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPICore.java#L408)
3+
[CheckConsistencyResponse](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/dto/response/CheckConsistencyResponse.java) checkConsistency(String[] tails)
4+
5+
Checks the consistency of the subtangle formed by the provided tails.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| tails | String[] | Required | The tails describing the subtangle. |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
| [CheckConsistencyResponse](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/dto/response/CheckConsistencyResponse.java) | The The the raw transaction data (trytes) of a specific transaction. |
17+
18+
19+
20+
## Example
21+
22+
```Java
23+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
24+
25+
try {
26+
CheckConsistencyResponse response = iotaAPI.checkConsistency(["ITFEBTJVQVWWZPHIXXB9IZNMESZSS9CFU9GZXWJJEJYKCKDHM9CKXZUWZBKLNRUMRBIVUV9EJVRZWRRBL", "N9ZDAGEUASCFSZIIYRROFQRAXLFJPOLMKEEEVTKRRMQXAKGXRLFOTGFCBCKPQDHANGWDOSFZIOJTCOWSM"]);
27+
} catch (ArgumentException e) {
28+
// Handle error
29+
e.printStackTrace();
30+
}
31+
```

‎docs/iota-java/reference/checkWereAddressSpentFrom.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
# [checkWereAddressSpentFrom](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPI.java#L823)
3+
boolean[] checkWereAddressSpentFrom(String[] addresses)
4+
5+
Check if a list of addresses was ever spent from, in the current epoch, or in previous epochs. If the address has a checksum, it is removed
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| addresses | String[] | Required | the addresses to check |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
| boolean[] | list of address boolean checks |
17+
18+
## Exceptions
19+
| Exceptions | Description |
20+
|:---------------|:--------|
21+
| [ArgumentException](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/error/ArgumentException.java) | |
22+
23+
24+
## Example
25+
26+
```Java
27+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
28+
29+
try {
30+
boolean response = iotaAPI.checkWereAddressSpentFrom(["QBMKILBOYESLUCXMNIQIBBOICSRWMO9PMY99YHPACWLFPXLCVAELQZNRFLJPGDHWZHGIQYDG9JLREW99WOEWUXYVLVRXPXJJWSY9LCGSRYKLPZRSEHKKYNBSD9ESNDN9YUPBOGBXOBPOKASLNUEHANHCNWD99GLLMF", "RUKJQZIQHBSPRVRFOQMPIZOTP9FGQBVREIVLYL9HBSMTJCKBNLARQNLVWMEFAJQSEHVZPI9XRPJAKDAHOVRBMRUKREZWXVJEZGXIPREGDPWNFZDWIEPNDLNAN9CGEKEGUPIQNVC9KZGLUISHLZMOQGIHVJOZRRULGG"]);
31+
} catch (ArgumentException e) {
32+
// Handle error
33+
e.printStackTrace();
34+
}
35+
```

‎docs/iota-java/reference/findTransactionObjectsByAddresses.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# [findTransactionObjectsByAddresses](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPI.java#L395)
3+
List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> findTransactionObjectsByAddresses(String[] addresses)
4+
5+
Wrapper function for findTransactions, getTrytes and transactionObjects. Returns the transactionObject of a transaction hash. The input can be a list of valid addresses.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| addresses | String[] | Required | The addresses. |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
| List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> | Transactions. |
17+
18+
19+
20+
## Example
21+
22+
```Java
23+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
24+
25+
try {
26+
List response = iotaAPI.findTransactionObjectsByAddresses(["WOKMCCHEQBLAYGGDJZJKJSZSIPKNAKZNUB9JATOVQBEDERTSTPQQOJSPAXVVOXERFJDWEHWIEVLUIYSPQV9ZTGPMMWRMBIUQWX9CH9BHNYQUGEPK9BCXRUJO9VKLWBPJV9KOGHDTMWYJQDITSBLSIGDXHLFGNNHCWI", "TPZG9VORTYFHBYUAJQCZETCPW9THPGAGXELHGLULCTXKHNQJQSGOVUYNJZJOYVXNHREMRTSGMVCF9S9WGFFGIHZIHTCJGJ9EFTJGS9BVRMMOKQHLPWMQTRRPJGHRPG9YDPCXNGSJUBGDADJWGC9UNUYICNCTRKYNCV"]);
27+
} catch (ArgumentException e) {
28+
// Handle error
29+
e.printStackTrace();
30+
}
31+
```

‎docs/iota-java/reference/findTransactionObjectsByApprovees.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# [findTransactionObjectsByApprovees](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPI.java#L434)
3+
List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> findTransactionObjectsByApprovees(String[] approvees)
4+
5+
Wrapper function for findTransactions, getTrytes and transactionObjects. Returns the transactionObject of a transaction hash. The input can be a list of valid approvees.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| approvees | String[] | Required | The approvees. |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
| List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> | Transactions. |
17+
18+
19+
20+
## Example
21+
22+
```Java
23+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
24+
25+
try {
26+
List response = iotaAPI.findTransactionObjectsByApprovees(["9IHYITNFEMXXGDSVAAAHM9DJUZNKMWWFRQ9EWHVSIPXJTFVNZLYUQHIRM9ZSVSGPYIZWKJHRSVWIG9OBY", "KGXOGGGLFYCSDURRYFYKDTWJFNGQBICPTKIF9RMA9QPOGRICKWZWRRVSWWRTSKCQCAWVAPBGRXTGLNOXH"]);
27+
} catch (ArgumentException e) {
28+
// Handle error
29+
e.printStackTrace();
30+
}
31+
```

‎docs/iota-java/reference/findTransactionObjectsByBundle.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# [findTransactionObjectsByBundle](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPI.java#L451)
3+
List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> findTransactionObjectsByBundle(String[] bundles)
4+
5+
Wrapper function for findTransactions, getTrytes and transactionObjects. Returns the transactionObject of a transaction hash. The input can be a list of valid bundles. findTransactions input
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| bundles | String[] | Required | The bundles. |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
| List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> | Transactions. |
17+
18+
19+
20+
## Example
21+
22+
```Java
23+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
24+
25+
try {
26+
List response = iotaAPI.findTransactionObjectsByBundle(["XCXGSAADBJVBNKSHUQLCDSMJFFRADYYESEPKLWONABWOZBZNIYIUIPEHCSYDUZNIJBIDMERILGW9YC9OG", "BLUZKR9GWRHPNVQVFEVV99JAUIQHWTJWYKUKAVFIKNBWTNJAUQMWPZNUGRLAWMPKQOCXUUYAEMITPNKNE"]);
27+
} catch (ArgumentException e) {
28+
// Handle error
29+
e.printStackTrace();
30+
}
31+
```

‎docs/iota-java/reference/findTransactionObjectsByTag.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# [findTransactionObjectsByTag](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/IotaAPI.java#L418)
3+
List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> findTransactionObjectsByTag(String[] tags)
4+
5+
Wrapper function for findTransactions, getTrytes and transactionObjects. Returns the transactionObject of a transaction hash. The input can be a list of valid tags.
6+
> **Important note:** This API is currently in Beta and is subject to change. Use of these APIs in production applications is not supported.
7+
8+
## Input
9+
| Parameter | Type | Required or Optional | Description |
10+
|:---------------|:--------|:--------| :--------|
11+
| tags | String[] | Required | The tags. |
12+
13+
## Output
14+
| Return type | Description |
15+
|--|--|
16+
| List<[Transaction](https://github.com/iotaledger/iota-java/blob/dev/jota/src/main/java/jota/model/Transaction.java)> | Transactions. |
17+
18+
19+
20+
## Example
21+
22+
```Java
23+
IotaAPI iotaAPI = new IotaAPI.Builder().build();
24+
25+
try {
26+
List response = iotaAPI.findTransactionObjectsByTag(["HEKUGTODBUPOETWARMMJ9PSAYJUIJJLHFVOAHPDWSSURULWAGDFCDUNGAUDQDWTIIFVDTDZGRZXARCVTQ", "A9CAJ9WUFQKYUQOMZHPOHMQ9NUDNHBYBGHYBNPVPRXNDAHCYNN9UAKPNUCJQISJYKVQEVMYXFNBJHACRD"]);
27+
} catch (ArgumentException e) {
28+
// Handle error
29+
e.printStackTrace();
30+
}
31+
```

0 commit comments

Comments
 (0)