Configuration Options

NEO•ONE compiler configuration options.

Configure NEO•ONE for your project.

Config File

An initialized environment will have a .neo-one.config.ts file within the project root.

Example NEO•ONE configuration file

The .neo-one.config.ts configuration file may look something like this:

import { defaultNetworks } from '@neo-one/cli';

export default {
  contracts: {
    // The NEO•ONE compile command will output the compile results in this directory.
    outDir: 'neo-one/compiled',
    // NEO•ONE will look for smart contracts in this directory.
    path: 'neo-one/contracts',
    // Set this to true if you want the compile command to output JSON.
    // json: true,
    // Set this to true if you want the compile command to output AVM.
    // avm: false,
    // Set this to true if you want the compile command to output additional debug information.
    // debug: false,
    // Set this to true if you want the compile command to output the AVM in a human-readable format for debugging (requires debug: true).
    // opcodes: false,
  },
  artifacts: {
    // NEO•ONE will store build and deployment artifacts that should be checked in to vcs in this directory.
    path: 'neo-one/artifacts',
  },
  migration: {
    // NEO•ONE will load the deployment migration from this path.
    path: 'neo-one/migration.ts',
  },
  codegen: {
    // NEO•ONE will write source artifacts to this directory. This directory should be committed.
    path: 'src/neo-one',
    // NEO•ONE will generate code in the language specified here. Can be one of 'javascript' or 'typescript'.
    language: 'typescript',
    // NEO•ONE will generate client helpers for the framework specified here. Can be one of 'react', 'angular', 'vue' or 'none'.
    framework: 'react',
    // Set this to true if you're using an environment like Expo that doesn't handle browserifying dependencies automatically.
    browserify: false,
    // Set this to true if you're running in codesandbox to workaround certain limitations of codesandbox.
    codesandbox: false,
  },
  network: {
    // NEO•ONE will store network data here. This path should be ignored by your vcs, e.g. by specifiying it in a .gitignore file.
    path: '.neo-one/network',
    // NEO•ONE will start the network on this port.
    port: 9040,
  },
  // NEO•ONE will configure various parts of the CLI that require network accounts using the value provided here, for example, when deploying contracts.
  // Refer to the documentation at https://neo-one.io/docs/config-options for more information.
  networks: defaultNetworks,
  neotracker: {
    // NEO•ONE will start an instance of NEO Tracker using this path for local data. This directory should not be committed.
    path: '.neo-one/neotracker',
    // NEO•ONE will start an instance of NEO Tracker using this port.
    port: 9041,
    // Set to false if you'd like NEO•ONE to start an instance of NEO Tracker when running 'neo-one build'. You will need @neotracker/core installed as a dependency for this to work.
    skip: true,
  },
};

Networks

While we provide defaults for deployment networks it is also possible to use your own! You can provide a name and rpcUrl to our helper function createUserAccountProviderFunc from @neo-one/cli, which will prompt you to provide a list of privateKeys for use on the network when deploying:

import { createUserAccountProviderFunc, defaultNetworks } from '@neo-one/cli';

export default {
  // ...
  networks: {
    ...defaultNetworks,
    exampleNetwork: createUserAccountProviderFunc('exampleNetwork', 'exampleRpcUrl.io/rpc');
  }
  // ...
}

This is what the createUserAccountProviderFunc will do to create the new LocalUserAccountProvider:

export const createUserAccountProviderFunc = (network: string, rpcURL: string) => async () => {
  const keystore = new LocalKeyStore(new LocalMemoryStore());
  const { privateKeys } = await prompts({
    type: 'list',
    name: 'privateKeys',
    message: `Please enter one or more private keys separated by commas for use on the "${network}" network.`,
    validate: (value) => (value.length > 0 ? true : 'Must enter at least one private key.'),
  });
  await Promise.all(privateKeys.map((privateKey: string) => keystore.addUserAccount({ network, privateKey })));

  return new LocalUserAccountProvider({
    keystore,
    provider: new NEOONEProvider([{ network, rpcURL }]),
  });
};

Or you can create your own hard-coded async function that returns a UserAccountProvider, like so:

export default {
  // ...
  networks: {
    ...defaultNetworks,
    exampleNetwork: async () => {
      const keystore = new LocalKeyStore(new LocalMemoryStore());
      await keystore.addUserAccount('exampleNetwork', 'PRIVATE_KEY');

      return new LocalUserAccountProvider({
        keystore,
        provider: new NEOONEProvider([{ network: 'exampleNetwork', rpcUrl: 'exampleRpcUrl.io/rpc' }]),
      });
    },
  },
  // ...
};

Note

While hard-coding the LocalUserAccountProvider is a viable option in testing this also requires storing a private key as plain text in the .neo-one.config.ts file that is traditionally checked into version control, like Git/GitHub. For this reason we recommend only using a hard coded private key value for local on-the-fly testing and debugging.