update mkdocs structure & contract interfaces

docs/contract-interface.md

@@ -46,7 +46,7 @@ contract interface IAEX141 =
 ## IAENSWrapping
 
 ```sophia
-contract interface IAENSWrapping : IAEX141 =
+contract interface IAENSWrapping =
 
     datatype event
         // name, nft_id, owner, new_ttl
@@ -61,33 +61,14 @@ contract interface IAENSWrapping : IAEX141 =
         | NameRevoke(string, int)
         // nft_id, caller, reward
         | Reward(int, address, int)
-        // authorized_deployer
+            // authorized_deployer
         | MigrationTargetDeployerSet(address)
         | MigrationTargetDeployerUnset()
         // ceres_contract_address
         | MigrationActivation(address)
         // nft_id, wrapped_names_count, owner
         | Migrate(int, int, address)
 
-    record nft_data =
-        { id: int
-        , owner: address
-        , owner_config: option(config)
-        , names: list(string)
-        , expiration_height: int }
-
-    record config =
-        { reward: int
-        , reward_block_window: int
-        , emergency_reward: int
-        , emergency_reward_block_window: int
-        , can_receive_from_others: bool
-        , burnable_if_empty: bool }
-
-    record migration_data =
-        { names: list(string)
-        , expiration_height: Chain.ttl }
-
     /// @notice returns the account address of the real owner
     /// @param name the name to lookup
     /// @return real owner
@@ -106,7 +87,7 @@ contract interface IAENSWrapping : IAEX141 =
     /// @notice returns the nft id where the AENS name is wrapped into as well as the real owner of the name
     /// @param nft_id the NFT id
     /// @return nft_data
-    entrypoint get_nft_data : (string) => option(nft_data)
+    entrypoint get_nft_data : (int) => option(AENSWrappingTypes.nft_data)
 
     /// @notice returns the expiration height of names that are wrapped into the provided nft id
     /// @param nft_id the NFT id
@@ -116,7 +97,7 @@ contract interface IAENSWrapping : IAEX141 =
     /// @notice returns the global config for an account
     /// @param account the account address to lookup the config for
     /// @return the global config for an account OR None if not set
-    entrypoint get_global_config : (address) => option(config)
+    entrypoint get_global_config : (address) => option(AENSWrappingTypes.config)
 
     /// @notice returns the balance included in the reward pool
     /// @param account the account where the reward pool balance should be looked up for
@@ -224,15 +205,15 @@ contract interface IAENSWrapping : IAEX141 =
 
     /// @notice caller sets global config for NFTs owned by the caller
     /// @param config the global config
-    stateful entrypoint set_global_config : (config) => unit
+    stateful entrypoint set_global_config : (AENSWrappingTypes.config) => unit
 
     /// @notice caller removes global config for NFTs owned by the caller
     stateful entrypoint remove_global_config : () => unit
 
     /// @notice caller sets NFT specific config
     /// @param nft_id the id of the NFT to set the config
     /// @param config the nft specific config
-    stateful entrypoint set_nft_config : (int, config) => unit
+    stateful entrypoint set_nft_config : (int, AENSWrappingTypes.config) => unit
 
     /// @notice caller removes NFT specific config
     /// @param nft_id the id of the NFT to remove the config from
@@ -276,7 +257,7 @@ contract interface IAENSWrapping : IAEX141 =
 
     /// @notice defines an address which will be authorized to deploy the contract that activates the migration
     /// @param deployer the address that shall be authorized
-    stateful entrypoint set_migration_target_deployer : (address) => unit
+    stateful entrypoint set_migration_target_deployer : (option(address)) => unit
 
     /// @notice returns the address of the target ceres contract that users can use to perform a migration to
     /// @return the address of the target ceres contract that is allowed to trigger an NFT migration OR None if migration is not activated yet
@@ -288,5 +269,216 @@ contract interface IAENSWrapping : IAEX141 =
     /// @notice migrates & burns an NFT from this contract to the ceres contract (can only be executed by the NFT owner via an entrypoint in the ceres contract)
     /// @param nft_id the id of the NFT to migrate & burn
     /// @return the migration data that the ceres contract needs set the correct internal state
-    stateful entrypoint migrate : (int) => migration_data
+    stateful entrypoint migrate : (int) => AENSWrappingTypes.migration_data
+```
+
+## IAENSWrappingCeres
+
+```sophia
+contract interface IAENSWrappingCeres =
+
+    datatype event
+        // name, nft_id, owner, new_ttl
+        = NameWrap(string, int, address, int)
+        // name, nft_id, current_owner, recipient
+        | NameUnwrap(string, int, address, address)
+        // name, nft_id, new_ttl, caller
+        | NameExtend(string, int, int, address)
+        // name, nft_id_old, nft_id_new
+        | NameTransfer(string, int, int)
+        // name, nft_id
+        | NameRevoke(string, int)
+        // nft_id, caller, reward
+        | Reward(int, address, int)
+
+    /// @notice returns the account address of the real owner
+    /// @param name the name to lookup
+    /// @return real owner
+    entrypoint resolve_owner : (string) => option(address)
+
+    /// @notice returns the nft id where the AENS name is wrapped into
+    /// @param name the name to lookup
+    /// @return nft_id
+    entrypoint resolve_nft_id : (string) => option(int)
+
+    /// @notice returns the nft id where the AENS name is wrapped into as well as the real owner of the name
+    /// @param name the name to lookup
+    /// @return nft_id and owner
+    entrypoint resolve_nft_id_and_owner : (string) => option(int * address)
+
+    /// @notice returns the nft id where the AENS name is wrapped into as well as the real owner of the name
+    /// @param nft_id the NFT id
+    /// @return nft_data
+    entrypoint get_nft_data : (int) => option(AENSWrappingTypes.nft_data)
+
+    /// @notice returns the expiration height of names that are wrapped into the provided nft id
+    /// @param nft_id the NFT id
+    /// @return the (fixed) height where all names wrapped into the nft will expire
+    entrypoint get_expiration_by_nft_id : (int) => option(int)
+
+    /// @notice returns the global config for an account
+    /// @param account the account address to lookup the config for
+    /// @return the global config for an account OR None if not set
+    entrypoint get_global_config : (address) => option(AENSWrappingTypes.config)
+
+    /// @notice returns the balance included in the reward pool
+    /// @param account the account where the reward pool balance should be looked up for
+    /// @return the reward pool balance
+    entrypoint get_reward_pool : (address) => int
+
+    /// @notice returns the total reward that has been distributed for extending names with this contract
+    /// @return total_reward_distributed
+    entrypoint get_total_reward_distributed : () => int
+
+    /// @notice provides delegation signature to let the contract manage all existing and future AENS names on behalf of the owner
+    /// @param delegation_sig the global delegation signature (network id + owner address + string "AENS" + Contract.address)
+    stateful entrypoint provide_delegation_sig : (signature) => unit
+
+    /// @notice removes the delegation signature
+    stateful entrypoint remove_delegation_sig : () => unit
+
+    /// @notice wraps AENS names into a fresh minted NFT, adds NFT metadata, extends all names
+    /// @param names the set of AENS names to wrap
+    /// @return the NFT id
+    stateful entrypoint wrap_and_mint : (Set.set(string)) => int
+
+    /// @notice wraps a single AENS name into an existing NFT, adds NFT metadata, updates expiry of name to match expiry of already wrapped names
+    /// @param nft_id the id of the NFT to wrap the AENS name into
+    /// @param name the AENS name to wrap
+    stateful entrypoint wrap_single : (int, string) => unit
+
+    /// @notice wraps multiple AENS names into an existing NFT, adds NFT metadata, updates expiry of names to match expiry of already wrapped names
+    /// @param nft_id the id of the NFT to wrap the AENS name into
+    /// @param names the set of AENS names to wrap
+    stateful entrypoint wrap_multiple : (int, Set.set(string)) => unit
+
+    /// @notice adds / replaces a pointer of the AENS name while keeping existing pointers
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    /// @param name the AENS name where the pointer will be added / replaced
+    /// @param key the key of the pointer
+    /// @param pt the object to point to (account, channel, contract, oracle)
+    stateful entrypoint add_or_replace_pointer : (int, string, string, AENSv2.pointee) => unit
+
+    /// @notice adds / replaces a set of pointers of the AENS name
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    /// @param name the AENS name where the pointers will be added / replaced
+    /// @param pointers a map of pointers to set
+    /// @param keep_existing a bool indicating whether to keep existing pointers or not
+    stateful entrypoint add_or_replace_pointers : (int, string, map(string, AENSv2.pointee), bool) => unit
+
+    /// @notice removes a pointer of the AENS name
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    /// @param name the AENS name where the pointer will be removed
+    /// @param key the key of the pointer
+    stateful entrypoint remove_pointer : (int, string, string) => unit
+
+    /// @notice removes multiple pointers of the AENS name
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    /// @param name the AENS name where the pointers will be removed
+    /// @param keys a set of pointer keys
+    stateful entrypoint remove_pointers : (int, string, Set.set(string)) => unit
+
+    /// @notice removes all pointers of the AENS name
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    /// @param name the AENS name where the pointers will be removed
+    stateful entrypoint remove_all_pointers : (int, string) => unit
+
+    /// @notice revokes a single AENS name wrapped in the NFT, removes metadata
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    /// @param name the AENS name to revoke
+    stateful entrypoint revoke_single : (int, string) => unit
+
+    /// @notice revokes multiple AENS names wrapped in the NFT, removes metadata
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    /// @param names the AENS names to revoke
+    stateful entrypoint revoke_multiple : (int, Set.set(string)) => unit
+
+    /// @notice revokes all AENS names wrapped in the NFT, removes metadata
+    /// @param nft_id the id of the NFT where the AENS name is wrapped into
+    stateful entrypoint revoke_all : (int) => unit
+
+    /// @notice transfers a single AENS name to another NFT by updating metadata of both NFTs, updates expiry of name to match expiry of already wrapped names
+    /// @param nft_id_old the id of the NFT that currently wraps the AENS name
+    /// @param nft_id_new the id of the NFT that will wrap the AENS name in the future
+    /// @param name the AENS name to transfer
+    stateful entrypoint transfer_single : (int, int, string) => unit
+
+    /// @notice transfers multiple AENS names to another NFT by updating metadata of both NFTs, updates expiry of names to match expiry of already wrapped names
+    /// @param nft_id_old the id of the NFT that currently wraps the AENS name
+    /// @param nft_id_new the id of the NFT that will wrap the AENS name in the future
+    /// @param names the AENS names to transfer
+    stateful entrypoint transfer_multiple : (int, int, Set.set(string)) => unit
+
+    /// @notice transfers a single AENS name to another NFT by updating metadata of both NFTs, updates expiry of names to match expiry of already wrapped names
+    /// @param nft_id_old the id of the NFT that currently wraps the AENS name
+    /// @param nft_id_new the id of the NFT that will wrap the AENS name in the future
+    stateful entrypoint transfer_all : (int, int) => unit
+
+    /// @notice transfers the AENS name back to the owner or to another defined recipient, updates metadata
+    /// @param nft_id the id of the NFT that currently wraps the AENS name
+    /// @param name the AENS name to transfer
+    /// @param recipient the address that should receive the AENS name
+    stateful entrypoint unwrap_single : (int, string, option(address)) => unit
+
+    /// @notice transfers the AENS names back to the owner or to another defined recipient, updates metadata
+    /// @param nft_id the id of the NFT that currently wraps the AENS name
+    /// @param names the AENS names to transfer
+    /// @param recipient the address that should receive the AENS name
+    stateful entrypoint unwrap_multiple : (int, Set.set(string), option(address)) => unit
+
+    /// @notice transfers all AENS names back to the owner or to another defined recipient, updates metadata
+    /// @param nft_id the id of the NFT that currently wraps the AENS name
+    /// @param recipient the address that should receive the AENS name
+    stateful entrypoint unwrap_all : (int, option(address)) => unit
+
+    /// @notice caller sets global config for NFTs owned by the caller
+    /// @param config the global config
+    stateful entrypoint set_global_config : (AENSWrappingTypes.config) => unit
+
+    /// @notice caller removes global config for NFTs owned by the caller
+    stateful entrypoint remove_global_config : () => unit
+
+    /// @notice caller sets NFT specific config
+    /// @param nft_id the id of the NFT to set the config
+    /// @param config the nft specific config
+    stateful entrypoint set_nft_config : (int, AENSWrappingTypes.config) => unit
+
+    /// @notice caller removes NFT specific config
+    /// @param nft_id the id of the NFT to remove the config from
+    stateful entrypoint remove_nft_config : (int) => unit
+
+    /// @notice caller deposits AE to his reward pool
+    stateful payable entrypoint deposit_to_reward_pool : () => unit
+
+    /// @notice caller withdraws all AE or a specific amount from his reward pool
+    /// @param amount the optional amount of AE to withdraw
+    stateful entrypoint withdraw_from_reward_pool : (option(int)) => unit
+
+    /// @notice calculates the reward based on the expiration date of the names wrapped in an NFT, considering the global config (or the NFT specific config if set) and the amount of Æ deposited by the NFT owner
+    /// @param nft_id the id of the NFT to extend
+    /// @return the estimated reward
+    entrypoint estimate_reward : (int) => int
+
+    /// @notice extends all AENS names wrapped in the NFT without getting a reward
+    /// @param nft_id the id of the NFT that wraps the AENS names to extend
+    stateful entrypoint extend_all : (int) => unit
+
+    /// @notice extends all AENS names wrapped in the NFT and distributes a reward to the caller
+    /// @param nft_id the id of the NFT that wraps the AENS names to extend
+    stateful entrypoint extend_all_for_reward : (int) => unit
+
+    /// @notice transfers a set of NFTs to the desired recipient
+    /// @param recipient the address to become new owner of the NFTs
+    /// @param nft_ids the ids of the NFTs to transfer
+    /// @param data optional data to be provided to a contract receiver
+    stateful entrypoint transfer_multiple_nfts : (address, Set.set(int), option(string)) => unit
+
+    /// @notice burns a set of NFTs (only possible if AENS names are expired)
+    /// @param nft_ids the ids of the NFTs to burn
+    stateful entrypoint burn_multiple_nfts : (Set.set(int)) => unit
+
+    /// @notice triggers the migration of an NFT that exists in the old AENSWrapping contract (if set during deployment) and mints a new NFT in this contract
+    /// @param nft_id the id of the NFT to migrate
+    /// @return the id of the NFT minted in this contract
+    stateful entrypoint trigger_migration : (int) => int
 ```

mkdocs.yml

@@ -52,6 +52,5 @@ nav:
     - diagrams/extend_aens_names.md
     - diagrams/transfer_nfts.md
     - diagrams/burn_nfts.md
-  - diagrams/full-example-sequence.md
   - contract-interface.md
   - sponsors.md