Introduction

The work in this repository is part of a grant approved by the æternity crypto foundation.

Before the grant (status quo)

• No batch actions (updates, transfers) for AENS names are possible
• No trading of AENS names possible
• Users still suffer from name expiration as they fail to consistently track name expiration

After the grant (result of this work)

Wrapping AENS names into NFTs will make it easy to perform batch-actions on the names and enable new use cases. NFT trading is also highly anticipated and is another topic to tackle in that regards.

The results of the work in this grant will:

• provide a way for the community to better manage their AENS names
• enable batch-actions for AENS names
• allow strangers to extend AENS names and get rewarded for that
• make AENS names easily tradable on NFT marketplaces

Simple explainer

By calling the entrypoint wrap_and_mint, users can wrap up to 50 AENS names (name_limit configured during deployment of the contract) into an NFT.

The AENSWrapping contract syncs the expiration of all wrapped AENS names by extending all of them with the max_name_ttl (configured during deployment of the contract).

Every user can:

• create as many NFTs as they want and thus wrap as many AENS names as they want
• wrap/unwrap AENS names into/from existing NFTs that they own
• add or replace pointer(s) of a specific AENS name that is wrapped into an NFT that they own
• revoke AENS names that are wrapped into NFTs that they own
• transfer NFTs (and thus also the wrapped AENS names) to other users
• define a global config to define:
  • reward (incl. reward block window) for other users for extending their names
  • emergency-reward (incl. emergency reward block window) for other users for extending their names
  • if other users can transfer AENS names into NFTs that they own
  • if other users can burn NFTs that they own in case they are empty
• define a similar config for each NFT they own (overrrules the global config)
• deposit AE to the reward pool in order to reward other users for extending their names
• withdraw of AE from the reward pool
• extend all AENS names wrapped into a specific NFT (no matter if they own it or not) by calling:
  • extend_all (no reward, good will)
  • extend_all_for_reward (rewards the user in case there is a reward configured, the reward block window is reached and the owner of the NFT has AE deposited to the reward pool)

Full example sequence

sequenceDiagram
    actor AENS / NFT owner

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 1) wrap_and_mint
    Note left of AENSWrapping (NFT Contract): claims ownership of names<br />mints NFT with id 1<br />assigns names to NFT<br />extends all AENS names
    AENSWrapping (NFT Contract) -->> AENS / NFT owner: assign ownership of NFT with id 1

    actor User XY

    User XY ->> AENSWrapping (NFT Contract): 2) extend_all: nft_id (1)
    Note right of AENSWrapping (NFT Contract): extends all AENS names wrapped in the given NFT<br /> user does not get any reward

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 3) set_global_config: config
    Note left of AENSWrapping (NFT Contract): can enable global rewards for extending names<br />in NFTs owned by the caller according to the config<br />reward = 50 Æ<br />reward_block_window = 480<br />emergency_reward = 100 Æ<br />emergency_reward_block_window = 10<br />can_receive_from_others = false<br />burnable_if_empty = false

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 4) deposit_to_reward_pool
    AENS / NFT owner -->> AENSWrapping (NFT Contract): 500 Æ
    Note left of AENSWrapping (NFT Contract): adds 500 Æ to reward pool of NFT owner

    User XY ->> AENSWrapping (NFT Contract): 5) extend_all: nft_id (1)
    Note right of AENSWrapping (NFT Contract): extends all AENS names wrapped in the given NFT<br /> user does not get any reward<br /> can be called anytime

    User XY ->> AENSWrapping (NFT Contract): 6) extend_all_for_reward: nft_id (1)
    AENSWrapping (NFT Contract) -->> User XY: 50 Æ
    Note right of AENSWrapping (NFT Contract): extends all AENS names wrapped in the given NFT<br /> only rewards if called 480 blocks before the names expire
    Note right of AENSWrapping (NFT Contract): deducts 50 Æ from reward pool of NFT owner<br />new value: 450 Æ

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 7) wrap_and_mint
    Note left of AENSWrapping (NFT Contract): claims ownership of names<br />mints NFT with id 2<br />assigns names to NFT<br />extends all AENS names
    AENSWrapping (NFT Contract) -->> AENS / NFT owner: assign ownership of NFT with id 2

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 8) set_nft_config: nft_id (2), config
    Note left of AENSWrapping (NFT Contract): provide NFT specific config<br />reward = 350 Æ<br />reward_block_window = 2400<br />emergency_reward = 500 Æ<br />emergency_reward_block_window = 480<br />can_receive_from_others = false<br />burnable_if_empty = false

    User XY ->> AENSWrapping (NFT Contract): 9) extend_all_for_reward: nft_id (2)
    AENSWrapping (NFT Contract) -->> User XY: 450 Æ
    Note right of AENSWrapping (NFT Contract): emergency reward within the 480 block before expiration
    Note right of AENSWrapping (NFT Contract): deducts 450 Æ from reward pool of NFT owner<br />new value: 0 Æ
    Note right of AENSWrapping (NFT Contract): normally 500 Æ would have been paid, but only 450 are left in the reward pool of the NFT owner 
    
    AENS / NFT owner ->> AENSWrapping (NFT Contract): 10) transfer_single: nft_id_old (1), nft_id_new (2), name
    Note left of AENSWrapping (NFT Contract): associates provided name to nft with id 2<br />updates expiry of transferred name to match expiry of names in NFT with id 2

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 11) add_or_replace_pointer: nft_id, name, pointer_key, pointer_object
    Note left of AENSWrapping (NFT Contract): adds or replaces pointer for specific name wrapped in NFT

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 12) unwrap_all: nft_id (1), none
    AENSWrapping (NFT Contract) -->> AENS / NFT owner: transfer of all AENS names wrapped in NFT with id 1

    AENS / NFT owner ->> AENSWrapping (NFT Contract): 13) unwrap_all: nft_id (2), user xy
    AENSWrapping (NFT Contract) -->> User XY: transfer of all AENS names wrapped in NFT with id 2

Contracts

Iris (current protocol version)

AENSWrapping.aes

• implements IAEX141 interface as defined in the AEX-141 NFT Standard
• implements IAENSWrapping interface
• provides a migration path for a future deployment of AENSWrappingCeres.aes to allow a seamless migration to the new contract
  • the creator of the contract will be the admin that can optionally define a deployer of the future Ceres contract

Tests & artifacts:

• aensWrappingTest-iris.js (tests written in JavaScript using AEproject)
• aci-iris.json (contract interface generated via generateBytecodeAndAci-iris.js)
• bytecode-iris (contract bytecode generated via generateBytecodeAndAci-iris.js)

Deployments:

• testnet: ct_uzVp6Y8yrHumrbWVtmqTSUdHz59ByeTCMJUnaD2S9WSYEus8a
• mainnet: ct_M14j2hVwDqSraKqwi9udj31NM4f3SGYPXC7UDVqKqfoeUUjX2

Ceres (future protocol version)

AENSWrappingCeres.aes

• implements IAEX141 interface as defined in the AEX-141 NFT Standard
• implements IAENSWrappingCeres
• activates the migration path from Iris contract to itself during deployment
• provides an easy way for users to migrate an NFT from the old Iris contract to itself
• simplifies delegation signature handling
  • requires only one global delegation signature for all existing as well as future AENS names owned by a specific user
  • no need to pass a specific delegation signature for each AENS name

Tests & artifacts:

• aensWrappingTest-ceres.js (tests written in JavaScript using AEproject)

Note: Before generating the bytecode and aci for Ceres via generateBytecodeAndAci-ceres.js, the official compiler v8 release should be set in the docker-compose.yml!

Sponsors

This work is sponsored by the æternity crypto foundation.

Do you also wanna sponsor this work? Send some Æ coins to:

• buymeacoffee.chain or
• ak_3mw4DAv1mbo8XbEjTgt8UgWTgGJoNmiRnvCywz4BD6192kHtm