# Run the Examples Arcology provides several concurrent examples to help you started. These examples demonstrate the basics of building concurrent applications on the Arcology Network using Arcology’s concurrent library. ### Prerequisites You need the following tools installed on your machine: * Node.js 20.x or upper * Yarn * Git * Docker * VS Code * Hardhat ### Minimum Hardware * 4 CPU cores * 16GB RAM * 100GB free disk space {% hint style="success" %} 2 cores and 8 GB RAM are fine for development—just not for benchmarking. {% endhint %} ### Benchmark Hardware * 32 CPU cores or upper * 256GB RAM or more * 1000GB (NVMe SSD) free disk space or more ## Set up the DevNet Creates env var `localip` for your machine’s local IP (example shown: `192.168.1.109`). Then start the Arcology DevNet Docker container, replacing the IP address with your machine's local IP. ### Linux ```shell localip=$(hostname -I | awk '{print $1}') echo $localip ``` ### macOS ```shell localip=$(ipconfig getifaddr en0) echo $localip ``` Download and start the DevNet docker image: ```shell docker run -itd --name l1 -p 8545:8545 -p 26656:26656 -p 9191:9191 -p 9192:9192 -p 9292:9292 arcologynetwork/devnet -f http://$localip:7545 -b http://$localip:3500 -s http://$localip:8545 -r true -m false ``` You should see an output similar to this: ```shell Unable to find image 'arcologynetwork/devnet:latest' locally latest: Pulling from arcologynetwork/devnet eda6120e237e: Pull complete 1ddaf4addd51: Pull complete 4f4fb700ef54: Pull complete 7a377f784e1c: Pull complete 8ec60f2198bb: Pull complete 6b222784fac3: Pull complete 53231e7f88b6: Pull complete d466946a8540: Pull complete 2b9eda8dfee2: Pull complete Digest: sha256:34bda084de9ff7f62b4478848411b6f6c4b493f2a06059c4a5d30c99e44e1a89 Status: Downloaded newer image for arcologynetwork/devnet:latest 200ee2aac356625d5dad46384a678c3f5590d738f899893fa54b76bbcd3ff1d8 ``` ### Check the Docker Container Check if the Docker container is running properly: ```shell docker ps ``` ### Check the DevNet Status Install the Arcology frontend tools globally: ```shell npm install -g @arcologynetwork/frontend-tools ``` Check if your DevNet is running properly by using the `arcology.net-monitor` tool: ```shell npx arcology.net-monitor http://$localip:8545 ``` If the DevNet is running properly, you should see an output similar to this: ```shell height = 494, empty block, timestamp = 1757874737, maxTps = 0, realtimeTps(1m) = 0 height = 495, empty block, timestamp = 1757874738, maxTps = 0, realtimeTps(1m) = 0 height = 496, empty block, timestamp = 1757874739, maxTps = 0, realtimeTps(1m) = 0 height = 497, empty block, timestamp = 1757874740, maxTps = 0, realtimeTps(1m) = 0 ``` ## Install the Examples Pull the latest Arcology examples repository and install the Arcology frontend tools: ```shell git clone --recurse-submodules https://github.com/arcology-network/examples.git ``` ### Structure The examples are organized into folders. ```shell examples/ ├── account/ ├── scaffold/ ├── eth-examples/ ├── ds-token/ └── uniswap/ ``` * Account: Testing accounts. Columns: private key, account address, initial balance (wei). * Scaffold: Starting point for building concurrent applications. * eth-examples: Parallelized examples derived from some of the Ethereum examples (see ). * ds-token: A parallelized version of ds-token (). * uniswap: A parallelized version of uniswap v3 (). {% hint style="info" %} The `scaffold` folder is a good starting point for trying out the examples. {% endhint %} ## Run an Example {% stepper %} {% step %} ### Update the Configuration Each example folder contains a `network.json` file. It holds the info for connecting to your local node and some testing accounts. Replace the `url` field with your node's (DevNet docker) RPC URL. Example `network.json`: ```json { "TestnetInfo": { "url": "http://192.168.117.128:8545", //Your Devnet rpc-url "accounts": ["5bb1315c3ffa654c89f1f8b27f93cb4ef6b0474c4797cf2eb40d1bdd98dc26e7", "2289ae919f03075448d567c9c4a22846ce3711731c895f1bea572cef25bb346f", "19c439237a1e2c86f87b2d31438e5476738dd67297bf92d752b16bdb4ff37aa2", "236c7b430c2ea13f19add3920b0bb2795f35a969f8be617faa9629bc5f6201f1", "c4fbe435d6297959b0e326e560fdfb680a59807d75e1dec04d873fcd5b36597b", "f91fcd0784d0b2e5f88ec3ba6fe57fa7ef4fbf2fe42a8fa0aaa22625d2147a7a", "630549dc7564f9789eb4435098ca147424bcde3f1c14149a5ab18e826868f337", "2a31c00f193d4071adf4e45abaf76d7222d4af87ab30a7a4f7bae51e28aceb0a", "a2ffe69115c1f2f145297a4607e188775a1e56907ca882b7c6def550f218fa84", "d9815a0fa4f31172530f17a6ae64bf5f00a3a651f3d6476146d2c62ae5527dc4", "134aea740081ac7e0e892ff8e5d0a763ec400fcd34bae70bcfe6dae3aceeb7f0" ], "addrs": ["0xaB01a3BfC5de6b5Fc481e18F274ADBdbA9B111f0", "0x21522c86A586e696961b68aa39632948D9F11170", "0xa75Cd05BF16BbeA1759DE2A66c0472131BC5Bd8D", "0x2c7161284197e40E83B1b657e98B3bb8FF3C90ed", "0x57170608aE58b7d62dCdC3cbDb564C05dDBB7eee", "0x9F79316c20f3F83Fcf43deE8a1CeA185A47A5c45", "0x9f9E0F23aFd5404b34006678c900629183c9A25d", "0xd7cB260c7658589fe68789F2d678e1e85F7e4831", "0x230DCCC4660dcBeCb8A6AEA1C713eE7A04B35cAD", "0x8aa62d370585e28fd2333325d3dbaef6112279Ce", "0xc8bc50cA2443F4cE0ebF1bC9396B7f53f62e9C13" ], "chainId": 118 } } ``` {% endstep %} {% step %} ### Run the Test Script Optionally, you can avoid SSH authentication by configuring Git to use HTTPS instead of SSH: ```shell git config --global url."https://github.com/".insteadOf ssh://git@github.com ``` Run the test script inside the example folder (e.g. `scaffold`): ```shell npm install ``` ```shell npx hardhat run test/test-like.js --network TestnetInfo ``` {% endstep %} {% endstepper %} ## Benchmarking {% hint style="info" %} The real-time TPS and gas consumption metrics are very much related to the performance of your machine. Machines with more CPU cores and higher clock speeds will yield better results. {% endhint %} The `benchmark` folder in each example contains transaction generation scripts, each in its own subfolder. For example, the `Like` project has its transaction generation script at: ```shell examples/ └── scaffold/ └── benchmark/ └── like/ └── gen-tx-like.js ``` {% stepper %} {% step %} ### Generating Transactions This process may take quite a while, depending on the number of transactions you want to generate and your machine's performance. A transaction generation script is located under each `/benchmark//`. Run the following script to generate transactions for the `Like` under `scaffold`: ```shell npx hardhat run benchmark/like/gen-tx-like.js --network TestnetInfo ``` You should see an output similar to this: ```shell Deploying like ==== Deployed Like at 0xBe5a9f4b7C2AF3000bAc55e114Ec3A3d55d330db Generating Txs [**** ] 9% 131.4s ``` The generated transaction files can be found in the `txs` folder. For `like`, they are at: ```shell examples/ └── scaffold/ └── benchmark/ └── like/ └── txs/ └── like/ ``` There could be multiple transaction files in the folder, each containing a batch of transactions. {% endstep %} {% step %} ### Running the Benchmark Send the generated transactions to your local node in batch mode. Assuming your DevNet node IP is `192.168.1.103`, run (note: the node IP isn't necessarily the same as your machine IP): ```shell npx arcology.net-tx-sender http://192.168.1.103:8545 benchmark/like/txs/like/ ``` You should see an output similar to this: ```shell height = 2014, empty block, timestamp = 1757509990965, maxTps = 0, realtimeTps = 0 maxGasBurned = 493640, realtimeGasBurned = 0 height = 2015, total = 20000, success = 20000, fail = 0, timestamp = 1757509992541, maxTps = 12690, realtimeTps = 12690 maxGasBurned = 301992385, realtimeGasBurned = 301992385 height = 2016, total = 20000, success = 20000, fail = 0, timestamp = 1757509993742, maxTps = 16652, realtimeTps = 16652 maxGasBurned = 396286427, realtimeGasBurned = 396286427 height = 2017, total = 20000, success = 20000, fail = 0, timestamp = 1757509994826, maxTps = 18450, realtimeTps = 18450 maxGasBurned = 439059040, realtimeGasBurned = 439059040 ``` {% endstep %} {% step %} ### Benchmarking Metrics | Metric | Description | | --------------------- | ----------------------------------------------------------- | | **realtimeTps** | Real-time TPS during the benchmarking. | | **maxTps** | Maximum TPS achieved during the benchmarking. | | **Total** | Total number of transactions sent in the block. | | **Success** | Number of successful transactions in the block. | | **Fail** | Number of failed transactions in the block. | | **realtimeGasBurned** | Real-time gas consumed during the benchmarking. | | **maxGasBurned** | Maximum gas consumed in a single block during benchmarking. | | {% endstep %} | | | {% endstepper %} | | --- # 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.arcology.network/arcology-concurrent-programming-guide/run-the-examples.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.