-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathorderbook.html
More file actions
1933 lines (1913 loc) · 237 KB
/
Copy pathorderbook.html
File metadata and controls
1933 lines (1913 loc) · 237 KB
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>OriginByte</title>
<link type="text/css" rel="stylesheet" href="./assets/style.css">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600&display=swap" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script src="./assets/move.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/fuse.basic.min.js"></script>
<script>var moveModel = [{"d":"err::action_exclusive_to_standalone_listings","l":"./err.html#action_exclusive_to_standalone_listings","f":"err::<span class=\"function\">action_exclusive_to_standalone_listings</span>","de":""},{"d":"err::address_does_not_have_enough_shares","l":"./err.html#address_does_not_have_enough_shares","f":"err::<span class=\"function\">address_does_not_have_enough_shares</span>","de":""},{"d":"err::address_not_attributed","l":"./err.html#address_not_attributed","f":"err::<span class=\"function\">address_not_attributed</span>","de":""},{"d":"err::cannot_trade_with_self","l":"./err.html#cannot_trade_with_self","f":"err::<span class=\"function\">cannot_trade_with_self</span>","de":""},{"d":"err::generic_nft_must_not_be_protocol_type","l":"./err.html#generic_nft_must_not_be_protocol_type","f":"err::<span class=\"function\">generic_nft_must_not_be_protocol_type</span>","de":""},{"d":"err::has_custom_fee_policy","l":"./err.html#has_custom_fee_policy","f":"err::<span class=\"function\">has_custom_fee_policy</span>","de":""},{"d":"err::invalid_total_share_of_royalties","l":"./err.html#invalid_total_share_of_royalties","f":"err::<span class=\"function\">invalid_total_share_of_royalties</span>","de":""},{"d":"err::listing_already_attached_to_marketplace","l":"./err.html#listing_already_attached_to_marketplace","f":"err::<span class=\"function\">listing_already_attached_to_marketplace</span>","de":""},{"d":"err::listing_has_not_applied_to_this_marketplace","l":"./err.html#listing_has_not_applied_to_this_marketplace","f":"err::<span class=\"function\">listing_has_not_applied_to_this_marketplace</span>","de":""},{"d":"err::marketplace_listing_mismatch","l":"./err.html#marketplace_listing_mismatch","f":"err::<span class=\"function\">marketplace_listing_mismatch</span>","de":""},{"d":"err::max_supply_cannot_be_below_current_supply","l":"./err.html#max_supply_cannot_be_below_current_supply","f":"err::<span class=\"function\">max_supply_cannot_be_below_current_supply</span>","de":""},{"d":"err::must_be_witness","l":"./err.html#must_be_witness","f":"err::<span class=\"function\">must_be_witness</span>","de":""},{"d":"err::nft_exclusively_listed","l":"./err.html#nft_exclusively_listed","f":"err::<span class=\"function\">nft_exclusively_listed</span>","de":""},{"d":"err::nft_is_generic","l":"./err.html#nft_is_generic","f":"err::<span class=\"function\">nft_is_generic</span>","de":""},{"d":"err::nft_not_exclusively_listed","l":"./err.html#nft_not_exclusively_listed","f":"err::<span class=\"function\">nft_not_exclusively_listed</span>","de":""},{"d":"err::order_does_not_exist","l":"./err.html#order_does_not_exist","f":"err::<span class=\"function\">order_does_not_exist</span>","de":""},{"d":"err::order_owner_must_be_sender","l":"./err.html#order_owner_must_be_sender","f":"err::<span class=\"function\">order_owner_must_be_sender</span>","de":""},{"d":"err::order_price_below_reserve","l":"./err.html#order_price_below_reserve","f":"err::<span class=\"function\">order_price_below_reserve</span>","de":""},{"d":"err::safe_cap_mismatch","l":"./err.html#safe_cap_mismatch","f":"err::<span class=\"function\">safe_cap_mismatch</span>","de":""},{"d":"err::safe_does_not_accept_deposits","l":"./err.html#safe_does_not_accept_deposits","f":"err::<span class=\"function\">safe_does_not_accept_deposits</span>","de":""},{"d":"err::safe_does_not_contain_nft","l":"./err.html#safe_does_not_contain_nft","f":"err::<span class=\"function\">safe_does_not_contain_nft</span>","de":""},{"d":"err::safe_id_mismatch","l":"./err.html#safe_id_mismatch","f":"err::<span class=\"function\">safe_id_mismatch</span>","de":""},{"d":"err::sender_not_owner","l":"./err.html#sender_not_owner","f":"err::<span class=\"function\">sender_not_owner</span>","de":""},{"d":"err::share_attribution_already_exists","l":"./err.html#share_attribution_already_exists","f":"err::<span class=\"function\">share_attribution_already_exists</span>","de":""},{"d":"err::supply_frozen","l":"./err.html#supply_frozen","f":"err::<span class=\"function\">supply_frozen</span>","de":""},{"d":"err::supply_is_not_zero","l":"./err.html#supply_is_not_zero","f":"err::<span class=\"function\">supply_is_not_zero</span>","de":""},{"d":"err::supply_maxed_out","l":"./err.html#supply_maxed_out","f":"err::<span class=\"function\">supply_maxed_out</span>","de":""},{"d":"err::supply_not_frozen","l":"./err.html#supply_not_frozen","f":"err::<span class=\"function\">supply_not_frozen</span>","de":""},{"d":"err::supply_not_regulated","l":"./err.html#supply_not_regulated","f":"err::<span class=\"function\">supply_not_regulated</span>","de":""},{"d":"err::supply_regulated","l":"./err.html#supply_regulated","f":"err::<span class=\"function\">supply_regulated</span>","de":""},{"d":"err::transfer_cap_expired","l":"./err.html#transfer_cap_expired","f":"err::<span class=\"function\">transfer_cap_expired</span>","de":""},{"d":"err::transfer_cap_nft_mismatch","l":"./err.html#transfer_cap_nft_mismatch","f":"err::<span class=\"function\">transfer_cap_nft_mismatch</span>","de":""},{"d":"err::witness_source_mismatch","l":"./err.html#witness_source_mismatch","f":"err::<span class=\"function\">witness_source_mismatch</span>","de":""},{"d":"err::wrong_fee_policy_type","l":"./err.html#wrong_fee_policy_type","f":"err::<span class=\"function\">wrong_fee_policy_type</span>","de":""},{"d":"err::wrong_listing_admin","l":"./err.html#wrong_listing_admin","f":"err::<span class=\"function\">wrong_listing_admin</span>","de":""},{"d":"err::wrong_marketplace_admin","l":"./err.html#wrong_marketplace_admin","f":"err::<span class=\"function\">wrong_marketplace_admin</span>","de":""},{"d":"err::wrong_marketplace_or_listing_admin","l":"./err.html#wrong_marketplace_or_listing_admin","f":"err::<span class=\"function\">wrong_marketplace_or_listing_admin</span>","de":""},{"d":"utils::Marker","l":"./utils.html#Marker","f":"utils::<span class=\"hljs-type\">Marker</span>","de":" Used to mark type fields in dynamic fields"},{"d":"utils::assert_not_nft_protocol_type","l":"./utils.html#assert_not_nft_protocol_type","f":"utils::<span class=\"function\">assert_not_nft_protocol_type</span>","de":" T mustn't be exported by nft-protocol to avoid unexpected bugs"},{"d":"utils::assert_same_module_as_witness","l":"./utils.html#assert_same_module_as_witness","f":"utils::<span class=\"function\">assert_same_module_as_witness</span>","de":" First generic `T` is any type, second generic is `Witness`."},{"d":"utils::bps","l":"./utils.html#bps","f":"utils::<span class=\"function\">bps</span>","de":""},{"d":"utils::from_vec_to_map","l":"./utils.html#from_vec_to_map","f":"utils::<span class=\"function\">from_vec_to_map</span>","de":""},{"d":"utils::get_package_module_type","l":"./utils.html#get_package_module_type","f":"utils::<span class=\"function\">get_package_module_type</span>","de":""},{"d":"utils::is_nft_protocol_nft_type","l":"./utils.html#is_nft_protocol_nft_type","f":"utils::<span class=\"function\">is_nft_protocol_nft_type</span>","de":" Returns true if T is of type `nft_protocol::nft::Nft`"},{"d":"utils::marker","l":"./utils.html#marker","f":"utils::<span class=\"function\">marker</span>","de":""},{"d":"utils::nft_protocol_package_id","l":"./utils.html#nft_protocol_package_id","f":"utils::<span class=\"function\">nft_protocol_package_id</span>","de":""},{"d":"witness::Witness","l":"./witness.html#Witness","f":"witness::<span class=\"hljs-type\">Witness</span>","de":" Collection generic witness type"},{"d":"witness::WitnessGenerator","l":"./witness.html#WitnessGenerator","f":"witness::<span class=\"hljs-type\">WitnessGenerator</span>","de":" Collection witness generator"},{"d":"witness::delegate","l":"./witness.html#delegate","f":"witness::<span class=\"function\">delegate</span>","de":" Delegate a collection generic witness"},{"d":"witness::from_witness","l":"./witness.html#from_witness","f":"witness::<span class=\"function\">from_witness</span>","de":" Delegate a witness from collection witness"},{"d":"witness::generator","l":"./witness.html#generator","f":"witness::<span class=\"function\">generator</span>","de":" Create a new `WitnessGenerator` from collection witness"},{"d":"transfer_allowlist::Allowlist","l":"./transfer_allowlist.html#Allowlist","f":"transfer_allowlist::<span class=\"hljs-type\">Allowlist</span>","de":""},{"d":"transfer_allowlist::CollectionControlCap","l":"./transfer_allowlist.html#CollectionControlCap","f":"transfer_allowlist::<span class=\"hljs-type\">CollectionControlCap</span>","de":" Gives the collection admin a capability to insert and remove their"},{"d":"transfer_allowlist::assert_authority","l":"./transfer_allowlist.html#assert_authority","f":"transfer_allowlist::<span class=\"function\">assert_authority</span>","de":" Assert that `Auth` may be used to transfer using this `Allowlist`"},{"d":"transfer_allowlist::assert_collection","l":"./transfer_allowlist.html#assert_collection","f":"transfer_allowlist::<span class=\"function\">assert_collection</span>","de":" Assert that `Nft<C>` may be transferred using this `Allowlist`"},{"d":"transfer_allowlist::assert_transferable","l":"./transfer_allowlist.html#assert_transferable","f":"transfer_allowlist::<span class=\"function\">assert_transferable</span>","de":" Assert that `Nft<C>` is transferrable and `Auth` may be used to"},{"d":"transfer_allowlist::can_be_transferred","l":"./transfer_allowlist.html#can_be_transferred","f":"transfer_allowlist::<span class=\"function\">can_be_transferred</span>","de":" Checks whether given authority witness is in the allowlist, and also"},{"d":"transfer_allowlist::clear_collections","l":"./transfer_allowlist.html#clear_collections","f":"transfer_allowlist::<span class=\"function\">clear_collections</span>","de":" Removes all collections from this list."},{"d":"transfer_allowlist::contains_authority","l":"./transfer_allowlist.html#contains_authority","f":"transfer_allowlist::<span class=\"function\">contains_authority</span>","de":" Returns whether `Allowlist` contains authority `Auth`"},{"d":"transfer_allowlist::contains_collection","l":"./transfer_allowlist.html#contains_collection","f":"transfer_allowlist::<span class=\"function\">contains_collection</span>","de":" Returns whether `Allowlist` contains collection `C`"},{"d":"transfer_allowlist::create","l":"./transfer_allowlist.html#create","f":"transfer_allowlist::<span class=\"function\">create</span>","de":" Creates a new `Allowlist`"},{"d":"transfer_allowlist::create_collection_cap","l":"./transfer_allowlist.html#create_collection_cap","f":"transfer_allowlist::<span class=\"function\">create_collection_cap</span>","de":" See the docs for struct `CollectionControlCap`."},{"d":"transfer_allowlist::init_allowlist","l":"./transfer_allowlist.html#init_allowlist","f":"transfer_allowlist::<span class=\"function\">init_allowlist</span>","de":" Creates and shares a new `Allowlist`"},{"d":"transfer_allowlist::insert_authority","l":"./transfer_allowlist.html#insert_authority","f":"transfer_allowlist::<span class=\"function\">insert_authority</span>","de":" To insert a new authority into a list we need confirmation by the"},{"d":"transfer_allowlist::insert_collection","l":"./transfer_allowlist.html#insert_collection","f":"transfer_allowlist::<span class=\"function\">insert_collection</span>","de":""},{"d":"transfer_allowlist::insert_collection_with_cap","l":"./transfer_allowlist.html#insert_collection_with_cap","f":"transfer_allowlist::<span class=\"function\">insert_collection_with_cap</span>","de":" To add a collection to the list, we need a confirmation by both the"},{"d":"transfer_allowlist::remove_authority","l":"./transfer_allowlist.html#remove_authority","f":"transfer_allowlist::<span class=\"function\">remove_authority</span>","de":" The allowlist authority (via witness) can at any point remove any"},{"d":"transfer_allowlist::remove_collection","l":"./transfer_allowlist.html#remove_collection","f":"transfer_allowlist::<span class=\"function\">remove_collection</span>","de":" The allowlist owner can remove any collection at any point."},{"d":"transfer_allowlist::remove_itself","l":"./transfer_allowlist.html#remove_itself","f":"transfer_allowlist::<span class=\"function\">remove_itself</span>","de":" Any collection is allowed to remove itself from any allowlist at any"},{"d":"transfer_allowlist::requires_authority","l":"./transfer_allowlist.html#requires_authority","f":"transfer_allowlist::<span class=\"function\">requires_authority</span>","de":" Returns whether `Allowlist` requires an authority to transfer"},{"d":"supply::Supply","l":"./supply.html#Supply","f":"supply::<span class=\"hljs-type\">Supply</span>","de":" `Supply` tracks supply parameters"},{"d":"supply::max","l":"./supply.html#max","f":"supply::<span class=\"function\">max</span>","de":" Maximum supply"},{"d":"supply::new","l":"./supply.html#new","f":"supply::<span class=\"function\">new</span>","de":" Creates a new `Supply` object"},{"d":"supply::supply","l":"./supply.html#supply","f":"supply::<span class=\"function\">supply</span>","de":" Return remaining supply"},{"d":"supply::assert_frozen","l":"./supply.html#assert_frozen","f":"supply::<span class=\"function\">assert_frozen</span>","de":" Asserts that supply is frozen"},{"d":"supply::assert_not_frozen","l":"./supply.html#assert_not_frozen","f":"supply::<span class=\"function\">assert_not_frozen</span>","de":" Asserts that supply is not frozen"},{"d":"supply::assert_zero","l":"./supply.html#assert_zero","f":"supply::<span class=\"function\">assert_zero</span>","de":" Asserts that current supply is zero"},{"d":"supply::current","l":"./supply.html#current","f":"supply::<span class=\"function\">current</span>","de":" Current supply"},{"d":"supply::decrease_maximum","l":"./supply.html#decrease_maximum","f":"supply::<span class=\"function\">decrease_maximum</span>","de":" Decreases maximum supply"},{"d":"supply::decrement","l":"./supply.html#decrement","f":"supply::<span class=\"function\">decrement</span>","de":" Decrements current supply"},{"d":"supply::extend","l":"./supply.html#extend","f":"supply::<span class=\"function\">extend</span>","de":" Creates a new `Supply` which is extended from the current `Supply`"},{"d":"supply::freeze_supply","l":"./supply.html#freeze_supply","f":"supply::<span class=\"function\">freeze_supply</span>","de":" Freeze `Supply`"},{"d":"supply::increase_maximum","l":"./supply.html#increase_maximum","f":"supply::<span class=\"function\">increase_maximum</span>","de":" Increases maximum supply"},{"d":"supply::increment","l":"./supply.html#increment","f":"supply::<span class=\"function\">increment</span>","de":" Increments current supply"},{"d":"supply::merge","l":"./supply.html#merge","f":"supply::<span class=\"function\">merge</span>","de":" Merge two `Supply` to one"},{"d":"mint_cap::MintCap","l":"./mint_cap.html#MintCap","f":"mint_cap::<span class=\"hljs-type\">MintCap</span>","de":" `MintCap<C>` delegates the capability to it's owner to mint `Nft<C>`."},{"d":"mint_cap::RegulatedMintCap","l":"./mint_cap.html#RegulatedMintCap","f":"mint_cap::<span class=\"hljs-type\">RegulatedMintCap</span>","de":" `RegulatedMintCap` delegates the capability to it's owner to mint"},{"d":"mint_cap::UnregulatedMintCap","l":"./mint_cap.html#UnregulatedMintCap","f":"mint_cap::<span class=\"hljs-type\">UnregulatedMintCap</span>","de":" `UnregulatedMintCap` delegates the capability to it's owner to mint"},{"d":"mint_cap::new","l":"./mint_cap.html#new","f":"mint_cap::<span class=\"function\">new</span>","de":" Create a new `MintCap`"},{"d":"mint_cap::delegate","l":"./mint_cap.html#delegate","f":"mint_cap::<span class=\"function\">delegate</span>","de":" Creates a new `RegulatedMintCap` by delegating some supply from an"},{"d":"mint_cap::borrow_supply","l":"./mint_cap.html#borrow_supply","f":"mint_cap::<span class=\"function\">borrow_supply</span>","de":" Borrow `RegulatedMintCap` `Supply`"},{"d":"mint_cap::collection_id","l":"./mint_cap.html#collection_id","f":"mint_cap::<span class=\"function\">collection_id</span>","de":" Returns ID of `Collection` associated with `MintCap`"},{"d":"mint_cap::delegate_all","l":"./mint_cap.html#delegate_all","f":"mint_cap::<span class=\"function\">delegate_all</span>","de":" Creates a new `RegulatedMintCap` by delegating all remaining supply"},{"d":"mint_cap::delete_regulated","l":"./mint_cap.html#delete_regulated","f":"mint_cap::<span class=\"function\">delete_regulated</span>","de":" Delete `RegulatedMintCap<C>`"},{"d":"mint_cap::delete_unregulated","l":"./mint_cap.html#delete_unregulated","f":"mint_cap::<span class=\"function\">delete_unregulated</span>","de":" Delete `UnregulatedMintCap`"},{"d":"mint_cap::from_unregulated","l":"./mint_cap.html#from_unregulated","f":"mint_cap::<span class=\"function\">from_unregulated</span>","de":" Create a new `RegulatedMintCap` from `UnregulatedMintCap`"},{"d":"mint_cap::increment_supply","l":"./mint_cap.html#increment_supply","f":"mint_cap::<span class=\"function\">increment_supply</span>","de":" Increments the delegated supply of `Inventory`"},{"d":"mint_cap::new_regulated","l":"./mint_cap.html#new_regulated","f":"mint_cap::<span class=\"function\">new_regulated</span>","de":" Create a new `RegulatedMintCap`"},{"d":"mint_cap::new_unregulated","l":"./mint_cap.html#new_unregulated","f":"mint_cap::<span class=\"function\">new_unregulated</span>","de":" Create a new `UnregulatedMintCap`"},{"d":"mint_cap::regulated_collection_id","l":"./mint_cap.html#regulated_collection_id","f":"mint_cap::<span class=\"function\">regulated_collection_id</span>","de":" Returns ID of `Collection` associated with `RegulatedMintCap`"},{"d":"mint_cap::unregulated_collection_id","l":"./mint_cap.html#unregulated_collection_id","f":"mint_cap::<span class=\"function\">unregulated_collection_id</span>","de":" Returns ID of `Collection` associated with `RegulatedMintCap`"},{"d":"nft::ChangeLogicalOwnerEvent","l":"./nft.html#ChangeLogicalOwnerEvent","f":"nft::<span class=\"hljs-type\">ChangeLogicalOwnerEvent</span>","de":""},{"d":"nft::MintNftEvent","l":"./nft.html#MintNftEvent","f":"nft::<span class=\"hljs-type\">MintNftEvent</span>","de":" Event signalling that an `Nft` was minted"},{"d":"nft::Nft","l":"./nft.html#Nft","f":"nft::<span class=\"hljs-type\">Nft</span>","de":" `Nft` object"},{"d":"nft::new","l":"./nft.html#new","f":"nft::<span class=\"function\">new</span>","de":" Create a new `Nft` using `MintCap`"},{"d":"nft::name","l":"./nft.html#name","f":"nft::<span class=\"function\">name</span>","de":" Returns `Nft` name"},{"d":"nft::url","l":"./nft.html#url","f":"nft::<span class=\"function\">url</span>","de":" Returns `Nft` name"},{"d":"nft::transfer","l":"./nft.html#transfer","f":"nft::<span class=\"function\">transfer</span>","de":" Transfer the `Nft` to `recipient` while changing the `logical_owner`"},{"d":"nft::from_unregulated","l":"./nft.html#from_unregulated","f":"nft::<span class=\"function\">from_unregulated</span>","de":" Create a new `Nft` using `UnregulatedMintCap`"},{"d":"nft::add_domain","l":"./nft.html#add_domain","f":"nft::<span class=\"function\">add_domain</span>","de":" Adds domain of type `D` to `Nft`"},{"d":"nft::add_domain_delegated","l":"./nft.html#add_domain_delegated","f":"nft::<span class=\"function\">add_domain_delegated</span>","de":" Adds domain of type `D` to `Nft`"},{"d":"nft::add_domain_with_mint_cap","l":"./nft.html#add_domain_with_mint_cap","f":"nft::<span class=\"function\">add_domain_with_mint_cap</span>","de":" Adds domain of type `D` to `Nft`"},{"d":"nft::add_domain_with_regulated","l":"./nft.html#add_domain_with_regulated","f":"nft::<span class=\"function\">add_domain_with_regulated</span>","de":" Adds domain of type `D` to `Nft`"},{"d":"nft::add_domain_with_unregulated","l":"./nft.html#add_domain_with_unregulated","f":"nft::<span class=\"function\">add_domain_with_unregulated</span>","de":" Adds domain of type `D` to `Nft`"},{"d":"nft::assert_domain","l":"./nft.html#assert_domain","f":"nft::<span class=\"function\">assert_domain</span>","de":" Assert that domain, `D`, exists on `Nft`"},{"d":"nft::assert_logical_owner","l":"./nft.html#assert_logical_owner","f":"nft::<span class=\"function\">assert_logical_owner</span>","de":" Asserts that transaction sender is the logical owner of the Nft"},{"d":"nft::assert_no_domain","l":"./nft.html#assert_no_domain","f":"nft::<span class=\"function\">assert_no_domain</span>","de":" Assert that domain, `D`, does not exist on `Nft`"},{"d":"nft::borrow_domain","l":"./nft.html#borrow_domain","f":"nft::<span class=\"function\">borrow_domain</span>","de":" Borrow domain of type `D` from `Nft`"},{"d":"nft::borrow_domain_mut","l":"./nft.html#borrow_domain_mut","f":"nft::<span class=\"function\">borrow_domain_mut</span>","de":" Mutably borrow domain of type `D` from `Nft`"},{"d":"nft::burn","l":"./nft.html#burn","f":"nft::<span class=\"function\">burn</span>","de":" Burns an `Nft`"},{"d":"nft::change_logical_owner","l":"./nft.html#change_logical_owner","f":"nft::<span class=\"function\">change_logical_owner</span>","de":" Change the `logical_owner` of the `Nft` to `recipient`"},{"d":"nft::from_mint_cap","l":"./nft.html#from_mint_cap","f":"nft::<span class=\"function\">from_mint_cap</span>","de":" Create a new `Nft` using `MintCap`"},{"d":"nft::from_regulated","l":"./nft.html#from_regulated","f":"nft::<span class=\"function\">from_regulated</span>","de":" Create a new `Nft` using `RegulatedMintCap`"},{"d":"nft::has_domain","l":"./nft.html#has_domain","f":"nft::<span class=\"function\">has_domain</span>","de":" Check whether `Nft` has a domain of type `D`"},{"d":"nft::logical_owner","l":"./nft.html#logical_owner","f":"nft::<span class=\"function\">logical_owner</span>","de":" Returns the logical owner of the `Nft`"},{"d":"nft::remove_domain","l":"./nft.html#remove_domain","f":"nft::<span class=\"function\">remove_domain</span>","de":" Removes domain of type `D` from `Nft`"},{"d":"nft::set_name","l":"./nft.html#set_name","f":"nft::<span class=\"function\">set_name</span>","de":" Sets `Nft` static name"},{"d":"nft::set_url","l":"./nft.html#set_url","f":"nft::<span class=\"function\">set_url</span>","de":" Sets `Nft` static URL"},{"d":"attributes::Witness","l":"./attributes.html#Witness","f":"attributes::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"attributes::AttributesDomain","l":"./attributes.html#AttributesDomain","f":"attributes::<span class=\"hljs-type\">AttributesDomain</span>","de":" Domain for storing NFT string attributes"},{"d":"attributes::add_domain","l":"./attributes.html#add_domain","f":"attributes::<span class=\"function\">add_domain</span>","de":" Adds `AttributesDomain` to `Nft`"},{"d":"attributes::add_domain_delegated","l":"./attributes.html#add_domain_delegated","f":"attributes::<span class=\"function\">add_domain_delegated</span>","de":" Adds `AttributesDomain` to `Nft`"},{"d":"attributes::borrow_domain","l":"./attributes.html#borrow_domain","f":"attributes::<span class=\"function\">borrow_domain</span>","de":" Borrows `UrlDomain` from `Nft`"},{"d":"attributes::borrow_domain_mut","l":"./attributes.html#borrow_domain_mut","f":"attributes::<span class=\"function\">borrow_domain_mut</span>","de":" Mutably borrows `UrlDomain` from `Nft`"},{"d":"attributes::has_domain","l":"./attributes.html#has_domain","f":"attributes::<span class=\"function\">has_domain</span>","de":" Returns whether `AttributesDomain` is registered on `Nft`"},{"d":"attributes::add_domain_from_vec","l":"./attributes.html#add_domain_from_vec","f":"attributes::<span class=\"function\">add_domain_from_vec</span>","de":" Adds `AttributesDomain` to `Nft` from vector of keys and values"},{"d":"attributes::add_domain_from_vec_delegated","l":"./attributes.html#add_domain_from_vec_delegated","f":"attributes::<span class=\"function\">add_domain_from_vec_delegated</span>","de":" Adds `AttributesDomain` to `Nft` from vector of keys and values"},{"d":"attributes::add_empty_domain","l":"./attributes.html#add_empty_domain","f":"attributes::<span class=\"function\">add_empty_domain</span>","de":" Adds `AttributesDomain` to `Nft`"},{"d":"attributes::add_empty_domain_delegated","l":"./attributes.html#add_empty_domain_delegated","f":"attributes::<span class=\"function\">add_empty_domain_delegated</span>","de":" Adds `AttributesDomain` to `Nft`"},{"d":"attributes::as_url_parameters","l":"./attributes.html#as_url_parameters","f":"attributes::<span class=\"function\">as_url_parameters</span>","de":" Serializes attributes as URL parameters"},{"d":"attributes::assert_attributes","l":"./attributes.html#assert_attributes","f":"attributes::<span class=\"function\">assert_attributes</span>","de":" Asserts that `AttributesDomain` is registered on `Nft`"},{"d":"attributes::borrow_attributes","l":"./attributes.html#borrow_attributes","f":"attributes::<span class=\"function\">borrow_attributes</span>","de":" Borrows underlying attribute map of `AttributesDomain`"},{"d":"attributes::borrow_attributes_mut","l":"./attributes.html#borrow_attributes_mut","f":"attributes::<span class=\"function\">borrow_attributes_mut</span>","de":" Mutably borrows underlying attribute map of `AttributesDomain`"},{"d":"royalties::TradePayment","l":"./royalties.html#TradePayment","f":"royalties::<span class=\"hljs-type\">TradePayment</span>","de":" `W` is the collection's witness (not the one time witness!) which"},{"d":"royalties::TradePaymentCreatedEvent","l":"./royalties.html#TradePaymentCreatedEvent","f":"royalties::<span class=\"hljs-type\">TradePaymentCreatedEvent</span>","de":""},{"d":"royalties::create","l":"./royalties.html#create","f":"royalties::<span class=\"function\">create</span>","de":""},{"d":"royalties::balance","l":"./royalties.html#balance","f":"royalties::<span class=\"function\">balance</span>","de":""},{"d":"royalties::balance_mut","l":"./royalties.html#balance_mut","f":"royalties::<span class=\"function\">balance_mut</span>","de":" `W` is the collection's witness (not the one time witness!) which"},{"d":"royalties::amount","l":"./royalties.html#amount","f":"royalties::<span class=\"function\">amount</span>","de":""},{"d":"royalties::beneficiary","l":"./royalties.html#beneficiary","f":"royalties::<span class=\"function\">beneficiary</span>","de":""},{"d":"royalties::create_with_trade","l":"./royalties.html#create_with_trade","f":"royalties::<span class=\"function\">create_with_trade</span>","de":""},{"d":"royalties::transfer_remaining_to_beneficiary","l":"./royalties.html#transfer_remaining_to_beneficiary","f":"royalties::<span class=\"function\">transfer_remaining_to_beneficiary</span>","de":""},{"d":"trading::AskCommission","l":"./trading.html#AskCommission","f":"trading::<span class=\"hljs-type\">AskCommission</span>","de":" Enables collection of wallet/marketplace collection for listing an NFT."},{"d":"trading::BidCommission","l":"./trading.html#BidCommission","f":"trading::<span class=\"hljs-type\">BidCommission</span>","de":" Enables collection of wallet/marketplace collection for buying NFTs."},{"d":"trading::bid_commission_amount","l":"./trading.html#bid_commission_amount","f":"trading::<span class=\"function\">bid_commission_amount</span>","de":""},{"d":"trading::destroy_bid_commission","l":"./trading.html#destroy_bid_commission","f":"trading::<span class=\"function\">destroy_bid_commission</span>","de":""},{"d":"trading::new_ask_commission","l":"./trading.html#new_ask_commission","f":"trading::<span class=\"function\">new_ask_commission</span>","de":""},{"d":"trading::new_bid_commission","l":"./trading.html#new_bid_commission","f":"trading::<span class=\"function\">new_bid_commission</span>","de":""},{"d":"trading::settle_funds_no_royalties","l":"./trading.html#settle_funds_no_royalties","f":"trading::<span class=\"function\">settle_funds_no_royalties</span>","de":" No royalty collection, just transfer the funds directly."},{"d":"trading::settle_funds_with_royalties","l":"./trading.html#settle_funds_with_royalties","f":"trading::<span class=\"function\">settle_funds_with_royalties</span>","de":" Wraps the funds in an object which can be only unwrapped in a method"},{"d":"trading::transfer_bid_commission","l":"./trading.html#transfer_bid_commission","f":"trading::<span class=\"function\">transfer_bid_commission</span>","de":""},{"d":"unprotected_safe::DepositEvent","l":"./unprotected_safe.html#DepositEvent","f":"unprotected_safe::<span class=\"hljs-type\">DepositEvent</span>","de":""},{"d":"unprotected_safe::NftRef","l":"./unprotected_safe.html#NftRef","f":"unprotected_safe::<span class=\"hljs-type\">NftRef</span>","de":" Keeps info about an NFT which enables us to issue transfer caps etc."},{"d":"unprotected_safe::OwnerCap","l":"./unprotected_safe.html#OwnerCap","f":"unprotected_safe::<span class=\"hljs-type\">OwnerCap</span>","de":" Whoever owns this object can perform some admin actions against the"},{"d":"unprotected_safe::TransferCap","l":"./unprotected_safe.html#TransferCap","f":"unprotected_safe::<span class=\"hljs-type\">TransferCap</span>","de":" Enables the owner to transfer given NFT out of the `Safe`."},{"d":"unprotected_safe::TransferEvent","l":"./unprotected_safe.html#TransferEvent","f":"unprotected_safe::<span class=\"hljs-type\">TransferEvent</span>","de":""},{"d":"unprotected_safe::UnprotectedSafe","l":"./unprotected_safe.html#UnprotectedSafe","f":"unprotected_safe::<span class=\"hljs-type\">UnprotectedSafe</span>","de":""},{"d":"unprotected_safe::new","l":"./unprotected_safe.html#new","f":"unprotected_safe::<span class=\"function\">new</span>","de":""},{"d":"unprotected_safe::assert_generic_nft_type","l":"./unprotected_safe.html#assert_generic_nft_type","f":"unprotected_safe::<span class=\"function\">assert_generic_nft_type</span>","de":" Checks that the transfer cap is issued for an NFT of type `C`"},{"d":"unprotected_safe::assert_has_nft","l":"./unprotected_safe.html#assert_has_nft","f":"unprotected_safe::<span class=\"function\">assert_has_nft</span>","de":""},{"d":"unprotected_safe::assert_id","l":"./unprotected_safe.html#assert_id","f":"unprotected_safe::<span class=\"function\">assert_id</span>","de":""},{"d":"unprotected_safe::assert_nft_of_transfer_cap","l":"./unprotected_safe.html#assert_nft_of_transfer_cap","f":"unprotected_safe::<span class=\"function\">assert_nft_of_transfer_cap</span>","de":""},{"d":"unprotected_safe::assert_nft_type","l":"./unprotected_safe.html#assert_nft_type","f":"unprotected_safe::<span class=\"function\">assert_nft_type</span>","de":" Checks that the transfer cap is issued for an NFT of type `Nft<C>`"},{"d":"unprotected_safe::assert_not_exclusively_listed","l":"./unprotected_safe.html#assert_not_exclusively_listed","f":"unprotected_safe::<span class=\"function\">assert_not_exclusively_listed</span>","de":""},{"d":"unprotected_safe::assert_owner_cap","l":"./unprotected_safe.html#assert_owner_cap","f":"unprotected_safe::<span class=\"function\">assert_owner_cap</span>","de":""},{"d":"unprotected_safe::assert_transfer_cap_exclusive","l":"./unprotected_safe.html#assert_transfer_cap_exclusive","f":"unprotected_safe::<span class=\"function\">assert_transfer_cap_exclusive</span>","de":""},{"d":"unprotected_safe::assert_transfer_cap_of_native_nft","l":"./unprotected_safe.html#assert_transfer_cap_of_native_nft","f":"unprotected_safe::<span class=\"function\">assert_transfer_cap_of_native_nft</span>","de":""},{"d":"unprotected_safe::assert_transfer_cap_of_safe","l":"./unprotected_safe.html#assert_transfer_cap_of_safe","f":"unprotected_safe::<span class=\"function\">assert_transfer_cap_of_safe</span>","de":""},{"d":"unprotected_safe::borrow_generic_nft","l":"./unprotected_safe.html#borrow_generic_nft","f":"unprotected_safe::<span class=\"function\">borrow_generic_nft</span>","de":""},{"d":"unprotected_safe::borrow_nft","l":"./unprotected_safe.html#borrow_nft","f":"unprotected_safe::<span class=\"function\">borrow_nft</span>","de":""},{"d":"unprotected_safe::burn_transfer_cap","l":"./unprotected_safe.html#burn_transfer_cap","f":"unprotected_safe::<span class=\"function\">burn_transfer_cap</span>","de":" Destroys given transfer cap. This is mainly useful for exclusively listed"},{"d":"unprotected_safe::create_exclusive_transfer_cap","l":"./unprotected_safe.html#create_exclusive_transfer_cap","f":"unprotected_safe::<span class=\"function\">create_exclusive_transfer_cap</span>","de":" Creates an irrevocable and exclusive transfer cap."},{"d":"unprotected_safe::create_for_sender","l":"./unprotected_safe.html#create_for_sender","f":"unprotected_safe::<span class=\"function\">create_for_sender</span>","de":" Instantiates a new shared object `Safe` and transfer `OwnerCap` to the"},{"d":"unprotected_safe::create_safe","l":"./unprotected_safe.html#create_safe","f":"unprotected_safe::<span class=\"function\">create_safe</span>","de":" Creates a new `Safe` shared object and returns the authority capability"},{"d":"unprotected_safe::create_transfer_cap","l":"./unprotected_safe.html#create_transfer_cap","f":"unprotected_safe::<span class=\"function\">create_transfer_cap</span>","de":" Creates a `TransferCap` which must be claimed atomically."},{"d":"unprotected_safe::delist_nft","l":"./unprotected_safe.html#delist_nft","f":"unprotected_safe::<span class=\"function\">delist_nft</span>","de":" Changes the transfer ref version, thereby invalidating all existing"},{"d":"unprotected_safe::deposit_generic_nft","l":"./unprotected_safe.html#deposit_generic_nft","f":"unprotected_safe::<span class=\"function\">deposit_generic_nft</span>","de":" Transfer an NFT into the `Safe`."},{"d":"unprotected_safe::deposit_nft","l":"./unprotected_safe.html#deposit_nft","f":"unprotected_safe::<span class=\"function\">deposit_nft</span>","de":" Transfer an NFT into the `Safe`."},{"d":"unprotected_safe::has_generic_nft","l":"./unprotected_safe.html#has_generic_nft","f":"unprotected_safe::<span class=\"function\">has_generic_nft</span>","de":""},{"d":"unprotected_safe::has_nft","l":"./unprotected_safe.html#has_nft","f":"unprotected_safe::<span class=\"function\">has_nft</span>","de":""},{"d":"unprotected_safe::owner_cap_safe","l":"./unprotected_safe.html#owner_cap_safe","f":"unprotected_safe::<span class=\"function\">owner_cap_safe</span>","de":""},{"d":"unprotected_safe::transfer_cap_is_exclusive","l":"./unprotected_safe.html#transfer_cap_is_exclusive","f":"unprotected_safe::<span class=\"function\">transfer_cap_is_exclusive</span>","de":""},{"d":"unprotected_safe::transfer_cap_is_nft_generic","l":"./unprotected_safe.html#transfer_cap_is_nft_generic","f":"unprotected_safe::<span class=\"function\">transfer_cap_is_nft_generic</span>","de":""},{"d":"unprotected_safe::transfer_cap_nft","l":"./unprotected_safe.html#transfer_cap_nft","f":"unprotected_safe::<span class=\"function\">transfer_cap_nft</span>","de":""},{"d":"unprotected_safe::transfer_cap_object_type","l":"./unprotected_safe.html#transfer_cap_object_type","f":"unprotected_safe::<span class=\"function\">transfer_cap_object_type</span>","de":""},{"d":"unprotected_safe::transfer_cap_safe","l":"./unprotected_safe.html#transfer_cap_safe","f":"unprotected_safe::<span class=\"function\">transfer_cap_safe</span>","de":""},{"d":"unprotected_safe::transfer_cap_version","l":"./unprotected_safe.html#transfer_cap_version","f":"unprotected_safe::<span class=\"function\">transfer_cap_version</span>","de":""},{"d":"unprotected_safe::transfer_generic_nft_to_recipient","l":"./unprotected_safe.html#transfer_generic_nft_to_recipient","f":"unprotected_safe::<span class=\"function\">transfer_generic_nft_to_recipient</span>","de":""},{"d":"unprotected_safe::transfer_generic_nft_to_safe","l":"./unprotected_safe.html#transfer_generic_nft_to_safe","f":"unprotected_safe::<span class=\"function\">transfer_generic_nft_to_safe</span>","de":""},{"d":"unprotected_safe::transfer_nft_to_recipient","l":"./unprotected_safe.html#transfer_nft_to_recipient","f":"unprotected_safe::<span class=\"function\">transfer_nft_to_recipient</span>","de":" Use a transfer cap to get an NFT out of the `Safe`."},{"d":"unprotected_safe::transfer_nft_to_safe","l":"./unprotected_safe.html#transfer_nft_to_safe","f":"unprotected_safe::<span class=\"function\">transfer_nft_to_safe</span>","de":" Use a transfer cap to get an NFT out of source `Safe` and deposit it"},{"d":"safe::OwnerCap","l":"./safe.html#OwnerCap","f":"safe::<span class=\"hljs-type\">OwnerCap</span>","de":" Whoever owns this object can perform some admin actions against the"},{"d":"safe::TransferCap","l":"./safe.html#TransferCap","f":"safe::<span class=\"hljs-type\">TransferCap</span>","de":" Enables the owner to transfer given NFT out of the `Safe`."},{"d":"safe::Safe","l":"./safe.html#Safe","f":"safe::<span class=\"hljs-type\">Safe</span>","de":""},{"d":"safe::new","l":"./safe.html#new","f":"safe::<span class=\"function\">new</span>","de":" Creates a new safe."},{"d":"safe::assert_generic_nft_type","l":"./safe.html#assert_generic_nft_type","f":"safe::<span class=\"function\">assert_generic_nft_type</span>","de":" Checks that the transfer cap is issued for an NFT of type `C`"},{"d":"safe::assert_has_nft","l":"./safe.html#assert_has_nft","f":"safe::<span class=\"function\">assert_has_nft</span>","de":""},{"d":"safe::assert_id","l":"./safe.html#assert_id","f":"safe::<span class=\"function\">assert_id</span>","de":""},{"d":"safe::assert_nft_of_transfer_cap","l":"./safe.html#assert_nft_of_transfer_cap","f":"safe::<span class=\"function\">assert_nft_of_transfer_cap</span>","de":""},{"d":"safe::assert_nft_type","l":"./safe.html#assert_nft_type","f":"safe::<span class=\"function\">assert_nft_type</span>","de":" Checks that the transfer cap is issued for an NFT of type `Nft<C>`"},{"d":"safe::assert_not_exclusively_listed","l":"./safe.html#assert_not_exclusively_listed","f":"safe::<span class=\"function\">assert_not_exclusively_listed</span>","de":""},{"d":"safe::assert_owner_cap","l":"./safe.html#assert_owner_cap","f":"safe::<span class=\"function\">assert_owner_cap</span>","de":""},{"d":"safe::assert_transfer_cap_exclusive","l":"./safe.html#assert_transfer_cap_exclusive","f":"safe::<span class=\"function\">assert_transfer_cap_exclusive</span>","de":""},{"d":"safe::assert_transfer_cap_of_native_nft","l":"./safe.html#assert_transfer_cap_of_native_nft","f":"safe::<span class=\"function\">assert_transfer_cap_of_native_nft</span>","de":""},{"d":"safe::assert_transfer_cap_of_safe","l":"./safe.html#assert_transfer_cap_of_safe","f":"safe::<span class=\"function\">assert_transfer_cap_of_safe</span>","de":""},{"d":"safe::borrow_generic_nft","l":"./safe.html#borrow_generic_nft","f":"safe::<span class=\"function\">borrow_generic_nft</span>","de":""},{"d":"safe::borrow_nft","l":"./safe.html#borrow_nft","f":"safe::<span class=\"function\">borrow_nft</span>","de":""},{"d":"safe::burn_transfer_cap","l":"./safe.html#burn_transfer_cap","f":"safe::<span class=\"function\">burn_transfer_cap</span>","de":" Destroys given transfer cap. This is mainly useful for exclusively listed"},{"d":"safe::create_exclusive_transfer_cap","l":"./safe.html#create_exclusive_transfer_cap","f":"safe::<span class=\"function\">create_exclusive_transfer_cap</span>","de":" Creates an irrevocable and exclusive transfer cap."},{"d":"safe::create_for_sender","l":"./safe.html#create_for_sender","f":"safe::<span class=\"function\">create_for_sender</span>","de":" Instantiates a new shared object `Safe` and transfer"},{"d":"safe::create_safe","l":"./safe.html#create_safe","f":"safe::<span class=\"function\">create_safe</span>","de":" Creates a new `Safe` shared object and returns the"},{"d":"safe::create_transfer_cap","l":"./safe.html#create_transfer_cap","f":"safe::<span class=\"function\">create_transfer_cap</span>","de":" Creates a `TransferCap` which must be claimed atomically."},{"d":"safe::delist_nft","l":"./safe.html#delist_nft","f":"safe::<span class=\"function\">delist_nft</span>","de":" Changes the transfer ref version, thereby invalidating all existing"},{"d":"safe::deposit_generic_nft","l":"./safe.html#deposit_generic_nft","f":"safe::<span class=\"function\">deposit_generic_nft</span>","de":" Transfer an NFT into the `Safe`."},{"d":"safe::deposit_nft","l":"./safe.html#deposit_nft","f":"safe::<span class=\"function\">deposit_nft</span>","de":" Transfer an NFT into the `Safe`."},{"d":"safe::has_generic_nft","l":"./safe.html#has_generic_nft","f":"safe::<span class=\"function\">has_generic_nft</span>","de":""},{"d":"safe::has_nft","l":"./safe.html#has_nft","f":"safe::<span class=\"function\">has_nft</span>","de":""},{"d":"safe::owner_cap_safe","l":"./safe.html#owner_cap_safe","f":"safe::<span class=\"function\">owner_cap_safe</span>","de":""},{"d":"safe::transfer_cap_is_exclusive","l":"./safe.html#transfer_cap_is_exclusive","f":"safe::<span class=\"function\">transfer_cap_is_exclusive</span>","de":""},{"d":"safe::transfer_cap_is_nft_generic","l":"./safe.html#transfer_cap_is_nft_generic","f":"safe::<span class=\"function\">transfer_cap_is_nft_generic</span>","de":""},{"d":"safe::transfer_cap_nft","l":"./safe.html#transfer_cap_nft","f":"safe::<span class=\"function\">transfer_cap_nft</span>","de":""},{"d":"safe::transfer_cap_object_type","l":"./safe.html#transfer_cap_object_type","f":"safe::<span class=\"function\">transfer_cap_object_type</span>","de":""},{"d":"safe::transfer_cap_safe","l":"./safe.html#transfer_cap_safe","f":"safe::<span class=\"function\">transfer_cap_safe</span>","de":""},{"d":"safe::transfer_cap_version","l":"./safe.html#transfer_cap_version","f":"safe::<span class=\"function\">transfer_cap_version</span>","de":""},{"d":"safe::transfer_generic_nft_to_recipient","l":"./safe.html#transfer_generic_nft_to_recipient","f":"safe::<span class=\"function\">transfer_generic_nft_to_recipient</span>","de":""},{"d":"safe::transfer_generic_nft_to_safe","l":"./safe.html#transfer_generic_nft_to_safe","f":"safe::<span class=\"function\">transfer_generic_nft_to_safe</span>","de":""},{"d":"safe::transfer_nft_to_recipient","l":"./safe.html#transfer_nft_to_recipient","f":"safe::<span class=\"function\">transfer_nft_to_recipient</span>","de":" Use a transfer cap to get an NFT out of the `Safe`."},{"d":"safe::transfer_nft_to_safe","l":"./safe.html#transfer_nft_to_safe","f":"safe::<span class=\"function\">transfer_nft_to_safe</span>","de":" Use a transfer cap to get an NFT out of source `Safe` and"},{"d":"safe::are_all_deposits_enabled","l":"./safe.html#are_all_deposits_enabled","f":"safe::<span class=\"function\">are_all_deposits_enabled</span>","de":""},{"d":"safe::assert_can_deposit","l":"./safe.html#assert_can_deposit","f":"safe::<span class=\"function\">assert_can_deposit</span>","de":""},{"d":"safe::create_exclusive_transfer_cap_for_sender","l":"./safe.html#create_exclusive_transfer_cap_for_sender","f":"safe::<span class=\"function\">create_exclusive_transfer_cap_for_sender</span>","de":""},{"d":"safe::create_transfer_cap_for_sender","l":"./safe.html#create_transfer_cap_for_sender","f":"safe::<span class=\"function\">create_transfer_cap_for_sender</span>","de":""},{"d":"safe::deposit_generic_nft_privileged","l":"./safe.html#deposit_generic_nft_privileged","f":"safe::<span class=\"function\">deposit_generic_nft_privileged</span>","de":""},{"d":"safe::deposit_nft_privileged","l":"./safe.html#deposit_nft_privileged","f":"safe::<span class=\"function\">deposit_nft_privileged</span>","de":" Transfer an NFT from owner to the `Safe`."},{"d":"safe::disable_deposits_of_collection","l":"./safe.html#disable_deposits_of_collection","f":"safe::<span class=\"function\">disable_deposits_of_collection</span>","de":" The owner can restrict deposits into the `Safe` from given"},{"d":"safe::enable_any_deposit","l":"./safe.html#enable_any_deposit","f":"safe::<span class=\"function\">enable_any_deposit</span>","de":" No restriction on deposits."},{"d":"safe::enable_deposits_of_collection","l":"./safe.html#enable_deposits_of_collection","f":"safe::<span class=\"function\">enable_deposits_of_collection</span>","de":" The owner can enable deposits into the `Safe` from given"},{"d":"safe::inner","l":"./safe.html#inner","f":"safe::<span class=\"function\">inner</span>","de":""},{"d":"safe::restrict_deposits","l":"./safe.html#restrict_deposits","f":"safe::<span class=\"function\">restrict_deposits</span>","de":" Only owner or allowlisted collections can deposit."},{"d":"bidding::Witness","l":"./bidding.html#Witness","f":"bidding::<span class=\"hljs-type\">Witness</span>","de":" === Structs ==="},{"d":"bidding::Bid","l":"./bidding.html#Bid","f":"bidding::<span class=\"hljs-type\">Bid</span>","de":""},{"d":"bidding::BidClosedEvent","l":"./bidding.html#BidClosedEvent","f":"bidding::<span class=\"hljs-type\">BidClosedEvent</span>","de":" Bid was closed by the user, no sell happened"},{"d":"bidding::BidCreatedEvent","l":"./bidding.html#BidCreatedEvent","f":"bidding::<span class=\"hljs-type\">BidCreatedEvent</span>","de":""},{"d":"bidding::BidMatchedEvent","l":"./bidding.html#BidMatchedEvent","f":"bidding::<span class=\"hljs-type\">BidMatchedEvent</span>","de":" NFT was sold"},{"d":"bidding::close_bid","l":"./bidding.html#close_bid","f":"bidding::<span class=\"function\">close_bid</span>","de":" If a user wants to cancel their position, they get their coins back."},{"d":"bidding::create_bid","l":"./bidding.html#create_bid","f":"bidding::<span class=\"function\">create_bid</span>","de":" === Entry points ==="},{"d":"bidding::create_bid_with_commission","l":"./bidding.html#create_bid_with_commission","f":"bidding::<span class=\"function\">create_bid_with_commission</span>","de":" Payable entry function to create a bid for an NFT."},{"d":"bidding::new_bid","l":"./bidding.html#new_bid","f":"bidding::<span class=\"function\">new_bid</span>","de":" Sends funds Balance<FT> from `wallet` to the `bid` and"},{"d":"bidding::sell_generic_nft","l":"./bidding.html#sell_generic_nft","f":"bidding::<span class=\"function\">sell_generic_nft</span>","de":" Similar to [`sell_nft`] except that this is meant for"},{"d":"bidding::sell_generic_nft_with_commission","l":"./bidding.html#sell_generic_nft_with_commission","f":"bidding::<span class=\"function\">sell_generic_nft_with_commission</span>","de":" Similar to [`sell_nft_with_commission`] except that this is meant for"},{"d":"bidding::sell_nft","l":"./bidding.html#sell_nft","f":"bidding::<span class=\"function\">sell_nft</span>","de":" Entry function to sell an NFT with an open `bid`."},{"d":"bidding::sell_nft_with_commission","l":"./bidding.html#sell_nft_with_commission","f":"bidding::<span class=\"function\">sell_nft_with_commission</span>","de":" Entry function to sell an NFT with an open `bid`."},{"d":"bidding::share","l":"./bidding.html#share","f":"bidding::<span class=\"function\">share</span>","de":" === Helpers ==="},{"d":"collection::Collection","l":"./collection.html#Collection","f":"collection::<span class=\"hljs-type\">Collection</span>","de":" NFT `Collection` object"},{"d":"collection::MintCollectionEvent","l":"./collection.html#MintCollectionEvent","f":"collection::<span class=\"hljs-type\">MintCollectionEvent</span>","de":" Event signalling that a `Collection` was minted"},{"d":"collection::create","l":"./collection.html#create","f":"collection::<span class=\"function\">create</span>","de":" Creates a `Collection<C>` and corresponding `MintCap<C>`"},{"d":"collection::add_domain","l":"./collection.html#add_domain","f":"collection::<span class=\"function\">add_domain</span>","de":" Adds domain of type `D` to `Collection`"},{"d":"collection::add_domain_delegated","l":"./collection.html#add_domain_delegated","f":"collection::<span class=\"function\">add_domain_delegated</span>","de":" Adds domain of type `D` to `Collection`"},{"d":"collection::assert_domain","l":"./collection.html#assert_domain","f":"collection::<span class=\"function\">assert_domain</span>","de":" Assert that domain `D` exists on `Collection`"},{"d":"collection::assert_no_domain","l":"./collection.html#assert_no_domain","f":"collection::<span class=\"function\">assert_no_domain</span>","de":" Assert that domain `D` does not exist on `Collection`"},{"d":"collection::borrow_domain","l":"./collection.html#borrow_domain","f":"collection::<span class=\"function\">borrow_domain</span>","de":" Borrow domain of type `D` from `Nft`"},{"d":"collection::borrow_domain_mut","l":"./collection.html#borrow_domain_mut","f":"collection::<span class=\"function\">borrow_domain_mut</span>","de":" Mutably borrow domain of type `D` from `Collection`"},{"d":"collection::has_domain","l":"./collection.html#has_domain","f":"collection::<span class=\"function\">has_domain</span>","de":" Check whether `Collection` has a domain of type `D`"},{"d":"collection::remove_domain","l":"./collection.html#remove_domain","f":"collection::<span class=\"function\">remove_domain</span>","de":" Removes domain of type `D` from `Collection`"},{"d":"collection::init_collection","l":"./collection.html#init_collection","f":"collection::<span class=\"function\">init_collection</span>","de":" Creates a shared `Collection<C>` and corresponding `MintCap<C>`"},{"d":"nft_bag::Witness","l":"./nft_bag.html#Witness","f":"nft_bag::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"nft_bag::NftBagDomain","l":"./nft_bag.html#NftBagDomain","f":"nft_bag::<span class=\"hljs-type\">NftBagDomain</span>","de":" `NftBagDomain` object"},{"d":"nft_bag::borrow","l":"./nft_bag.html#borrow","f":"nft_bag::<span class=\"function\">borrow</span>","de":" Borrows `Nft` from `NftBagDomain`"},{"d":"nft_bag::borrow_mut","l":"./nft_bag.html#borrow_mut","f":"nft_bag::<span class=\"function\">borrow_mut</span>","de":" Mutably borrows `Nft` from `NftBagDomain`"},{"d":"nft_bag::new","l":"./nft_bag.html#new","f":"nft_bag::<span class=\"function\">new</span>","de":" Creates new `NftBagDomain`"},{"d":"nft_bag::add_domain","l":"./nft_bag.html#add_domain","f":"nft_bag::<span class=\"function\">add_domain</span>","de":" Register `NftBagDomain` on `Nft`"},{"d":"nft_bag::borrow_domain","l":"./nft_bag.html#borrow_domain","f":"nft_bag::<span class=\"function\">borrow_domain</span>","de":" Borrows `NftBagDomain` from `Nft`"},{"d":"nft_bag::borrow_domain_mut","l":"./nft_bag.html#borrow_domain_mut","f":"nft_bag::<span class=\"function\">borrow_domain_mut</span>","de":" Mutably borrows `NftBagDomain` from `Nft`"},{"d":"nft_bag::has_domain","l":"./nft_bag.html#has_domain","f":"nft_bag::<span class=\"function\">has_domain</span>","de":" Returns whether `NftBagDomain` is registered on `Nft`"},{"d":"nft_bag::borrow_nft","l":"./nft_bag.html#borrow_nft","f":"nft_bag::<span class=\"function\">borrow_nft</span>","de":" Borrows composed NFT with given ID from `Nft`"},{"d":"nft_bag::assert_composed","l":"./nft_bag.html#assert_composed","f":"nft_bag::<span class=\"function\">assert_composed</span>","de":" Assert that NFT with given ID is composed within the `NftBagDomain`"},{"d":"nft_bag::assert_container","l":"./nft_bag.html#assert_container","f":"nft_bag::<span class=\"function\">assert_container</span>","de":" Asserts that `NftBagDomain` is registered on `Nft`"},{"d":"nft_bag::borrow_nft_mut","l":"./nft_bag.html#borrow_nft_mut","f":"nft_bag::<span class=\"function\">borrow_nft_mut</span>","de":" Mutably borrows composed NFT with given ID from `Nft`"},{"d":"nft_bag::compose","l":"./nft_bag.html#compose","f":"nft_bag::<span class=\"function\">compose</span>","de":" Composes child NFT into `NftBagDomain`"},{"d":"nft_bag::compose_nft","l":"./nft_bag.html#compose_nft","f":"nft_bag::<span class=\"function\">compose_nft</span>","de":" Composes child NFT into parent NFT"},{"d":"nft_bag::count","l":"./nft_bag.html#count","f":"nft_bag::<span class=\"function\">count</span>","de":" Counts how many NFTs are registered under the given authority"},{"d":"nft_bag::decompose","l":"./nft_bag.html#decompose","f":"nft_bag::<span class=\"function\">decompose</span>","de":" Decomposes child NFT from `NftBagDomain`"},{"d":"nft_bag::decompose_nft","l":"./nft_bag.html#decompose_nft","f":"nft_bag::<span class=\"function\">decompose_nft</span>","de":" Decomposes child NFT from parent NFT"},{"d":"nft_bag::has","l":"./nft_bag.html#has","f":"nft_bag::<span class=\"function\">has</span>","de":" Returns whether NFT with given ID is composed within provided"},{"d":"composable_nft::Witness","l":"./composable_nft.html#Witness","f":"composable_nft::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"composable_nft::Blueprint","l":"./composable_nft.html#Blueprint","f":"composable_nft::<span class=\"hljs-type\">Blueprint</span>","de":" Domain held in the Collection object, blueprinting all the composability"},{"d":"composable_nft::Key","l":"./composable_nft.html#Key","f":"composable_nft::<span class=\"hljs-type\">Key</span>","de":" Internal struct for indexing NFTs in `NftBagDomain`"},{"d":"composable_nft::Node","l":"./composable_nft.html#Node","f":"composable_nft::<span class=\"hljs-type\">Node</span>","de":" Defines the properties of a child NFT in the context of type-limited"},{"d":"composable_nft::Type","l":"./composable_nft.html#Type","f":"composable_nft::<span class=\"hljs-type\">Type</span>","de":" NFT type domain"},{"d":"composable_nft::compose","l":"./composable_nft.html#compose","f":"composable_nft::<span class=\"function\">compose</span>","de":" Compose child NFT into parent NFT"},{"d":"composable_nft::decompose","l":"./composable_nft.html#decompose","f":"composable_nft::<span class=\"function\">decompose</span>","de":" Decomposes NFT with given ID from parent NFT"},{"d":"composable_nft::add_blueprint_domain","l":"./composable_nft.html#add_blueprint_domain","f":"composable_nft::<span class=\"function\">add_blueprint_domain</span>","de":" Registers `Blueprint` on the given `Collection`"},{"d":"composable_nft::add_relationship","l":"./composable_nft.html#add_relationship","f":"composable_nft::<span class=\"function\">add_relationship</span>","de":" Adds parent child relationship to `Blueprint`"},{"d":"composable_nft::add_type_domain","l":"./composable_nft.html#add_type_domain","f":"composable_nft::<span class=\"function\">add_type_domain</span>","de":" Registers `Type` as a domain on the `Nft`"},{"d":"composable_nft::assert_composable","l":"./composable_nft.html#assert_composable","f":"composable_nft::<span class=\"function\">assert_composable</span>","de":" Assert that parent and child types are composable"},{"d":"composable_nft::borrow_child","l":"./composable_nft.html#borrow_child","f":"composable_nft::<span class=\"function\">borrow_child</span>","de":" Borrow child node from composability blueprint"},{"d":"composable_nft::decompose_and_transfer","l":"./composable_nft.html#decompose_and_transfer","f":"composable_nft::<span class=\"function\">decompose_and_transfer</span>","de":" Decomposes NFT with given ID from parent NFT and transfers to"},{"d":"composable_nft::has_child","l":"./composable_nft.html#has_child","f":"composable_nft::<span class=\"function\">has_child</span>","de":" Returns whether a parent child relationship exists in the blueprint"},{"d":"composable_nft::new_blueprint","l":"./composable_nft.html#new_blueprint","f":"composable_nft::<span class=\"function\">new_blueprint</span>","de":""},{"d":"composable_nft::new_type","l":"./composable_nft.html#new_type","f":"composable_nft::<span class=\"function\">new_type</span>","de":" Creates a new `Type`"},{"d":"svg::Witness","l":"./svg.html#Witness","f":"svg::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"svg::SvgDomain","l":"./svg.html#SvgDomain","f":"svg::<span class=\"hljs-type\">SvgDomain</span>","de":" Domain for storing an associated SVG data"},{"d":"svg::new","l":"./svg.html#new","f":"svg::<span class=\"function\">new</span>","de":" Creates new `SvgDomain`"},{"d":"svg::add_domain","l":"./svg.html#add_domain","f":"svg::<span class=\"function\">add_domain</span>","de":" Adds `SvgDomain` to `Nft`"},{"d":"svg::has_domain","l":"./svg.html#has_domain","f":"svg::<span class=\"function\">has_domain</span>","de":" Returns whether `SvgDomain` is registered on `Nft`"},{"d":"svg::add_domain_collection","l":"./svg.html#add_domain_collection","f":"svg::<span class=\"function\">add_domain_collection</span>","de":" Adds `SvgDomain` to `Collection`"},{"d":"svg::assert_collection_svg","l":"./svg.html#assert_collection_svg","f":"svg::<span class=\"function\">assert_collection_svg</span>","de":" Asserts that `SvgDomain` is registered on `Nft`"},{"d":"svg::assert_svg","l":"./svg.html#assert_svg","f":"svg::<span class=\"function\">assert_svg</span>","de":" Asserts that `SvgDomain` is registered on `Nft`"},{"d":"svg::borrow_collection_svg","l":"./svg.html#borrow_collection_svg","f":"svg::<span class=\"function\">borrow_collection_svg</span>","de":" Borrows SVG data from `Collection`"},{"d":"svg::borrow_svg","l":"./svg.html#borrow_svg","f":"svg::<span class=\"function\">borrow_svg</span>","de":" Borrows SVG data from `Nft`"},{"d":"svg::has_domain_collection","l":"./svg.html#has_domain_collection","f":"svg::<span class=\"function\">has_domain_collection</span>","de":" Returns whether `SvgDomain` is registered on `Collection`"},{"d":"svg::set_collection_svg","l":"./svg.html#set_collection_svg","f":"svg::<span class=\"function\">set_collection_svg</span>","de":" Sets SVG data of `SvgDomain`"},{"d":"svg::set_svg","l":"./svg.html#set_svg","f":"svg::<span class=\"function\">set_svg</span>","de":" Sets SVG data of `SvgDomain`"},{"d":"composable_svg::Witness","l":"./composable_svg.html#Witness","f":"composable_svg::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"composable_svg::ComposableSvgDomain","l":"./composable_svg.html#ComposableSvgDomain","f":"composable_svg::<span class=\"hljs-type\">ComposableSvgDomain</span>","de":" Domain for providing composed SVG data"},{"d":"composable_svg::new","l":"./composable_svg.html#new","f":"composable_svg::<span class=\"function\">new</span>","de":" Creates new `ComposableSvgDomain` with no predefined NFTs"},{"d":"composable_svg::add_domain","l":"./composable_svg.html#add_domain","f":"composable_svg::<span class=\"function\">add_domain</span>","de":" Adds `SvgDomain` to `Nft`"},{"d":"composable_svg::borrow_domain","l":"./composable_svg.html#borrow_domain","f":"composable_svg::<span class=\"function\">borrow_domain</span>","de":" Borrows SVG data from `Nft`"},{"d":"composable_svg::has_domain","l":"./composable_svg.html#has_domain","f":"composable_svg::<span class=\"function\">has_domain</span>","de":" Returns whether `SvgDomain` is registered on `Nft`"},{"d":"composable_svg::borrow_attributes","l":"./composable_svg.html#borrow_attributes","f":"composable_svg::<span class=\"function\">borrow_attributes</span>","de":" Borrows root tag attributes from `ComposableSvgDomain`"},{"d":"composable_svg::assert_composable_svg","l":"./composable_svg.html#assert_composable_svg","f":"composable_svg::<span class=\"function\">assert_composable_svg</span>","de":" Asserts that `ComposableSvgDomain` is registered on `Nft`"},{"d":"composable_svg::borrow_nfts","l":"./composable_svg.html#borrow_nfts","f":"composable_svg::<span class=\"function\">borrow_nfts</span>","de":" Borrows registered NFTs from `ComposableSvgDomain`"},{"d":"composable_svg::deregister","l":"./composable_svg.html#deregister","f":"composable_svg::<span class=\"function\">deregister</span>","de":" Deregisters NFT whose SVG data is being composed within"},{"d":"composable_svg::regenerate","l":"./composable_svg.html#regenerate","f":"composable_svg::<span class=\"function\">regenerate</span>","de":" Regenerates composed SVG data"},{"d":"composable_svg::register","l":"./composable_svg.html#register","f":"composable_svg::<span class=\"function\">register</span>","de":" Registers NFT whose SVG data should be composed within the final"},{"d":"url::Witness","l":"./url.html#Witness","f":"url::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"url::UrlDomain","l":"./url.html#UrlDomain","f":"url::<span class=\"hljs-type\">UrlDomain</span>","de":" Domain for storing an associated URL"},{"d":"url::new","l":"./url.html#new","f":"url::<span class=\"function\">new</span>","de":" Creates new `UrlDomain` with a URL"},{"d":"url::set_url","l":"./url.html#set_url","f":"url::<span class=\"function\">set_url</span>","de":" Sets URL of `UrlDomain`"},{"d":"url::add_collection_url_domain","l":"./url.html#add_collection_url_domain","f":"url::<span class=\"function\">add_collection_url_domain</span>","de":" Adds `UrlDomain` to `Collection`"},{"d":"url::add_collection_url_domain_delegated","l":"./url.html#add_collection_url_domain_delegated","f":"url::<span class=\"function\">add_collection_url_domain_delegated</span>","de":" Adds `UrlDomain` to `Collection`"},{"d":"url::add_url_domain","l":"./url.html#add_url_domain","f":"url::<span class=\"function\">add_url_domain</span>","de":" Adds `UrlDomain` to `Nft`"},{"d":"url::add_url_domain_delegated","l":"./url.html#add_url_domain_delegated","f":"url::<span class=\"function\">add_url_domain_delegated</span>","de":" Adds `UrlDomain` to `Nft`"},{"d":"url::assert_collection_url","l":"./url.html#assert_collection_url","f":"url::<span class=\"function\">assert_collection_url</span>","de":" Asserts that `UrlDomain` is registered on `Nft`"},{"d":"url::assert_url","l":"./url.html#assert_url","f":"url::<span class=\"function\">assert_url</span>","de":" Asserts that `UrlDomain` is registered on `Nft`"},{"d":"url::borrow_collection_url","l":"./url.html#borrow_collection_url","f":"url::<span class=\"function\">borrow_collection_url</span>","de":" Borrows `UrlDomain` from `Collection`"},{"d":"url::borrow_url","l":"./url.html#borrow_url","f":"url::<span class=\"function\">borrow_url</span>","de":" Borrows `UrlDomain` from `Nft`"},{"d":"url::has_collection_url","l":"./url.html#has_collection_url","f":"url::<span class=\"function\">has_collection_url</span>","de":" Returns whether `UrlDomain` is registered on `Collection`"},{"d":"url::has_url","l":"./url.html#has_url","f":"url::<span class=\"function\">has_url</span>","de":" Returns whether `UrlDomain` is registered on `Nft`"},{"d":"url::set_collection_url","l":"./url.html#set_collection_url","f":"url::<span class=\"function\">set_collection_url</span>","de":" Sets URL of `UrlDomain`"},{"d":"composable_url::Witness","l":"./composable_url.html#Witness","f":"composable_url::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"composable_url::ComposableUrlDomain","l":"./composable_url.html#ComposableUrlDomain","f":"composable_url::<span class=\"hljs-type\">ComposableUrlDomain</span>","de":" Domain for providing composed URL data"},{"d":"composable_url::new","l":"./composable_url.html#new","f":"composable_url::<span class=\"function\">new</span>","de":" Creates new `ComposableUrlDomain` with no predefined NFTs"},{"d":"composable_url::set_url","l":"./composable_url.html#set_url","f":"composable_url::<span class=\"function\">set_url</span>","de":" Sets URL of `ComposableUrlDomain`"},{"d":"composable_url::regenerate","l":"./composable_url.html#regenerate","f":"composable_url::<span class=\"function\">regenerate</span>","de":" Regenerates composed URL data"},{"d":"composable_url::add_composable_url","l":"./composable_url.html#add_composable_url","f":"composable_url::<span class=\"function\">add_composable_url</span>","de":" Adds `UrlDomain` to `Nft`"},{"d":"composable_url::add_composable_url_delegated","l":"./composable_url.html#add_composable_url_delegated","f":"composable_url::<span class=\"function\">add_composable_url_delegated</span>","de":" Adds `UrlDomain` to `Nft`"},{"d":"composable_url::assert_composable_url","l":"./composable_url.html#assert_composable_url","f":"composable_url::<span class=\"function\">assert_composable_url</span>","de":" Asserts that `ComposableUrlDomain` is registered on `Nft`"},{"d":"composable_url::borrow_composable_url","l":"./composable_url.html#borrow_composable_url","f":"composable_url::<span class=\"function\">borrow_composable_url</span>","de":" Borrows composed URL data from `Nft`"},{"d":"composable_url::has_composable_url","l":"./composable_url.html#has_composable_url","f":"composable_url::<span class=\"function\">has_composable_url</span>","de":" Returns whether `ComposableUrlDomain` is registered on `Nft`"},{"d":"creators::Witness","l":"./creators.html#Witness","f":"creators::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"creators::CreatorsDomain","l":"./creators.html#CreatorsDomain","f":"creators::<span class=\"hljs-type\">CreatorsDomain</span>","de":" `CreatorsDomain` tracks collection creators"},{"d":"creators::empty","l":"./creators.html#empty","f":"creators::<span class=\"function\">empty</span>","de":" Creates an empty `CreatorsDomain` object"},{"d":"creators::is_empty","l":"./creators.html#is_empty","f":"creators::<span class=\"function\">is_empty</span>","de":" Returns whether `CreatorsDomain` has no defined creators"},{"d":"creators::delegate","l":"./creators.html#delegate","f":"creators::<span class=\"function\">delegate</span>","de":" Create a delegated witness"},{"d":"creators::assert_domain","l":"./creators.html#assert_domain","f":"creators::<span class=\"function\">assert_domain</span>","de":" Asserts that `CreatorsDomain` is defined on the `Collection`"},{"d":"creators::add_creator","l":"./creators.html#add_creator","f":"creators::<span class=\"function\">add_creator</span>","de":" Attributes the given address as a creator on the `Collection`"},{"d":"creators::add_creator_external","l":"./creators.html#add_creator_external","f":"creators::<span class=\"function\">add_creator_external</span>","de":" Attributes the given address as a creator on the `Collection`"},{"d":"creators::assert_creator","l":"./creators.html#assert_creator","f":"creators::<span class=\"function\">assert_creator</span>","de":" Asserts that address is a creator attributed in `CreatorsDomain`"},{"d":"creators::borrow_creators","l":"./creators.html#borrow_creators","f":"creators::<span class=\"function\">borrow_creators</span>","de":" Returns the list of creators defined on the `CreatorsDomain`"},{"d":"creators::contains_creator","l":"./creators.html#contains_creator","f":"creators::<span class=\"function\">contains_creator</span>","de":" Returns whether address is a defined creator"},{"d":"creators::creators_domain","l":"./creators.html#creators_domain","f":"creators::<span class=\"function\">creators_domain</span>","de":" Borrows `CreatorsDomain` from `Collection`"},{"d":"creators::from_address","l":"./creators.html#from_address","f":"creators::<span class=\"function\">from_address</span>","de":" Creates a `CreatorsDomain` object with only one creator"},{"d":"creators::from_creators","l":"./creators.html#from_creators","f":"creators::<span class=\"function\">from_creators</span>","de":" Creates a `CreatorsDomain` with multiple creators"},{"d":"display::Witness","l":"./display.html#Witness","f":"display::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"display::CollectionIdDomain","l":"./display.html#CollectionIdDomain","f":"display::<span class=\"hljs-type\">CollectionIdDomain</span>","de":""},{"d":"display::DisplayDomain","l":"./display.html#DisplayDomain","f":"display::<span class=\"hljs-type\">DisplayDomain</span>","de":""},{"d":"display::SymbolDomain","l":"./display.html#SymbolDomain","f":"display::<span class=\"hljs-type\">SymbolDomain</span>","de":""},{"d":"display::name","l":"./display.html#name","f":"display::<span class=\"function\">name</span>","de":" Gets name of `DisplayDomain`"},{"d":"display::collection_id","l":"./display.html#collection_id","f":"display::<span class=\"function\">collection_id</span>","de":" Gets name of `CollectionIdDomain`"},{"d":"display::set_name","l":"./display.html#set_name","f":"display::<span class=\"function\">set_name</span>","de":" Sets name of `DisplayDomain`"},{"d":"display::symbol","l":"./display.html#symbol","f":"display::<span class=\"function\">symbol</span>","de":" Gets symbol of `SymbolDomain`"},{"d":"display::description","l":"./display.html#description","f":"display::<span class=\"function\">description</span>","de":" Gets description of `DisplayDomain`"},{"d":"display::add_collection_display_domain","l":"./display.html#add_collection_display_domain","f":"display::<span class=\"function\">add_collection_display_domain</span>","de":""},{"d":"display::add_collection_id_domain","l":"./display.html#add_collection_id_domain","f":"display::<span class=\"function\">add_collection_id_domain</span>","de":""},{"d":"display::add_collection_symbol_domain","l":"./display.html#add_collection_symbol_domain","f":"display::<span class=\"function\">add_collection_symbol_domain</span>","de":""},{"d":"display::add_display_domain","l":"./display.html#add_display_domain","f":"display::<span class=\"function\">add_display_domain</span>","de":""},{"d":"display::add_symbol_domain","l":"./display.html#add_symbol_domain","f":"display::<span class=\"function\">add_symbol_domain</span>","de":""},{"d":"display::collection_display_domain","l":"./display.html#collection_display_domain","f":"display::<span class=\"function\">collection_display_domain</span>","de":""},{"d":"display::collection_id_domain","l":"./display.html#collection_id_domain","f":"display::<span class=\"function\">collection_id_domain</span>","de":""},{"d":"display::display_collection_symbol","l":"./display.html#display_collection_symbol","f":"display::<span class=\"function\">display_collection_symbol</span>","de":""},{"d":"display::display_domain","l":"./display.html#display_domain","f":"display::<span class=\"function\">display_domain</span>","de":""},{"d":"display::display_symbol","l":"./display.html#display_symbol","f":"display::<span class=\"function\">display_symbol</span>","de":""},{"d":"display::new_collection_id_domain","l":"./display.html#new_collection_id_domain","f":"display::<span class=\"function\">new_collection_id_domain</span>","de":" Creates a new `CollectionIdDomain` with name"},{"d":"display::new_display_domain","l":"./display.html#new_display_domain","f":"display::<span class=\"function\">new_display_domain</span>","de":" Creates a new `DisplayDomain` with name and description"},{"d":"display::new_symbol_domain","l":"./display.html#new_symbol_domain","f":"display::<span class=\"function\">new_symbol_domain</span>","de":" Creates new `SymbolDomain` with a symbol"},{"d":"display::remove_display_domain","l":"./display.html#remove_display_domain","f":"display::<span class=\"function\">remove_display_domain</span>","de":""},{"d":"display::remove_display_domain_delegated","l":"./display.html#remove_display_domain_delegated","f":"display::<span class=\"function\">remove_display_domain_delegated</span>","de":""},{"d":"display::set_collection_id","l":"./display.html#set_collection_id","f":"display::<span class=\"function\">set_collection_id</span>","de":" Sets name of `CollectionIdDomain`"},{"d":"display::set_description","l":"./display.html#set_description","f":"display::<span class=\"function\">set_description</span>","de":" Sets description of `DisplayDomain`"},{"d":"display::set_symbol","l":"./display.html#set_symbol","f":"display::<span class=\"function\">set_symbol</span>","de":" Sets name of `DisplayDomain`"},{"d":"venue::Venue","l":"./venue.html#Venue","f":"venue::<span class=\"hljs-type\">Venue</span>","de":" `Venue` object"},{"d":"venue::new","l":"./venue.html#new","f":"venue::<span class=\"function\">new</span>","de":" Create a new `Venue`"},{"d":"venue::assert_is_live","l":"./venue.html#assert_is_live","f":"venue::<span class=\"function\">assert_is_live</span>","de":" Asserts that `Venue` is live"},{"d":"venue::assert_is_not_whitelisted","l":"./venue.html#assert_is_not_whitelisted","f":"venue::<span class=\"function\">assert_is_not_whitelisted</span>","de":" Asserts that `Venue` is not whitelisted"},{"d":"venue::assert_is_whitelisted","l":"./venue.html#assert_is_whitelisted","f":"venue::<span class=\"function\">assert_is_whitelisted</span>","de":" Asserts that `Venue` is whitelisted"},{"d":"venue::assert_market","l":"./venue.html#assert_market","f":"venue::<span class=\"function\">assert_market</span>","de":" Asserts the type of the underlying market of the `Venue`"},{"d":"venue::borrow_market","l":"./venue.html#borrow_market","f":"venue::<span class=\"function\">borrow_market</span>","de":" Borrow `Venue` market"},{"d":"venue::borrow_market_mut","l":"./venue.html#borrow_market_mut","f":"venue::<span class=\"function\">borrow_market_mut</span>","de":" Mutably borrow `Venue` market"},{"d":"venue::init_venue","l":"./venue.html#init_venue","f":"venue::<span class=\"function\">init_venue</span>","de":" Initializes a `Venue` and transfers to transaction sender"},{"d":"venue::is_whitelisted","l":"./venue.html#is_whitelisted","f":"venue::<span class=\"function\">is_whitelisted</span>","de":" Get whether the venue is whitelisted"},{"d":"venue::is_live","l":"./venue.html#is_live","f":"venue::<span class=\"function\">is_live</span>","de":" Get whether the venue is live"},{"d":"venue::set_live","l":"./venue.html#set_live","f":"venue::<span class=\"function\">set_live</span>","de":" Set market's live status"},{"d":"venue::set_whitelisted","l":"./venue.html#set_whitelisted","f":"venue::<span class=\"function\">set_whitelisted</span>","de":" Set market's whitelist status"},{"d":"supply_domain::Witness","l":"./supply_domain.html#Witness","f":"supply_domain::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"supply_domain::SupplyDomain","l":"./supply_domain.html#SupplyDomain","f":"supply_domain::<span class=\"hljs-type\">SupplyDomain</span>","de":""},{"d":"supply_domain::delegate","l":"./supply_domain.html#delegate","f":"supply_domain::<span class=\"function\">delegate</span>","de":" Delegate partial `DelegatedSupply<C>` for use in composing an"},{"d":"supply_domain::supply","l":"./supply_domain.html#supply","f":"supply_domain::<span class=\"function\">supply</span>","de":" Borrows `Supply` from `Collection`"},{"d":"supply_domain::freeze_supply","l":"./supply_domain.html#freeze_supply","f":"supply_domain::<span class=\"function\">freeze_supply</span>","de":" Freeze the supply of `Collection`"},{"d":"supply_domain::increment_supply","l":"./supply_domain.html#increment_supply","f":"supply_domain::<span class=\"function\">increment_supply</span>","de":" Increments current supply"},{"d":"supply_domain::assert_regulated","l":"./supply_domain.html#assert_regulated","f":"supply_domain::<span class=\"function\">assert_regulated</span>","de":" Assert that the `Collection` supply is regulated"},{"d":"supply_domain::assert_unregulated","l":"./supply_domain.html#assert_unregulated","f":"supply_domain::<span class=\"function\">assert_unregulated</span>","de":" Assert that the `Collection` supply is not regulated"},{"d":"supply_domain::decrease_max_supply","l":"./supply_domain.html#decrease_max_supply","f":"supply_domain::<span class=\"function\">decrease_max_supply</span>","de":" Decreases maximum supply"},{"d":"supply_domain::decrement_supply","l":"./supply_domain.html#decrement_supply","f":"supply_domain::<span class=\"function\">decrement_supply</span>","de":" Increments current supply"},{"d":"supply_domain::delegate_and_transfer","l":"./supply_domain.html#delegate_and_transfer","f":"supply_domain::<span class=\"function\">delegate_and_transfer</span>","de":" Delegate partial `DelegatedSupply<C>` for use in composing an"},{"d":"supply_domain::delegate_unregulated","l":"./supply_domain.html#delegate_unregulated","f":"supply_domain::<span class=\"function\">delegate_unregulated</span>","de":" Delegate unregulated mint permission for use in composing a `Factory`."},{"d":"supply_domain::delegate_unregulated_and_transfer","l":"./supply_domain.html#delegate_unregulated_and_transfer","f":"supply_domain::<span class=\"function\">delegate_unregulated_and_transfer</span>","de":" Delegate unregulated mint permission for use in composing a `Factory`"},{"d":"supply_domain::deregulate","l":"./supply_domain.html#deregulate","f":"supply_domain::<span class=\"function\">deregulate</span>","de":" Deregulate the supply of `Collection`"},{"d":"supply_domain::increase_max_supply","l":"./supply_domain.html#increase_max_supply","f":"supply_domain::<span class=\"function\">increase_max_supply</span>","de":" Increases maximum supply"},{"d":"supply_domain::is_regulated","l":"./supply_domain.html#is_regulated","f":"supply_domain::<span class=\"function\">is_regulated</span>","de":" Returns whether `Collection` supply is regulated"},{"d":"supply_domain::merge_delegated","l":"./supply_domain.html#merge_delegated","f":"supply_domain::<span class=\"function\">merge_delegated</span>","de":" Merge delegated `RegulatedMintCap`"},{"d":"supply_domain::regulate","l":"./supply_domain.html#regulate","f":"supply_domain::<span class=\"function\">regulate</span>","de":" Regulate the supply of `Collection`"},{"d":"warehouse::RedeemCommitment","l":"./warehouse.html#RedeemCommitment","f":"warehouse::<span class=\"hljs-type\">RedeemCommitment</span>","de":" Used for the client to commit a pseudo-random"},{"d":"warehouse::Warehouse","l":"./warehouse.html#Warehouse","f":"warehouse::<span class=\"hljs-type\">Warehouse</span>","de":" `Warehouse` object"},{"d":"warehouse::is_empty","l":"./warehouse.html#is_empty","f":"warehouse::<span class=\"function\">is_empty</span>","de":" Return whether there are any `Nft` in the `Warehouse`"},{"d":"warehouse::new","l":"./warehouse.html#new","f":"warehouse::<span class=\"function\">new</span>","de":" Create a new `Warehouse`"},{"d":"warehouse::supply","l":"./warehouse.html#supply","f":"warehouse::<span class=\"function\">supply</span>","de":" Return how many `Nft` there are to sell"},{"d":"warehouse::deposit_nft","l":"./warehouse.html#deposit_nft","f":"warehouse::<span class=\"function\">deposit_nft</span>","de":" Deposits NFT to `Warehouse`"},{"d":"warehouse::nfts","l":"./warehouse.html#nfts","f":"warehouse::<span class=\"function\">nfts</span>","de":" Returns list of all NFTs stored in `Warehouse`"},{"d":"warehouse::assert_is_empty","l":"./warehouse.html#assert_is_empty","f":"warehouse::<span class=\"function\">assert_is_empty</span>","de":" Asserts that `Warehouse` is empty"},{"d":"warehouse::destroy","l":"./warehouse.html#destroy","f":"warehouse::<span class=\"function\">destroy</span>","de":" Destroys `Warehouse`"},{"d":"warehouse::destroy_commitment","l":"./warehouse.html#destroy_commitment","f":"warehouse::<span class=\"function\">destroy_commitment</span>","de":" Destroyes `RedeemCommitment`"},{"d":"warehouse::init_redeem_commitment","l":"./warehouse.html#init_redeem_commitment","f":"warehouse::<span class=\"function\">init_redeem_commitment</span>","de":" Creates a new `RedeemCommitment` and transfers it to the transaction"},{"d":"warehouse::init_warehouse","l":"./warehouse.html#init_warehouse","f":"warehouse::<span class=\"function\">init_warehouse</span>","de":" Creates a `Warehouse` and transfers to transaction sender"},{"d":"warehouse::new_redeem_commitment","l":"./warehouse.html#new_redeem_commitment","f":"warehouse::<span class=\"function\">new_redeem_commitment</span>","de":" Create a new `RedeemCommitment`"},{"d":"warehouse::redeem_nft","l":"./warehouse.html#redeem_nft","f":"warehouse::<span class=\"function\">redeem_nft</span>","de":" Redeems NFT from `Warehouse`"},{"d":"warehouse::redeem_nft_and_transfer","l":"./warehouse.html#redeem_nft_and_transfer","f":"warehouse::<span class=\"function\">redeem_nft_and_transfer</span>","de":" Redeems NFT from `Warehouse` and transfers to sender"},{"d":"warehouse::redeem_nft_at_index","l":"./warehouse.html#redeem_nft_at_index","f":"warehouse::<span class=\"function\">redeem_nft_at_index</span>","de":" Redeems NFT from specific index in `Warehouse`"},{"d":"warehouse::redeem_nft_at_index_and_transfer","l":"./warehouse.html#redeem_nft_at_index_and_transfer","f":"warehouse::<span class=\"function\">redeem_nft_at_index_and_transfer</span>","de":" Redeems NFT from specific index in `Warehouse` and transfers to sender"},{"d":"warehouse::redeem_pseudorandom_nft","l":"./warehouse.html#redeem_pseudorandom_nft","f":"warehouse::<span class=\"function\">redeem_pseudorandom_nft</span>","de":" Pseudo-randomly redeems NFT from `Warehouse`"},{"d":"warehouse::redeem_pseudorandom_nft_and_transfer","l":"./warehouse.html#redeem_pseudorandom_nft_and_transfer","f":"warehouse::<span class=\"function\">redeem_pseudorandom_nft_and_transfer</span>","de":" Pseudo-randomly redeems specific NFT from `Warehouse` and transfers to"},{"d":"warehouse::redeem_random_nft","l":"./warehouse.html#redeem_random_nft","f":"warehouse::<span class=\"function\">redeem_random_nft</span>","de":" Randomly redeems NFT from `Warehouse`"},{"d":"warehouse::redeem_random_nft_and_transfer","l":"./warehouse.html#redeem_random_nft_and_transfer","f":"warehouse::<span class=\"function\">redeem_random_nft_and_transfer</span>","de":" Randomly redeems NFT from `Warehouse` and transfers to sender"},{"d":"warehouse::total_deposited","l":"./warehouse.html#total_deposited","f":"warehouse::<span class=\"function\">total_deposited</span>","de":" Return cumulated amount of `Nft`s deposited in the `Warehouse`"},{"d":"warehouse::total_redeemed","l":"./warehouse.html#total_redeemed","f":"warehouse::<span class=\"function\">total_redeemed</span>","de":" Return cumulated amount of `Nft`s redeemed in the `Warehouse`"},{"d":"proceeds::Proceeds","l":"./proceeds.html#Proceeds","f":"proceeds::<span class=\"hljs-type\">Proceeds</span>","de":""},{"d":"proceeds::QtSold","l":"./proceeds.html#QtSold","f":"proceeds::<span class=\"hljs-type\">QtSold</span>","de":""},{"d":"proceeds::empty","l":"./proceeds.html#empty","f":"proceeds::<span class=\"function\">empty</span>","de":""},{"d":"proceeds::add","l":"./proceeds.html#add","f":"proceeds::<span class=\"function\">add</span>","de":""},{"d":"proceeds::balance","l":"./proceeds.html#balance","f":"proceeds::<span class=\"function\">balance</span>","de":""},{"d":"proceeds::total","l":"./proceeds.html#total","f":"proceeds::<span class=\"function\">total</span>","de":""},{"d":"proceeds::collect_with_fees","l":"./proceeds.html#collect_with_fees","f":"proceeds::<span class=\"function\">collect_with_fees</span>","de":""},{"d":"proceeds::collect_without_fees","l":"./proceeds.html#collect_without_fees","f":"proceeds::<span class=\"function\">collect_without_fees</span>","de":""},{"d":"proceeds::collected","l":"./proceeds.html#collected","f":"proceeds::<span class=\"function\">collected</span>","de":""},{"d":"marketplace::Marketplace","l":"./marketplace.html#Marketplace","f":"marketplace::<span class=\"hljs-type\">Marketplace</span>","de":""},{"d":"marketplace::new","l":"./marketplace.html#new","f":"marketplace::<span class=\"function\">new</span>","de":" Initialises a `Marketplace` object and returns it"},{"d":"marketplace::receiver","l":"./marketplace.html#receiver","f":"marketplace::<span class=\"function\">receiver</span>","de":" Get the Marketplace's `receiver` address"},{"d":"marketplace::admin","l":"./marketplace.html#admin","f":"marketplace::<span class=\"function\">admin</span>","de":" Get the Marketplace's `admin` address"},{"d":"marketplace::assert_marketplace_admin","l":"./marketplace.html#assert_marketplace_admin","f":"marketplace::<span class=\"function\">assert_marketplace_admin</span>","de":""},{"d":"marketplace::default_fee","l":"./marketplace.html#default_fee","f":"marketplace::<span class=\"function\">default_fee</span>","de":" Get the Marketplace's `default_fee`"},{"d":"marketplace::init_marketplace","l":"./marketplace.html#init_marketplace","f":"marketplace::<span class=\"function\">init_marketplace</span>","de":" Initialises a `Marketplace` object and shares it"},{"d":"loose_mint_cap::LooseMintCap","l":"./loose_mint_cap.html#LooseMintCap","f":"loose_mint_cap::<span class=\"hljs-type\">LooseMintCap</span>","de":" `LooseMintCap` object"},{"d":"loose_mint_cap::PointerDomain","l":"./loose_mint_cap.html#PointerDomain","f":"loose_mint_cap::<span class=\"hljs-type\">PointerDomain</span>","de":""},{"d":"loose_mint_cap::name","l":"./loose_mint_cap.html#name","f":"loose_mint_cap::<span class=\"function\">name</span>","de":" Get loose `Nft` name"},{"d":"loose_mint_cap::url","l":"./loose_mint_cap.html#url","f":"loose_mint_cap::<span class=\"function\">url</span>","de":" Get loose `Nft` URL"},{"d":"loose_mint_cap::supply","l":"./loose_mint_cap.html#supply","f":"loose_mint_cap::<span class=\"function\">supply</span>","de":" Returns the remaining supply available to `LooseMintCap`"},{"d":"loose_mint_cap::from_unregulated","l":"./loose_mint_cap.html#from_unregulated","f":"loose_mint_cap::<span class=\"function\">from_unregulated</span>","de":" Create `LooseMintCap` with unregulated supply"},{"d":"loose_mint_cap::from_regulated","l":"./loose_mint_cap.html#from_regulated","f":"loose_mint_cap::<span class=\"function\">from_regulated</span>","de":" Create `LooseMintCap` with unregulated supply"},{"d":"loose_mint_cap::is_regulated","l":"./loose_mint_cap.html#is_regulated","f":"loose_mint_cap::<span class=\"function\">is_regulated</span>","de":" Returns whether `LooseMintCap` is eligible to mint NFTs of the"},{"d":"loose_mint_cap::metadata_id","l":"./loose_mint_cap.html#metadata_id","f":"loose_mint_cap::<span class=\"function\">metadata_id</span>","de":" Return `ID` of `Metadata` associated with this pointer"},{"d":"loose_mint_cap::mint_nft","l":"./loose_mint_cap.html#mint_nft","f":"loose_mint_cap::<span class=\"function\">mint_nft</span>","de":" Mints `Nft` from `LooseMintCap`"},{"d":"loose_mint_cap::mint_nft_and_transfer","l":"./loose_mint_cap.html#mint_nft_and_transfer","f":"loose_mint_cap::<span class=\"function\">mint_nft_and_transfer</span>","de":" Mints `Nft` from `LooseMintCap` and transfer to transaction sender"},{"d":"metadata::Metadata","l":"./metadata.html#Metadata","f":"metadata::<span class=\"hljs-type\">Metadata</span>","de":" `Metadata` object"},{"d":"metadata::freeze_supply","l":"./metadata.html#freeze_supply","f":"metadata::<span class=\"function\">freeze_supply</span>","de":" Freeze `Metadata` supply"},{"d":"metadata::borrow_supply","l":"./metadata.html#borrow_supply","f":"metadata::<span class=\"function\">borrow_supply</span>","de":" Returns the `Metadata` supply"},{"d":"metadata::new_regulated","l":"./metadata.html#new_regulated","f":"metadata::<span class=\"function\">new_regulated</span>","de":" Create `Metadata` with unregulated supply"},{"d":"metadata::new_unregulated","l":"./metadata.html#new_unregulated","f":"metadata::<span class=\"function\">new_unregulated</span>","de":" Create `Metadata` with unregulated supply"},{"d":"metadata::assert_regulated","l":"./metadata.html#assert_regulated","f":"metadata::<span class=\"function\">assert_regulated</span>","de":" Asserts that `Metadata` has a regulated supply"},{"d":"metadata::assert_unregulated","l":"./metadata.html#assert_unregulated","f":"metadata::<span class=\"function\">assert_unregulated</span>","de":" Asserts that `Metadata` has a regulated supply"},{"d":"metadata::delegate_unregulated","l":"./metadata.html#delegate_unregulated","f":"metadata::<span class=\"function\">delegate_unregulated</span>","de":" Delegates metadata minting rights while maintaining `Collection` and"},{"d":"metadata::is_regulated","l":"./metadata.html#is_regulated","f":"metadata::<span class=\"function\">is_regulated</span>","de":" Returns whether `Metadata` has a regulated supply"},{"d":"metadata::borrow_metadata","l":"./metadata.html#borrow_metadata","f":"metadata::<span class=\"function\">borrow_metadata</span>","de":" Returns the `Metadata` `Nft`"},{"d":"metadata::create_regulated","l":"./metadata.html#create_regulated","f":"metadata::<span class=\"function\">create_regulated</span>","de":" Create `Metadata` with regulated supply and transfer to transaction"},{"d":"metadata::create_unregulated","l":"./metadata.html#create_unregulated","f":"metadata::<span class=\"function\">create_unregulated</span>","de":" Create `Metadata` with unregulated supply and transfer to transaction"},{"d":"metadata::delegate_regulated","l":"./metadata.html#delegate_regulated","f":"metadata::<span class=\"function\">delegate_regulated</span>","de":" Delegates metadata minting rights while maintaining `Collection` and"},{"d":"metadata_bag::Witness","l":"./metadata_bag.html#Witness","f":"metadata_bag::<span class=\"hljs-type\">Witness</span>","de":""},{"d":"metadata_bag::MetadataBagDomain","l":"./metadata_bag.html#MetadataBagDomain","f":"metadata_bag::<span class=\"hljs-type\">MetadataBagDomain</span>","de":" `MetadataBagDomain` object"},{"d":"metadata_bag::delegate_unregulated","l":"./metadata_bag.html#delegate_unregulated","f":"metadata_bag::<span class=\"function\">delegate_unregulated</span>","de":" Delegates metadata minting rights while maintaining `Collection` and"},{"d":"metadata_bag::borrow_metadata","l":"./metadata_bag.html#borrow_metadata","f":"metadata_bag::<span class=\"function\">borrow_metadata</span>","de":" Borrows `Metadata` from `MetadataBagDomain`"},{"d":"metadata_bag::delegate_regulated","l":"./metadata_bag.html#delegate_regulated","f":"metadata_bag::<span class=\"function\">delegate_regulated</span>","de":" Delegates metadata minting rights while maintaining `Collection` and"},{"d":"metadata_bag::add_metadata","l":"./metadata_bag.html#add_metadata","f":"metadata_bag::<span class=\"function\">add_metadata</span>","de":" Add `Metadata` to `MetadataBagDomain`"},{"d":"metadata_bag::add_metadata_bag","l":"./metadata_bag.html#add_metadata_bag","f":"metadata_bag::<span class=\"function\">add_metadata_bag</span>","de":" Add `MetadataBagDomain` to `Collection`"},{"d":"metadata_bag::add_metadata_to_collection","l":"./metadata_bag.html#add_metadata_to_collection","f":"metadata_bag::<span class=\"function\">add_metadata_to_collection</span>","de":" Add `Metadata` to `Collection`"},{"d":"metadata_bag::assert_archetypal","l":"./metadata_bag.html#assert_archetypal","f":"metadata_bag::<span class=\"function\">assert_archetypal</span>","de":" Asserts that `Collection` has a defined `MetadataBagDomain`"},{"d":"metadata_bag::assert_metadata","l":"./metadata_bag.html#assert_metadata","f":"metadata_bag::<span class=\"function\">assert_metadata</span>","de":" Asserts that `Metadata` with `ID` is registered on `MetadataBagDomain`"},{"d":"metadata_bag::borrow_metagada_bag","l":"./metadata_bag.html#borrow_metagada_bag","f":"metadata_bag::<span class=\"function\">borrow_metagada_bag</span>","de":" Borrows `MetadataBagDomain` from `Collection`"},{"d":"metadata_bag::contains_metadata","l":"./metadata_bag.html#contains_metadata","f":"metadata_bag::<span class=\"function\">contains_metadata</span>","de":" Returns whether `Metadata` with `ID` is registered on `MetadataBagDomain`"},{"d":"metadata_bag::freeze_metadata_supply","l":"./metadata_bag.html#freeze_metadata_supply","f":"metadata_bag::<span class=\"function\">freeze_metadata_supply</span>","de":" Freeze `Metadata` supply in `Collection`"},{"d":"metadata_bag::init_metadata_bag","l":"./metadata_bag.html#init_metadata_bag","f":"metadata_bag::<span class=\"function\">init_metadata_bag</span>","de":" Create a `MetadataBagDomain` object and register on `Collection`"},{"d":"metadata_bag::is_archetypal","l":"./metadata_bag.html#is_archetypal","f":"metadata_bag::<span class=\"function\">is_archetypal</span>","de":" Return whether `Collection` has defined an metadata `MetadataBagDomain`"},{"d":"metadata_bag::new_metadata_bag","l":"./metadata_bag.html#new_metadata_bag","f":"metadata_bag::<span class=\"function\">new_metadata_bag</span>","de":" Create a `MetadataBagDomain` object"},{"d":"factory::Factory","l":"./factory.html#Factory","f":"factory::<span class=\"hljs-type\">Factory</span>","de":" `Factory` is an inventory that can mint loose NFTs"},{"d":"factory::supply","l":"./factory.html#supply","f":"factory::<span class=\"function\">supply</span>","de":" Returns the remaining supply available to `Factory`"},{"d":"factory::from_unregulated","l":"./factory.html#from_unregulated","f":"factory::<span class=\"function\">from_unregulated</span>","de":" Create `Factory` with unregulated supply"},{"d":"factory::from_regulated","l":"./factory.html#from_regulated","f":"factory::<span class=\"function\">from_regulated</span>","de":" Creates a new `Factory`"},{"d":"factory::redeem_nft","l":"./factory.html#redeem_nft","f":"factory::<span class=\"function\">redeem_nft</span>","de":" Mints NFT from `Factory`"},{"d":"inventory::Witness","l":"./inventory.html#Witness","f":"inventory::<span class=\"hljs-type\">Witness</span>","de":""},{"d":"inventory::Inventory","l":"./inventory.html#Inventory","f":"inventory::<span class=\"hljs-type\">Inventory</span>","de":" A type-erased wrapper around `Warehouse` and `Factory`"},{"d":"inventory::is_empty","l":"./inventory.html#is_empty","f":"inventory::<span class=\"function\">is_empty</span>","de":" Returns whether `Inventory` has any remaining supply"},{"d":"inventory::supply","l":"./inventory.html#supply","f":"inventory::<span class=\"function\">supply</span>","de":" Returns the available supply in `Inventory`"},{"d":"inventory::deposit_nft","l":"./inventory.html#deposit_nft","f":"inventory::<span class=\"function\">deposit_nft</span>","de":" Deposits NFT to `Inventory`"},{"d":"inventory::redeem_nft","l":"./inventory.html#redeem_nft","f":"inventory::<span class=\"function\">redeem_nft</span>","de":" Redeems NFT from `Inventory`"},{"d":"inventory::redeem_nft_and_transfer","l":"./inventory.html#redeem_nft_and_transfer","f":"inventory::<span class=\"function\">redeem_nft_and_transfer</span>","de":" Redeems NFT from `Inventory` and transfers to owner"},{"d":"inventory::redeem_pseudorandom_nft","l":"./inventory.html#redeem_pseudorandom_nft","f":"inventory::<span class=\"function\">redeem_pseudorandom_nft</span>","de":" Pseudo-randomly redeems NFT from `Inventory`"},{"d":"inventory::redeem_pseudorandom_nft_and_transfer","l":"./inventory.html#redeem_pseudorandom_nft_and_transfer","f":"inventory::<span class=\"function\">redeem_pseudorandom_nft_and_transfer</span>","de":" Pseudo-randomly redeems NFT from `Inventory` and transfers to owner"},{"d":"inventory::redeem_random_nft","l":"./inventory.html#redeem_random_nft","f":"inventory::<span class=\"function\">redeem_random_nft</span>","de":" Randomly redeems NFT from `Inventory`"},{"d":"inventory::redeem_random_nft_and_transfer","l":"./inventory.html#redeem_random_nft_and_transfer","f":"inventory::<span class=\"function\">redeem_random_nft_and_transfer</span>","de":" Randomly redeems NFT from `Inventory` and transfers to owner"},{"d":"inventory::assert_factory","l":"./inventory.html#assert_factory","f":"inventory::<span class=\"function\">assert_factory</span>","de":" Asserts that `Inventory` is a `Factory`"},{"d":"inventory::assert_warehouse","l":"./inventory.html#assert_warehouse","f":"inventory::<span class=\"function\">assert_warehouse</span>","de":" Asserts that `Inventory` is a `Warehouse`"},{"d":"inventory::borrow_factory","l":"./inventory.html#borrow_factory","f":"inventory::<span class=\"function\">borrow_factory</span>","de":" Borrows `Inventory` as `Factory`"},{"d":"inventory::borrow_factory_mut","l":"./inventory.html#borrow_factory_mut","f":"inventory::<span class=\"function\">borrow_factory_mut</span>","de":" Mutably borrows `Inventory` as `Factory`"},{"d":"inventory::borrow_warehouse","l":"./inventory.html#borrow_warehouse","f":"inventory::<span class=\"function\">borrow_warehouse</span>","de":" Borrows `Inventory` as `Warehouse`"},{"d":"inventory::from_factory","l":"./inventory.html#from_factory","f":"inventory::<span class=\"function\">from_factory</span>","de":" Create a new `Inventory` from a `Factory`"},{"d":"inventory::from_warehouse","l":"./inventory.html#from_warehouse","f":"inventory::<span class=\"function\">from_warehouse</span>","de":" Create a new `Inventory` from a `Warehouse`"},{"d":"inventory::is_factory","l":"./inventory.html#is_factory","f":"inventory::<span class=\"function\">is_factory</span>","de":" Returns whether `Inventory` is a `Factory`"},{"d":"inventory::is_warehouse","l":"./inventory.html#is_warehouse","f":"inventory::<span class=\"function\">is_warehouse</span>","de":" Returns whether `Inventory` is a `Warehouse`"},{"d":"listing::CreateListingEvent","l":"./listing.html#CreateListingEvent","f":"listing::<span class=\"hljs-type\">CreateListingEvent</span>","de":" Event signalling that a `Listing` was created"},{"d":"listing::DeleteListingEvent","l":"./listing.html#DeleteListingEvent","f":"listing::<span class=\"hljs-type\">DeleteListingEvent</span>","de":" Event signalling that a `Listing` was deleted"},{"d":"listing::Listing","l":"./listing.html#Listing","f":"listing::<span class=\"hljs-type\">Listing</span>","de":""},{"d":"listing::NftSoldEvent","l":"./listing.html#NftSoldEvent","f":"listing::<span class=\"hljs-type\">NftSoldEvent</span>","de":" Event signalling that `Nft` was sold by `Listing`"},{"d":"listing::RequestToJoin","l":"./listing.html#RequestToJoin","f":"listing::<span class=\"hljs-type\">RequestToJoin</span>","de":" An ephemeral object representing the intention of a `Listing` admin"},{"d":"listing::new","l":"./listing.html#new","f":"listing::<span class=\"function\">new</span>","de":" Initialises a `Listing` object and returns it."},{"d":"listing::supply","l":"./listing.html#supply","f":"listing::<span class=\"function\">supply</span>","de":" Returns how many NFTs can be withdrawn"},{"d":"listing::borrow_market","l":"./listing.html#borrow_market","f":"listing::<span class=\"function\">borrow_market</span>","de":" Borrow the listing's `Market`"},{"d":"listing::init_venue","l":"./listing.html#init_venue","f":"listing::<span class=\"function\">init_venue</span>","de":" Initializes a `Venue` on `Listing`"},{"d":"listing::receiver","l":"./listing.html#receiver","f":"listing::<span class=\"function\">receiver</span>","de":" Get the Listing's `receiver` address"},{"d":"listing::init_warehouse","l":"./listing.html#init_warehouse","f":"listing::<span class=\"function\">init_warehouse</span>","de":" Initializes an empty `Warehouse` on `Listing`"},{"d":"listing::admin","l":"./listing.html#admin","f":"listing::<span class=\"function\">admin</span>","de":" Get the Listing's `admin` address"},{"d":"listing::accept_listing_request","l":"./listing.html#accept_listing_request","f":"listing::<span class=\"function\">accept_listing_request</span>","de":" To be called by the `Marketplace` administrator, to accept the `Listing`"},{"d":"listing::add_factory","l":"./listing.html#add_factory","f":"listing::<span class=\"function\">add_factory</span>","de":" Adds `Factory` to `Listing`"},{"d":"listing::add_fee","l":"./listing.html#add_fee","f":"listing::<span class=\"function\">add_fee</span>","de":" Adds a fee object to the Listing's `custom_fee`"},{"d":"listing::add_inventory","l":"./listing.html#add_inventory","f":"listing::<span class=\"function\">add_inventory</span>","de":" Adds `Inventory` to `Listing`"},{"d":"listing::add_nft","l":"./listing.html#add_nft","f":"listing::<span class=\"function\">add_nft</span>","de":" Adds an `Nft` to a `Warehouse` on the `Listing`"},{"d":"listing::add_venue","l":"./listing.html#add_venue","f":"listing::<span class=\"function\">add_venue</span>","de":" Adds a `Venue` to the `Listing`"},{"d":"listing::add_warehouse","l":"./listing.html#add_warehouse","f":"listing::<span class=\"function\">add_warehouse</span>","de":" Adds `Warehouse` to `Listing`"},{"d":"listing::assert_correct_admin","l":"./listing.html#assert_correct_admin","f":"listing::<span class=\"function\">assert_correct_admin</span>","de":""},{"d":"listing::assert_default_fee","l":"./listing.html#assert_default_fee","f":"listing::<span class=\"function\">assert_default_fee</span>","de":""},{"d":"listing::assert_inventory","l":"./listing.html#assert_inventory","f":"listing::<span class=\"function\">assert_inventory</span>","de":""},{"d":"listing::assert_listing_admin","l":"./listing.html#assert_listing_admin","f":"listing::<span class=\"function\">assert_listing_admin</span>","de":""},{"d":"listing::assert_listing_marketplace_match","l":"./listing.html#assert_listing_marketplace_match","f":"listing::<span class=\"function\">assert_listing_marketplace_match</span>","de":""},{"d":"listing::assert_venue","l":"./listing.html#assert_venue","f":"listing::<span class=\"function\">assert_venue</span>","de":""},{"d":"listing::borrow_inventory","l":"./listing.html#borrow_inventory","f":"listing::<span class=\"function\">borrow_inventory</span>","de":" Borrow the listing's `Inventory`"},{"d":"listing::borrow_proceeds","l":"./listing.html#borrow_proceeds","f":"listing::<span class=\"function\">borrow_proceeds</span>","de":" Borrow the Listing's `Proceeds`"},{"d":"listing::borrow_proceeds_mut","l":"./listing.html#borrow_proceeds_mut","f":"listing::<span class=\"function\">borrow_proceeds_mut</span>","de":" Mutably borrow the Listing's `Proceeds`"},{"d":"listing::borrow_venue","l":"./listing.html#borrow_venue","f":"listing::<span class=\"function\">borrow_venue</span>","de":" Borrow the listing's `Venue`"},{"d":"listing::buy_nft","l":"./listing.html#buy_nft","f":"listing::<span class=\"function\">buy_nft</span>","de":" Buys an NFT from an `Inventory`"},{"d":"listing::buy_pseudorandom_nft","l":"./listing.html#buy_pseudorandom_nft","f":"listing::<span class=\"function\">buy_pseudorandom_nft</span>","de":" Buys a pseudo-random NFT from an `Inventory`"},{"d":"listing::buy_random_nft","l":"./listing.html#buy_random_nft","f":"listing::<span class=\"function\">buy_random_nft</span>","de":" Buys a random NFT from `Inventory`"},{"d":"listing::collect_proceeds","l":"./listing.html#collect_proceeds","f":"listing::<span class=\"function\">collect_proceeds</span>","de":" To be called by `Listing` admins for standalone `Listings`."},{"d":"listing::contains_custom_fee","l":"./listing.html#contains_custom_fee","f":"listing::<span class=\"function\">contains_custom_fee</span>","de":""},{"d":"listing::contains_inventory","l":"./listing.html#contains_inventory","f":"listing::<span class=\"function\">contains_inventory</span>","de":" Returns whether `Inventory` with given ID exists"},{"d":"listing::contains_venue","l":"./listing.html#contains_venue","f":"listing::<span class=\"function\">contains_venue</span>","de":" Returns whether `Venue` with given ID exists"},{"d":"listing::create_venue","l":"./listing.html#create_venue","f":"listing::<span class=\"function\">create_venue</span>","de":" Creates a `Venue` on `Listing` and returns it's ID"},{"d":"listing::create_warehouse","l":"./listing.html#create_warehouse","f":"listing::<span class=\"function\">create_warehouse</span>","de":" Creates an empty `Warehouse` on `Listing` and returns it's ID"},{"d":"listing::custom_fee","l":"./listing.html#custom_fee","f":"listing::<span class=\"function\">custom_fee</span>","de":""},{"d":"listing::emit_sold_event","l":"./listing.html#emit_sold_event","f":"listing::<span class=\"function\">emit_sold_event</span>","de":" Emits `NftSoldEvent` for provided `Nft`"},{"d":"listing::init_listing","l":"./listing.html#init_listing","f":"listing::<span class=\"function\">init_listing</span>","de":" Initialises a standalone `Listing` object."},{"d":"listing::insert_factory","l":"./listing.html#insert_factory","f":"listing::<span class=\"function\">insert_factory</span>","de":" Adds `Factory` to `Listing` and returns it's ID"},{"d":"listing::insert_warehouse","l":"./listing.html#insert_warehouse","f":"listing::<span class=\"function\">insert_warehouse</span>","de":" Adds `Warehouse` to `Listing` and returns it's ID"},{"d":"listing::inventory_internal_mut","l":"./listing.html#inventory_internal_mut","f":"listing::<span class=\"function\">inventory_internal_mut</span>","de":" Mutably borrow a `Warehouse`"},{"d":"listing::market_internal_mut","l":"./listing.html#market_internal_mut","f":"listing::<span class=\"function\">market_internal_mut</span>","de":" Mutably borrow the Listing's `Market`"},{"d":"listing::pay","l":"./listing.html#pay","f":"listing::<span class=\"function\">pay</span>","de":" Pay for `Nft` sale and direct funds to `Listing` proceeds"},{"d":"listing::pay_and_emit_sold_event","l":"./listing.html#pay_and_emit_sold_event","f":"listing::<span class=\"function\">pay_and_emit_sold_event</span>","de":" Pay for `Nft` sale, direct fund to `Listing` proceeds, and emit sale"},{"d":"listing::request_to_join_marketplace","l":"./listing.html#request_to_join_marketplace","f":"listing::<span class=\"function\">request_to_join_marketplace</span>","de":" To be called by the `Listing` administrator, to declare the intention"},{"d":"listing::sale_off","l":"./listing.html#sale_off","f":"listing::<span class=\"function\">sale_off</span>","de":" Set market's live status to `false` therefore pausing or stopping the"},{"d":"listing::sale_off_delegated","l":"./listing.html#sale_off_delegated","f":"listing::<span class=\"function\">sale_off_delegated</span>","de":" Set market's live status to `false` therefore pausing or stopping the"},{"d":"listing::sale_on","l":"./listing.html#sale_on","f":"listing::<span class=\"function\">sale_on</span>","de":" Set market's live status to `true` therefore making the NFT sale live."},{"d":"listing::sale_on_delegated","l":"./listing.html#sale_on_delegated","f":"listing::<span class=\"function\">sale_on_delegated</span>","de":" Set market's live status to `true` therefore making the NFT sale live."},{"d":"listing::venue_internal_mut","l":"./listing.html#venue_internal_mut","f":"listing::<span class=\"function\">venue_internal_mut</span>","de":" Mutably borrow the listing's `Venue`"},{"d":"market_whitelist::Certificate","l":"./market_whitelist.html#Certificate","f":"market_whitelist::<span class=\"hljs-type\">Certificate</span>","de":" Grants owner the privilege to participate in an NFT sale in a"},{"d":"market_whitelist::new","l":"./market_whitelist.html#new","f":"market_whitelist::<span class=\"function\">new</span>","de":" Create a new `Certificate`"},{"d":"market_whitelist::burn","l":"./market_whitelist.html#burn","f":"market_whitelist::<span class=\"function\">burn</span>","de":" Burns a `Certificate`"},{"d":"market_whitelist::assert_certificate","l":"./market_whitelist.html#assert_certificate","f":"market_whitelist::<span class=\"function\">assert_certificate</span>","de":" Assert `Certificate` parameters"},{"d":"market_whitelist::assert_whitelist","l":"./market_whitelist.html#assert_whitelist","f":"market_whitelist::<span class=\"function\">assert_whitelist</span>","de":" Assert `Certificate` parameters based on `Venue`"},{"d":"market_whitelist::issue","l":"./market_whitelist.html#issue","f":"market_whitelist::<span class=\"function\">issue</span>","de":" Issue a new `Certificate` to an address"},{"d":"dutch_auction::Witness","l":"./dutch_auction.html#Witness","f":"dutch_auction::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"dutch_auction::Bid","l":"./dutch_auction.html#Bid","f":"dutch_auction::<span class=\"hljs-type\">Bid</span>","de":" A bid for one NFT"},{"d":"dutch_auction::DutchAuctionMarket","l":"./dutch_auction.html#DutchAuctionMarket","f":"dutch_auction::<span class=\"hljs-type\">DutchAuctionMarket</span>","de":""},{"d":"dutch_auction::new","l":"./dutch_auction.html#new","f":"dutch_auction::<span class=\"function\">new</span>","de":""},{"d":"dutch_auction::create_bid","l":"./dutch_auction.html#create_bid","f":"dutch_auction::<span class=\"function\">create_bid</span>","de":" Creates a bid in a FIFO manner, previous bids are retained"},{"d":"dutch_auction::init_venue","l":"./dutch_auction.html#init_venue","f":"dutch_auction::<span class=\"function\">init_venue</span>","de":" Initializes a `Venue` with `DutchAuctionMarket<FT>`"},{"d":"dutch_auction::create_venue","l":"./dutch_auction.html#create_venue","f":"dutch_auction::<span class=\"function\">create_venue</span>","de":" Creates a `Venue` with `DutchAuctionMarket<FT>`"},{"d":"dutch_auction::bid_amount","l":"./dutch_auction.html#bid_amount","f":"dutch_auction::<span class=\"function\">bid_amount</span>","de":""},{"d":"dutch_auction::bid_owner","l":"./dutch_auction.html#bid_owner","f":"dutch_auction::<span class=\"function\">bid_owner</span>","de":""},{"d":"dutch_auction::bids","l":"./dutch_auction.html#bids","f":"dutch_auction::<span class=\"function\">bids</span>","de":" Get the auction's bids"},{"d":"dutch_auction::cancel_bid","l":"./dutch_auction.html#cancel_bid","f":"dutch_auction::<span class=\"function\">cancel_bid</span>","de":" Cancels a single bid at the given price level in a FIFO manner"},{"d":"dutch_auction::create_bid_whitelisted","l":"./dutch_auction.html#create_bid_whitelisted","f":"dutch_auction::<span class=\"function\">create_bid_whitelisted</span>","de":""},{"d":"dutch_auction::reserve_price","l":"./dutch_auction.html#reserve_price","f":"dutch_auction::<span class=\"function\">reserve_price</span>","de":" Get the auction's reserve price"},{"d":"dutch_auction::init_market","l":"./dutch_auction.html#init_market","f":"dutch_auction::<span class=\"function\">init_market</span>","de":" Creates a `DutchAuctionMarket<FT>` and transfers to transaction sender"},{"d":"dutch_auction::sale_cancel","l":"./dutch_auction.html#sale_cancel","f":"dutch_auction::<span class=\"function\">sale_cancel</span>","de":" Cancel the auction and toggle the Slingshot's `live` to `false`."},{"d":"dutch_auction::sale_conclude","l":"./dutch_auction.html#sale_conclude","f":"dutch_auction::<span class=\"function\">sale_conclude</span>","de":" Conclude the auction and toggle the Slingshot's `live` to `false`."},{"d":"fixed_price::Witness","l":"./fixed_price.html#Witness","f":"fixed_price::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"fixed_price::FixedPriceMarket","l":"./fixed_price.html#FixedPriceMarket","f":"fixed_price::<span class=\"hljs-type\">FixedPriceMarket</span>","de":" Fixed price market object"},{"d":"fixed_price::new","l":"./fixed_price.html#new","f":"fixed_price::<span class=\"function\">new</span>","de":" Create a new `FixedPriceMarket<FT>`"},{"d":"fixed_price::price","l":"./fixed_price.html#price","f":"fixed_price::<span class=\"function\">price</span>","de":" Return market price"},{"d":"fixed_price::init_venue","l":"./fixed_price.html#init_venue","f":"fixed_price::<span class=\"function\">init_venue</span>","de":" Initializes a `Venue` with `FixedPriceMarket<FT>`"},{"d":"fixed_price::buy_nft","l":"./fixed_price.html#buy_nft","f":"fixed_price::<span class=\"function\">buy_nft</span>","de":" Buy NFT for non-whitelisted sale"},{"d":"fixed_price::create_venue","l":"./fixed_price.html#create_venue","f":"fixed_price::<span class=\"function\">create_venue</span>","de":" Creates a `Venue` with `FixedPriceMarket<FT>`"},{"d":"fixed_price::init_market","l":"./fixed_price.html#init_market","f":"fixed_price::<span class=\"function\">init_market</span>","de":" Creates a `FixedPriceMarket<FT>` and transfers to transaction sender"},{"d":"fixed_price::buy_nft_into_safe","l":"./fixed_price.html#buy_nft_into_safe","f":"fixed_price::<span class=\"function\">buy_nft_into_safe</span>","de":" Buy NFT for non-whitelisted sale"},{"d":"fixed_price::buy_whitelisted_nft","l":"./fixed_price.html#buy_whitelisted_nft","f":"fixed_price::<span class=\"function\">buy_whitelisted_nft</span>","de":" Buy NFT for whitelisted sale"},{"d":"fixed_price::buy_whitelisted_nft_into_safe","l":"./fixed_price.html#buy_whitelisted_nft_into_safe","f":"fixed_price::<span class=\"function\">buy_whitelisted_nft_into_safe</span>","de":" Buy NFT for whitelisted sale"},{"d":"fixed_price::create_safe_and_buy_nft","l":"./fixed_price.html#create_safe_and_buy_nft","f":"fixed_price::<span class=\"function\">create_safe_and_buy_nft</span>","de":" Buy NFT for non-whitelisted sale."},{"d":"fixed_price::create_safe_and_buy_whitelisted_nft","l":"./fixed_price.html#create_safe_and_buy_whitelisted_nft","f":"fixed_price::<span class=\"function\">create_safe_and_buy_whitelisted_nft</span>","de":" Buy NFT for whitelisted sale"},{"d":"fixed_price::set_price","l":"./fixed_price.html#set_price","f":"fixed_price::<span class=\"function\">set_price</span>","de":" Change market price"},{"d":"flat_fee::FlatFee","l":"./flat_fee.html#FlatFee","f":"flat_fee::<span class=\"hljs-type\">FlatFee</span>","de":""},{"d":"flat_fee::new","l":"./flat_fee.html#new","f":"flat_fee::<span class=\"function\">new</span>","de":""},{"d":"flat_fee::collect_proceeds_and_fees","l":"./flat_fee.html#collect_proceeds_and_fees","f":"flat_fee::<span class=\"function\">collect_proceeds_and_fees</span>","de":""},{"d":"flat_fee::init_fee","l":"./flat_fee.html#init_fee","f":"flat_fee::<span class=\"function\">init_fee</span>","de":""},{"d":"limited_fixed_price::Witness","l":"./limited_fixed_price.html#Witness","f":"limited_fixed_price::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"limited_fixed_price::LimitedFixedPriceMarket","l":"./limited_fixed_price.html#LimitedFixedPriceMarket","f":"limited_fixed_price::<span class=\"hljs-type\">LimitedFixedPriceMarket</span>","de":" Fixed price market object"},{"d":"limited_fixed_price::new","l":"./limited_fixed_price.html#new","f":"limited_fixed_price::<span class=\"function\">new</span>","de":" Create a new `LimitedFixedPriceMarket<FT>`"},{"d":"limited_fixed_price::price","l":"./limited_fixed_price.html#price","f":"limited_fixed_price::<span class=\"function\">price</span>","de":" Return market price"},{"d":"limited_fixed_price::limit","l":"./limited_fixed_price.html#limit","f":"limited_fixed_price::<span class=\"function\">limit</span>","de":" Return market limit"},{"d":"limited_fixed_price::init_venue","l":"./limited_fixed_price.html#init_venue","f":"limited_fixed_price::<span class=\"function\">init_venue</span>","de":" Initializes a `Venue` with `LimitedFixedPriceMarket<FT>`"},{"d":"limited_fixed_price::buy_nft","l":"./limited_fixed_price.html#buy_nft","f":"limited_fixed_price::<span class=\"function\">buy_nft</span>","de":" Buy NFT for non-whitelisted sale"},{"d":"limited_fixed_price::create_venue","l":"./limited_fixed_price.html#create_venue","f":"limited_fixed_price::<span class=\"function\">create_venue</span>","de":" Creates a `Venue` with `LimitedFixedPriceMarket<FT>`"},{"d":"limited_fixed_price::init_market","l":"./limited_fixed_price.html#init_market","f":"limited_fixed_price::<span class=\"function\">init_market</span>","de":" Creates a `LimitedFixedPriceMarket<FT>` and transfers to transaction sender"},{"d":"limited_fixed_price::buy_nft_into_safe","l":"./limited_fixed_price.html#buy_nft_into_safe","f":"limited_fixed_price::<span class=\"function\">buy_nft_into_safe</span>","de":" Buy NFT for non-whitelisted sale"},{"d":"limited_fixed_price::buy_whitelisted_nft","l":"./limited_fixed_price.html#buy_whitelisted_nft","f":"limited_fixed_price::<span class=\"function\">buy_whitelisted_nft</span>","de":" Buy NFT for whitelisted sale"},{"d":"limited_fixed_price::buy_whitelisted_nft_into_safe","l":"./limited_fixed_price.html#buy_whitelisted_nft_into_safe","f":"limited_fixed_price::<span class=\"function\">buy_whitelisted_nft_into_safe</span>","de":" Buy NFT for whitelisted sale"},{"d":"limited_fixed_price::create_safe_and_buy_nft","l":"./limited_fixed_price.html#create_safe_and_buy_nft","f":"limited_fixed_price::<span class=\"function\">create_safe_and_buy_nft</span>","de":" Buy NFT for non-whitelisted sale."},{"d":"limited_fixed_price::create_safe_and_buy_whitelisted_nft","l":"./limited_fixed_price.html#create_safe_and_buy_whitelisted_nft","f":"limited_fixed_price::<span class=\"function\">create_safe_and_buy_whitelisted_nft</span>","de":" Buy NFT for whitelisted sale"},{"d":"limited_fixed_price::set_price","l":"./limited_fixed_price.html#set_price","f":"limited_fixed_price::<span class=\"function\">set_price</span>","de":" Change market price"},{"d":"limited_fixed_price::assert_limit","l":"./limited_fixed_price.html#assert_limit","f":"limited_fixed_price::<span class=\"function\">assert_limit</span>","de":" Asserts that limit does not violate market limit"},{"d":"limited_fixed_price::borrow_count","l":"./limited_fixed_price.html#borrow_count","f":"limited_fixed_price::<span class=\"function\">borrow_count</span>","de":" Returns how many NFTs the given address bought from the market"},{"d":"limited_fixed_price::increment_count","l":"./limited_fixed_price.html#increment_count","f":"limited_fixed_price::<span class=\"function\">increment_count</span>","de":" Increments count while enforcing market limit"},{"d":"limited_fixed_price::set_limit","l":"./limited_fixed_price.html#set_limit","f":"limited_fixed_price::<span class=\"function\">set_limit</span>","de":" Change market limit"},{"d":"modify::ModifyDomain","l":"./modify.html#ModifyDomain","f":"modify::<span class=\"hljs-type\">ModifyDomain</span>","de":" `ModifyDomain` object"},{"d":"modify::add_domain","l":"./modify.html#add_domain","f":"modify::<span class=\"function\">add_domain</span>","de":" Adds domain of type `D` to `Nft`"},{"d":"modify::assert_domain","l":"./modify.html#assert_domain","f":"modify::<span class=\"function\">assert_domain</span>","de":" Asserts that `ModifyDomain` is defined on the `Collection`"},{"d":"modify::add_modify_domain","l":"./modify.html#add_modify_domain","f":"modify::<span class=\"function\">add_modify_domain</span>","de":" Adds `ModifyDomain` to `Collection`"},{"d":"modify::assert_owner","l":"./modify.html#assert_owner","f":"modify::<span class=\"function\">assert_owner</span>","de":" Asserts that transaction sender is the logical owner of the NFT"},{"d":"orderbook::Witness","l":"./orderbook.html#Witness","f":"orderbook::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"orderbook::Bid","l":"./orderbook.html#Bid","f":"orderbook::<span class=\"hljs-type\">Bid</span>","de":" An offer for a single NFT in a collection."},{"d":"orderbook::BidClosedEvent","l":"./orderbook.html#BidClosedEvent","f":"orderbook::<span class=\"hljs-type\">BidClosedEvent</span>","de":" When de-listed, not when bought!"},{"d":"orderbook::BidCreatedEvent","l":"./orderbook.html#BidCreatedEvent","f":"orderbook::<span class=\"hljs-type\">BidCreatedEvent</span>","de":""},{"d":"orderbook::Ask","l":"./orderbook.html#Ask","f":"orderbook::<span class=\"hljs-type\">Ask</span>","de":" Object which is associated with a single NFT."},{"d":"orderbook::AskClosedEvent","l":"./orderbook.html#AskClosedEvent","f":"orderbook::<span class=\"hljs-type\">AskClosedEvent</span>","de":" When de-listed, not when sold!"},{"d":"orderbook::AskCreatedEvent","l":"./orderbook.html#AskCreatedEvent","f":"orderbook::<span class=\"hljs-type\">AskCreatedEvent</span>","de":""},{"d":"orderbook::Orderbook","l":"./orderbook.html#Orderbook","f":"orderbook::<span class=\"hljs-type\">Orderbook</span>","de":" A critbit order book implementation. Contains two ordered trees:"},{"d":"orderbook::OrderbookCreatedEvent","l":"./orderbook.html#OrderbookCreatedEvent","f":"orderbook::<span class=\"hljs-type\">OrderbookCreatedEvent</span>","de":""},{"d":"orderbook::TradeFilledEvent","l":"./orderbook.html#TradeFilledEvent","f":"orderbook::<span class=\"hljs-type\">TradeFilledEvent</span>","de":" Either an ask is created and immediately matched with a bid, or a bid"},{"d":"orderbook::TradeIntermediate","l":"./orderbook.html#TradeIntermediate","f":"orderbook::<span class=\"hljs-type\">TradeIntermediate</span>","de":" `TradeIntermediate` is made a shared object and can be called"},{"d":"orderbook::WitnessProtectedActions","l":"./orderbook.html#WitnessProtectedActions","f":"orderbook::<span class=\"hljs-type\">WitnessProtectedActions</span>","de":" The contract which creates the orderbook can restrict specific actions"},{"d":"orderbook::new","l":"./orderbook.html#new","f":"orderbook::<span class=\"function\">new</span>","de":" `C`ollection kind of NFTs to be traded, and `F`ungible `T`oken to be"},{"d":"orderbook::create","l":"./orderbook.html#create","f":"orderbook::<span class=\"function\">create</span>","de":" Creates a new empty orderbook as a shared object."},{"d":"orderbook::create_bid","l":"./orderbook.html#create_bid","f":"orderbook::<span class=\"function\">create_bid</span>","de":" How many (`price`) fungible tokens should be taken from sender's wallet"},{"d":"orderbook::create_bid_with_commission","l":"./orderbook.html#create_bid_with_commission","f":"orderbook::<span class=\"function\">create_bid_with_commission</span>","de":" Same as [`create_bid`] but with a"},{"d":"orderbook::share","l":"./orderbook.html#share","f":"orderbook::<span class=\"function\">share</span>","de":""},{"d":"orderbook::buy_nft","l":"./orderbook.html#buy_nft","f":"orderbook::<span class=\"function\">buy_nft</span>","de":" To buy a specific NFT listed in the orderbook, the client provides the"},{"d":"orderbook::bid_owner","l":"./orderbook.html#bid_owner","f":"orderbook::<span class=\"function\">bid_owner</span>","de":""},{"d":"orderbook::cancel_bid","l":"./orderbook.html#cancel_bid","f":"orderbook::<span class=\"function\">cancel_bid</span>","de":" Cancel a bid owned by the sender at given price. If there are two bids"},{"d":"orderbook::create_safe_and_buy_nft","l":"./orderbook.html#create_safe_and_buy_nft","f":"orderbook::<span class=\"function\">create_safe_and_buy_nft</span>","de":" 1. Creates a new [`Safe`] for the sender"},{"d":"orderbook::ask_nft","l":"./orderbook.html#ask_nft","f":"orderbook::<span class=\"function\">ask_nft</span>","de":""},{"d":"orderbook::ask_owner","l":"./orderbook.html#ask_owner","f":"orderbook::<span class=\"function\">ask_owner</span>","de":""},{"d":"orderbook::ask_price","l":"./orderbook.html#ask_price","f":"orderbook::<span class=\"function\">ask_price</span>","de":""},{"d":"orderbook::bid_offer","l":"./orderbook.html#bid_offer","f":"orderbook::<span class=\"function\">bid_offer</span>","de":""},{"d":"orderbook::borrow_asks","l":"./orderbook.html#borrow_asks","f":"orderbook::<span class=\"function\">borrow_asks</span>","de":""},{"d":"orderbook::borrow_bids","l":"./orderbook.html#borrow_bids","f":"orderbook::<span class=\"function\">borrow_bids</span>","de":""},{"d":"orderbook::buy_generic_nft","l":"./orderbook.html#buy_generic_nft","f":"orderbook::<span class=\"function\">buy_generic_nft</span>","de":" Similar to [`buy_nft`] except that this is meant for generic"},{"d":"orderbook::buy_generic_nft_protected","l":"./orderbook.html#buy_generic_nft_protected","f":"orderbook::<span class=\"function\">buy_generic_nft_protected</span>","de":" Same as [`buy_generic_nft`] but protected by"},{"d":"orderbook::buy_nft_protected","l":"./orderbook.html#buy_nft_protected","f":"orderbook::<span class=\"function\">buy_nft_protected</span>","de":" Same as [`buy_nft`] but protected by"},{"d":"orderbook::cancel_ask","l":"./orderbook.html#cancel_ask","f":"orderbook::<span class=\"function\">cancel_ask</span>","de":" To cancel an offer on a specific NFT, the client provides the price they"},{"d":"orderbook::cancel_ask_and_discard_transfer_cap","l":"./orderbook.html#cancel_ask_and_discard_transfer_cap","f":"orderbook::<span class=\"function\">cancel_ask_and_discard_transfer_cap</span>","de":" Same as [`cancel_ask`] but the [`TransferCap`] is burned instead of"},{"d":"orderbook::cancel_ask_protected","l":"./orderbook.html#cancel_ask_protected","f":"orderbook::<span class=\"function\">cancel_ask_protected</span>","de":" Same as [`cancel_ask`] but protected by"},{"d":"orderbook::cancel_bid_protected","l":"./orderbook.html#cancel_bid_protected","f":"orderbook::<span class=\"function\">cancel_bid_protected</span>","de":" Same as [`cancel_bid`] but protected by"},{"d":"orderbook::create_ask","l":"./orderbook.html#create_ask","f":"orderbook::<span class=\"function\">create_ask</span>","de":" Offer given NFT to be traded for given (`requested_tokens`) tokens."},{"d":"orderbook::create_ask_protected","l":"./orderbook.html#create_ask_protected","f":"orderbook::<span class=\"function\">create_ask_protected</span>","de":" Same as [`create_ask`] but protected by"},{"d":"orderbook::create_ask_with_commission","l":"./orderbook.html#create_ask_with_commission","f":"orderbook::<span class=\"function\">create_ask_with_commission</span>","de":" Same as [`create_ask`] but with a"},{"d":"orderbook::create_ask_with_commission_protected","l":"./orderbook.html#create_ask_with_commission_protected","f":"orderbook::<span class=\"function\">create_ask_with_commission_protected</span>","de":" Same as [`create_ask_protected`] but with a"},{"d":"orderbook::create_bid_protected","l":"./orderbook.html#create_bid_protected","f":"orderbook::<span class=\"function\">create_bid_protected</span>","de":" Same as [`create_bid`] but protected by"},{"d":"orderbook::create_bid_with_commission_protected","l":"./orderbook.html#create_bid_with_commission_protected","f":"orderbook::<span class=\"function\">create_bid_with_commission_protected</span>","de":" Same as [`create_bid_protected`] but with a"},{"d":"orderbook::create_safe_and_bid","l":"./orderbook.html#create_safe_and_bid","f":"orderbook::<span class=\"function\">create_safe_and_bid</span>","de":" Same as [`create_bid`] but creates a new safe for the sender first"},{"d":"orderbook::create_safe_and_bid_with_commission","l":"./orderbook.html#create_safe_and_bid_with_commission","f":"orderbook::<span class=\"function\">create_safe_and_bid_with_commission</span>","de":" Same as [`create_safe_and_bid`] but with a"},{"d":"orderbook::create_safe_and_buy_generic_nft","l":"./orderbook.html#create_safe_and_buy_generic_nft","f":"orderbook::<span class=\"function\">create_safe_and_buy_generic_nft</span>","de":" 1. Creates a new [`Safe`] for the sender"},{"d":"orderbook::create_safe_and_deposit_and_list_nft","l":"./orderbook.html#create_safe_and_deposit_and_list_nft","f":"orderbook::<span class=\"function\">create_safe_and_deposit_and_list_nft</span>","de":" 1. Creates a new safe for the sender"},{"d":"orderbook::create_safe_and_deposit_and_list_nft_with_commission","l":"./orderbook.html#create_safe_and_deposit_and_list_nft_with_commission","f":"orderbook::<span class=\"function\">create_safe_and_deposit_and_list_nft_with_commission</span>","de":" Same as [`create_safe_and_deposit_and_list_nft`] but with a"},{"d":"orderbook::custom_protection","l":"./orderbook.html#custom_protection","f":"orderbook::<span class=\"function\">custom_protection</span>","de":""},{"d":"orderbook::deposit_and_list_nft","l":"./orderbook.html#deposit_and_list_nft","f":"orderbook::<span class=\"function\">deposit_and_list_nft</span>","de":" 1. Deposits an NFT to safe"},{"d":"orderbook::deposit_and_list_nft_with_commission","l":"./orderbook.html#deposit_and_list_nft_with_commission","f":"orderbook::<span class=\"function\">deposit_and_list_nft_with_commission</span>","de":" Same as [`deposit_and_list_nft_with`] but with a"},{"d":"orderbook::edit_ask","l":"./orderbook.html#edit_ask","f":"orderbook::<span class=\"function\">edit_ask</span>","de":" Removes the old ask and creates a new one with the same NFT."},{"d":"orderbook::edit_bid","l":"./orderbook.html#edit_bid","f":"orderbook::<span class=\"function\">edit_bid</span>","de":" Cancels the old bid and creates a new one with new price."},{"d":"orderbook::finish_trade","l":"./orderbook.html#finish_trade","f":"orderbook::<span class=\"function\">finish_trade</span>","de":" When a bid is created and there's an ask with a lower price, then the"},{"d":"orderbook::finish_trade_of_generic_nft","l":"./orderbook.html#finish_trade_of_generic_nft","f":"orderbook::<span class=\"function\">finish_trade_of_generic_nft</span>","de":" Similar to [`finish_trade`] except that this is meant for generic"},{"d":"orderbook::is_buy_nft_protected","l":"./orderbook.html#is_buy_nft_protected","f":"orderbook::<span class=\"function\">is_buy_nft_protected</span>","de":""},{"d":"orderbook::protected_actions","l":"./orderbook.html#protected_actions","f":"orderbook::<span class=\"function\">protected_actions</span>","de":""},{"d":"orderbook::is_cancel_ask_protected","l":"./orderbook.html#is_cancel_ask_protected","f":"orderbook::<span class=\"function\">is_cancel_ask_protected</span>","de":""},{"d":"orderbook::is_cancel_bid_protected","l":"./orderbook.html#is_cancel_bid_protected","f":"orderbook::<span class=\"function\">is_cancel_bid_protected</span>","de":""},{"d":"orderbook::is_create_ask_protected","l":"./orderbook.html#is_create_ask_protected","f":"orderbook::<span class=\"function\">is_create_ask_protected</span>","de":""},{"d":"orderbook::is_create_bid_protected","l":"./orderbook.html#is_create_bid_protected","f":"orderbook::<span class=\"function\">is_create_bid_protected</span>","de":""},{"d":"orderbook::list_multiple_nfts","l":"./orderbook.html#list_multiple_nfts","f":"orderbook::<span class=\"function\">list_multiple_nfts</span>","de":" Provide list of NFTs and corresponding prices (index # match.)"},{"d":"orderbook::list_multiple_nfts_with_commission","l":"./orderbook.html#list_multiple_nfts_with_commission","f":"orderbook::<span class=\"function\">list_multiple_nfts_with_commission</span>","de":" Same as [`list_multiple_nfts`] but with a"},{"d":"orderbook::list_nft","l":"./orderbook.html#list_nft","f":"orderbook::<span class=\"function\">list_nft</span>","de":" Creates exclusive transfer cap and then calls [`create_ask`]."},{"d":"orderbook::list_nft_with_commission","l":"./orderbook.html#list_nft_with_commission","f":"orderbook::<span class=\"function\">list_nft_with_commission</span>","de":" Same as [`list_nft`] but with a"},{"d":"orderbook::new_unprotected","l":"./orderbook.html#new_unprotected","f":"orderbook::<span class=\"function\">new_unprotected</span>","de":" Returns a new orderbook without any protection, ie. all endpoints can"},{"d":"orderbook::new_with_protected_actions","l":"./orderbook.html#new_with_protected_actions","f":"orderbook::<span class=\"function\">new_with_protected_actions</span>","de":""},{"d":"orderbook::no_protection","l":"./orderbook.html#no_protection","f":"orderbook::<span class=\"function\">no_protection</span>","de":" Settings where all endpoints can be called as entry point functions."},{"d":"orderbook::set_protection","l":"./orderbook.html#set_protection","f":"orderbook::<span class=\"function\">set_protection</span>","de":""},{"d":"orderbook::toggle_protection_on_buy_nft","l":"./orderbook.html#toggle_protection_on_buy_nft","f":"orderbook::<span class=\"function\">toggle_protection_on_buy_nft</span>","de":""},{"d":"orderbook::toggle_protection_on_cancel_ask","l":"./orderbook.html#toggle_protection_on_cancel_ask","f":"orderbook::<span class=\"function\">toggle_protection_on_cancel_ask</span>","de":""},{"d":"orderbook::toggle_protection_on_cancel_bid","l":"./orderbook.html#toggle_protection_on_cancel_bid","f":"orderbook::<span class=\"function\">toggle_protection_on_cancel_bid</span>","de":""},{"d":"orderbook::toggle_protection_on_create_ask","l":"./orderbook.html#toggle_protection_on_create_ask","f":"orderbook::<span class=\"function\">toggle_protection_on_create_ask</span>","de":""},{"d":"orderbook::toggle_protection_on_create_bid","l":"./orderbook.html#toggle_protection_on_create_bid","f":"orderbook::<span class=\"function\">toggle_protection_on_create_bid</span>","de":""},{"d":"plugins::Witness","l":"./plugins.html#Witness","f":"plugins::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"plugins::PluginDomain","l":"./plugins.html#PluginDomain","f":"plugins::<span class=\"hljs-type\">PluginDomain</span>","de":""},{"d":"plugins::delegate","l":"./plugins.html#delegate","f":"plugins::<span class=\"function\">delegate</span>","de":" Create a delegated witness"},{"d":"plugins::assert_domain","l":"./plugins.html#assert_domain","f":"plugins::<span class=\"function\">assert_domain</span>","de":" Asserts that `PluginDomain` is defined on the `Collection`"},{"d":"plugins::add_plugin","l":"./plugins.html#add_plugin","f":"plugins::<span class=\"function\">add_plugin</span>","de":" Attributes witness as a plugin on the `Collection`"},{"d":"plugins::add_plugin_domain","l":"./plugins.html#add_plugin_domain","f":"plugins::<span class=\"function\">add_plugin_domain</span>","de":" Adds `PluginDomain` to `Collection`"},{"d":"plugins::assert_plugin","l":"./plugins.html#assert_plugin","f":"plugins::<span class=\"function\">assert_plugin</span>","de":" Asserts that witness is attributed in `PluginDomain`"},{"d":"plugins::borrow_plugin_domain","l":"./plugins.html#borrow_plugin_domain","f":"plugins::<span class=\"function\">borrow_plugin_domain</span>","de":" Borrows `PluginDomain` from `Collection`"},{"d":"plugins::borrow_plugins","l":"./plugins.html#borrow_plugins","f":"plugins::<span class=\"function\">borrow_plugins</span>","de":" Returns list of all defined plugins"},{"d":"plugins::contains_plugin","l":"./plugins.html#contains_plugin","f":"plugins::<span class=\"function\">contains_plugin</span>","de":" Returns whether witness is a defined plugin"},{"d":"plugins::remove_plugin","l":"./plugins.html#remove_plugin","f":"plugins::<span class=\"function\">remove_plugin</span>","de":" Removes witness as a plugin on the `Collection`"},{"d":"royalty_strategy_constant::ConstantRoyaltyStrategy","l":"./royalty_strategy_constant.html#ConstantRoyaltyStrategy","f":"royalty_strategy_constant::<span class=\"hljs-type\">ConstantRoyaltyStrategy</span>","de":""},{"d":"royalty_strategy_constant::new","l":"./royalty_strategy_constant.html#new","f":"royalty_strategy_constant::<span class=\"function\">new</span>","de":""},{"d":"royalty_strategy_constant::calculate","l":"./royalty_strategy_constant.html#calculate","f":"royalty_strategy_constant::<span class=\"function\">calculate</span>","de":""},{"d":"royalty_strategy_constant::royalty_fee","l":"./royalty_strategy_constant.html#royalty_fee","f":"royalty_strategy_constant::<span class=\"function\">royalty_fee</span>","de":""},{"d":"royalty_strategy_bps::BpsRoyaltyStrategy","l":"./royalty_strategy_bps.html#BpsRoyaltyStrategy","f":"royalty_strategy_bps::<span class=\"hljs-type\">BpsRoyaltyStrategy</span>","de":""},{"d":"royalty_strategy_bps::new","l":"./royalty_strategy_bps.html#new","f":"royalty_strategy_bps::<span class=\"function\">new</span>","de":""},{"d":"royalty_strategy_bps::calculate","l":"./royalty_strategy_bps.html#calculate","f":"royalty_strategy_bps::<span class=\"function\">calculate</span>","de":""},{"d":"royalty_strategy_bps::royalty_fee_bps","l":"./royalty_strategy_bps.html#royalty_fee_bps","f":"royalty_strategy_bps::<span class=\"function\">royalty_fee_bps</span>","de":""},{"d":"royalty::Witness","l":"./royalty.html#Witness","f":"royalty::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"royalty::RoyaltyDomain","l":"./royalty.html#RoyaltyDomain","f":"royalty::<span class=\"hljs-type\">RoyaltyDomain</span>","de":" `RoyaltyDomain` stores royalty strategies for `Collection` and"},{"d":"royalty::from_address","l":"./royalty.html#from_address","f":"royalty::<span class=\"function\">from_address</span>","de":" Creates a `RoyaltyDomain` object with only one address attribution"},{"d":"royalty::add_constant_royalty","l":"./royalty.html#add_constant_royalty","f":"royalty::<span class=\"function\">add_constant_royalty</span>","de":" Add constant royalty policy"},{"d":"royalty::add_proportional_royalty","l":"./royalty.html#add_proportional_royalty","f":"royalty::<span class=\"function\">add_proportional_royalty</span>","de":" Add proportional royalty policy"},{"d":"royalty::add_royalty_domain","l":"./royalty.html#add_royalty_domain","f":"royalty::<span class=\"function\">add_royalty_domain</span>","de":" Registers `RoyaltyDomain` on the given `Collection`"},{"d":"royalty::add_royalty_strategy","l":"./royalty.html#add_royalty_strategy","f":"royalty::<span class=\"function\">add_royalty_strategy</span>","de":" Add a generic royalty strategy"},{"d":"royalty::add_share","l":"./royalty.html#add_share","f":"royalty::<span class=\"function\">add_share</span>","de":" Attribute a share of royalties to an address"},{"d":"royalty::add_share_to_empty","l":"./royalty.html#add_share_to_empty","f":"royalty::<span class=\"function\">add_share_to_empty</span>","de":" Attribute royalties to an address"},{"d":"royalty::add_shares_to_empty","l":"./royalty.html#add_shares_to_empty","f":"royalty::<span class=\"function\">add_shares_to_empty</span>","de":" Attribute royalties to addresses"},{"d":"royalty::borrow_share","l":"./royalty.html#borrow_share","f":"royalty::<span class=\"function\">borrow_share</span>","de":" Returns the `Creator` type for the given address"},{"d":"royalty::borrow_shares","l":"./royalty.html#borrow_shares","f":"royalty::<span class=\"function\">borrow_shares</span>","de":" Returns the list of creators defined on the `CreatorsDomain`"},{"d":"royalty::borrow_strategy","l":"./royalty.html#borrow_strategy","f":"royalty::<span class=\"function\">borrow_strategy</span>","de":" Borrow a royalty strategy"},{"d":"royalty::borrow_strategy_mut","l":"./royalty.html#borrow_strategy_mut","f":"royalty::<span class=\"function\">borrow_strategy_mut</span>","de":" Mutably borrow a royalty strategy"},{"d":"royalty::calculate_constant_royalty","l":"./royalty.html#calculate_constant_royalty","f":"royalty::<span class=\"function\">calculate_constant_royalty</span>","de":" Calculate how many tokens are due for the defined constant royalty"},{"d":"royalty::calculate_proportional_royalty","l":"./royalty.html#calculate_proportional_royalty","f":"royalty::<span class=\"function\">calculate_proportional_royalty</span>","de":" Calculate how many tokens are due for the defined proportional royalty"},{"d":"royalty::collect_royalty","l":"./royalty.html#collect_royalty","f":"royalty::<span class=\"function\">collect_royalty</span>","de":" Collects an `amount` of tokens from the provided balance into the"},{"d":"royalty::contains_share","l":"./royalty.html#contains_share","f":"royalty::<span class=\"function\">contains_share</span>","de":" Returns true when address is a defined creator"},{"d":"royalty::contains_shares","l":"./royalty.html#contains_shares","f":"royalty::<span class=\"function\">contains_shares</span>","de":" Returns true when a share attribution exists"},{"d":"royalty::contains_strategy","l":"./royalty.html#contains_strategy","f":"royalty::<span class=\"function\">contains_strategy</span>","de":" Check whether a royalty strategy is defined"},{"d":"royalty::distribute_balance","l":"./royalty.html#distribute_balance","f":"royalty::<span class=\"function\">distribute_balance</span>","de":" Distributes the contents of a `Balance<FT>` among the addresses defined"},{"d":"royalty::distribute_royalties","l":"./royalty.html#distribute_royalties","f":"royalty::<span class=\"function\">distribute_royalties</span>","de":" Distributes the aggregated royalties for fungible token, `FT`, among"},{"d":"royalty::from_shares","l":"./royalty.html#from_shares","f":"royalty::<span class=\"function\">from_shares</span>","de":" Creates a `RoyaltyDomain` with multiple attributions"},{"d":"royalty::new_empty","l":"./royalty.html#new_empty","f":"royalty::<span class=\"function\">new_empty</span>","de":" Creates an empty `RoyaltyDomain` object"},{"d":"royalty::remove_constant_royalty","l":"./royalty.html#remove_constant_royalty","f":"royalty::<span class=\"function\">remove_constant_royalty</span>","de":" Remove constant royalty policy"},{"d":"royalty::remove_creator_by_transfer","l":"./royalty.html#remove_creator_by_transfer","f":"royalty::<span class=\"function\">remove_creator_by_transfer</span>","de":" Remove a share attribution from an address and transfer attribution to"},{"d":"royalty::remove_proportional_royalty","l":"./royalty.html#remove_proportional_royalty","f":"royalty::<span class=\"function\">remove_proportional_royalty</span>","de":" Remove proportional royalty policy"},{"d":"royalty::remove_strategy","l":"./royalty.html#remove_strategy","f":"royalty::<span class=\"function\">remove_strategy</span>","de":" Remove a royalty strategy"},{"d":"royalty::royalty_domain","l":"./royalty.html#royalty_domain","f":"royalty::<span class=\"function\">royalty_domain</span>","de":" Get reference to `RoyaltyDomain`"},{"d":"royalty::royalty_domain_mut","l":"./royalty.html#royalty_domain_mut","f":"royalty::<span class=\"function\">royalty_domain_mut</span>","de":" Get mutable reference to `RoyaltyDomain`"},{"d":"tags::Witness","l":"./tags.html#Witness","f":"tags::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"tags::Art","l":"./tags.html#Art","f":"tags::<span class=\"hljs-type\">Art</span>","de":""},{"d":"tags::Collectible","l":"./tags.html#Collectible","f":"tags::<span class=\"hljs-type\">Collectible</span>","de":""},{"d":"tags::DomainName","l":"./tags.html#DomainName","f":"tags::<span class=\"hljs-type\">DomainName</span>","de":""},{"d":"tags::GameAsset","l":"./tags.html#GameAsset","f":"tags::<span class=\"hljs-type\">GameAsset</span>","de":""},{"d":"tags::License","l":"./tags.html#License","f":"tags::<span class=\"hljs-type\">License</span>","de":""},{"d":"tags::Music","l":"./tags.html#Music","f":"tags::<span class=\"hljs-type\">Music</span>","de":""},{"d":"tags::ProfilePicture","l":"./tags.html#ProfilePicture","f":"tags::<span class=\"hljs-type\">ProfilePicture</span>","de":""},{"d":"tags::TagDomain","l":"./tags.html#TagDomain","f":"tags::<span class=\"hljs-type\">TagDomain</span>","de":""},{"d":"tags::Ticker","l":"./tags.html#Ticker","f":"tags::<span class=\"hljs-type\">Ticker</span>","de":""},{"d":"tags::Ticket","l":"./tags.html#Ticket","f":"tags::<span class=\"hljs-type\">Ticket</span>","de":""},{"d":"tags::TokenisedAsset","l":"./tags.html#TokenisedAsset","f":"tags::<span class=\"hljs-type\">TokenisedAsset</span>","de":""},{"d":"tags::Video","l":"./tags.html#Video","f":"tags::<span class=\"hljs-type\">Video</span>","de":""},{"d":"tags::empty","l":"./tags.html#empty","f":"tags::<span class=\"function\">empty</span>","de":""},{"d":"tags::add_collection_tag_domain","l":"./tags.html#add_collection_tag_domain","f":"tags::<span class=\"function\">add_collection_tag_domain</span>","de":""},{"d":"tags::add_tag","l":"./tags.html#add_tag","f":"tags::<span class=\"function\">add_tag</span>","de":" Adds tag to `TagDomain`"},{"d":"tags::add_tag_domain","l":"./tags.html#add_tag_domain","f":"tags::<span class=\"function\">add_tag_domain</span>","de":""},{"d":"tags::art","l":"./tags.html#art","f":"tags::<span class=\"function\">art</span>","de":""},{"d":"tags::collectible","l":"./tags.html#collectible","f":"tags::<span class=\"function\">collectible</span>","de":""},{"d":"tags::collection_tag_domain","l":"./tags.html#collection_tag_domain","f":"tags::<span class=\"function\">collection_tag_domain</span>","de":""},{"d":"tags::collection_tag_domain_mut","l":"./tags.html#collection_tag_domain_mut","f":"tags::<span class=\"function\">collection_tag_domain_mut</span>","de":" Requires that sender is a creator"},{"d":"tags::domain_name","l":"./tags.html#domain_name","f":"tags::<span class=\"function\">domain_name</span>","de":""},{"d":"tags::game_asset","l":"./tags.html#game_asset","f":"tags::<span class=\"function\">game_asset</span>","de":""},{"d":"tags::has_tag","l":"./tags.html#has_tag","f":"tags::<span class=\"function\">has_tag</span>","de":""},{"d":"tags::license","l":"./tags.html#license","f":"tags::<span class=\"function\">license</span>","de":""},{"d":"tags::music","l":"./tags.html#music","f":"tags::<span class=\"function\">music</span>","de":""},{"d":"tags::profile_picture","l":"./tags.html#profile_picture","f":"tags::<span class=\"function\">profile_picture</span>","de":""},{"d":"tags::remove_tag","l":"./tags.html#remove_tag","f":"tags::<span class=\"function\">remove_tag</span>","de":" Removes tag from `TagDomain`"},{"d":"tags::tag_domain","l":"./tags.html#tag_domain","f":"tags::<span class=\"function\">tag_domain</span>","de":""},{"d":"tags::ticker","l":"./tags.html#ticker","f":"tags::<span class=\"function\">ticker</span>","de":""},{"d":"tags::ticket","l":"./tags.html#ticket","f":"tags::<span class=\"function\">ticket</span>","de":""},{"d":"tags::tokenised_asset","l":"./tags.html#tokenised_asset","f":"tags::<span class=\"function\">tokenised_asset</span>","de":""},{"d":"tags::video","l":"./tags.html#video","f":"tags::<span class=\"function\">video</span>","de":""},{"d":"transfer_allowlist_domain::Witness","l":"./transfer_allowlist_domain.html#Witness","f":"transfer_allowlist_domain::<span class=\"hljs-type\">Witness</span>","de":" Witness used to authenticate witness protected endpoints"},{"d":"transfer_allowlist_domain::TransferAllowlistDomain","l":"./transfer_allowlist_domain.html#TransferAllowlistDomain","f":"transfer_allowlist_domain::<span class=\"hljs-type\">TransferAllowlistDomain</span>","de":" `TransferAllowlistDomain` tracks allowlists which authorize transfer"},{"d":"transfer_allowlist_domain::empty","l":"./transfer_allowlist_domain.html#empty","f":"transfer_allowlist_domain::<span class=\"function\">empty</span>","de":" Creates an empty `TransferAllowlistDomain` object"},{"d":"transfer_allowlist_domain::assert_domain","l":"./transfer_allowlist_domain.html#assert_domain","f":"transfer_allowlist_domain::<span class=\"function\">assert_domain</span>","de":" Asserts that `TransferAllowlistDomain` is defined on the `Collection`"},{"d":"transfer_allowlist_domain::transfer_allowlist_domain","l":"./transfer_allowlist_domain.html#transfer_allowlist_domain","f":"transfer_allowlist_domain::<span class=\"function\">transfer_allowlist_domain</span>","de":" Borrows `TransferAllowlistDomain` from `Collection`"},{"d":"transfer_allowlist_domain::add_id","l":"./transfer_allowlist_domain.html#add_id","f":"transfer_allowlist_domain::<span class=\"function\">add_id</span>","de":" Adds new allowlist to `TransferAllowlistDomain`."},{"d":"transfer_allowlist_domain::add_id_with_cap","l":"./transfer_allowlist_domain.html#add_id_with_cap","f":"transfer_allowlist_domain::<span class=\"function\">add_id_with_cap</span>","de":" Like [`add_id`] but as an endpoint"},{"d":"transfer_allowlist_domain::borrow_allowlists","l":"./transfer_allowlist_domain.html#borrow_allowlists","f":"transfer_allowlist_domain::<span class=\"function\">borrow_allowlists</span>","de":" Returns the list of IDs defined on the `TransferAllowlistDomain`"},{"d":"transfer_allowlist_domain::from_id","l":"./transfer_allowlist_domain.html#from_id","f":"transfer_allowlist_domain::<span class=\"function\">from_id</span>","de":" Creates a `TransferAllowlistDomain` object with a single allowlist"},{"d":"transfer_allowlist_domain::remove_id","l":"./transfer_allowlist_domain.html#remove_id","f":"transfer_allowlist_domain::<span class=\"function\">remove_id</span>","de":" Removes existing allowlist from `TransferAllowlistDomain`."},{"d":"transfer_allowlist_domain::remove_id_with_cap","l":"./transfer_allowlist_domain.html#remove_id_with_cap","f":"transfer_allowlist_domain::<span class=\"function\">remove_id_with_cap</span>","de":" Like [`remove_id`] but as an endpoint"}]</script>
<script>
hljs.configure({languages:["move"]})
hljs.highlightAll();
</script>
</head>
<body>
<div id="container-movedoc">
<nav class="sidebar"><a href="./index.html">
<img src="./assets/accent.svg" style="position: absolute">
<img src="./assets/ob.svg" class="logo">
</a>
<h2>Modules</h2>
<ul><li>
<a href="./err.html">err</a>
<ul class="methods"></ul>
</li><li>
<a href="./utils.html">utils</a>
<ul class="methods"><li>
<a href="./utils.html#Marker">Marker</a>
</li></ul>
</li><li>
<a href="./witness.html">witness</a>
<ul class="methods"><li>
<a href="./witness.html#Witness">Witness</a>
</li><li>
<a href="./witness.html#WitnessGenerator">WitnessGenerator</a>
</li></ul>
</li><li>
<a href="./transfer_allowlist.html">transfer_allowlist</a>
<ul class="methods"><li>
<a href="./transfer_allowlist.html#Allowlist">Allowlist</a>
</li><li>
<a href="./transfer_allowlist.html#CollectionControlCap">CollectionControlCap</a>
</li></ul>
</li><li>
<a href="./supply.html">supply</a>
<ul class="methods"><li>
<a href="./supply.html#Supply">Supply</a>
</li></ul>
</li><li>
<a href="./mint_cap.html">mint_cap</a>
<ul class="methods"><li>
<a href="./mint_cap.html#MintCap">MintCap</a>
</li><li>
<a href="./mint_cap.html#RegulatedMintCap">RegulatedMintCap</a>
</li><li>
<a href="./mint_cap.html#UnregulatedMintCap">UnregulatedMintCap</a>
</li></ul>
</li><li>
<a href="./nft.html">nft</a>
<ul class="methods"><li>
<a href="./nft.html#ChangeLogicalOwnerEvent">ChangeLogicalOwnerEvent</a>
</li><li>
<a href="./nft.html#MintNftEvent">MintNftEvent</a>
</li><li>
<a href="./nft.html#Nft">Nft</a>
</li></ul>
</li><li>
<a href="./attributes.html">attributes</a>
<ul class="methods"><li>
<a href="./attributes.html#Witness">Witness</a>
</li><li>
<a href="./attributes.html#AttributesDomain">AttributesDomain</a>
</li></ul>
</li><li>
<a href="./royalties.html">royalties</a>
<ul class="methods"><li>
<a href="./royalties.html#TradePayment">TradePayment</a>
</li><li>
<a href="./royalties.html#TradePaymentCreatedEvent">TradePaymentCreatedEvent</a>
</li></ul>
</li><li>
<a href="./trading.html">trading</a>
<ul class="methods"><li>
<a href="./trading.html#AskCommission">AskCommission</a>
</li><li>
<a href="./trading.html#BidCommission">BidCommission</a>
</li></ul>
</li><li>
<a href="./unprotected_safe.html">unprotected_safe</a>
<ul class="methods"><li>
<a href="./unprotected_safe.html#DepositEvent">DepositEvent</a>
</li><li>
<a href="./unprotected_safe.html#NftRef">NftRef</a>
</li><li>
<a href="./unprotected_safe.html#OwnerCap">OwnerCap</a>
</li><li>
<a href="./unprotected_safe.html#TransferCap">TransferCap</a>
</li><li>
<a href="./unprotected_safe.html#TransferEvent">TransferEvent</a>
</li><li>
<a href="./unprotected_safe.html#UnprotectedSafe">UnprotectedSafe</a>
</li></ul>
</li><li>
<a href="./safe.html">safe</a>
<ul class="methods"><li>
<a href="./safe.html#OwnerCap">OwnerCap</a>
</li><li>
<a href="./safe.html#TransferCap">TransferCap</a>
</li><li>
<a href="./safe.html#Safe">Safe</a>
</li></ul>
</li><li>
<a href="./bidding.html">bidding</a>
<ul class="methods"><li>
<a href="./bidding.html#Witness">Witness</a>
</li><li>
<a href="./bidding.html#Bid">Bid</a>
</li><li>
<a href="./bidding.html#BidClosedEvent">BidClosedEvent</a>
</li><li>
<a href="./bidding.html#BidCreatedEvent">BidCreatedEvent</a>
</li><li>
<a href="./bidding.html#BidMatchedEvent">BidMatchedEvent</a>
</li></ul>
</li><li>
<a href="./collection.html">collection</a>
<ul class="methods"><li>
<a href="./collection.html#Collection">Collection</a>
</li><li>
<a href="./collection.html#MintCollectionEvent">MintCollectionEvent</a>
</li></ul>
</li><li>
<a href="./nft_bag.html">nft_bag</a>
<ul class="methods"><li>
<a href="./nft_bag.html#Witness">Witness</a>
</li><li>
<a href="./nft_bag.html#NftBagDomain">NftBagDomain</a>
</li></ul>
</li><li>
<a href="./composable_nft.html">composable_nft</a>
<ul class="methods"><li>
<a href="./composable_nft.html#Witness">Witness</a>
</li><li>
<a href="./composable_nft.html#Blueprint">Blueprint</a>
</li><li>
<a href="./composable_nft.html#Key">Key</a>
</li><li>
<a href="./composable_nft.html#Node">Node</a>
</li><li>
<a href="./composable_nft.html#Type">Type</a>
</li></ul>
</li><li>
<a href="./svg.html">svg</a>
<ul class="methods"><li>
<a href="./svg.html#Witness">Witness</a>
</li><li>
<a href="./svg.html#SvgDomain">SvgDomain</a>
</li></ul>
</li><li>
<a href="./composable_svg.html">composable_svg</a>
<ul class="methods"><li>
<a href="./composable_svg.html#Witness">Witness</a>
</li><li>
<a href="./composable_svg.html#ComposableSvgDomain">ComposableSvgDomain</a>
</li></ul>
</li><li>
<a href="./url.html">url</a>
<ul class="methods"><li>
<a href="./url.html#Witness">Witness</a>
</li><li>
<a href="./url.html#UrlDomain">UrlDomain</a>
</li></ul>
</li><li>
<a href="./composable_url.html">composable_url</a>
<ul class="methods"><li>
<a href="./composable_url.html#Witness">Witness</a>
</li><li>
<a href="./composable_url.html#ComposableUrlDomain">ComposableUrlDomain</a>
</li></ul>
</li><li>
<a href="./creators.html">creators</a>
<ul class="methods"><li>
<a href="./creators.html#Witness">Witness</a>
</li><li>
<a href="./creators.html#CreatorsDomain">CreatorsDomain</a>
</li></ul>
</li><li>
<a href="./display.html">display</a>
<ul class="methods"><li>
<a href="./display.html#Witness">Witness</a>
</li><li>
<a href="./display.html#CollectionIdDomain">CollectionIdDomain</a>
</li><li>
<a href="./display.html#DisplayDomain">DisplayDomain</a>
</li><li>
<a href="./display.html#SymbolDomain">SymbolDomain</a>
</li></ul>
</li><li>
<a href="./venue.html">venue</a>
<ul class="methods"><li>
<a href="./venue.html#Venue">Venue</a>
</li></ul>
</li><li>
<a href="./supply_domain.html">supply_domain</a>
<ul class="methods"><li>
<a href="./supply_domain.html#Witness">Witness</a>
</li><li>
<a href="./supply_domain.html#SupplyDomain">SupplyDomain</a>
</li></ul>
</li><li>
<a href="./warehouse.html">warehouse</a>
<ul class="methods"><li>
<a href="./warehouse.html#RedeemCommitment">RedeemCommitment</a>
</li><li>
<a href="./warehouse.html#Warehouse">Warehouse</a>
</li></ul>
</li><li>
<a href="./proceeds.html">proceeds</a>
<ul class="methods"><li>
<a href="./proceeds.html#Proceeds">Proceeds</a>
</li><li>
<a href="./proceeds.html#QtSold">QtSold</a>
</li></ul>
</li><li>
<a href="./marketplace.html">marketplace</a>
<ul class="methods"><li>
<a href="./marketplace.html#Marketplace">Marketplace</a>
</li></ul>
</li><li>
<a href="./loose_mint_cap.html">loose_mint_cap</a>
<ul class="methods"><li>
<a href="./loose_mint_cap.html#LooseMintCap">LooseMintCap</a>
</li><li>
<a href="./loose_mint_cap.html#PointerDomain">PointerDomain</a>
</li></ul>
</li><li>
<a href="./metadata.html">metadata</a>
<ul class="methods"><li>
<a href="./metadata.html#Metadata">Metadata</a>
</li></ul>
</li><li>
<a href="./metadata_bag.html">metadata_bag</a>
<ul class="methods"><li>
<a href="./metadata_bag.html#Witness">Witness</a>
</li><li>
<a href="./metadata_bag.html#MetadataBagDomain">MetadataBagDomain</a>
</li></ul>
</li><li>
<a href="./factory.html">factory</a>
<ul class="methods"><li>
<a href="./factory.html#Factory">Factory</a>
</li></ul>
</li><li>
<a href="./inventory.html">inventory</a>
<ul class="methods"><li>
<a href="./inventory.html#Witness">Witness</a>
</li><li>
<a href="./inventory.html#Inventory">Inventory</a>
</li></ul>
</li><li>
<a href="./listing.html">listing</a>
<ul class="methods"><li>
<a href="./listing.html#CreateListingEvent">CreateListingEvent</a>
</li><li>
<a href="./listing.html#DeleteListingEvent">DeleteListingEvent</a>
</li><li>
<a href="./listing.html#Listing">Listing</a>
</li><li>
<a href="./listing.html#NftSoldEvent">NftSoldEvent</a>
</li><li>
<a href="./listing.html#RequestToJoin">RequestToJoin</a>
</li></ul>
</li><li>
<a href="./market_whitelist.html">market_whitelist</a>
<ul class="methods"><li>
<a href="./market_whitelist.html#Certificate">Certificate</a>
</li></ul>
</li><li>
<a href="./dutch_auction.html">dutch_auction</a>
<ul class="methods"><li>
<a href="./dutch_auction.html#Witness">Witness</a>
</li><li>
<a href="./dutch_auction.html#Bid">Bid</a>
</li><li>
<a href="./dutch_auction.html#DutchAuctionMarket">DutchAuctionMarket</a>
</li></ul>
</li><li>
<a href="./fixed_price.html">fixed_price</a>
<ul class="methods"><li>
<a href="./fixed_price.html#Witness">Witness</a>
</li><li>
<a href="./fixed_price.html#FixedPriceMarket">FixedPriceMarket</a>
</li></ul>
</li><li>
<a href="./flat_fee.html">flat_fee</a>
<ul class="methods"><li>
<a href="./flat_fee.html#FlatFee">FlatFee</a>
</li></ul>
</li><li>
<a href="./limited_fixed_price.html">limited_fixed_price</a>
<ul class="methods"><li>
<a href="./limited_fixed_price.html#Witness">Witness</a>
</li><li>
<a href="./limited_fixed_price.html#LimitedFixedPriceMarket">LimitedFixedPriceMarket</a>
</li></ul>
</li><li>
<a href="./modify.html">modify</a>
<ul class="methods"><li>
<a href="./modify.html#ModifyDomain">ModifyDomain</a>
</li></ul>
</li><li>
<a href="./orderbook.html">orderbook</a>
<ul class="methods"><li>
<a href="./orderbook.html#Witness">Witness</a>
</li><li>
<a href="./orderbook.html#Bid">Bid</a>
</li><li>
<a href="./orderbook.html#BidClosedEvent">BidClosedEvent</a>
</li><li>
<a href="./orderbook.html#BidCreatedEvent">BidCreatedEvent</a>
</li><li>
<a href="./orderbook.html#Ask">Ask</a>
</li><li>
<a href="./orderbook.html#AskClosedEvent">AskClosedEvent</a>
</li><li>
<a href="./orderbook.html#AskCreatedEvent">AskCreatedEvent</a>
</li><li>
<a href="./orderbook.html#Orderbook">Orderbook</a>
</li><li>
<a href="./orderbook.html#OrderbookCreatedEvent">OrderbookCreatedEvent</a>
</li><li>
<a href="./orderbook.html#TradeFilledEvent">TradeFilledEvent</a>
</li><li>
<a href="./orderbook.html#TradeIntermediate">TradeIntermediate</a>
</li><li>
<a href="./orderbook.html#WitnessProtectedActions">WitnessProtectedActions</a>
</li></ul>
</li><li>
<a href="./plugins.html">plugins</a>
<ul class="methods"><li>
<a href="./plugins.html#Witness">Witness</a>
</li><li>
<a href="./plugins.html#PluginDomain">PluginDomain</a>
</li></ul>
</li><li>
<a href="./royalty_strategy_constant.html">royalty_strategy_constant</a>
<ul class="methods"><li>
<a href="./royalty_strategy_constant.html#ConstantRoyaltyStrategy">ConstantRoyaltyStrategy</a>
</li></ul>
</li><li>
<a href="./royalty_strategy_bps.html">royalty_strategy_bps</a>
<ul class="methods"><li>
<a href="./royalty_strategy_bps.html#BpsRoyaltyStrategy">BpsRoyaltyStrategy</a>
</li></ul>
</li><li>
<a href="./royalty.html">royalty</a>
<ul class="methods"><li>
<a href="./royalty.html#Witness">Witness</a>
</li><li>
<a href="./royalty.html#RoyaltyDomain">RoyaltyDomain</a>
</li></ul>
</li><li>
<a href="./tags.html">tags</a>
<ul class="methods"><li>
<a href="./tags.html#Witness">Witness</a>
</li><li>
<a href="./tags.html#Art">Art</a>
</li><li>
<a href="./tags.html#Collectible">Collectible</a>
</li><li>
<a href="./tags.html#DomainName">DomainName</a>
</li><li>
<a href="./tags.html#GameAsset">GameAsset</a>
</li><li>
<a href="./tags.html#License">License</a>
</li><li>
<a href="./tags.html#Music">Music</a>
</li><li>
<a href="./tags.html#ProfilePicture">ProfilePicture</a>
</li><li>
<a href="./tags.html#TagDomain">TagDomain</a>
</li><li>
<a href="./tags.html#Ticker">Ticker</a>
</li><li>
<a href="./tags.html#Ticket">Ticket</a>
</li><li>
<a href="./tags.html#TokenisedAsset">TokenisedAsset</a>
</li><li>
<a href="./tags.html#Video">Video</a>
</li></ul>
</li><li>
<a href="./transfer_allowlist_domain.html">transfer_allowlist_domain</a>
<ul class="methods"><li>
<a href="./transfer_allowlist_domain.html#Witness">Witness</a>
</li><li>
<a href="./transfer_allowlist_domain.html#TransferAllowlistDomain">TransferAllowlistDomain</a>
</li></ul>
</li></ul></nav>
<main>
<nav>
<form>
<input id="search-input" name="search" aria-label="Search the documentation" autocomplete="off" spellcheck="false" placeholder="Click to search" type="search">
</form>
</nav>
<section id="main-content"><h1>0x0::orderbook</h1>
<article>
<p>Orderbook where bids are fungible tokens and asks are NFTs.
A bid is a request to buy one NFT from a specific collection.
An ask is one NFT with a min price condition.</p>
<p>One can</p>
<ul>
<li>create a new orderbook between a given collection and a bid token;</li>
<li>set publicly accessible actions to be witness protected;</li>
<li>open a new bid;</li>
<li>cancel an existing bid they own;</li>
<li>offer an NFT if collection matches OB collection;</li>
<li>cancel an existing NFT offer;</li>
<li>instantly buy a specific NFT;</li>
<li>open bids and asks with a commission on behalf of a user;</li>
<li>trade both native and 3rd party collections.</li>
</ul>
<h1>Other resources</h1>
<ul>
<li>https://docs.originbyte.io/origin-byte/about-our-programs/liquidity-layer/orderbook</li>
<li>https://origin-byte.github.io/ob.html</li>
</ul>
<h2>Structs</h2>
<details class="toggle" open>
<summary>
<h3 class="code-header" id="Witness"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#Witness" class="hljs-type">Witness</a> has <span class="ability">drop</span><pre></h3>
</summary>
<div class="description">
<p>Witness used to authenticate witness protected endpoints</p>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="Orderbook"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#Orderbook" class="hljs-type">Orderbook</a><C, FT> has <span class="ability">key</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>id</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">UID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>protected_actions</code>
</td>
<td class="hljs-type">
<code><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#WitnessProtectedActions" class="hljs-type">WitnessProtectedActions</a></code>
</td>
<td class="description last"><p>Actions which have a flag set to true can only be called via a
witness protected implementation.</p>
</td>
</tr><tr>
<td class="name">
<code>asks</code>
</td>
<td class="hljs-type">
<code>crit_bit_u64::<span class="hljs-type">CB</span><<span class="hljs-type">vector<span><<a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#Ask" class="hljs-type">Ask</a>>></code>
</td>
<td class="description last"><p>An ask order stores an NFT to be traded. The price associated with
such an order is saying:</p>
<blockquote>
<p>for this NFT, I want to receive at least this amount of FT.</p>
</blockquote>
</td>
</tr><tr>
<td class="name">
<code>bids</code>
</td>
<td class="hljs-type">
<code>crit_bit_u64::<span class="hljs-type">CB</span><<span class="hljs-type">vector<span><<a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#Bid" class="hljs-type">Bid</a><FT>>></code>
</td>
<td class="description last"><p>A bid order stores amount of tokens of type "B"(id) to trade. A bid
order is saying:</p>
<blockquote>
<p>for any NFT in this collection, I will spare this many tokens</p>
</blockquote>
</td>
</tr></tbody>
</table>
<p>A critbit order book implementation. Contains two ordered trees:</p>
<ol>
<li>bids ASC</li>
<li>asks DESC</li>
</ol>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="WitnessProtectedActions"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#WitnessProtectedActions" class="hljs-type">WitnessProtectedActions</a> has <span class="ability">drop</span>, <span class="ability">store</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>buy_nft</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">bool</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>cancel_ask</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">bool</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>cancel_bid</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">bool</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>create_ask</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">bool</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>create_bid</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">bool</span></code>
</td>
<td class="description last"></td>
</tr></tbody>
</table>
<p>The contract which creates the orderbook can restrict specific actions
to be only callable with a witness pattern and not via the entry point
function.</p>
<p>This means contracts can build on top of this orderbook their custom
logic if they desire so, or they can just use the entry point functions
which might be good enough for most use cases.</p>
<h1>Important</h1>
<p>If a method is protected, then clients call instead of the relevant
endpoint in the orderbook a standardized endpoint in the witness-owning
smart contract.</p>
<p>Another way to think about this from marketplace or wallet POV:
If I see that an action is protected, I can decide to either call
the downstream implementation in the collection smart contract, or just
not enable to perform that specific action at all.</p>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="Bid"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#Bid" class="hljs-type">Bid</a><FT> has <span class="ability">store</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>offer</code>
</td>
<td class="hljs-type">
<code>balance::<span class="hljs-type">Balance</span><FT></code>
</td>
<td class="description last"><p>How many token are being offered by the order issuer for one NFT.</p>
</td>
</tr><tr>
<td class="name">
<code>owner</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">address</span></code>
</td>
<td class="description last"><p>The address of the user who created this bid and who will receive an
NFT in exchange for their tokens.</p>
</td>
</tr><tr>
<td class="name">
<code>safe</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"><p>Points to <code>Safe</code> shared object into which to deposit NFT.</p>
</td>
</tr><tr>
<td class="name">
<code>commission</code>
</td>
<td class="hljs-type">
<code>option::<span class="hljs-type">Option</span><<a href="./trading.html">trading</a>::<a href="./trading.html#BidCommission" class="hljs-type">BidCommission</a><FT>></code>
</td>
<td class="description last"><p>If the NFT is offered via a marketplace or a wallet, the
facilitator can optionally set how many tokens they want to claim
on top of the offer.</p>
</td>
</tr></tbody>
</table>
<p>An offer for a single NFT in a collection.</p>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="Ask"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#Ask" class="hljs-type">Ask</a> has <span class="ability">store</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>price</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">u64</span></code>
</td>
<td class="description last"><p>How many tokens does the seller want for their NFT in exchange.</p>
</td>
</tr><tr>
<td class="name">
<code>transfer_cap</code>
</td>
<td class="hljs-type">
<code><a href="./safe.html">safe</a>::<a href="./safe.html#TransferCap" class="hljs-type">TransferCap</a></code>
</td>
<td class="description last"><p>Capability to get an NFT from a safe.</p>
</td>
</tr><tr>
<td class="name">
<code>owner</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">address</span></code>
</td>
<td class="description last"><p>Who owns the NFT.</p>
</td>
</tr><tr>
<td class="name">
<code>commission</code>
</td>
<td class="hljs-type">
<code>option::<span class="hljs-type">Option</span><<a href="./trading.html">trading</a>::<a href="./trading.html#AskCommission" class="hljs-type">AskCommission</a>></code>
</td>
<td class="description last"><p>If the NFT is offered via a marketplace or a wallet, the
facilitator can optionally set how many tokens they want to claim
from the price of the NFT for themselves as a commission.</p>
</td>
</tr></tbody>
</table>
<p>Object which is associated with a single NFT.</p>
<p>When [<code>Ask</code>] is created, we transfer the ownership of the NFT to this
new object.
When an ask is matched with a bid, we transfer the ownership of the
[<code>Ask</code>] object to the bid owner (buyer).
The buyer can then claim the NFT via [<code>claim_nft</code>] endpoint.</p>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="TradeIntermediate"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#TradeIntermediate" class="hljs-type">TradeIntermediate</a><C, FT> has <span class="ability">key</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>id</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">UID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>transfer_cap</code>
</td>
<td class="hljs-type">
<code>option::<span class="hljs-type">Option</span><<a href="./safe.html">safe</a>::<a href="./safe.html#TransferCap" class="hljs-type">TransferCap</a>></code>
</td>
<td class="description last"><p>in option bcs we want to extract it but cannot destroy shared obj
in Sui yet</p>
<p>https://github.com/MystenLabs/sui/issues/2083</p>
</td>
</tr><tr>
<td class="name">
<code>seller</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">address</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>buyer</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">address</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>buyer_safe</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>paid</code>
</td>
<td class="hljs-type">
<code>balance::<span class="hljs-type">Balance</span><FT></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>commission</code>
</td>
<td class="hljs-type">
<code>option::<span class="hljs-type">Option</span><<a href="./trading.html">trading</a>::<a href="./trading.html#AskCommission" class="hljs-type">AskCommission</a>></code>
</td>
<td class="description last"></td>
</tr></tbody>
</table>
<p><code>TradeIntermediate</code> is made a shared object and can be called
permissionlessly.</p>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="OrderbookCreatedEvent"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#OrderbookCreatedEvent" class="hljs-type">OrderbookCreatedEvent</a> has <span class="ability">copy</span>, <span class="ability">drop</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>orderbook</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>nft_type</code>
</td>
<td class="hljs-type">
<code>ascii::<span class="hljs-type">String</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>ft_type</code>
</td>
<td class="hljs-type">
<code>ascii::<span class="hljs-type">String</span></code>
</td>
<td class="description last"></td>
</tr></tbody>
</table>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="AskCreatedEvent"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#AskCreatedEvent" class="hljs-type">AskCreatedEvent</a> has <span class="ability">copy</span>, <span class="ability">drop</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>nft</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>orderbook</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>owner</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">address</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>price</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">u64</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>safe</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>nft_type</code>
</td>
<td class="hljs-type">
<code>ascii::<span class="hljs-type">String</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>ft_type</code>
</td>
<td class="hljs-type">
<code>ascii::<span class="hljs-type">String</span></code>
</td>
<td class="description last"></td>
</tr></tbody>
</table>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="AskClosedEvent"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#AskClosedEvent" class="hljs-type">AskClosedEvent</a> has <span class="ability">copy</span>, <span class="ability">drop</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>nft</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>orderbook</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>owner</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">address</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>price</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">u64</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>nft_type</code>
</td>
<td class="hljs-type">
<code>ascii::<span class="hljs-type">String</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>ft_type</code>
</td>
<td class="hljs-type">
<code>ascii::<span class="hljs-type">String</span></code>
</td>
<td class="description last"></td>
</tr></tbody>
</table>
<p>When de-listed, not when sold!</p>
</div>
</details><details class="toggle" open>
<summary>
<h3 class="code-header" id="BidCreatedEvent"><pre><a href="./orderbook.html">orderbook</a>::<a href="./orderbook.html#BidCreatedEvent" class="hljs-type">BidCreatedEvent</a> has <span class="ability">copy</span>, <span class="ability">drop</span><pre></h3>
</summary>
<div class="description">
<h4>Fields:</h4>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody><tr>
<td class="name">
<code>orderbook</code>
</td>
<td class="hljs-type">
<code>object::<span class="hljs-type">ID</span></code>
</td>
<td class="description last"></td>
</tr><tr>
<td class="name">
<code>owner</code>
</td>
<td class="hljs-type">
<code><span class="hljs-type">address</span></code>
</td>
<td class="description last"></td>
</tr><tr>