ERC-6551 Reference Implementation on Starknet

This repository contains the reference implementation of ERC-6551 on Starknet.

NB: This project is under active development and may undergo changes until SNIP-72 is finalized.

The Tokenbound Standard

This proposal defines a system which assigns contract accounts to Non-fungible tokens (ERC-721s).

These accounts are referred to as token bound accounts and they allow NFTs to own assets and interact with applications, without requiring changes to existing smart contracts or infrastructure.

For more information, you could reference the original EIP proposed by Jayden Windle, Benny Giang and a few others.

Repository Structure

This Repository contains reference implementation of:

1. A singleton registry contract
2. An account contract

The Registry Contract

The registry serves as a single entry point for all token bound account address queries. It has three functions:

1. create_account - creates the token bound account for an NFT given an implementation_hash, public_key, token_contract, token_id and salt.

2. get_account - computes the token bound account address for an NFT given an implementation_hash, public_key, token_contract, token_id and salt.

3. total_deployed_accounts - returns the number of deployed token bound accounts for a particular NFT using the registry.

The Account Contract

The Account Contract provides a minimal reference implementation for a TBA. Thanks to native account abstraction on Starknet, it can be easily tweaked to contain as much use case as needed.

All token bound accounts must at least implement all functions contained within the reference account.

Development Setup

You will need to have Scarb and Starknet Foundry installed on your system. Refer to the documentations below:

• Starknet Foundry
• Scarb

To use this repository, first clone it:

git clone [email protected]:Starknet-Africa-Edu/TBA.git
cd TBA

Building contracts

To build the contracts, run the command:

scarb build

Running Tests

To run the tests contained within the tests folder, run the command:

snforge test

For more information on writing and running tests, refer to the Starknet-Foundry documentation