Skip to content

Commit 6dd861a

Browse files
nodechnodech
committed
api-docs: add height to bids and bidPrevout to reveals.
1 parent e327fc5 commit 6dd861a

File tree

1 file changed

+90
-47
lines changed

1 file changed

+90
-47
lines changed

‎src/api-docs/source/includes/_wallet_auctions.md‎

Lines changed: 90 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22

33

44
## Get Wallet Names
5+
```javascript
6+
let id, own;
7+
```
58

69
```shell--vars
710
id='primary'
11+
own=false
812
```
913

1014
```shell--curl
11-
curl http://x:[email protected]:14039/wallet/$id/name
15+
curl http://x:[email protected]:14039/wallet/$id/name?own=$own
1216
```
1317

1418
```shell--cli
@@ -29,7 +33,11 @@ const walletClient = new WalletClient(walletOptions);
2933
const wallet = walletClient.wallet(id);
3034

3135
(async () => {
32-
const result = await wallet.getNames();
36+
const options = {
37+
own: own
38+
};
39+
40+
const result = await wallet.getNames(options);
3341
console.log(result);
3442
})();
3543
```
@@ -75,9 +83,15 @@ List the states of all names known to the wallet.
7583
`GET /wallet/:id/name`
7684

7785

78-
Parameters | Description
79-
---------- | -----------
80-
id <br> _string_ | wallet id
86+
Parameter | Description
87+
---------------- | -----------
88+
id <br> _string_ | Wallet ID
89+
90+
### GET Parameters
91+
92+
Parameter | Default | Description
93+
--------------- | ------- | ------------
94+
own <br> _bool_ | `false` | List only owned names
8195

8296

8397
## Get Wallet Name
@@ -233,6 +247,7 @@ const wallet = walletClient.wallet(id);
233247
"value": 1000000,
234248
"lockup": 2000000,
235249
"blind": "3d694cb7529caae741b6e70db09a0102c61813420b161cee65fb657e116d1f5b",
250+
"height": 110,
236251
"own": true
237252
}
238253
],
@@ -244,6 +259,10 @@ const wallet = walletClient.wallet(id);
244259
"hash": "10f18571b6b7af1f256ebe74d5da06d792da91ceb7f3f93302c0d216e1f899b8",
245260
"index": 0
246261
},
262+
"bidPrevout": {
263+
"hash": "0702d5f7cf4afd626189c1f8362676a5e7b7edfa5110d256a57185f32a3d12e1",
264+
"index": 0
265+
},
247266
"value": 1000000,
248267
"height": 125,
249268
"own": true
@@ -260,9 +279,9 @@ List the states of all auctions known to the wallet.
260279
`GET /wallet/:id/auction`
261280

262281

263-
Parameters | Description
264-
---------- | -----------
265-
id <br> _string_ | wallet id
282+
Parameter | Description
283+
---------------- | -----------
284+
id <br> _string_ | Wallet ID
266285

267286

268287
## Get Wallet Auction by Name
@@ -339,6 +358,7 @@ const wallet = walletClient.wallet(id);
339358
"value": 1000000,
340359
"lockup": 2000000,
341360
"blind": "3d694cb7529caae741b6e70db09a0102c61813420b161cee65fb657e116d1f5b",
361+
"height": 110,
342362
"own": true
343363
}
344364
],
@@ -350,6 +370,10 @@ const wallet = walletClient.wallet(id);
350370
"hash": "10f18571b6b7af1f256ebe74d5da06d792da91ceb7f3f93302c0d216e1f899b8",
351371
"index": 0
352372
},
373+
"bidPrevout": {
374+
"hash": "0702d5f7cf4afd626189c1f8362676a5e7b7edfa5110d256a57185f32a3d12e1",
375+
"index": 0
376+
},
353377
"value": 1000000,
354378
"height": 125,
355379
"own": true
@@ -365,10 +389,10 @@ List the states of all auctions known to the wallet.
365389
`GET /wallet/:id/auction/:name`
366390

367391

368-
Parameters | Description
369-
---------- | -----------
370-
id <br> _string_ | wallet id
371-
name <br> _string_ | name
392+
Parameters | Description
393+
------------------ | -----------
394+
id <br> _string_ | Wallet ID
395+
name <br> _string_ | Name
372396

373397

374398
## Get Wallet Bids
@@ -421,6 +445,7 @@ const wallet = walletClient.wallet(id);
421445
"value": 1000000,
422446
"lockup": 2000000,
423447
"blind": "3d694cb7529caae741b6e70db09a0102c61813420b161cee65fb657e116d1f5b",
448+
"height": 110,
424449
"own": true
425450
}
426451
]
@@ -490,6 +515,7 @@ const wallet = walletClient.wallet(id);
490515
"value": 1000000,
491516
"lockup": 2000000,
492517
"blind": "3d694cb7529caae741b6e70db09a0102c61813420b161cee65fb657e116d1f5b",
518+
"height": 110,
493519
"own": true
494520
},
495521
{
@@ -501,6 +527,7 @@ const wallet = walletClient.wallet(id);
501527
},
502528
"lockup": 20000000,
503529
"blind": "47e8cf3dacfe6aeb14187ebd52f25c55c6f63fd24fed666c676c8ada0b132c10",
530+
"height": 110,
504531
"own": false
505532
}
506533
]
@@ -513,11 +540,11 @@ List the bids for a specific name known to the wallet.
513540
`GET /wallet/:id/bid/:name`
514541

515542

516-
Parameters | Description
517-
---------- | -----------
518-
id <br> _string_ | wallet id
543+
Parameters | Description
544+
------------------ | -----------
545+
id <br> _string_ | wallet id
519546
name <br> _string_ | name
520-
own <br> _bool_ | whether to only show bids from this wallet
547+
own <br> _bool_ | whether to only show bids from this wallet
521548

522549

523550
## Get Wallet Reveals
@@ -567,6 +594,10 @@ const wallet = walletClient.wallet(id);
567594
"hash": "6b90495db28d71bc96ad6211d87b78ab6a3b548b702a98f3149e41c3a0892140",
568595
"index": 0
569596
},
597+
"bidPrevout": {
598+
"hash": "0243800d6ac2631225ec94ce7a958ad95aa43433cab079dae17ef5d199e23ed9",
599+
"index": 0
600+
},
570601
"value": 1000000,
571602
"height": 221,
572603
"own": true
@@ -578,6 +609,10 @@ const wallet = walletClient.wallet(id);
578609
"hash": "d8acd574cba75c32f5e671fad2adf7cc93854303be02212fe8628a727229d610",
579610
"index": 0
580611
},
612+
"bidPrevout": {
613+
"hash": "0702d5f7cf4afd626189c1f8362676a5e7b7edfa5110d256a57185f32a3d12e1",
614+
"index": 0
615+
},
581616
"value": 10000000,
582617
"height": 221,
583618
"own": false
@@ -646,6 +681,10 @@ const wallet = walletClient.wallet(id);
646681
"hash": "6b90495db28d71bc96ad6211d87b78ab6a3b548b702a98f3149e41c3a0892140",
647682
"index": 0
648683
},
684+
"bidPrevout": {
685+
"hash": "0702d5f7cf4afd626189c1f8362676a5e7b7edfa5110d256a57185f32a3d12e1",
686+
"index": 0
687+
},
649688
"value": 1000000,
650689
"height": 221,
651690
"own": true
@@ -657,6 +696,10 @@ const wallet = walletClient.wallet(id);
657696
"hash": "d8acd574cba75c32f5e671fad2adf7cc93854303be02212fe8628a727229d610",
658697
"index": 0
659698
},
699+
"bidPrevout": {
700+
"hash": "0243800d6ac2631225ec94ce7a958ad95aa43433cab079dae17ef5d199e23ed9",
701+
"index": 0
702+
},
660703
"value": 10000000,
661704
"height": 221,
662705
"own": false
@@ -864,7 +907,7 @@ const wallet = walletClient.wallet(id);
864907
const options = {passphrase, name, broadcastBid, sign, bid, lockup};
865908

866909
(async () => {
867-
const result = await wallet.createAuctionTxs(options);
910+
const result = await wallet.createAuctionTXs(options);
868911
console.log(result);
869912
})();
870913
```
@@ -1109,9 +1152,9 @@ Create, sign, and send a name OPEN.
11091152

11101153
`POST /wallet/:id/open`
11111154

1112-
Parameter | Description
1113-
------------------------ | -----------------
1114-
id <br> _string_ | Wallet ID
1155+
Parameter | Description
1156+
---------------- | -----------
1157+
id <br> _string_ | Wallet ID
11151158

11161159
### POST Parameters
11171160

@@ -1235,9 +1278,9 @@ Create, sign, and send a name BID.
12351278

12361279
`POST /wallet/:id/bid`
12371280

1238-
Parameter | Description
1239-
------------------------ | -----------------
1240-
id <br> _string_ | Wallet ID
1281+
Parameter | Description
1282+
---------------- | -----------
1283+
id <br> _string_ | Wallet ID
12411284

12421285
### POST Parameters
12431286
See [Create a transaction](#create-a-transaction) for the more options.
@@ -1373,9 +1416,9 @@ all reveals for all names in the wallet will be sent.
13731416

13741417
`POST /wallet/:id/reveal`
13751418

1376-
Parameter | Description
1377-
------------------------ | -----------------
1378-
id <br> _string_ | Wallet ID
1419+
Parameter | Description
1420+
---------------- | -----------
1421+
id <br> _string_ | Wallet ID
13791422

13801423
### POST Parameters
13811424

@@ -1520,9 +1563,9 @@ all qualifying bids are redeemed.
15201563

15211564
`POST /wallet/:id/redeem`
15221565

1523-
Parameter | Description
1524-
------------------------ | -----------------
1525-
id <br> _string_ | Wallet ID
1566+
Parameter | Description
1567+
---------------- | -----------
1568+
id <br> _string_ | Wallet ID
15261569

15271570
### POST Parameters
15281571

@@ -1663,9 +1706,9 @@ associated with a given name.
16631706

16641707
`POST /wallet/:id/update`
16651708

1666-
Parameter | Description
1667-
------------------------ | -----------------
1668-
id <br> _string_ | Wallet ID
1709+
Parameter | Description
1710+
---------------- | -----------
1711+
id <br> _string_ | Wallet ID
16691712

16701713
### POST Parameters
16711714

@@ -1844,9 +1887,9 @@ Create, sign, and send a RENEW.
18441887

18451888
`POST /wallet/:id/renew`
18461889

1847-
Parameter | Description
1848-
------------------------ | -----------------
1849-
id <br> _string_ | Wallet ID
1890+
Parameter | Description
1891+
---------------- | -----------
1892+
id <br> _string_ | Wallet ID
18501893

18511894
### POST Parameters
18521895

@@ -1977,9 +2020,9 @@ Create, sign, and send a TRANSFER.
19772020

19782021
`POST /wallet/:id/transfer`
19792022

1980-
Parameter | Description
1981-
------------------------ | -----------------
1982-
id <br> _string_ | Wallet ID
2023+
Parameter | Description
2024+
---------------- | -----------
2025+
id <br> _string_ | Wallet ID
19832026

19842027
### POST Parameters
19852028

@@ -2111,9 +2154,9 @@ already in progress.
21112154

21122155
`POST /wallet/:id/cancel`
21132156

2114-
Parameter | Description
2115-
------------------------ | -----------------
2116-
id <br> _string_ | Wallet ID
2157+
Parameter | Description
2158+
---------------- | -----------
2159+
id <br> _string_ | Wallet ID
21172160

21182161
### POST Parameters
21192162

@@ -2245,9 +2288,9 @@ Create, sign, and send a FINALIZE.
22452288

22462289
`POST /wallet/:id/finalize`
22472290

2248-
Parameter | Description
2249-
------------------------ | -----------------
2250-
id <br> _string_ | Wallet ID
2291+
Parameter | Description
2292+
---------------- | -----------
2293+
id <br> _string_ | Wallet ID
22512294

22522295
### POST Parameters
22532296

@@ -2379,9 +2422,9 @@ updates or transfers. The name can be reopened with a new auction after a set ti
23792422

23802423
`POST /wallet/:id/revoke`
23812424

2382-
Parameter | Description
2383-
------------------------ | -----------------
2384-
id <br> _string_ | Wallet ID
2425+
Parameter | Description
2426+
---------------- | -----------
2427+
id <br> _string_ | Wallet ID
23852428

23862429
### POST Parameters
23872430

0 commit comments

Comments
 (0)