Importing base library functions

In this tutorial, you are going to write a simple program that enables you to store and look up telephone numbers. This tutorial illustrates how to import and use a few basic Motoko library functions.

For this tutorial, the Motoko base library functions are defined in the List and AssocList modules and enable you to work with lists as linked key-value pairs. In this example, the key is a name and the value is the phone text string associated with that name.

This program supports the following function calls:

  • The insert function accepts the name and phone key-value pair as input stored in the book variable.

  • The lookup function is a query that uses the specified name key as input to find the associated phone number.

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 10 minutes to complete.

Creating 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. Creating a new project by running the following command:

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

    cd phonebook

Modify the default program

For this tutorial, let’s create a new main.mo file for the simple phone number lookup program.

To modify the default template:

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

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

    // Import standard library functions for lists
    
    import L "mo:base/List";
    import A "mo:base/AssocList";
    
    // The PhoneBook actor.
    actor {
    
        // Type aliases make the rest of the code easier to read.
        public type Name = Text;
        public type Phone = Text;
    
        // The actor maps names to phone numbers.
        flexible var book: A.AssocList<Name, Phone> = L.nil<(Name, Phone)>();
    
        // An auxiliary function checks whether two names are equal.
        func nameEq(l: Name, r: Name): Bool {
            return l == r;
        };
    
        // A shared invokable function that inserts a new entry
        // into the phone book or replaces the previous one.
        public func insert(name: Name, phone: Phone): async () {
            let (newBook, _) = A.replace<Name, Phone>(book, name, nameEq, ?phone);
            book := newBook;
        };
    
        // A shared read-only query function that returns the (optional)
        // phone number corresponding to the person with the given name.
        public query func lookup(name: Name): async ?Phone {
            return A.find<Name, Phone>(book, name, nameEq);
        };
    };

    In looking at this sample program, you might notice the following key elements:

    • The code defines Name and Phone as custom Text types. Creating user-defined types improves the readability of the code.

    • The insert function is an update call and the lookup function is a query call.

    • The Phone type is identified as an optional value by using the ?Phone syntax.

Start the local network

Before you can build the phonebook 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/phonebook 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 canister identifiers

After you connect to the Internet Computer network running locally in your development environment, you can register with the network to generate unique canister identifiers for your project.

To register canister identifiers for the local network:

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

  2. Register unique canister identifiers for the project by running the following command:

    dfx canister create --all

    The command displays the network-specific canister identifiers for the canisters defined in the dfx.json configuration file.

    "phonebook" canister created with canister id: "75hes-oqbaa-aaaaa-aaaaa-aaaaa-aaaaa-aaaaa-q"
    "phonebook_assets" canister created with canister id: "cxeji-wacaa-aaaaa-aaaaa-aaaaa-aaaaa-aaaaa-q"

    Keep in mind that because you are running the Internet Computer locally, these identifiers are only valid on the local network. To deploy canisters on a remote network, you must connect to that network using the --network command-line option and a specific network name or address to register identifiers on that network.

Build and deploy the program

Now that you have registered with the network, you are ready to compile your program into an executable WebAssembly module that you can then deploy on your local Internet Computer network.

To build and deploy the program:

  1. Check that you are still in your project directory by running the pwd command, if necessary.

  2. Build the WebAssembly executable by running the following command:

    dfx build phonebook

    The dfx.json file provides default settings for creating an application front-end entry point and assets canister. For this tutorial, however, you can build your project using the phonebook canister name because the project is a terminal-based application that doesn’t include any front-end assets.

    Although this tutorial illustrates how to skip compiling a front-end canister, you can add a simple user interface to this application later by exploring the phone-book project in the examples repository.

  3. Deploy your phonebook project on the local network by running the following command:

    dfx canister install phonebook

Add names and numbers using the insert function

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

To test the program you have deployed on the local replica network:

  1. Use the dfx canister call command to call the canister phonebook using the insert function and pass it a name and phone number by running the following command:

    dfx canister call phonebook insert '("Chris Lynn", "01 415 792 1333")'
  2. Add a second name and number pair by running the following command:

    dfx canister call phonebook insert '("Maya Garcia", "01 408 395 7276")'
  3. Verify that the command returns the number associated with "Chris Lynn" using the lookup function by running the following command:

    dfx canister call phonebook lookup '("Chris Lynn")'

    The command returns output similar to the following:

    (opt "01 415 792 1333")
  4. Try to call the lookup function with the number associated with "Maya Garcia" by running the following command:

    dfx canister call phonebook lookup '("01 408 395 7276")'

    Note that, in this case, the command returns (null) because the phone number is not a key associated with the "Maya Garcia" name entry.

  5. Try to call the lookup function again to return the phone numbers for both "Maya Garcia" and "Chris Lynn" by running the following command:

    dfx canister call phonebook lookup '("Maya Garcia","Chris Lynn")'

    Because the program is written to return one value for one key, the command only returns information associated with the first key, in this example the phone number for Maya Garcia.

Test functions in a browser

The canister interface description language—often referred to as Candid or more generally as the IDL—provides a common language for specifying the signature of a canister service. The language provides a unified way of interacting with canisters in various languages and tools, such as the dfx command-line interface, JavaScript, and Motoko.

Based on the type signature of the actor, Candid provides a web interface that allows you to call canister functions for testing and debugging.

To use the Candid web interface to test canister functions:

  1. Deploy your project using the dfx canister install command and copy the canister identifier associated with the main actor for your application.

  2. Open a browser and navigate to the address and port number specified in the dfx.json configuration file.

    By default, the local network binds to the 127.0.0.1:8000 address and port number.

  3. Add the candid endpoint to access the Candid web interface followed by the required canisterId parameter and canister identifier.

    For example, the full URL should look similar to the following but with the canister_identifier that was returned by the dfx canister install command:

    http://127.0.0.1:8000/candid?canisterId=<YOUR-CANISTER-IDENTIFIER>
  4. Review the list of function calls and types defined in the program.

  5. Type a value of the appropriate type for a function or click Lucky to generate a value, then click Call or Query to see the result.

    Note that depending on the data type, the Candid interface might display additional configuration settings for testing functions. For example, if a function takes an array, you might need to specify the number of items in the array before entering values.

    Phonebook functions

Revise the source code in your program

To extend what you have learned in this tutorial, you might want to try modifying the source code to return different results.

For example, you might want to change the source code so that instead of a program that inserts and looks up a current key-value (name-phone) pair to create a program that stores contact information similar to a database "record" in which a primary key is associated with multiple fields. In this example, your program might enable users or another program to add information—such as a home phone number, a cell phone number, an email address, and a street address—and selectively return all or specific field values.

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