Quick Start

Create a file system wallet

A file system wallet is a private key stored in a file on your local machine.

This will create a new wallet and save the private key to a file in the default path of ~/.config/n1/keys/admin.json (on macOS). You can change the output path by using the optional --outfile flag.

n1 key generate

Setup your config settings

Run the following command to view your current config settings.

n1 config get

You should see something like this:

┌─────────────┬────────────────────────────┐
│ Key         │ Value                      │
├─────────────┼────────────────────────────┤
│ nts_url     │ https:/n1ts.n1.xyz         │
├─────────────┼────────────────────────────┤
│ default_key │ key                        │
└─────────────┴────────────────────────────┘

If the default_key is not set to the correct key, you can set it by running the following command:

n1 config set default_key <name of your key>

Initialize a new project

Create a new directory and initialize a new N1 project by running the following command:

n1 app init <name of your app>

This will create a new directory with the following structure:

• my-n1-project
  • contracts
    • app.ts
  • tests
    • index.test.ts
  • n1config.json
  • package.json
  • .gitignore

Install dependencies

Run the following command to install the dependencies inside your project:

pnpm install

You can now start building your app in the src directory and write tests in the tests directory.

Start development mode

Run the following command in your project directory:

n1 app dev

This will:

• Watch your contract files for changes and automatically rebuild
• Watch your test files for changes
• Start an interactive development REPL

Available commands

In the development REPL, you have access to the following commands:

• run - Builds, deploys, and runs all tests
• clear - Clears the terminal screen
• help - Shows available commands
• exit - Exits the development mode