Skip to content

Commit 7546561

Browse files
committed
docs: add docs for addresses methods
1 parent 2e2e937 commit 7546561

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

api_addresses.go

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,32 +22,55 @@ type AddressAmount struct {
2222
}
2323

2424
type Address struct {
25-
Address string `json:"address"`
26-
Amount []AddressAmount `json:"amount"`
27-
StakeAddress string `json:"stake_address"`
28-
Type string `json:"type"`
29-
Script bool `json:"script"`
25+
// Bech32 encoded addresses
26+
Address string `json:"address"`
27+
Amount []AddressAmount `json:"amount"`
28+
29+
// Stake address that controls the key
30+
StakeAddress string `json:"stake_address"`
31+
32+
// Address era.
33+
// Enum: "byron" "shelley"
34+
Type string `json:"type"`
35+
36+
// True if this is a script address
37+
Script bool `json:"script"`
3038
}
3139

3240
type AddressDetails struct {
41+
// Bech32 encoded address
3342
Address string `json:"address"`
3443
ReceivedSum []AddressAmount `json:"received_sum"`
3544
SentSum []AddressAmount `json:"sent_sum"`
36-
TxCount int `json:"tx_count"`
45+
46+
// Count of all transactions on the address
47+
TxCount int `json:"tx_count"`
3748
}
3849

3950
type AddressTransactions struct {
40-
TxHash string `json:"tx_hash"`
41-
TxIndex int `json:"tx_index"`
42-
BlockHeight int `json:"block_height"`
51+
// Hash of the transaction
52+
TxHash string `json:"tx_hash"`
53+
54+
// Transaction index within the block
55+
TxIndex int `json:"tx_index"`
56+
57+
// Block height
58+
BlockHeight int `json:"block_height"`
4359
}
4460

4561
type AddressUTXO struct {
46-
TxHash string `json:"tx_hash"`
62+
// Transaction hash of the UTXO
63+
TxHash string `json:"tx_hash"`
64+
65+
// UTXO index in the transaction
4766
OutputIndex int `json:"output_index"`
4867
Amount []AddressAmount `json:"amount"`
49-
Block string `json:"block"`
50-
DataHash string `json:"data_hash"`
68+
69+
// Block hash of the UTXO
70+
Block string `json:"block"`
71+
72+
// The hash of the transaction output datum
73+
DataHash string `json:"data_hash"`
5174
}
5275

5376
type AddressTxResult struct {

0 commit comments

Comments
 (0)