Manual App Registration

To participate in Fee Monetization, a project must be registered using the ProjectsRegistrar contract. You will need to prepare a metadata JSON file describing your project and a logo in PNG format.

A reasonable size is around 200x200px and at most 32 kiB in size. The logo and metadata need to be accessible on the Internet via a public URL. Alternatively, the JSON file and your logo can be hosted by Sonic Labs. Check the Fee Monetization dashboard to apply and upload.

Step-by-Step Registration

1. Create a metadata config file in JSON format with the following parameters:

{
  "name": "MySuperCoolProject",
  "image_url": "https://mysupercoolproject.com/icons/icon.png",
  "website": "https://mysupercoolproject.com/"
}

1. Host it somewhere so it is publicly accessible. Make sure anybody can download the JSON file using a browser and that the hosting site supports HTTPS. A 200x200px logo size in PNG format, not bigger than 32 kiB, is sufficient.

2. Go to the FeeM ProjectsRegistrar smart contract and execute the register function providing all the required information. Alternatively, use the Fee Monetization dashboard to apply. A unique Project ID will be assigned to your registration in response. Use this ID to identify your project in subsequent calls.

3. If done manually, go to the ContractsRegistrar project to add contracts to be assigned to your project via the register call. You will need the unique Project ID from the previous call.

4. Please note, if you rely on a manual registration process, moderators will have to approve your registration before your project is added to FeeM and will start to accumulate rewards. Please check the self-registration process below to get your contracts approved faster.

Contracts Self Registration

If you can directly interact with your contracts from an EOA (externally owned account) or can have the contract call itself:

• Use the ContractRegistrar contract to call selfRegister(projectID) from the contract address you wish to register. This will automatically confirm the contract to be part of your project identified by the unique Project ID.

• This bypasses the need for manual verification. Self-registration is free (beyond normal gas costs).

If your contracts cannot call selfRegister() themselves, try at least to self-register the deployer address. This often enables automated approval flows and speeds up the project approval process significantly.

Disputing a Contract Registration

If a contract is already registered under a different project and you believe it belongs to you:

1. The call to register will fail with ContractAlreadyRegistered(contract, projectID).

2. Use the DisputeResolver to open a dispute. Attach a refundable dispute fee and call openDispute() providing all the details required to resolve the issue.

3. If resolved in your favor, the dispute fee is refunded back to you and the disputed contracts are moved over to your project.

The Fee Monetization dashboard offers a user-friendly management UX for the disputes.