Using multiple actors

In this tutorial, you are going to create a project with multiple actors. Currently, you can only define one actor in a Motoko file and a single actor is always compiled to a single canister. In addition, you cannot yet define an actor class to support multiple actor instances in your Motoko programs. You can, however, create projects that have multiple actors and can build multiple canisters from the same dfx.json configuration file.

For this tutorial, you are going to create separate program files for three actors in the same project. This project defines the following unrelated actors:

  • The assistant actor provides functions to add and show tasks in a to-do list.

    For simplicity, the code sample for this tutorial only includes the functions to add to-do items and to show the current list of to-do items that have been added. A more complete version of this program-with additional functions for marking items as complete and removing items from the list—is available in the examples repository as Simple to-do checklist.

  • The rock_paper_scissors actor provides a function for determining a winner in a hard-coded rock-paper-scissors contest.

    This code sample illustrates the basic use of switch and case in a Motoko program with hard-coded players and choices.

  • The daemon actor provides mock functions for starting and stopping a daemon.

    This code sample simply assigns a variable and prints messages for demonstration purposes.

Before you begin

Before starting the tutorial, verify the following:

  • You have downloaded and installed the DFINITY Canister SDK package as described in Download and install.

  • You have stopped any Internet Computer network processes running on the local computer.

This tutorial takes approximately 20 minutes to complete.

Create a new project

To create a new project for this tutorial:

  1. Open a terminal shell on your local computer, if you don’t already have one open.

  2. Change to the folder you are using for your Internet Computer sample projects.

  3. Create a new project by running the following command:

    dfx new multiple_actors
  4. Change to your project directory by running the following command:

    cd multiple_actors

Modify the default configuration

You have already seen that creating a new project adds a default dfx.json configuration file to your project directory. For this tutorial, you need to add sections to this file to specify the location of each program that defines an actor you want to build.

To modify the default dfx.json configuration file:

  1. Open the dfx.json configuration file in a text editor, then change the default multiple_actors canister name and source directory to assistant.

    For example, under the canisters key:

        "assistant": {
          "main": "src/assistant/main.mo",
          "type": "motoko"
        },

    Because you are going to add settings to this canisters section of the configuration file, you must also add a comma after the curly brace that encloses the location of the assistant main source code file and the canister type.

  2. Remove the multiple_actors_assets section from the file.

  3. Add a new canister name, source code location, and canister type for the rock_paper_scissors program and a new canister name, source code location, and canister type for the daemon program files below the assistant canister definition.

    After making the changes, the canisters section of the dfx.json file should look similar to this:

    {
      "canisters": {
          "assistant": {
          "main": "src/assistant/main.mo",
          "type": "motoko"
        },
        "rock_paper_scissors": {
          "main": "src/rock_paper_scissors/main.mo",
          "type": "motoko"
        },
        "daemon": {
          "main": "src/daemon/main.mo",
          "type": "motoko"
        }
      },
      "defaults": {
        "build": {
          "packtool": ""
        }
      },
      "dfx": "0.6.12",
      "networks": {
        "local": {
          "bind": "127.0.0.1:8000",
          "type": "ephemeral"
        },
        "ic": {
          "providers": [
            "https://gw.dfinity.network"
          ],
          "type": "persistent"
        }
      },
      "version": 1
    }

    You can leave the other sections as-is.

  4. Save your changes and close the dfx.json file to continue.

  5. Change the name of the default source file directory to match the name specified in the dfx.json configuration file by running the following command:

    cp -r src/multiple_actors/ src/assistant/
  6. Copy the assistant source file directory to create the main program file for the rock_paper_scissors actor by running the following command:

    cp -r src/assistant/ src/rock_paper_scissors/
  7. Copy the assistant source file directory to create the main program file for the daemon actor by running the following command:

    cp -r src/assistant/ src/daemon/

Modify the default programs

You now have three separate directories in the src directory, each with a template main.mo file. For this tutorial, you will replace the content in each template main.mo file with a different actor.

To modify the default source code:

  1. Open the src/assistant/main.mo file in a text editor and delete the existing content.

  2. Copy and paste the following sample code into the file:

    import Array "mo:base/Array";
    import Nat "mo:base/Nat";
    
    // Define the actor
    actor Assistant {
    
    	stable var todos : [ToDo] = [];
    	stable var nextId : Nat = 1;
    
    // Define to-do item properties
    type ToDo = {
    	id: Nat;
    	description: Text;
    	completed: Bool;
    };
    
      // Add to-do item utility
      func add(todos : [ToDo], desc : Text, nextId : Nat) : [ToDo] {
        let todo : ToDo = {
          id = nextId;
          description = desc;
          completed = false;
        };
        Array.append<ToDo>(todos, [todo])
    };
    
      // Show to-do item utility
      func show(todos : [ToDo]) : Text {
        var output : Text = "\n___TO-DOs___";
        for (todo : ToDo in todos.vals()) {
          output #= "\n(" # Nat.toText(todo.id) # ") " # todo.description;
          if (todo.completed) { output #= " ✔"; };
        };
        output
      };
    
      public func addTodo (description : Text) : async () {
        todos := add(todos, description, nextId);
        nextId += 1;
      };
    
      public query func showTodos () : async Text {
        show(todos)
      };
    
    };
  3. Save your changes and close the main.mo file to continue.

  4. Open the src/rock_paper_scissors/main.mo file in a text editor and delete the existing content.

  5. Copy and paste the following sample code into the file:

    import I "mo:base/Iter";
    
    actor rock_paper_scissors {
    
    	stable var alice_score: Nat = 0;
        stable var bob_score: Nat = 0;
        stable var alice_last: Choice = { #scissors };
        stable var bob_last: Choice = { #rock };
    
    	type Choice = {
    		#rock;
    		#paper;
    		#scissors;
    	};
    
        public func contest() : async Text {
    		for (i in I.range(0,99)) {
    			battle_round();
    		};
            var winner = "The contest was a draw";
    		if (alice_score > bob_score) winner := "Alice won"
    		else if (alice_score < bob_score) winner := "Bob won";
            return (winner);
    	};
    
        func battle_round() : () {
         	let a = alice(bob_last);
    	    let b = bob(alice_last);
    
    	  switch (a,b) {
    		case (#rock,#scissors) alice_score +=1;
    		case (#rock,#paper) bob_score +=1;
    		case (#paper,#scissors) alice_score +=1;
    		case (#paper,#rock) bob_score +=1;
    		case (#scissors,#paper) alice_score +=1;
    		case (#scissors,#rock) bob_score +=1;
            case (#rock,#rock) alice_score +=0;
            case (#paper,#paper) bob_score +=0;
            case (#scissors,#scissors) alice_score +=0;
    	  };
    
    	  alice_last := a;
    	  bob_last := b;
    
    	  return ();
    };
          // Hard-coded players and choices
          func bob(last: Choice) : Choice {
        	return #paper;
          };
    
          func alice(last: Choice) : Choice {
        	return #rock;
    	  };
    };
  6. Save your changes and close the main.mo file to continue.

  7. Open the src/daemon/main.mo file in a text editor and delete the existing content.

  8. Copy and paste the following sample code into the file:

    actor daemon {
        stable var running = false;
    
        public func launch(): async Text {
            running :=  true;
            debug_show "The daemon process is running";
        };
    
        public func stop(): async Text {
            running := false;
            debug_show "The daemon is stopped";
        };
    };
  9. Save your changes and close the main.mo file to continue.

Start the local network

Before you can build the multiple_actors project, you need to connect to the Internet Computer network either running locally in your development environment or running remotely on a sub-network that you can access.

To start the network locally:

  1. Open a new terminal window or tab on your local computer and navigate to your project directory.

    For example, you can do either of the following if running Terminal on macOS:

    • Click Shell, then select New Tab to open a new terminal in your current working directory.

    • Click Shell and select New Window, then run cd ~/ic-projects/multiple_actors in the new terminal if your project is in the ic-projects working folder.

    You should now have two terminals open with your project directory as your current working directory.

  2. Start the Internet Computer network on your local computer by running the following command:

    dfx start

    After you start the local network, this terminal displays messages about network operations.

  3. Leave the terminal that displays network operations open and switch your focus to your original terminal where you created your new project.

Register, build, and deploy your application

After you connect to the Internet Computer network running locally in your development environment, you can register, build, and deploy your multi-canister application locally.

To deploy the application locally:

  1. Check that you are still in the root directory for your project, if needed.

  2. Register, build, and deploy the application by running the following command:

    dfx deploy

    If you have access to the Internet Computer running remotely, you can deploy to the that network instead of deploying locally by specifying the --network option and the network alias configured in the dfx.json file. For example, if you are connecting to the URL specified by the network alias ic you would run a command similar the following:

    dfx deploy --network ic

    The dfx deploy command output displays information about the operations it performs. For example, the command displays the network-specific canister identifiers for the three canisters defined in the dfx.json configuration file.

    Deploying all canisters.
    Creating canisters...
    Creating canister "assistant"...
    "assistant" canister created with canister id: "75hes-oqbaa-aaaaa-aaaaa-aaaaa-aaaaa-aaaaa-q"
    Creating canister "daemon"...
    "daemon" canister created with canister id: "cxeji-wacaa-aaaaa-aaaaa-aaaaa-aaaaa-aaaaa-q"
    Creating canister "rock_paper_scissors"...
    "rock_paper_scissors" canister created with canister id: "7kncf-oidaa-aaaaa-aaaaa-aaaaa-aaaaa-aaaaa-q"

Verify deployment by calling functions

You now have three programs deployed as a canisters on your local replica network and can test each program by using dfx canister call commands.

To test the programs you have deployed:

  1. Use the dfx canister call command to call the canister assistant using the addTodo function and pass it the task you want to add by running the following command:

    dfx canister call assistant addTodo '("Schedule monthly demos")'
  2. Verify that the command returns the to-do list item using the showTodos function by running the following command:

    dfx canister call assistant showTodos

    The command returns output similar to the following:

    ("
    ___TO-DOs___
    (1) Schedule monthly demos")
  3. Use the dfx canister call command to call the canister rock_paper_scissors using the contest function by running the following command:

    dfx canister call rock_paper_scissors contest

    The command returns the result of the hard-coded contest similar to the following:

    ("Bob won")
  4. Use the dfx canister call command to call the canister daemon using the launch function by running the following command:

    dfx canister call daemon launch
  5. Verify the mock launch function returns "The daemon process is running" message":

    (""The daemon process is running"")

Stop the local network

After you finish experimenting with your program, you can stop the local Internet Computer network so that it doesn’t continue running in the background.

To stop the local network:

  1. In the terminal that displays network operations, press Control-C to interrupt the local network process.

  2. Stop the Internet Computer network by running the following command:

    dfx stop