Creating A Service

This section details how to create a service using the ers-scripts repo.

Set Up

If you are trying to execute a transaction it is assumed that you have also read the Set Up section. If you are just looking for an example read on

To be able to create a service you first need to specify the Ethereum account you want to call createService, note that this address will be set as the "owner" of the service however that can be changed post-creation. To do this, you must input the private key of the account you wish to use into the .env file. The .env file should look something like this:

...
TESTNET_SERVICE_CREATOR_PRIVATE_KEY=ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
...
BASE_SERVICE_CREATOR_PRIVATE_KEY=ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Replace the stand-in private keys (pulled from Hardhat) with the private key you wish to use. Make sure that you are using the correct private key for the network you are deploying to.

Most Developers deploying Projects will also create their own Services, so this key will typically be the same as the Developer key.

Executing the Script

The script to create a service is located in tasks/serviceCreation.ts. To execute the script run:

yarn createService --network [network]

You will be prompted for several pieces of information:

• service-name is the name you wish to give your service, each name must be unique so if it has been chosen previously it will revert
• content is an https or ipfs address of the content you wish to tie to the chips enrolled in the service
• append-id is a boolean that determines whether or not the chipId will be appended to the end of the content string (useful for tokenUri data hosted in a directory or in IPFS)

When the script is run the service-name is transformed into a bytes32 representation that is used as the serviceId for the service like so:

const serviceId = ethers.utils.formatBytes32String(serviceName);

We then form the ServiceRecord struct that will be used to create the service, note that we convent the passed content into bytes and pass in the CONTENT_APP_RECORD_TYPE as the recordType (which is defined as bytes32("contentApp")):

    const serviceRecord: ServiceRecord = {
      recordType: CONTENT_APP_RECORD_TYPE,
      content: stringToBytes(content),
      appendId
    };

The ServiceRecord struct and the serviceId are then passed to the smart contract:

    await rawTx({
      from: serviceCreator,
      to: servicesRegistry.address,
      data: servicesRegistry.interface.encodeFunctionData(
        "createService",
        [
          serviceId,
          [serviceRecord]
        ]
      )
    });

Example

Here's what the CLI interaction looks like when running yarn createService --network sepolia:

$ yarn createService --network sepolia
What would you like to name the service? MyBrandApp
 
What root URL or URI would you like to redirect chips enrolled in this service to? https://app.mybrand.com
 
Do you want to append chip IDs to the end of your root URI/URL (e.g. ipfs.com/0x123/$chipId)? Doing so allows you to create personalized tokenUri data for each chip (yes/no) yes
 
Creating service with the following details:
- Service Name: MyBrandApp
- Service ID: 0x4d794272616e64417070000000000000000000000000000000000000000000
- Content: https://app.mybrand.com/
- Append ID: true
 
✓ Service created successfully!
Transaction: 0x1234567890abcdef...
Service ID: 0x4d794272616e64417070000000000000000000000000000000000000000000