# Running a Local Network ## Running a Local Network via Endless CLI Local networks can be helpful when testing your code. They are not connected to any production Endless networks like mainnet, but they are useful for three main reasons: 1. **No rate limits:** You can interact with hosted services like the Node API, Indexer API, and faucet with no rate-limits to speed up testing. 2. **Reproducibility:** You can set up specific on-chain scenarios and restart the network from scratch at any point to return to a clean slate. 3. **High availability**: The Endless devnet and testnet networks are periodically upgraded, during which time they can be unavailable. Local development networks are also always available even if you have no internet access. ## Starting A Local Network 1. Ensure you have the Endless CLI installed. 2. Run the following command in a new terminal to start the private network: ```bash endless node run-local-testnet ``` {% hint style="info" %} Despite the name (`local-testnet`), this has nothing to do with the Endless testnet, it will run a network entirely local to your machine. ::: {% endhint %} You should expect to see an output similar to this: ``` Readiness endpoint: http://0.0.0.0:8070/ Transaction stream is starting, please wait... Node API is starting, please wait... Completed generating configuration: Log file: "/Users/dport/.endless/testnet/validator.log" Test dir: "/Users/dport/.endless/testnet" Endless root key path: "/Users/dport/.endless/testnet/mint.key" Waypoint: 0:397412c0f96b10fa3daa24bfda962671c3c3ae484e2d67ed60534750e2311f3d ChainId: 4 REST API endpoint: http://0.0.0.0:8080 Metrics endpoint: http://0.0.0.0:9101/metrics Endlessnet fullnode network endpoint: /ip4/0.0.0.0/tcp/6181 Indexer gRPC node stream endpoint: 0.0.0.0:50051 Endless is running, press ctrl-c to exit Node API is ready. Endpoint: http://0.0.0.0:8080/ Transaction stream is ready. Endpoint: http://0.0.0.0:50051/ Applying post startup steps... Setup is complete, you can now use the local testnet! ``` 3. Wait for the final line `Setup is complete, you can now use the localnet!` {% hint style="info" %} If you ran into an error, jump to the Common Errors section below. {% endhint %} As you can see from the above example output, once the local network is running, you have access to the following services: * Node API: This is a REST API that runs directly on the node. It enables core write functionality such as transaction submission and a limited set of read functionality, such as reading account resources or Move module information. * Transaction Stream Service: This is a gRPC stream of transactions used by the Indexer API. This is only relevant to you if you are developing a custom processor. If you do not want to run `Transaction Stream Service`, there is a `--no-txn-stream` flag to disable it. If you are writing a script and would like to wait for the local network to come up with all services, you can make a GET request to `http://127.0.0.1:8070`. At first this will return http code [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503). When it returns [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) it means all the services are ready. For more information on different flags you can pass when starting your local network, or configuration settings such as changing which port certain services run on, run the help command: ```bash endless node run-local-testnet --help ``` ### Common Errors On Network Startup #### Address Already In Use ```bash panicked at 'error binding to 0.0.0.0:8080: error creating server listener: Address already in use (os error 48) ``` This means one of the ports needed by the local network is already in use by another process. To fix this on Unix systems, you can: 1. Identify the name and PID of the process by running `lsof -i :8080`. 2. Run `kill ` once you know the PID to free up that port. #### Too many open files error ```bash panicked at crates/endless/src/node/local_testnet/logging.rs:64:10: called `Result::unwrap()` on an `Err` value: Os { code: 24, kind: Uncategorized, message: \"Too many open files\" }""" ``` This means there were too many open files on your system. On many Unix systems you can increase the maximum number of open files by adding something like this to your `.zshrc`: ```bash ulimit -n 32768 ``` ### Using The Local Network Now that the network is running, you can use it like you would any other network. So, you can create a local profile like this: ```bash endless init --profile --network local ``` You can then use that profile for any commands you want to use going forward. For example, if you wanted to publish a Move module like the [`hello_blockchain`](/endless/devbuild/build/advanced-builder-guides/develop-locally/running-a-local-network.md) package to your local network you could run: ```bash endless move publish --profile --package-dir /opt/git/endless-core/endless-move/move-examples/hello_blockchain --named-addresses hello_blockchain= ``` #### Configuring the TypeScript SDK If you want to use the local network with the TypeScript SDK, you can use local network URLs when initializing the client object (`Endless`): ```tsx import { Endless, EndlessConfig, Network } from "@endless-labs/ts-sdk"; const network = Network.LOCAL; const config = new EndlessConfig({ network }); const client = new Endless(config); ``` #### Resetting the local network Sometimes while developing it is helpful to reset the local network back to its initial state, for example: * You made backwards incompatible changes to a Move module, and you'd like to redeploy it without renaming it or using a new account. * You want to clear all on chain state, e.g. accounts, objects, etc. To start with a brand new local network, use the `--force-restart` flag: ```bash endless node run-local-testnet --force-restart ``` It will then prompt you if you really want to restart the chain, to ensure that you do not delete your work by accident. ```bash Are you sure you want to delete the existing chain? [yes/no] > yes ``` If you do not want to be prompted, include `--assume-yes` as well: ```bash endless node run-local-testnet --force-restart --assume-yes ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.endless.link/endless/devbuild/build/advanced-builder-guides/develop-locally/running-a-local-network.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.