/
UniqueRefungible.sol
805 lines (704 loc) · 34.1 KB
/
UniqueRefungible.sol
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
// SPDX-License-Identifier: OTHER
// This code is automatically generated
pragma solidity >=0.8.0 <0.9.0;
/// @dev common stubs holder
interface Dummy {
}
interface ERC165 is Dummy {
function supportsInterface(bytes4 interfaceID) external view returns (bool);
}
/// @dev inlined interface
interface ERC721TokenEvent {
event TokenChanged(uint256 indexed tokenId);
}
/// @title A contract that allows to set and delete token properties and change token property permissions.
/// @dev the ERC-165 identifier for this interface is 0xde0695c2
interface TokenProperties is Dummy, ERC165, ERC721TokenEvent {
// /// @notice Set permissions for token property.
// /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
// /// @param key Property key.
// /// @param isMutable Permission to mutate property.
// /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.
// /// @param tokenOwner Permission to mutate property by token owner if property is mutable.
// /// @dev EVM selector for this function is: 0x222d97fa,
// /// or in textual repr: setTokenPropertyPermission(string,bool,bool,bool)
// function setTokenPropertyPermission(string memory key, bool isMutable, bool collectionAdmin, bool tokenOwner) external;
/// @notice Set permissions for token property.
/// @dev Throws error if `msg.sender` is not admin or owner of the collection.
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
function setTokenPropertyPermissions(TokenPropertyPermission[] memory permissions) external;
/// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
function tokenPropertyPermissions() external view returns (TokenPropertyPermission[] memory);
// /// @notice Set token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
// /// @param tokenId ID of the token.
// /// @param key Property key.
// /// @param value Property value.
// /// @dev EVM selector for this function is: 0x1752d67b,
// /// or in textual repr: setProperty(uint256,string,bytes)
// function setProperty(uint256 tokenId, string memory key, bytes memory value) external;
/// @notice Set token properties value.
/// @dev Throws error if `msg.sender` has no permission to edit the property.
/// @param tokenId ID of the token.
/// @param properties settable properties
/// @dev EVM selector for this function is: 0x14ed3a6e,
/// or in textual repr: setProperties(uint256,(string,bytes)[])
function setProperties(uint256 tokenId, Property[] memory properties) external;
// /// @notice Delete token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
// /// @param tokenId ID of the token.
// /// @param key Property key.
// /// @dev EVM selector for this function is: 0x066111d1,
// /// or in textual repr: deleteProperty(uint256,string)
// function deleteProperty(uint256 tokenId, string memory key) external;
/// @notice Delete token properties value.
/// @dev Throws error if `msg.sender` has no permission to edit the property.
/// @param tokenId ID of the token.
/// @param keys Properties key.
/// @dev EVM selector for this function is: 0xc472d371,
/// or in textual repr: deleteProperties(uint256,string[])
function deleteProperties(uint256 tokenId, string[] memory keys) external;
/// @notice Get token property value.
/// @dev Throws error if key not found
/// @param tokenId ID of the token.
/// @param key Property key.
/// @return Property value bytes
/// @dev EVM selector for this function is: 0x7228c327,
/// or in textual repr: property(uint256,string)
function property(uint256 tokenId, string memory key) external view returns (bytes memory);
}
/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
}
/// Ethereum representation of Token Property Permissions.
struct TokenPropertyPermission {
/// Token property key.
string key;
/// Token property permissions.
PropertyPermission[] permissions;
}
/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
struct PropertyPermission {
/// TokenPermission field.
TokenPermissionField code;
/// TokenPermission value.
bool value;
}
/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum TokenPermissionField {
/// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
/// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
/// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
/// @title A contract that allows you to work with collections.
/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
// /// @param key Property key.
// /// @param value Propery value.
// /// @dev EVM selector for this function is: 0x2f073f66,
// /// or in textual repr: setCollectionProperty(string,bytes)
// function setCollectionProperty(string memory key, bytes memory value) external;
/// Set collection properties.
///
/// @param properties Vector of properties key/value pair.
/// @dev EVM selector for this function is: 0x50b26b2a,
/// or in textual repr: setCollectionProperties((string,bytes)[])
function setCollectionProperties(Property[] memory properties) external;
// /// Delete collection property.
// ///
// /// @param key Property key.
// /// @dev EVM selector for this function is: 0x7b7debce,
// /// or in textual repr: deleteCollectionProperty(string)
// function deleteCollectionProperty(string memory key) external;
/// Delete collection properties.
///
/// @param keys Properties keys.
/// @dev EVM selector for this function is: 0xee206ee3,
/// or in textual repr: deleteCollectionProperties(string[])
function deleteCollectionProperties(string[] memory keys) external;
/// Get collection property.
///
/// @dev Throws error if key not found.
///
/// @param key Property key.
/// @return bytes The property corresponding to the key.
/// @dev EVM selector for this function is: 0xcf24fd6d,
/// or in textual repr: collectionProperty(string)
function collectionProperty(string memory key) external view returns (bytes memory);
/// Get collection properties.
///
/// @param keys Properties keys. Empty keys for all propertyes.
/// @return Vector of properties key/value pairs.
/// @dev EVM selector for this function is: 0x285fb8e6,
/// or in textual repr: collectionProperties(string[])
function collectionProperties(string[] memory keys) external view returns (Property[] memory);
// /// Set the sponsor of the collection.
// ///
// /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.
// ///
// /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.
// /// @dev EVM selector for this function is: 0x7623402e,
// /// or in textual repr: setCollectionSponsor(address)
// function setCollectionSponsor(address sponsor) external;
/// Set the sponsor of the collection.
///
/// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.
///
/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.
/// @dev EVM selector for this function is: 0x84a1d5a8,
/// or in textual repr: setCollectionSponsorCross((address,uint256))
function setCollectionSponsorCross(CrossAddress memory sponsor) external;
/// Whether there is a pending sponsor.
/// @dev EVM selector for this function is: 0x058ac185,
/// or in textual repr: hasCollectionPendingSponsor()
function hasCollectionPendingSponsor() external view returns (bool);
/// Collection sponsorship confirmation.
///
/// @dev After setting the sponsor for the collection, it must be confirmed with this function.
/// @dev EVM selector for this function is: 0x3c50e97a,
/// or in textual repr: confirmCollectionSponsorship()
function confirmCollectionSponsorship() external;
/// Remove collection sponsor.
/// @dev EVM selector for this function is: 0x6e0326a3,
/// or in textual repr: removeCollectionSponsor()
function removeCollectionSponsor() external;
/// Get current sponsor.
///
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x6ec0a9f1,
/// or in textual repr: collectionSponsor()
function collectionSponsor() external view returns (CrossAddress memory);
/// Get current collection limits.
///
/// @return Array of collection limits
/// @dev EVM selector for this function is: 0xf63bc572,
/// or in textual repr: collectionLimits()
function collectionLimits() external view returns (CollectionLimit[] memory);
/// Set limits for the collection.
/// @dev Throws error if limit not found.
/// @param limit Some limit.
/// @dev EVM selector for this function is: 0x2316ee74,
/// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))
function setCollectionLimit(CollectionLimit memory limit) external;
/// Get contract address.
/// @dev EVM selector for this function is: 0xf6b4dfb4,
/// or in textual repr: contractAddress()
function contractAddress() external view returns (address);
/// Add collection admin.
/// @param newAdmin Cross account administrator address.
/// @dev EVM selector for this function is: 0x859aa7d6,
/// or in textual repr: addCollectionAdminCross((address,uint256))
function addCollectionAdminCross(CrossAddress memory newAdmin) external;
/// Remove collection admin.
/// @param admin Cross account administrator address.
/// @dev EVM selector for this function is: 0x6c0cd173,
/// or in textual repr: removeCollectionAdminCross((address,uint256))
function removeCollectionAdminCross(CrossAddress memory admin) external;
// /// Add collection admin.
// /// @param newAdmin Address of the added administrator.
// /// @dev EVM selector for this function is: 0x92e462c7,
// /// or in textual repr: addCollectionAdmin(address)
// function addCollectionAdmin(address newAdmin) external;
// /// Remove collection admin.
// ///
// /// @param admin Address of the removed administrator.
// /// @dev EVM selector for this function is: 0xfafd7b42,
// /// or in textual repr: removeCollectionAdmin(address)
// function removeCollectionAdmin(address admin) external;
/// Toggle accessibility of collection nesting.
///
/// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'
/// @dev EVM selector for this function is: 0x112d4586,
/// or in textual repr: setCollectionNesting(bool)
function setCollectionNesting(bool enable) external;
/// Toggle accessibility of collection nesting.
///
/// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'
/// @param collections Addresses of collections that will be available for nesting.
/// @dev EVM selector for this function is: 0x64872396,
/// or in textual repr: setCollectionNesting(bool,address[])
function setCollectionNesting(bool enable, address[] memory collections) external;
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
function collectionNestingRestrictedCollectionIds() external view returns (CollectionNesting memory);
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
function collectionNestingPermissions() external view returns (CollectionNestingPermission[] memory);
/// Set the collection access method.
/// @param mode Access mode
/// @dev EVM selector for this function is: 0x41835d4c,
/// or in textual repr: setCollectionAccess(uint8)
function setCollectionAccess(AccessMode mode) external;
/// Checks that user allowed to operate with collection.
///
/// @param user User address to check.
/// @dev EVM selector for this function is: 0x91b6df49,
/// or in textual repr: allowlistedCross((address,uint256))
function allowlistedCross(CrossAddress memory user) external view returns (bool);
// /// Add the user to the allowed list.
// ///
// /// @param user Address of a trusted user.
// /// @dev EVM selector for this function is: 0x67844fe6,
// /// or in textual repr: addToCollectionAllowList(address)
// function addToCollectionAllowList(address user) external;
/// Add user to allowed list.
///
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0xa0184a3a,
/// or in textual repr: addToCollectionAllowListCross((address,uint256))
function addToCollectionAllowListCross(CrossAddress memory user) external;
// /// Remove the user from the allowed list.
// ///
// /// @param user Address of a removed user.
// /// @dev EVM selector for this function is: 0x85c51acb,
// /// or in textual repr: removeFromCollectionAllowList(address)
// function removeFromCollectionAllowList(address user) external;
/// Remove user from allowed list.
///
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0x09ba452a,
/// or in textual repr: removeFromCollectionAllowListCross((address,uint256))
function removeFromCollectionAllowListCross(CrossAddress memory user) external;
/// Switch permission for minting.
///
/// @param mode Enable if "true".
/// @dev EVM selector for this function is: 0x00018e84,
/// or in textual repr: setCollectionMintMode(bool)
function setCollectionMintMode(bool mode) external;
// /// Check that account is the owner or admin of the collection
// ///
// /// @param user account to verify
// /// @return "true" if account is the owner or admin
// /// @dev EVM selector for this function is: 0x9811b0c7,
// /// or in textual repr: isOwnerOrAdmin(address)
// function isOwnerOrAdmin(address user) external view returns (bool);
/// Check that account is the owner or admin of the collection
///
/// @param user User cross account to verify
/// @return "true" if account is the owner or admin
/// @dev EVM selector for this function is: 0x3e75a905,
/// or in textual repr: isOwnerOrAdminCross((address,uint256))
function isOwnerOrAdminCross(CrossAddress memory user) external view returns (bool);
/// Returns collection type
///
/// @return `Fungible` or `NFT` or `ReFungible`
/// @dev EVM selector for this function is: 0xd34b55b8,
/// or in textual repr: uniqueCollectionType()
function uniqueCollectionType() external view returns (string memory);
/// Get collection owner.
///
/// @return Tuble with sponsor address and his substrate mirror.
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0xdf727d3b,
/// or in textual repr: collectionOwner()
function collectionOwner() external view returns (CrossAddress memory);
// /// Changes collection owner to another account
// ///
// /// @dev Owner can be changed only by current owner
// /// @param newOwner new owner account
// /// @dev EVM selector for this function is: 0x4f53e226,
// /// or in textual repr: changeCollectionOwner(address)
// function changeCollectionOwner(address newOwner) external;
/// Get collection administrators
///
/// @return Vector of tuples with admins address and his substrate mirror.
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0x5813216b,
/// or in textual repr: collectionAdmins()
function collectionAdmins() external view returns (CrossAddress[] memory);
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
/// @param newOwner new owner cross account
/// @dev EVM selector for this function is: 0x6496c497,
/// or in textual repr: changeCollectionOwnerCross((address,uint256))
function changeCollectionOwnerCross(CrossAddress memory newOwner) external;
}
/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
enum AccessMode {
/// Access grant for owner and admins. Used as default.
Normal,
/// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
AllowList
}
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
bool value;
}
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissionField {
/// Owner of token can nest tokens under it.
TokenOwner,
/// Admin of token collection can nest tokens under token.
CollectionAdmin
}
/// Nested collections.
struct CollectionNesting {
bool token_owner;
uint256[] ids;
}
/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
struct CollectionLimit {
CollectionLimitField field;
OptionUint256 value;
}
/// Optional value
struct OptionUint256 {
/// Shows the status of accessibility of value
bool status;
/// Actual value if `status` is true
uint256 value;
}
/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
enum CollectionLimitField {
/// How many tokens can a user have on one account.
AccountTokenOwnership,
/// How many bytes of data are available for sponsorship.
SponsoredDataSize,
/// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
SponsoredDataRateLimit,
/// How many tokens can be mined into this collection.
TokenLimit,
/// Timeouts for transfer sponsoring.
SponsorTransferTimeout,
/// Timeout for sponsoring an approval in passed blocks.
SponsorApproveTimeout,
/// Whether the collection owner of the collection can send tokens (which belong to other users).
OwnerCanTransfer,
/// Can the collection owner burn other people's tokens.
OwnerCanDestroy,
/// Is it possible to send tokens from this collection between users.
TransferEnabled
}
/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension
/// @dev See https://eips.ethereum.org/EIPS/eip-721
/// @dev the ERC-165 identifier for this interface is 0x5b5e139f
interface ERC721Metadata is Dummy, ERC165 {
// /// @notice A descriptive name for a collection of NFTs in this contract
// /// @dev real implementation of this function lies in `ERC721UniqueExtensions`
// /// @dev EVM selector for this function is: 0x06fdde03,
// /// or in textual repr: name()
// function name() external view returns (string memory);
// /// @notice An abbreviated name for NFTs in this contract
// /// @dev real implementation of this function lies in `ERC721UniqueExtensions`
// /// @dev EVM selector for this function is: 0x95d89b41,
// /// or in textual repr: symbol()
// function symbol() external view returns (string memory);
/// @notice A distinct Uniform Resource Identifier (URI) for a given asset.
///
/// @dev If the token has a `url` property and it is not empty, it is returned.
/// Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.
/// If the collection property `baseURI` is empty or absent, return "" (empty string)
/// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix
/// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).
///
/// @return token's const_metadata
/// @dev EVM selector for this function is: 0xc87b56dd,
/// or in textual repr: tokenURI(uint256)
function tokenURI(uint256 tokenId) external view returns (string memory);
}
/// @title ERC721 Token that can be irreversibly burned (destroyed).
/// @dev the ERC-165 identifier for this interface is 0x42966c68
interface ERC721Burnable is Dummy, ERC165 {
/// @notice Burns a specific ERC721 token.
/// @dev Throws unless `msg.sender` is the current RFT owner, or an authorized
/// operator of the current owner.
/// @param tokenId The RFT to approve
/// @dev EVM selector for this function is: 0x42966c68,
/// or in textual repr: burn(uint256)
function burn(uint256 tokenId) external;
}
/// @title ERC721 minting logic.
/// @dev the ERC-165 identifier for this interface is 0x3fd94ea6
interface ERC721UniqueMintable is Dummy, ERC165 {
/// @notice Function to mint a token.
/// @param to The new owner
/// @return uint256 The id of the newly minted token
/// @dev EVM selector for this function is: 0x6a627842,
/// or in textual repr: mint(address)
function mint(address to) external returns (uint256);
// /// @notice Function to mint a token.
// /// @dev `tokenId` should be obtained with `nextTokenId` method,
// /// unlike standard, you can't specify it manually
// /// @param to The new owner
// /// @param tokenId ID of the minted RFT
// /// @dev EVM selector for this function is: 0x40c10f19,
// /// or in textual repr: mint(address,uint256)
// function mint(address to, uint256 tokenId) external returns (bool);
/// @notice Function to mint token with the given tokenUri.
/// @param to The new owner
/// @param tokenUri Token URI that would be stored in the NFT properties
/// @return uint256 The id of the newly minted token
/// @dev EVM selector for this function is: 0x45c17782,
/// or in textual repr: mintWithTokenURI(address,string)
function mintWithTokenURI(address to, string memory tokenUri) external returns (uint256);
// /// @notice Function to mint token with the given tokenUri.
// /// @dev `tokenId` should be obtained with `nextTokenId` method,
// /// unlike standard, you can't specify it manually
// /// @param to The new owner
// /// @param tokenId ID of the minted RFT
// /// @param tokenUri Token URI that would be stored in the RFT properties
// /// @dev EVM selector for this function is: 0x50bb4e7f,
// /// or in textual repr: mintWithTokenURI(address,uint256,string)
// function mintWithTokenURI(address to, uint256 tokenId, string memory tokenUri) external returns (bool);
}
/// @title Unique extensions for ERC721.
/// @dev the ERC-165 identifier for this interface is 0xb365c124
interface ERC721UniqueExtensions is Dummy, ERC165 {
/// @notice A descriptive name for a collection of NFTs in this contract
/// @dev EVM selector for this function is: 0x06fdde03,
/// or in textual repr: name()
function name() external view returns (string memory);
/// @notice An abbreviated name for NFTs in this contract
/// @dev EVM selector for this function is: 0x95d89b41,
/// or in textual repr: symbol()
function symbol() external view returns (string memory);
/// @notice A description for the collection.
/// @dev EVM selector for this function is: 0x7284e416,
/// or in textual repr: description()
function description() external view returns (string memory);
/// Returns the owner (in cross format) of the token.
///
/// @param tokenId Id for the token.
/// @dev EVM selector for this function is: 0x2b29dace,
/// or in textual repr: crossOwnerOf(uint256)
function crossOwnerOf(uint256 tokenId) external view returns (CrossAddress memory);
/// Returns the token properties.
///
/// @param tokenId Id for the token.
/// @param keys Properties keys. Empty keys for all propertyes.
/// @return Vector of properties key/value pairs.
/// @dev EVM selector for this function is: 0xe07ede7e,
/// or in textual repr: properties(uint256,string[])
function properties(uint256 tokenId, string[] memory keys) external view returns (Property[] memory);
/// @notice Transfer ownership of an RFT
/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
/// is the zero address. Throws if `tokenId` is not a valid RFT.
/// Throws if RFT pieces have multiple owners.
/// @param to The new owner
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0xa9059cbb,
/// or in textual repr: transfer(address,uint256)
function transfer(address to, uint256 tokenId) external;
/// @notice Transfer ownership of an RFT
/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
/// is the zero address. Throws if `tokenId` is not a valid RFT.
/// Throws if RFT pieces have multiple owners.
/// @param to The new owner
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
function transferCross(CrossAddress memory to, uint256 tokenId) external;
/// @notice Transfer ownership of an RFT
/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
/// is the zero address. Throws if `tokenId` is not a valid RFT.
/// Throws if RFT pieces have multiple owners.
/// @param to The new owner
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
CrossAddress memory from,
CrossAddress memory to,
uint256 tokenId
) external;
// /// @notice Burns a specific ERC721 token.
// /// @dev Throws unless `msg.sender` is the current owner or an authorized
// /// operator for this RFT. Throws if `from` is not the current owner. Throws
// /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.
// /// Throws if RFT pieces have multiple owners.
// /// @param from The current owner of the RFT
// /// @param tokenId The RFT to transfer
// /// @dev EVM selector for this function is: 0x79cc6790,
// /// or in textual repr: burnFrom(address,uint256)
// function burnFrom(address from, uint256 tokenId) external;
/// @notice Burns a specific ERC721 token.
/// @dev Throws unless `msg.sender` is the current owner or an authorized
/// operator for this RFT. Throws if `from` is not the current owner. Throws
/// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.
/// Throws if RFT pieces have multiple owners.
/// @param from The current owner of the RFT
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
function burnFromCross(CrossAddress memory from, uint256 tokenId) external;
/// @notice Returns next free RFT ID.
/// @dev EVM selector for this function is: 0x75794a3c,
/// or in textual repr: nextTokenId()
function nextTokenId() external view returns (uint256);
// /// @notice Function to mint multiple tokens.
// /// @dev `tokenIds` should be an array of consecutive numbers and first number
// /// should be obtained with `nextTokenId` method
// /// @param to The new owner
// /// @param tokenIds IDs of the minted RFTs
// /// @dev EVM selector for this function is: 0x44a9945e,
// /// or in textual repr: mintBulk(address,uint256[])
// function mintBulk(address to, uint256[] memory tokenIds) external returns (bool);
// /// @notice Function to mint multiple tokens with the given tokenUris.
// /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive
// /// numbers and first number should be obtained with `nextTokenId` method
// /// @param to The new owner
// /// @param tokens array of pairs of token ID and token URI for minted tokens
// /// @dev EVM selector for this function is: 0x36543006,
// /// or in textual repr: mintBulkWithTokenURI(address,(uint256,string)[])
// function mintBulkWithTokenURI(address to, TokenUri[] memory tokens) external returns (bool);
/// @notice Function to mint a token.
/// @param to The new owner crossAccountId
/// @param properties Properties of minted token
/// @return uint256 The id of the newly minted token
/// @dev EVM selector for this function is: 0xb904db03,
/// or in textual repr: mintCross((address,uint256),(string,bytes)[])
function mintCross(CrossAddress memory to, Property[] memory properties) external returns (uint256);
/// Returns EVM address for refungible token
///
/// @param token ID of the token
/// @dev EVM selector for this function is: 0xab76fac6,
/// or in textual repr: tokenContractAddress(uint256)
function tokenContractAddress(uint256 token) external view returns (address);
/// @notice Returns collection helper contract address
/// @dev EVM selector for this function is: 0x1896cce6,
/// or in textual repr: collectionHelperAddress()
function collectionHelperAddress() external view returns (address);
}
/// Data for creation token with uri.
struct TokenUri {
/// Id of new token.
uint256 id;
/// Uri of new token.
string uri;
}
/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
/// @dev See https://eips.ethereum.org/EIPS/eip-721
/// @dev the ERC-165 identifier for this interface is 0x780e9d63
interface ERC721Enumerable is Dummy, ERC165 {
/// @notice Enumerate valid RFTs
/// @param index A counter less than `totalSupply()`
/// @return The token identifier for the `index`th NFT,
/// (sort order not specified)
/// @dev EVM selector for this function is: 0x4f6ccce7,
/// or in textual repr: tokenByIndex(uint256)
function tokenByIndex(uint256 index) external view returns (uint256);
/// Not implemented
/// @dev EVM selector for this function is: 0x2f745c59,
/// or in textual repr: tokenOfOwnerByIndex(address,uint256)
function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);
/// @notice Count RFTs tracked by this contract
/// @return A count of valid RFTs tracked by this contract, where each one of
/// them has an assigned and queryable owner not equal to the zero address
/// @dev EVM selector for this function is: 0x18160ddd,
/// or in textual repr: totalSupply()
function totalSupply() external view returns (uint256);
}
/// @dev inlined interface
interface ERC721Events {
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
}
/// @title ERC-721 Non-Fungible Token Standard
/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md
/// @dev the ERC-165 identifier for this interface is 0x80ac58cd
interface ERC721 is Dummy, ERC165, ERC721Events {
/// @notice Count all RFTs assigned to an owner
/// @dev RFTs assigned to the zero address are considered invalid, and this
/// function throws for queries about the zero address.
/// @param owner An address for whom to query the balance
/// @return The number of RFTs owned by `owner`, possibly zero
/// @dev EVM selector for this function is: 0x70a08231,
/// or in textual repr: balanceOf(address)
function balanceOf(address owner) external view returns (uint256);
/// @notice Find the owner of an RFT
/// @dev RFTs assigned to zero address are considered invalid, and queries
/// about them do throw.
/// Returns special 0xffffffffffffffffffffffffffffffffffffffff address for
/// the tokens that are partially owned.
/// @param tokenId The identifier for an RFT
/// @return The address of the owner of the RFT
/// @dev EVM selector for this function is: 0x6352211e,
/// or in textual repr: ownerOf(uint256)
function ownerOf(uint256 tokenId) external view returns (address);
/// @dev Not implemented
/// @dev EVM selector for this function is: 0xb88d4fde,
/// or in textual repr: safeTransferFrom(address,address,uint256,bytes)
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes memory data
) external;
/// @dev Not implemented
/// @dev EVM selector for this function is: 0x42842e0e,
/// or in textual repr: safeTransferFrom(address,address,uint256)
function safeTransferFrom(
address from,
address to,
uint256 tokenId
) external;
/// @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE
/// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
/// THEY MAY BE PERMANENTLY LOST
/// @dev Throws unless `msg.sender` is the current owner or an authorized
/// operator for this RFT. Throws if `from` is not the current owner. Throws
/// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.
/// Throws if RFT pieces have multiple owners.
/// @param from The current owner of the NFT
/// @param to The new owner
/// @param tokenId The NFT to transfer
/// @dev EVM selector for this function is: 0x23b872dd,
/// or in textual repr: transferFrom(address,address,uint256)
function transferFrom(
address from,
address to,
uint256 tokenId
) external;
/// @dev Not implemented
/// @dev EVM selector for this function is: 0x095ea7b3,
/// or in textual repr: approve(address,uint256)
function approve(address approved, uint256 tokenId) external;
/// @notice Sets or unsets the approval of a given operator.
/// The `operator` is allowed to transfer all token pieces of the `caller` on their behalf.
/// @param operator Operator
/// @param approved Should operator status be granted or revoked?
/// @dev EVM selector for this function is: 0xa22cb465,
/// or in textual repr: setApprovalForAll(address,bool)
function setApprovalForAll(address operator, bool approved) external;
/// @dev Not implemented
/// @dev EVM selector for this function is: 0x081812fc,
/// or in textual repr: getApproved(uint256)
function getApproved(uint256 tokenId) external view returns (address);
/// @notice Tells whether the given `owner` approves the `operator`.
/// @dev EVM selector for this function is: 0xe985e9c5,
/// or in textual repr: isApprovedForAll(address,address)
function isApprovedForAll(address owner, address operator) external view returns (bool);
}
interface UniqueRefungible is
Dummy,
ERC165,
ERC721,
ERC721Enumerable,
ERC721UniqueExtensions,
ERC721UniqueMintable,
ERC721Burnable,
ERC721Metadata,
Collection,
TokenProperties
{}