Skip to content

Latest commit

 

History

History
143 lines (102 loc) · 5.95 KB

readme.md

File metadata and controls

143 lines (102 loc) · 5.95 KB

DApps Profiling

Overview

This is a Node.js application designed to profile Soroban smart contracts. It focuses on analyzing the performance of various smart contract use cases, offering insights into their efficiency and resource utilization.

This project is not intended for execution on the Mainnet! Please run it on the Testnet or Futurenet.

Table of Contents

Project Setup

Requirements

  • Node.js environment.
  • stellar-plus package, a all-in-one library developed by Cheesecake Labs. Check the documentation for more details.
  • js-stellar-sdk package for interacting with the Stellar network.

Running the Project

  1. Installation:

    • Clone the repository and navigate to the project directory.
    • Run npm install to install the required dependencies.

  2. Define the use case:

    • To run a use case, import its entry function in the main index file (./src/index.ts) and execute it with the required arguments.

  3. Starting the Application:

    • Use the command npm run dev to start the application in development mode. This utilizes nodemon and ts-node for automatic reloading and TypeScript support.

Use Cases

The profiling use cases are located in the ./src/profilings directory. Each use case is designed as a standalone module with an entry function that executes the profiling scenario. Each directory has a specific readme file with information on its use, implementation and results obtained.

Available Use Cases

Token profiling

  • Path: ./src/profilings/tokens
  • Function: tokensProfiling
  • Description: Compares the performance of SAC (Stellar Asset Contract) tokens and Soroban Tokens.

Check the tokens profiling Readme for more details.

Usage example
import { StellarPlus } from "stellar-plus";
import { tokenTransactions, tokensProfiling } from "./profilings/tokens";

tokensProfiling({
  nUsers: 5,
  nTransactions: 100,
  network: StellarPlus.Constants.testnet,
  transactions: [
    tokenTransactions.burn,
    tokenTransactions.mint,
    tokenTransactions.transfer,
  ],
  // Add Validation Cloud API Key if desired
});

Comet DEX profiling

  • Path: ./src/profilings/comet-dex
  • Function: cometDexProfiling
  • Description: Logs the performance and resources used in all Comet contracts transactions.

Comet DEX is a protocol that can be checked here. Check the Comet profiling Readme for more details.

Usage example
import { StellarPlus } from "stellar-plus";
import { cometDexProfiling } from "./profilings/comet-dex";

cometDexProfiling({
  nUsers: 1,
  network: StellarPlus.Constants.testnet,
});

Liquidity Pool Profiling

Check the Liqudity Pool profiling Readme for more details.

Usage example
import { StellarPlus } from "stellar-plus";
import { cometDexProfiling } from "./profilings/liquidity-pool";

liquidityPoolProfiling({
  nUsers: 5,
  nTransactions: 100,
  network: StellarPlus.Constants.testnet,
  transactions: [
    liquidityPoolTransactions.deposit,
    liquidityPoolTransactions.swap,
    liquidityPoolTransactions.get_rsrvs,
    liquidityPoolTransactions.withdraw,
  ],
});

Results achieved

This project is a preview of a larger study based on profiling different Soroban protocols on Testnet in order to understand the behaviour os transaction costs. An overview os the values obtained can be seen in the table below. The full data can be accessed at this link.

Resources Average Maximum Minimum Median
CPU Instructions 18,076,055 66,851,295 3,797,619 15,607,473
RAM 3,932,318 20,827,168 1,214,061 2,736,335
Fees 231,516 813,645 45,272 202,884
Ledger Read Bytes 33,284 82,904 696 34,348
Ledger Write Bytes 473 3,116 0 148
Ledger Entry Reads 3 10 1 2
Ledger Entry Writes 2 11 0 1
Events & return value size 158 1,360 4 24
Transaction size 334 1,732 116 192

The individual results can be consulted in the Readme for each use case:

This profiling approach can be useful for understanding the resource utilization of your contract in order to avoid exceeding network resource limits, as well as obtaining an estimate of the resource fees that will be paid for transactions.

Contributing

Feel free to open an issue for bug reports, feature requests, general comments or include a profiling of a new contract.