Incorporate modules in the dapp

Let’s put this into practice by organizing code into smaller modules. First, create a folder named news_feed and add a module.rell file inside it:

src/news_feed/module.rell

module;

Next, import everything from this module into your main.rell file by adding the following line:

src/main.rell

import news_feed.*;

Then, create a file named model.rell in the src/news_feed folder and move the entity definitions from the main file into this new file:

src/news_feed/model.rell

entity user {
  mutable name;
  key id: byte_array;
  key account;
}

entity follower {
  index user;
  index follower: user;
  key user, follower;
}

entity post {
  timestamp = op_context.last_block_time;
  index user;
  content: text;
}

Now, shift the import statement for the account entity from the ft-library to the module.rell file. This arrangement allows all files within the module to access it:

src/news_feed/module.rell

module;

import lib.ft4.accounts.{ account };
import lib.ft4.auth;

Move the auth_handler to src/news_feed/auth.rell and shift post_dto to src/news_feed/dto.rell. If preferred, you can also add the require_user and format_user utility functions directly to module.rell. Place the queries in src/news_feed/queries.rell, and relocate the operations to src/news_feed/operations.rell.

After these changes, your module.rell file in the news_feed module should look like this:

src/news_feed/module.rell

module;

import lib.ft4.accounts.{ account };
import lib.ft4.auth;

function require_user(id: byte_array) = require(user @? { id }, "User with id %s does not exist".format(id));
function format_user(user) = "%s#%s".format(user.name, user.id.to_hex().sub(0, 5));

With the proper imports in place, the main.rell file should now only include the create_user operation, which is beneficial for testing purposes.

Next, create a new module called test_operations in the test folder by creating a file there and declaring it as a module:

src/test/test_operations.rell

module;

import lib.ft4.core.accounts.{ create_account_with_auth, single_sig_auth_descriptor };
import news_feed.*;

operation create_user(name, pubkey) {
  val account = create_account_with_auth(single_sig_auth_descriptor(pubkey, set(["A", "T", "MySession"])));
  create user ( name, pubkey, account );
}

In your test file, explicitly import this module, possibly using relative imports:

src/test/news_feed_test.rell

import ^.test_operations.{ create_user };

Although the create_user operation is no longer accessible from main.rell, it remains useful for testing against a test node. To facilitate this, create a new module named development alongside main.rell, which will include the test operation:

src/development.rell

module;

import main;
import test.test_operations.*;

In your chromia.yml file, you can switch between using the main module and the development module as the entry point for your dapp by adjusting the module: tag in the blockchains definition:

chromia.yml

blockchains:
  my_news_feed:
    module: development # set to "main" for production

You have now learned how to effectively structure your project using Rell modules. Your file structure should resemble the following:

├── development.rell
├── main.rell
├── news_feed
│   ├── auth.rell
│   ├── dto.rell
│   ├── model.rell
│   ├── module.rell
│   ├── operations.rell
│   └── queries.rell
└── test
    ├── news_feed_test.rell
    └── test_operations.rell