-
Notifications
You must be signed in to change notification settings - Fork 669
/
client.go
470 lines (434 loc) · 13 KB
/
client.go
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
// (c) 2019-2020, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package avm
import (
"fmt"
"time"
"github.com/ava-labs/avalanchego/api"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/snow/choices"
"github.com/ava-labs/avalanchego/utils/formatting"
"github.com/ava-labs/avalanchego/utils/rpc"
cjson "github.com/ava-labs/avalanchego/utils/json"
)
// Client ...
type Client struct {
requester rpc.EndpointRequester
}
// NewClient returns an AVM client for interacting with avm [chain]
func NewClient(uri, chain string, requestTimeout time.Duration) *Client {
return &Client{
requester: rpc.NewEndpointRequester(uri, fmt.Sprintf("/ext/bc/%s", chain), "avm", requestTimeout),
}
}
// IssueTx issues a transaction to a node and returns the TxID
func (c *Client) IssueTx(txBytes []byte) (ids.ID, error) {
txStr, err := formatting.Encode(formatting.Hex, txBytes)
if err != nil {
return ids.ID{}, err
}
res := &api.JSONTxID{}
err = c.requester.SendRequest("issueTx", &api.FormattedTx{
Tx: txStr,
Encoding: formatting.Hex,
}, res)
return res.TxID, err
}
// GetTxStatus returns the status of [txID]
func (c *Client) GetTxStatus(txID ids.ID) (choices.Status, error) {
res := &GetTxStatusReply{}
err := c.requester.SendRequest("getTxStatus", &api.JSONTxID{
TxID: txID,
}, res)
return res.Status, err
}
// ConfirmTx attempts to confirm [txID] by checking its status [attempts] times
// with a [delay] in between each attempt. If the transaction has not been decided
// by the final attempt, it returns the status of the last attempt.
// Note: ConfirmTx will block until either the last attempt finishes or the client
// returns a decided status.
func (c *Client) ConfirmTx(txID ids.ID, attempts int, delay time.Duration) (choices.Status, error) {
for i := 0; i < attempts-1; i++ {
status, err := c.GetTxStatus(txID)
if err != nil {
return status, err
}
if status.Decided() {
return status, nil
}
time.Sleep(delay)
}
return c.GetTxStatus(txID)
}
// GetTx returns the byte representation of [txID]
func (c *Client) GetTx(txID ids.ID) ([]byte, error) {
res := &api.FormattedTx{}
err := c.requester.SendRequest("getTx", &api.GetTxArgs{
TxID: txID,
Encoding: formatting.Hex,
}, res)
if err != nil {
return nil, err
}
txBytes, err := formatting.Decode(res.Encoding, res.Tx)
if err != nil {
return nil, err
}
return txBytes, nil
}
// GetUTXOs returns the byte representation of the UTXOs controlled by [addrs]
func (c *Client) GetUTXOs(addrs []string, limit uint32, startAddress, startUTXOID string) ([][]byte, api.Index, error) {
return c.GetAtomicUTXOs(addrs, "", limit, startAddress, startUTXOID)
}
// GetAtomicUTXOs returns the byte representation of the atomic UTXOs controlled by [addresses]
// from [sourceChain]
func (c *Client) GetAtomicUTXOs(addrs []string, sourceChain string, limit uint32, startAddress, startUTXOID string) ([][]byte, api.Index, error) {
res := &api.GetUTXOsReply{}
err := c.requester.SendRequest("getUTXOs", &api.GetUTXOsArgs{
Addresses: addrs,
SourceChain: sourceChain,
Limit: cjson.Uint32(limit),
StartIndex: api.Index{
Address: startAddress,
UTXO: startUTXOID,
},
Encoding: formatting.Hex,
}, res)
if err != nil {
return nil, api.Index{}, err
}
utxos := make([][]byte, len(res.UTXOs))
for i, utxo := range res.UTXOs {
utxoBytes, err := formatting.Decode(res.Encoding, utxo)
if err != nil {
return nil, api.Index{}, err
}
utxos[i] = utxoBytes
}
return utxos, res.EndIndex, nil
}
// GetAssetDescription returns a description of [assetID]
func (c *Client) GetAssetDescription(assetID string) (*GetAssetDescriptionReply, error) {
res := &GetAssetDescriptionReply{}
err := c.requester.SendRequest("getAssetDescription", &GetAssetDescriptionArgs{
AssetID: assetID,
}, res)
return res, err
}
// GetBalance returns the balance of [assetID] held by [addr].
// If [includePartial], balance includes partial owned (i.e. in a multisig) funds.
func (c *Client) GetBalance(addr string, assetID string, includePartial bool) (*GetBalanceReply, error) {
res := &GetBalanceReply{}
err := c.requester.SendRequest("getBalance", &GetBalanceArgs{
Address: addr,
AssetID: assetID,
IncludePartial: includePartial,
}, res)
return res, err
}
// GetAllBalances returns all asset balances for [addr]
func (c *Client) GetAllBalances(addr string, includePartial bool) (*GetAllBalancesReply, error) {
res := &GetAllBalancesReply{}
err := c.requester.SendRequest("getAllBalances", &GetAllBalancesArgs{
JSONAddress: api.JSONAddress{Address: addr},
IncludePartial: includePartial,
}, res)
return res, err
}
// CreateAsset creates a new asset and returns its assetID
func (c *Client) CreateAsset(
user api.UserPass,
from []string,
changeAddr,
name,
symbol string,
denomination byte,
holders []*Holder,
minters []Owners,
) (ids.ID, error) {
res := &FormattedAssetID{}
err := c.requester.SendRequest("createAsset", &CreateAssetArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
Name: name,
Symbol: symbol,
Denomination: denomination,
InitialHolders: holders,
MinterSets: minters,
}, res)
return res.AssetID, err
}
// CreateFixedCapAsset creates a new fixed cap asset and returns its assetID
func (c *Client) CreateFixedCapAsset(
user api.UserPass,
from []string,
changeAddr,
name,
symbol string,
denomination byte,
holders []*Holder,
) (ids.ID, error) {
res := &FormattedAssetID{}
err := c.requester.SendRequest("createAsset", &CreateAssetArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
Name: name,
Symbol: symbol,
Denomination: denomination,
InitialHolders: holders,
}, res)
return res.AssetID, err
}
// CreateVariableCapAsset creates a new variable cap asset and returns its assetID
func (c *Client) CreateVariableCapAsset(
user api.UserPass,
from []string,
changeAddr,
name,
symbol string,
denomination byte,
minters []Owners,
) (ids.ID, error) {
res := &FormattedAssetID{}
err := c.requester.SendRequest("createAsset", &CreateAssetArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
Name: name,
Symbol: symbol,
Denomination: denomination,
MinterSets: minters,
}, res)
return res.AssetID, err
}
// CreateNFTAsset creates a new NFT asset and returns its assetID
func (c *Client) CreateNFTAsset(
user api.UserPass,
from []string,
changeAddr,
name,
symbol string,
minters []Owners,
) (ids.ID, error) {
res := &FormattedAssetID{}
err := c.requester.SendRequest("createNFTAsset", &CreateNFTAssetArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
Name: name,
Symbol: symbol,
MinterSets: minters,
}, res)
return res.AssetID, err
}
// CreateAddress creates a new address controlled by [user]
func (c *Client) CreateAddress(user api.UserPass) (string, error) {
res := &api.JSONAddress{}
err := c.requester.SendRequest("createAddress", &user, res)
return res.Address, err
}
// ListAddresses returns all addresses on this chain controlled by [user]
func (c *Client) ListAddresses(user api.UserPass) ([]string, error) {
res := &api.JSONAddresses{}
err := c.requester.SendRequest("listAddresses", &user, res)
return res.Addresses, err
}
// ExportKey returns the private key corresponding to [addr] controlled by [user]
func (c *Client) ExportKey(user api.UserPass, addr string) (string, error) {
res := &ExportKeyReply{}
err := c.requester.SendRequest("exportKey", &ExportKeyArgs{
UserPass: user,
Address: addr,
}, res)
return res.PrivateKey, err
}
// ImportKey imports [privateKey] to [user]
func (c *Client) ImportKey(user api.UserPass, privateKey string) (string, error) {
res := &api.JSONAddress{}
err := c.requester.SendRequest("importKey", &ImportKeyArgs{
UserPass: user,
PrivateKey: privateKey,
}, res)
return res.Address, err
}
// Send [amount] of [assetID] to address [to]
func (c *Client) Send(
user api.UserPass,
from []string,
changeAddr string,
amount uint64,
assetID,
to,
memo string,
) (ids.ID, error) {
res := &api.JSONTxID{}
err := c.requester.SendRequest("send", &SendArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
SendOutput: SendOutput{
Amount: cjson.Uint64(amount),
AssetID: assetID,
To: to,
},
Memo: memo,
}, res)
return res.TxID, err
}
// SendMultiple sends a transaction from [user] funding all [outputs]
func (c *Client) SendMultiple(
user api.UserPass,
from []string,
changeAddr string,
outputs []SendOutput,
memo string,
) (ids.ID, error) {
res := &api.JSONTxID{}
err := c.requester.SendRequest("sendMultiple", &SendMultipleArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
Outputs: outputs,
Memo: memo,
}, res)
return res.TxID, err
}
// Mint [amount] of [assetID] to be owned by [to]
func (c *Client) Mint(
user api.UserPass,
from []string,
changeAddr string,
amount uint64,
assetID,
to string,
) (ids.ID, error) {
res := &api.JSONTxID{}
err := c.requester.SendRequest("mint", &MintArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
Amount: cjson.Uint64(amount),
AssetID: assetID,
To: to,
}, res)
return res.TxID, err
}
// SendNFT sends an NFT and returns the ID of the newly created transaction
func (c *Client) SendNFT(
user api.UserPass,
from []string,
changeAddr string,
assetID string,
groupID uint32,
to string,
) (ids.ID, error) {
res := &api.JSONTxID{}
err := c.requester.SendRequest("sendNFT", &SendNFTArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
AssetID: assetID,
GroupID: cjson.Uint32(groupID),
To: to,
}, res)
return res.TxID, err
}
// MintNFT issues a MintNFT transaction and returns the ID of the newly created transaction
func (c *Client) MintNFT(
user api.UserPass,
from []string,
changeAddr string,
assetID string,
payload []byte,
to string,
) (ids.ID, error) {
payloadStr, err := formatting.Encode(formatting.Hex, payload)
if err != nil {
return ids.ID{}, err
}
res := &api.JSONTxID{}
err = c.requester.SendRequest("mintNFT", &MintNFTArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
AssetID: assetID,
Payload: payloadStr,
To: to,
Encoding: formatting.Hex,
}, res)
return res.TxID, err
}
// ImportAVAX sends an import transaction to import funds from [sourceChain] and
// returns the ID of the newly created transaction
// This is a deprecated name for Import
func (c *Client) ImportAVAX(user api.UserPass, to, sourceChain string) (ids.ID, error) {
return c.Import(user, to, sourceChain)
}
// Import sends an import transaction to import funds from [sourceChain] and
// returns the ID of the newly created transaction
func (c *Client) Import(user api.UserPass, to, sourceChain string) (ids.ID, error) {
res := &api.JSONTxID{}
err := c.requester.SendRequest("import", &ImportArgs{
UserPass: user,
To: to,
SourceChain: sourceChain,
}, res)
return res.TxID, err
}
// ExportAVAX sends AVAX from this chain to the address specified by [to].
// Returns the ID of the newly created atomic transaction
func (c *Client) ExportAVAX(
user api.UserPass,
from []string,
changeAddr string,
amount uint64,
to string,
) (ids.ID, error) {
return c.Export(user, from, changeAddr, amount, to, "AVAX")
}
// Export sends an asset from this chain to the P/C-Chain.
// After this tx is accepted, the AVAX must be imported to the P/C-chain with an importTx.
// Returns the ID of the newly created atomic transaction
func (c *Client) Export(
user api.UserPass,
from []string,
changeAddr string,
amount uint64,
to string,
assetID string,
) (ids.ID, error) {
res := &api.JSONTxID{}
err := c.requester.SendRequest("export", &ExportArgs{
ExportAVAXArgs: ExportAVAXArgs{
JSONSpendHeader: api.JSONSpendHeader{
UserPass: user,
JSONFromAddrs: api.JSONFromAddrs{From: from},
JSONChangeAddr: api.JSONChangeAddr{ChangeAddr: changeAddr},
},
Amount: cjson.Uint64(amount),
To: to,
},
AssetID: assetID,
}, res)
return res.TxID, err
}