git.delta.rocks / unique-network / refs/commits / 2e3b6c3dad3e

difftreelog

source

tests/src/eth/api/UniqueFungible.sol18.9 KiBsourcehistory
1// SPDX-License-Identifier: OTHER2// This code is automatically generated34pragma solidity >=0.8.0 <0.9.0;56/// @dev common stubs holder7interface Dummy {89}1011interface ERC165 is Dummy {12	function supportsInterface(bytes4 interfaceID) external view returns (bool);13}1415/// @title A contract that allows you to work with collections.16/// @dev the ERC-165 identifier for this interface is 0x2a14cfd117interface Collection is Dummy, ERC165 {18	// /// Set collection property.19	// ///20	// /// @param key Property key.21	// /// @param value Propery value.22	// /// @dev EVM selector for this function is: 0x2f073f66,23	// ///  or in textual repr: setCollectionProperty(string,bytes)24	// function setCollectionProperty(string memory key, bytes memory value) external;2526	/// Set collection properties.27	///28	/// @param properties Vector of properties key/value pair.29	/// @dev EVM selector for this function is: 0x50b26b2a,30	///  or in textual repr: setCollectionProperties((string,bytes)[])31	function setCollectionProperties(Property[] memory properties) external;3233	// /// Delete collection property.34	// ///35	// /// @param key Property key.36	// /// @dev EVM selector for this function is: 0x7b7debce,37	// ///  or in textual repr: deleteCollectionProperty(string)38	// function deleteCollectionProperty(string memory key) external;3940	/// Delete collection properties.41	///42	/// @param keys Properties keys.43	/// @dev EVM selector for this function is: 0xee206ee3,44	///  or in textual repr: deleteCollectionProperties(string[])45	function deleteCollectionProperties(string[] memory keys) external;4647	/// Get collection property.48	///49	/// @dev Throws error if key not found.50	///51	/// @param key Property key.52	/// @return bytes The property corresponding to the key.53	/// @dev EVM selector for this function is: 0xcf24fd6d,54	///  or in textual repr: collectionProperty(string)55	function collectionProperty(string memory key) external view returns (bytes memory);5657	/// Get collection properties.58	///59	/// @param keys Properties keys. Empty keys for all propertyes.60	/// @return Vector of properties key/value pairs.61	/// @dev EVM selector for this function is: 0x285fb8e6,62	///  or in textual repr: collectionProperties(string[])63	function collectionProperties(string[] memory keys) external view returns (Property[] memory);6465	// /// Set the sponsor of the collection.66	// ///67	// /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.68	// ///69	// /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.70	// /// @dev EVM selector for this function is: 0x7623402e,71	// ///  or in textual repr: setCollectionSponsor(address)72	// function setCollectionSponsor(address sponsor) external;7374	/// Set the sponsor of the collection.75	///76	/// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.77	///78	/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.79	/// @dev EVM selector for this function is: 0x84a1d5a8,80	///  or in textual repr: setCollectionSponsorCross((address,uint256))81	function setCollectionSponsorCross(CrossAddress memory sponsor) external;8283	/// Whether there is a pending sponsor.84	/// @dev EVM selector for this function is: 0x058ac185,85	///  or in textual repr: hasCollectionPendingSponsor()86	function hasCollectionPendingSponsor() external view returns (bool);8788	/// Collection sponsorship confirmation.89	///90	/// @dev After setting the sponsor for the collection, it must be confirmed with this function.91	/// @dev EVM selector for this function is: 0x3c50e97a,92	///  or in textual repr: confirmCollectionSponsorship()93	function confirmCollectionSponsorship() external;9495	/// Remove collection sponsor.96	/// @dev EVM selector for this function is: 0x6e0326a3,97	///  or in textual repr: removeCollectionSponsor()98	function removeCollectionSponsor() external;99100	/// Get current sponsor.101	///102	/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.103	/// @dev EVM selector for this function is: 0x6ec0a9f1,104	///  or in textual repr: collectionSponsor()105	function collectionSponsor() external view returns (CrossAddress memory);106107	/// Get current collection limits.108	///109	/// @return Array of collection limits110	/// @dev EVM selector for this function is: 0xf63bc572,111	///  or in textual repr: collectionLimits()112	function collectionLimits() external view returns (CollectionLimit[] memory);113114	/// Set limits for the collection.115	/// @dev Throws error if limit not found.116	/// @param limit Some limit.117	/// @dev EVM selector for this function is: 0x2316ee74,118	///  or in textual repr: setCollectionLimit((uint8,(bool,uint256)))119	function setCollectionLimit(CollectionLimit memory limit) external;120121	/// Get contract address.122	/// @dev EVM selector for this function is: 0xf6b4dfb4,123	///  or in textual repr: contractAddress()124	function contractAddress() external view returns (address);125126	/// Add collection admin.127	/// @param newAdmin Cross account administrator address.128	/// @dev EVM selector for this function is: 0x859aa7d6,129	///  or in textual repr: addCollectionAdminCross((address,uint256))130	function addCollectionAdminCross(CrossAddress memory newAdmin) external;131132	/// Remove collection admin.133	/// @param admin Cross account administrator address.134	/// @dev EVM selector for this function is: 0x6c0cd173,135	///  or in textual repr: removeCollectionAdminCross((address,uint256))136	function removeCollectionAdminCross(CrossAddress memory admin) external;137138	// /// Add collection admin.139	// /// @param newAdmin Address of the added administrator.140	// /// @dev EVM selector for this function is: 0x92e462c7,141	// ///  or in textual repr: addCollectionAdmin(address)142	// function addCollectionAdmin(address newAdmin) external;143144	// /// Remove collection admin.145	// ///146	// /// @param admin Address of the removed administrator.147	// /// @dev EVM selector for this function is: 0xfafd7b42,148	// ///  or in textual repr: removeCollectionAdmin(address)149	// function removeCollectionAdmin(address admin) external;150151	/// Toggle accessibility of collection nesting.152	///153	/// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'154	/// @dev EVM selector for this function is: 0x112d4586,155	///  or in textual repr: setCollectionNesting(bool)156	function setCollectionNesting(bool enable) external;157158	/// Toggle accessibility of collection nesting.159	///160	/// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'161	/// @param collections Addresses of collections that will be available for nesting.162	/// @dev EVM selector for this function is: 0x64872396,163	///  or in textual repr: setCollectionNesting(bool,address[])164	function setCollectionNesting(bool enable, address[] memory collections) external;165166	/// Returns nesting for a collection167	/// @dev EVM selector for this function is: 0x22d25bfe,168	///  or in textual repr: collectionNestingRestrictedCollectionIds()169	function collectionNestingRestrictedCollectionIds() external view returns (CollectionNesting memory);170171	/// Returns permissions for a collection172	/// @dev EVM selector for this function is: 0x5b2eaf4b,173	///  or in textual repr: collectionNestingPermissions()174	function collectionNestingPermissions() external view returns (CollectionNestingPermission[] memory);175176	/// Set the collection access method.177	/// @param mode Access mode178	/// @dev EVM selector for this function is: 0x41835d4c,179	///  or in textual repr: setCollectionAccess(uint8)180	function setCollectionAccess(AccessMode mode) external;181182	/// Checks that user allowed to operate with collection.183	///184	/// @param user User address to check.185	/// @dev EVM selector for this function is: 0x91b6df49,186	///  or in textual repr: allowlistedCross((address,uint256))187	function allowlistedCross(CrossAddress memory user) external view returns (bool);188189	// /// Add the user to the allowed list.190	// ///191	// /// @param user Address of a trusted user.192	// /// @dev EVM selector for this function is: 0x67844fe6,193	// ///  or in textual repr: addToCollectionAllowList(address)194	// function addToCollectionAllowList(address user) external;195196	/// Add user to allowed list.197	///198	/// @param user User cross account address.199	/// @dev EVM selector for this function is: 0xa0184a3a,200	///  or in textual repr: addToCollectionAllowListCross((address,uint256))201	function addToCollectionAllowListCross(CrossAddress memory user) external;202203	// /// Remove the user from the allowed list.204	// ///205	// /// @param user Address of a removed user.206	// /// @dev EVM selector for this function is: 0x85c51acb,207	// ///  or in textual repr: removeFromCollectionAllowList(address)208	// function removeFromCollectionAllowList(address user) external;209210	/// Remove user from allowed list.211	///212	/// @param user User cross account address.213	/// @dev EVM selector for this function is: 0x09ba452a,214	///  or in textual repr: removeFromCollectionAllowListCross((address,uint256))215	function removeFromCollectionAllowListCross(CrossAddress memory user) external;216217	/// Switch permission for minting.218	///219	/// @param mode Enable if "true".220	/// @dev EVM selector for this function is: 0x00018e84,221	///  or in textual repr: setCollectionMintMode(bool)222	function setCollectionMintMode(bool mode) external;223224	// /// Check that account is the owner or admin of the collection225	// ///226	// /// @param user account to verify227	// /// @return "true" if account is the owner or admin228	// /// @dev EVM selector for this function is: 0x9811b0c7,229	// ///  or in textual repr: isOwnerOrAdmin(address)230	// function isOwnerOrAdmin(address user) external view returns (bool);231232	/// Check that account is the owner or admin of the collection233	///234	/// @param user User cross account to verify235	/// @return "true" if account is the owner or admin236	/// @dev EVM selector for this function is: 0x3e75a905,237	///  or in textual repr: isOwnerOrAdminCross((address,uint256))238	function isOwnerOrAdminCross(CrossAddress memory user) external view returns (bool);239240	/// Returns collection type241	///242	/// @return `Fungible` or `NFT` or `ReFungible`243	/// @dev EVM selector for this function is: 0xd34b55b8,244	///  or in textual repr: uniqueCollectionType()245	function uniqueCollectionType() external view returns (string memory);246247	/// Get collection owner.248	///249	/// @return Tuble with sponsor address and his substrate mirror.250	/// If address is canonical then substrate mirror is zero and vice versa.251	/// @dev EVM selector for this function is: 0xdf727d3b,252	///  or in textual repr: collectionOwner()253	function collectionOwner() external view returns (CrossAddress memory);254255	// /// Changes collection owner to another account256	// ///257	// /// @dev Owner can be changed only by current owner258	// /// @param newOwner new owner account259	// /// @dev EVM selector for this function is: 0x4f53e226,260	// ///  or in textual repr: changeCollectionOwner(address)261	// function changeCollectionOwner(address newOwner) external;262263	/// Get collection administrators264	///265	/// @return Vector of tuples with admins address and his substrate mirror.266	/// If address is canonical then substrate mirror is zero and vice versa.267	/// @dev EVM selector for this function is: 0x5813216b,268	///  or in textual repr: collectionAdmins()269	function collectionAdmins() external view returns (CrossAddress[] memory);270271	/// Changes collection owner to another account272	///273	/// @dev Owner can be changed only by current owner274	/// @param newOwner new owner cross account275	/// @dev EVM selector for this function is: 0x6496c497,276	///  or in textual repr: changeCollectionOwnerCross((address,uint256))277	function changeCollectionOwnerCross(CrossAddress memory newOwner) external;278}279280/// Cross account struct281struct CrossAddress {282	address eth;283	uint256 sub;284}285286/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).287enum AccessMode {288	/// Access grant for owner and admins. Used as default.289	Normal,290	/// Like a [`Normal`](AccessMode::Normal) but also users in allow list.291	AllowList292}293294/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.295struct CollectionNestingPermission {296	CollectionPermissionField field;297	bool value;298}299300/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.301enum CollectionPermissionField {302	/// Owner of token can nest tokens under it.303	TokenOwner,304	/// Admin of token collection can nest tokens under token.305	CollectionAdmin306}307308/// Nested collections.309struct CollectionNesting {310	bool token_owner;311	uint256[] ids;312}313314/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.315struct CollectionLimit {316	CollectionLimitField field;317	OptionUint256 value;318}319320/// Optional value321struct OptionUint256 {322	/// Shows the status of accessibility of value323	bool status;324	/// Actual value if `status` is true325	uint256 value;326}327328/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.329enum CollectionLimitField {330	/// How many tokens can a user have on one account.331	AccountTokenOwnership,332	/// How many bytes of data are available for sponsorship.333	SponsoredDataSize,334	/// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]335	SponsoredDataRateLimit,336	/// How many tokens can be mined into this collection.337	TokenLimit,338	/// Timeouts for transfer sponsoring.339	SponsorTransferTimeout,340	/// Timeout for sponsoring an approval in passed blocks.341	SponsorApproveTimeout,342	/// Whether the collection owner of the collection can send tokens (which belong to other users).343	OwnerCanTransfer,344	/// Can the collection owner burn other people's tokens.345	OwnerCanDestroy,346	/// Is it possible to send tokens from this collection between users.347	TransferEnabled348}349350/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).351struct Property {352	string key;353	bytes value;354}355356/// @dev the ERC-165 identifier for this interface is 0x65789571357interface ERC20UniqueExtensions is Dummy, ERC165 {358	/// @notice A description for the collection.359	/// @dev EVM selector for this function is: 0x7284e416,360	///  or in textual repr: description()361	function description() external view returns (string memory);362363	/// @dev EVM selector for this function is: 0x269e6158,364	///  or in textual repr: mintCross((address,uint256),uint256)365	function mintCross(CrossAddress memory to, uint256 amount) external returns (bool);366367	/// @dev EVM selector for this function is: 0x0ecd0ab0,368	///  or in textual repr: approveCross((address,uint256),uint256)369	function approveCross(CrossAddress memory spender, uint256 amount) external returns (bool);370371	// /// Burn tokens from account372	// /// @dev Function that burns an `amount` of the tokens of a given account,373	// /// deducting from the sender's allowance for said account.374	// /// @param from The account whose tokens will be burnt.375	// /// @param amount The amount that will be burnt.376	// /// @dev EVM selector for this function is: 0x79cc6790,377	// ///  or in textual repr: burnFrom(address,uint256)378	// function burnFrom(address from, uint256 amount) external returns (bool);379380	/// Burn tokens from account381	/// @dev Function that burns an `amount` of the tokens of a given account,382	/// deducting from the sender's allowance for said account.383	/// @param from The account whose tokens will be burnt.384	/// @param amount The amount that will be burnt.385	/// @dev EVM selector for this function is: 0xbb2f5a58,386	///  or in textual repr: burnFromCross((address,uint256),uint256)387	function burnFromCross(CrossAddress memory from, uint256 amount) external returns (bool);388389	/// Mint tokens for multiple accounts.390	/// @param amounts array of pairs of account address and amount391	/// @dev EVM selector for this function is: 0x1acf2d55,392	///  or in textual repr: mintBulk((address,uint256)[])393	function mintBulk(Tuple9[] memory amounts) external returns (bool);394395	/// @dev EVM selector for this function is: 0x2ada85ff,396	///  or in textual repr: transferCross((address,uint256),uint256)397	function transferCross(CrossAddress memory to, uint256 amount) external returns (bool);398399	/// @dev EVM selector for this function is: 0xd5cf430b,400	///  or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)401	function transferFromCross(402		CrossAddress memory from,403		CrossAddress memory to,404		uint256 amount405	) external returns (bool);406407	/// @notice Returns collection helper contract address408	/// @dev EVM selector for this function is: 0x1896cce6,409	///  or in textual repr: collectionHelperAddress()410	function collectionHelperAddress() external view returns (address);411}412413/// @dev anonymous struct414struct Tuple9 {415	address field_0;416	uint256 field_1;417}418419/// @dev the ERC-165 identifier for this interface is 0x40c10f19420interface ERC20Mintable is Dummy, ERC165 {421	/// Mint tokens for `to` account.422	/// @param to account that will receive minted tokens423	/// @param amount amount of tokens to mint424	/// @dev EVM selector for this function is: 0x40c10f19,425	///  or in textual repr: mint(address,uint256)426	function mint(address to, uint256 amount) external returns (bool);427}428429/// @dev inlined interface430interface ERC20Events {431	event Transfer(address indexed from, address indexed to, uint256 value);432	event Approval(address indexed owner, address indexed spender, uint256 value);433}434435/// @dev the ERC-165 identifier for this interface is 0x942e8b22436interface ERC20 is Dummy, ERC165, ERC20Events {437	/// @dev EVM selector for this function is: 0x06fdde03,438	///  or in textual repr: name()439	function name() external view returns (string memory);440441	/// @dev EVM selector for this function is: 0x95d89b41,442	///  or in textual repr: symbol()443	function symbol() external view returns (string memory);444445	/// @dev EVM selector for this function is: 0x18160ddd,446	///  or in textual repr: totalSupply()447	function totalSupply() external view returns (uint256);448449	/// @dev EVM selector for this function is: 0x313ce567,450	///  or in textual repr: decimals()451	function decimals() external view returns (uint8);452453	/// @dev EVM selector for this function is: 0x70a08231,454	///  or in textual repr: balanceOf(address)455	function balanceOf(address owner) external view returns (uint256);456457	/// @dev EVM selector for this function is: 0xa9059cbb,458	///  or in textual repr: transfer(address,uint256)459	function transfer(address to, uint256 amount) external returns (bool);460461	/// @dev EVM selector for this function is: 0x23b872dd,462	///  or in textual repr: transferFrom(address,address,uint256)463	function transferFrom(464		address from,465		address to,466		uint256 amount467	) external returns (bool);468469	/// @dev EVM selector for this function is: 0x095ea7b3,470	///  or in textual repr: approve(address,uint256)471	function approve(address spender, uint256 amount) external returns (bool);472473	/// @dev EVM selector for this function is: 0xdd62ed3e,474	///  or in textual repr: allowance(address,address)475	function allowance(address owner, address spender) external view returns (uint256);476}477478interface UniqueFungible is Dummy, ERC165, ERC20, ERC20Mintable, ERC20UniqueExtensions, Collection {}