lbcd/btcjson/claimcmds.go at 5a99dcfe81edcb31acf9755d47ff8e34fe6b5b7a · lbryio/lbcd · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
package btcjson

func init() {
	// No special flags for commands in this file.
	flags := UsageFlag(0)

	MustRegisterCmd("getchangesinblock", (*GetChangesInBlockCmd)(nil), flags)
	MustRegisterCmd("getclaimsforname", (*GetClaimsForNameCmd)(nil), flags)
	MustRegisterCmd("getclaimsfornamebyid", (*GetClaimsForNameByIDCmd)(nil), flags)
	MustRegisterCmd("getclaimsfornamebybid", (*GetClaimsForNameByBidCmd)(nil), flags)
	MustRegisterCmd("getclaimsfornamebyseq", (*GetClaimsForNameBySeqCmd)(nil), flags)
	MustRegisterCmd("normalize", (*GetNormalizedCmd)(nil), flags)

	MustRegisterCmd("getprooffornamebyid", (*GetProofForNameByIDCmd)(nil), flags)
	MustRegisterCmd("getprooffornamebybid", (*GetProofForNameByBidCmd)(nil), flags)
	MustRegisterCmd("getprooffornamebyseq", (*GetProofForNameBySeqCmd)(nil), flags)
}

// optional inputs are required to be pointers, but they support things like `jsonrpcdefault:"false"`
// optional inputs have to be at the bottom of the struct
// optional outputs require ",omitempty"
// traditional bitcoin fields are all lowercase

type GetChangesInBlockCmd struct {
	HashOrHeight *string `json:"hashorheight" jsonrpcdefault:""`
}

type GetChangesInBlockResult struct {
	Hash   string   `json:"hash"`
	Height int32    `json:"height"`
	Names  []string `json:"names"`
}

type GetClaimsForNameCmd struct {
	Name          string  `json:"name"`
	HashOrHeight  *string `json:"hashorheight" jsonrpcdefault:""`
	IncludeValues *bool   `json:"includevalues" jsonrpcdefault:"false"`
}

type GetClaimsForNameByIDCmd struct {
	Name            string   `json:"name"`
	PartialClaimIDs []string `json:"partialclaimids"`
	HashOrHeight    *string  `json:"hashorheight" jsonrpcdefault:""`
	IncludeValues   *bool    `json:"includevalues" jsonrpcdefault:"false"`
}

type GetClaimsForNameByBidCmd struct {
	Name          string  `json:"name"`
	Bids          []int32 `json:"bids"`
	HashOrHeight  *string `json:"hashorheight" jsonrpcdefault:""`
	IncludeValues *bool   `json:"includevalues" jsonrpcdefault:"false"`
}

type GetClaimsForNameBySeqCmd struct {
	Name          string  `json:"name"`
	Sequences     []int32 `json:"sequences" jsonrpcusage:"[sequence,...]"`
	HashOrHeight  *string `json:"hashorheight" jsonrpcdefault:""`
	IncludeValues *bool   `json:"includevalues" jsonrpcdefault:"false"`
}

type GetClaimsForNameResult struct {
	Hash               string        `json:"hash"`
	Height             int32         `json:"height"`
	LastTakeoverHeight int32         `json:"lasttakeoverheight"`
	NormalizedName     string        `json:"normalizedname"`
	Claims             []ClaimResult `json:"claims"`
	// UnclaimedSupports []SupportResult `json:"supportswithoutclaim"` how would this work with other constraints?
}

type SupportResult struct {
	TXID          string `json:"txid"`
	N             uint32 `json:"n"`
	Height        int32  `json:"height"`
	ValidAtHeight int32  `json:"validatheight"`
	Amount        int64  `json:"amount"`
	Address       string `json:"address,omitempty"`
	Value         string `json:"value,omitempty"`
}

type ClaimResult struct {
	ClaimID         string          `json:"claimid"`
	TXID            string          `json:"txid"`
	N               uint32          `json:"n"`
	Bid             int32           `json:"bid"`
	Sequence        int32           `json:"sequence"`
	Height          int32           `json:"height"`
	ValidAtHeight   int32           `json:"validatheight"`
	Amount          int64           `json:"amount"`
	EffectiveAmount int64           `json:"effectiveamount"`
	Supports        []SupportResult `json:"supports,omitempty"`
	Address         string          `json:"address,omitempty"`
	Value           string          `json:"value,omitempty"`
}

type GetNormalizedCmd struct {
	Name string `json:"name"`
}

type GetNormalizedResult struct {
	NormalizedName string `json:"normalizedname"`
}

type GetProofForNameByIDCmd struct {
	Name           string `json:"name"`
	PartialClaimID string `json:"partialclaimid"`
}

type GetProofForNameByBidCmd struct {
	Name string `json:"name"`
	Bid  int    `json:"bid"`
}

type GetProofForNameBySeqCmd struct {
	Name     string `json:"name"`
	Sequence int    `json:"sequence"`
}

type ProofPairResult struct {
	Right bool   `json:"right"`
	Hash  string `json:"hash"`
}

type ProofResult struct { // should we include the claim trie hash?
	BlockHash      string            `json:"blockhash"`
	BlockHeight    int32             `json:"blockheight"`
	NormalizedName string            `json:"normalizedname"`
	ClaimID        string            `json:"claimid"`
	TXID           string            `json:"txid"`
	N              uint32            `json:"n"`
	Bid            int32             `json:"bid"`
	Sequence       int32             `json:"sequence"`
	Takeover       int32             `json:"takeover"`
	Pairs          []ProofPairResult `json:"pairs"`
}