Skip to content

Commit 52f89a7

Browse files
authored
Revise getUTXOs function documentation
1 parent 8964db1 commit 52f89a7

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

packages/docs/Lib/Computer/getUTXOs2.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ async getUTXOs(q: GetTXOsQuery): Promise<string[] | DbOutput[]>
1212

1313
## Description
1414

15-
The `getUTXOs` function is a **syntactic sugar** built on top of [`getTXOs`](./getTXOs.md).
16-
It automatically sets the parameter `isSpent: false` to return only **unspent** outputs.
1715

18-
It can be used to query Bitcoin UTXOs or Bitcoin Computer objects that have not been spent yet.
16+
17+
The `getUTXOs` function is *syntactic sugar* for [`getTXOs`](./getTXOs.md) function where `isSpent` is set to `false`. It return only unspent outputs that may or may not contain smart objects.
1918

2019
## Parameters
2120

@@ -29,7 +28,7 @@ It accepts the same parameters as [`getTXOs`](./getTXOs.md), except that `isSpen
2928

3029
## Return Value
3130

32-
An array of either revision strings or rows from the Output table, depending on the verbosity level. It is important to highlight that the returned outputs are Bitcoin UTXOs that can encode Bitcoin Computer objects, based on the query parameters provided. If `isObject` is not specified, the returned UTXOs may include both regular Bitcoin outputs or outputs that encode Bitcoin Computer objects.
31+
An array of either revision strings or rows from the Output table, depending on the verbosity level. It is important to highlight that the returned outputs are UTXOs that can encode smart objects, based on the query parameters provided.
3332

3433
## Example
3534

0 commit comments

Comments
 (0)