From c97572a31f3cea44d0fb7b34d7604a038108c664 Mon Sep 17 00:00:00 2001 From: darshankabariya Date: Fri, 10 Apr 2026 19:59:51 +0530 Subject: [PATCH] chore: fixing simulator book --- book.toml | 10 +- docker-compose.yml | 4 +- monitoring/prometheus-config.yml | 400 +++++++++--------- src/SUMMARY.md | 4 +- src/connect-full-node.md | 6 +- src/connect-light-node.md | 4 +- src/connect-spam-node.md | 6 +- src/connect-store-node.md | 6 +- src/deploy-waku-network.md | 12 +- src/inject-traffic.md | 6 +- ...r.md => intro-logos-delivery-simulator.md} | 16 +- src/register-memberships.md | 4 +- tools/rest-traffic/traffic.py | 4 +- 13 files changed, 241 insertions(+), 241 deletions(-) rename src/{intro-waku-simulator.md => intro-logos-delivery-simulator.md} (51%) diff --git a/book.toml b/book.toml index c630463..0e18a16 100644 --- a/book.toml +++ b/book.toml @@ -1,12 +1,12 @@ [book] -authors = ["waku-org"] +authors = ["logos-messaging"] language = "en" multilingual = false src = "src" -title = "Waku Simulator Book" -description = "A brief description of your book." +title = "Logos Delivery Simulator Book" +description = "Documentation for the Logos Delivery Simulator." [output.html] -git-repository-url = "https://github.com/waku-org/waku-simulator" +git-repository-url = "https://github.com/logos-messaging/logos-delivery-simulator" git-repository-icon = "fa-github" -edit-url-template = "https://github.com/waku-org/waku-simulator/edit/master/{path}" +edit-url-template = "https://github.com/logos-messaging/logos-delivery-simulator/edit/master/{path}" diff --git a/docker-compose.yml b/docker-compose.yml index c28cdd9..37fa746 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,7 +11,7 @@ networks: services: # Accounts are hardcoded to 520 with the idea that nwaku nodes use up to 500 for membership registration and the last 20 are used for ad-hoc testing. -# The account number and private key pairs of the last 20 accounts can be found in the Register memberships section of the Waku-simulator book. +# The account number and private key pairs of the last 20 accounts can be found in the Register memberships section of the Logos Delivery Simulator book. foundry: image: ghcr.io/foundry-rs/foundry:nightly-9b73e06e1fe376738b92ae081107620291d50188 labels: @@ -131,7 +131,7 @@ services: context: ./tools/rest-traffic dockerfile: Dockerfile command: - --multiple-nodes=http://waku-simulator-nwaku-[1..${NUM_NWAKU_NODES:-5}]:8645 + --multiple-nodes=http://logos-delivery-simulator_nwaku_[1..${NUM_NWAKU_NODES:-5}]:8645 --msg-size-kbytes=${MSG_SIZE_KBYTES:-10} --delay-seconds=${TRAFFIC_DELAY_SECONDS:-15} networks: diff --git a/monitoring/prometheus-config.yml b/monitoring/prometheus-config.yml index 033f8d0..6392321 100644 --- a/monitoring/prometheus-config.yml +++ b/monitoring/prometheus-config.yml @@ -14,203 +14,203 @@ scrape_configs: static_configs: - targets: - bootstrap:8008 - - waku-simulator-nwaku-1:8008 - - waku-simulator-nwaku-2:8008 - - waku-simulator-nwaku-3:8008 - - waku-simulator-nwaku-4:8008 - - waku-simulator-nwaku-5:8008 - - waku-simulator-nwaku-6:8008 - - waku-simulator-nwaku-7:8008 - - waku-simulator-nwaku-8:8008 - - waku-simulator-nwaku-9:8008 - - waku-simulator-nwaku-10:8008 - - waku-simulator-nwaku-11:8008 - - waku-simulator-nwaku-12:8008 - - waku-simulator-nwaku-13:8008 - - waku-simulator-nwaku-14:8008 - - waku-simulator-nwaku-15:8008 - - waku-simulator-nwaku-16:8008 - - waku-simulator-nwaku-17:8008 - - waku-simulator-nwaku-18:8008 - - waku-simulator-nwaku-19:8008 - - waku-simulator-nwaku-20:8008 - - waku-simulator-nwaku-21:8008 - - waku-simulator-nwaku-22:8008 - - waku-simulator-nwaku-23:8008 - - waku-simulator-nwaku-24:8008 - - waku-simulator-nwaku-25:8008 - - waku-simulator-nwaku-26:8008 - - waku-simulator-nwaku-27:8008 - - waku-simulator-nwaku-28:8008 - - waku-simulator-nwaku-29:8008 - - waku-simulator-nwaku-30:8008 - - waku-simulator-nwaku-31:8008 - - waku-simulator-nwaku-32:8008 - - waku-simulator-nwaku-33:8008 - - waku-simulator-nwaku-34:8008 - - waku-simulator-nwaku-35:8008 - - waku-simulator-nwaku-36:8008 - - waku-simulator-nwaku-37:8008 - - waku-simulator-nwaku-38:8008 - - waku-simulator-nwaku-39:8008 - - waku-simulator-nwaku-40:8008 - - waku-simulator-nwaku-41:8008 - - waku-simulator-nwaku-42:8008 - - waku-simulator-nwaku-43:8008 - - waku-simulator-nwaku-44:8008 - - waku-simulator-nwaku-45:8008 - - waku-simulator-nwaku-46:8008 - - waku-simulator-nwaku-47:8008 - - waku-simulator-nwaku-48:8008 - - waku-simulator-nwaku-49:8008 - - waku-simulator-nwaku-50:8008 - - waku-simulator-nwaku-51:8008 - - waku-simulator-nwaku-52:8008 - - waku-simulator-nwaku-53:8008 - - waku-simulator-nwaku-54:8008 - - waku-simulator-nwaku-55:8008 - - waku-simulator-nwaku-56:8008 - - waku-simulator-nwaku-57:8008 - - waku-simulator-nwaku-58:8008 - - waku-simulator-nwaku-59:8008 - - waku-simulator-nwaku-60:8008 - - waku-simulator-nwaku-61:8008 - - waku-simulator-nwaku-62:8008 - - waku-simulator-nwaku-63:8008 - - waku-simulator-nwaku-64:8008 - - waku-simulator-nwaku-65:8008 - - waku-simulator-nwaku-66:8008 - - waku-simulator-nwaku-67:8008 - - waku-simulator-nwaku-68:8008 - - waku-simulator-nwaku-69:8008 - - waku-simulator-nwaku-70:8008 - - waku-simulator-nwaku-71:8008 - - waku-simulator-nwaku-72:8008 - - waku-simulator-nwaku-73:8008 - - waku-simulator-nwaku-74:8008 - - waku-simulator-nwaku-75:8008 - - waku-simulator-nwaku-76:8008 - - waku-simulator-nwaku-77:8008 - - waku-simulator-nwaku-78:8008 - - waku-simulator-nwaku-79:8008 - - waku-simulator-nwaku-80:8008 - - waku-simulator-nwaku-81:8008 - - waku-simulator-nwaku-82:8008 - - waku-simulator-nwaku-83:8008 - - waku-simulator-nwaku-84:8008 - - waku-simulator-nwaku-85:8008 - - waku-simulator-nwaku-86:8008 - - waku-simulator-nwaku-87:8008 - - waku-simulator-nwaku-88:8008 - - waku-simulator-nwaku-89:8008 - - waku-simulator-nwaku-90:8008 - - waku-simulator-nwaku-91:8008 - - waku-simulator-nwaku-92:8008 - - waku-simulator-nwaku-93:8008 - - waku-simulator-nwaku-94:8008 - - waku-simulator-nwaku-95:8008 - - waku-simulator-nwaku-96:8008 - - waku-simulator-nwaku-97:8008 - - waku-simulator-nwaku-98:8008 - - waku-simulator-nwaku-99:8008 - - waku-simulator-nwaku-100:8008 - - waku-simulator-nwaku-101:8008 - - waku-simulator-nwaku-102:8008 - - waku-simulator-nwaku-103:8008 - - waku-simulator-nwaku-104:8008 - - waku-simulator-nwaku-105:8008 - - waku-simulator-nwaku-106:8008 - - waku-simulator-nwaku-107:8008 - - waku-simulator-nwaku-108:8008 - - waku-simulator-nwaku-109:8008 - - waku-simulator-nwaku-110:8008 - - waku-simulator-nwaku-111:8008 - - waku-simulator-nwaku-112:8008 - - waku-simulator-nwaku-113:8008 - - waku-simulator-nwaku-114:8008 - - waku-simulator-nwaku-115:8008 - - waku-simulator-nwaku-116:8008 - - waku-simulator-nwaku-117:8008 - - waku-simulator-nwaku-118:8008 - - waku-simulator-nwaku-119:8008 - - waku-simulator-nwaku-120:8008 - - waku-simulator-nwaku-121:8008 - - waku-simulator-nwaku-122:8008 - - waku-simulator-nwaku-123:8008 - - waku-simulator-nwaku-124:8008 - - waku-simulator-nwaku-125:8008 - - waku-simulator-nwaku-126:8008 - - waku-simulator-nwaku-127:8008 - - waku-simulator-nwaku-128:8008 - - waku-simulator-nwaku-129:8008 - - waku-simulator-nwaku-130:8008 - - waku-simulator-nwaku-131:8008 - - waku-simulator-nwaku-132:8008 - - waku-simulator-nwaku-133:8008 - - waku-simulator-nwaku-134:8008 - - waku-simulator-nwaku-135:8008 - - waku-simulator-nwaku-136:8008 - - waku-simulator-nwaku-137:8008 - - waku-simulator-nwaku-138:8008 - - waku-simulator-nwaku-139:8008 - - waku-simulator-nwaku-140:8008 - - waku-simulator-nwaku-141:8008 - - waku-simulator-nwaku-142:8008 - - waku-simulator-nwaku-143:8008 - - waku-simulator-nwaku-144:8008 - - waku-simulator-nwaku-145:8008 - - waku-simulator-nwaku-146:8008 - - waku-simulator-nwaku-147:8008 - - waku-simulator-nwaku-148:8008 - - waku-simulator-nwaku-149:8008 - - waku-simulator-nwaku-150:8008 - - waku-simulator-nwaku-151:8008 - - waku-simulator-nwaku-152:8008 - - waku-simulator-nwaku-153:8008 - - waku-simulator-nwaku-154:8008 - - waku-simulator-nwaku-155:8008 - - waku-simulator-nwaku-156:8008 - - waku-simulator-nwaku-157:8008 - - waku-simulator-nwaku-158:8008 - - waku-simulator-nwaku-159:8008 - - waku-simulator-nwaku-160:8008 - - waku-simulator-nwaku-161:8008 - - waku-simulator-nwaku-162:8008 - - waku-simulator-nwaku-163:8008 - - waku-simulator-nwaku-164:8008 - - waku-simulator-nwaku-165:8008 - - waku-simulator-nwaku-166:8008 - - waku-simulator-nwaku-167:8008 - - waku-simulator-nwaku-168:8008 - - waku-simulator-nwaku-169:8008 - - waku-simulator-nwaku-170:8008 - - waku-simulator-nwaku-171:8008 - - waku-simulator-nwaku-172:8008 - - waku-simulator-nwaku-173:8008 - - waku-simulator-nwaku-174:8008 - - waku-simulator-nwaku-175:8008 - - waku-simulator-nwaku-176:8008 - - waku-simulator-nwaku-177:8008 - - waku-simulator-nwaku-178:8008 - - waku-simulator-nwaku-179:8008 - - waku-simulator-nwaku-180:8008 - - waku-simulator-nwaku-181:8008 - - waku-simulator-nwaku-182:8008 - - waku-simulator-nwaku-183:8008 - - waku-simulator-nwaku-184:8008 - - waku-simulator-nwaku-185:8008 - - waku-simulator-nwaku-186:8008 - - waku-simulator-nwaku-187:8008 - - waku-simulator-nwaku-188:8008 - - waku-simulator-nwaku-189:8008 - - waku-simulator-nwaku-190:8008 - - waku-simulator-nwaku-191:8008 - - waku-simulator-nwaku-192:8008 - - waku-simulator-nwaku-193:8008 - - waku-simulator-nwaku-194:8008 - - waku-simulator-nwaku-195:8008 - - waku-simulator-nwaku-196:8008 - - waku-simulator-nwaku-197:8008 - - waku-simulator-nwaku-198:8008 - - waku-simulator-nwaku-199:8008 - - waku-simulator-nwaku-200:8008 \ No newline at end of file + - logos-delivery-simulator_nwaku_1:8008 + - logos-delivery-simulator_nwaku_2:8008 + - logos-delivery-simulator_nwaku_3:8008 + - logos-delivery-simulator_nwaku_4:8008 + - logos-delivery-simulator_nwaku_5:8008 + - logos-delivery-simulator_nwaku_6:8008 + - logos-delivery-simulator_nwaku_7:8008 + - logos-delivery-simulator_nwaku_8:8008 + - logos-delivery-simulator_nwaku_9:8008 + - logos-delivery-simulator_nwaku_10:8008 + - logos-delivery-simulator_nwaku_11:8008 + - logos-delivery-simulator_nwaku_12:8008 + - logos-delivery-simulator_nwaku_13:8008 + - logos-delivery-simulator_nwaku_14:8008 + - logos-delivery-simulator_nwaku_15:8008 + - logos-delivery-simulator_nwaku_16:8008 + - logos-delivery-simulator_nwaku_17:8008 + - logos-delivery-simulator_nwaku_18:8008 + - logos-delivery-simulator_nwaku_19:8008 + - logos-delivery-simulator_nwaku_20:8008 + - logos-delivery-simulator_nwaku_21:8008 + - logos-delivery-simulator_nwaku_22:8008 + - logos-delivery-simulator_nwaku_23:8008 + - logos-delivery-simulator_nwaku_24:8008 + - logos-delivery-simulator_nwaku_25:8008 + - logos-delivery-simulator_nwaku_26:8008 + - logos-delivery-simulator_nwaku_27:8008 + - logos-delivery-simulator_nwaku_28:8008 + - logos-delivery-simulator_nwaku_29:8008 + - logos-delivery-simulator_nwaku_30:8008 + - logos-delivery-simulator_nwaku_31:8008 + - logos-delivery-simulator_nwaku_32:8008 + - logos-delivery-simulator_nwaku_33:8008 + - logos-delivery-simulator_nwaku_34:8008 + - logos-delivery-simulator_nwaku_35:8008 + - logos-delivery-simulator_nwaku_36:8008 + - logos-delivery-simulator_nwaku_37:8008 + - logos-delivery-simulator_nwaku_38:8008 + - logos-delivery-simulator_nwaku_39:8008 + - logos-delivery-simulator_nwaku_40:8008 + - logos-delivery-simulator_nwaku_41:8008 + - logos-delivery-simulator_nwaku_42:8008 + - logos-delivery-simulator_nwaku_43:8008 + - logos-delivery-simulator_nwaku_44:8008 + - logos-delivery-simulator_nwaku_45:8008 + - logos-delivery-simulator_nwaku_46:8008 + - logos-delivery-simulator_nwaku_47:8008 + - logos-delivery-simulator_nwaku_48:8008 + - logos-delivery-simulator_nwaku_49:8008 + - logos-delivery-simulator_nwaku_50:8008 + - logos-delivery-simulator_nwaku_51:8008 + - logos-delivery-simulator_nwaku_52:8008 + - logos-delivery-simulator_nwaku_53:8008 + - logos-delivery-simulator_nwaku_54:8008 + - logos-delivery-simulator_nwaku_55:8008 + - logos-delivery-simulator_nwaku_56:8008 + - logos-delivery-simulator_nwaku_57:8008 + - logos-delivery-simulator_nwaku_58:8008 + - logos-delivery-simulator_nwaku_59:8008 + - logos-delivery-simulator_nwaku_60:8008 + - logos-delivery-simulator_nwaku_61:8008 + - logos-delivery-simulator_nwaku_62:8008 + - logos-delivery-simulator_nwaku_63:8008 + - logos-delivery-simulator_nwaku_64:8008 + - logos-delivery-simulator_nwaku_65:8008 + - logos-delivery-simulator_nwaku_66:8008 + - logos-delivery-simulator_nwaku_67:8008 + - logos-delivery-simulator_nwaku_68:8008 + - logos-delivery-simulator_nwaku_69:8008 + - logos-delivery-simulator_nwaku_70:8008 + - logos-delivery-simulator_nwaku_71:8008 + - logos-delivery-simulator_nwaku_72:8008 + - logos-delivery-simulator_nwaku_73:8008 + - logos-delivery-simulator_nwaku_74:8008 + - logos-delivery-simulator_nwaku_75:8008 + - logos-delivery-simulator_nwaku_76:8008 + - logos-delivery-simulator_nwaku_77:8008 + - logos-delivery-simulator_nwaku_78:8008 + - logos-delivery-simulator_nwaku_79:8008 + - logos-delivery-simulator_nwaku_80:8008 + - logos-delivery-simulator_nwaku_81:8008 + - logos-delivery-simulator_nwaku_82:8008 + - logos-delivery-simulator_nwaku_83:8008 + - logos-delivery-simulator_nwaku_84:8008 + - logos-delivery-simulator_nwaku_85:8008 + - logos-delivery-simulator_nwaku_86:8008 + - logos-delivery-simulator_nwaku_87:8008 + - logos-delivery-simulator_nwaku_88:8008 + - logos-delivery-simulator_nwaku_89:8008 + - logos-delivery-simulator_nwaku_90:8008 + - logos-delivery-simulator_nwaku_91:8008 + - logos-delivery-simulator_nwaku_92:8008 + - logos-delivery-simulator_nwaku_93:8008 + - logos-delivery-simulator_nwaku_94:8008 + - logos-delivery-simulator_nwaku_95:8008 + - logos-delivery-simulator_nwaku_96:8008 + - logos-delivery-simulator_nwaku_97:8008 + - logos-delivery-simulator_nwaku_98:8008 + - logos-delivery-simulator_nwaku_99:8008 + - logos-delivery-simulator_nwaku_100:8008 + - logos-delivery-simulator_nwaku_101:8008 + - logos-delivery-simulator_nwaku_102:8008 + - logos-delivery-simulator_nwaku_103:8008 + - logos-delivery-simulator_nwaku_104:8008 + - logos-delivery-simulator_nwaku_105:8008 + - logos-delivery-simulator_nwaku_106:8008 + - logos-delivery-simulator_nwaku_107:8008 + - logos-delivery-simulator_nwaku_108:8008 + - logos-delivery-simulator_nwaku_109:8008 + - logos-delivery-simulator_nwaku_110:8008 + - logos-delivery-simulator_nwaku_111:8008 + - logos-delivery-simulator_nwaku_112:8008 + - logos-delivery-simulator_nwaku_113:8008 + - logos-delivery-simulator_nwaku_114:8008 + - logos-delivery-simulator_nwaku_115:8008 + - logos-delivery-simulator_nwaku_116:8008 + - logos-delivery-simulator_nwaku_117:8008 + - logos-delivery-simulator_nwaku_118:8008 + - logos-delivery-simulator_nwaku_119:8008 + - logos-delivery-simulator_nwaku_120:8008 + - logos-delivery-simulator_nwaku_121:8008 + - logos-delivery-simulator_nwaku_122:8008 + - logos-delivery-simulator_nwaku_123:8008 + - logos-delivery-simulator_nwaku_124:8008 + - logos-delivery-simulator_nwaku_125:8008 + - logos-delivery-simulator_nwaku_126:8008 + - logos-delivery-simulator_nwaku_127:8008 + - logos-delivery-simulator_nwaku_128:8008 + - logos-delivery-simulator_nwaku_129:8008 + - logos-delivery-simulator_nwaku_130:8008 + - logos-delivery-simulator_nwaku_131:8008 + - logos-delivery-simulator_nwaku_132:8008 + - logos-delivery-simulator_nwaku_133:8008 + - logos-delivery-simulator_nwaku_134:8008 + - logos-delivery-simulator_nwaku_135:8008 + - logos-delivery-simulator_nwaku_136:8008 + - logos-delivery-simulator_nwaku_137:8008 + - logos-delivery-simulator_nwaku_138:8008 + - logos-delivery-simulator_nwaku_139:8008 + - logos-delivery-simulator_nwaku_140:8008 + - logos-delivery-simulator_nwaku_141:8008 + - logos-delivery-simulator_nwaku_142:8008 + - logos-delivery-simulator_nwaku_143:8008 + - logos-delivery-simulator_nwaku_144:8008 + - logos-delivery-simulator_nwaku_145:8008 + - logos-delivery-simulator_nwaku_146:8008 + - logos-delivery-simulator_nwaku_147:8008 + - logos-delivery-simulator_nwaku_148:8008 + - logos-delivery-simulator_nwaku_149:8008 + - logos-delivery-simulator_nwaku_150:8008 + - logos-delivery-simulator_nwaku_151:8008 + - logos-delivery-simulator_nwaku_152:8008 + - logos-delivery-simulator_nwaku_153:8008 + - logos-delivery-simulator_nwaku_154:8008 + - logos-delivery-simulator_nwaku_155:8008 + - logos-delivery-simulator_nwaku_156:8008 + - logos-delivery-simulator_nwaku_157:8008 + - logos-delivery-simulator_nwaku_158:8008 + - logos-delivery-simulator_nwaku_159:8008 + - logos-delivery-simulator_nwaku_160:8008 + - logos-delivery-simulator_nwaku_161:8008 + - logos-delivery-simulator_nwaku_162:8008 + - logos-delivery-simulator_nwaku_163:8008 + - logos-delivery-simulator_nwaku_164:8008 + - logos-delivery-simulator_nwaku_165:8008 + - logos-delivery-simulator_nwaku_166:8008 + - logos-delivery-simulator_nwaku_167:8008 + - logos-delivery-simulator_nwaku_168:8008 + - logos-delivery-simulator_nwaku_169:8008 + - logos-delivery-simulator_nwaku_170:8008 + - logos-delivery-simulator_nwaku_171:8008 + - logos-delivery-simulator_nwaku_172:8008 + - logos-delivery-simulator_nwaku_173:8008 + - logos-delivery-simulator_nwaku_174:8008 + - logos-delivery-simulator_nwaku_175:8008 + - logos-delivery-simulator_nwaku_176:8008 + - logos-delivery-simulator_nwaku_177:8008 + - logos-delivery-simulator_nwaku_178:8008 + - logos-delivery-simulator_nwaku_179:8008 + - logos-delivery-simulator_nwaku_180:8008 + - logos-delivery-simulator_nwaku_181:8008 + - logos-delivery-simulator_nwaku_182:8008 + - logos-delivery-simulator_nwaku_183:8008 + - logos-delivery-simulator_nwaku_184:8008 + - logos-delivery-simulator_nwaku_185:8008 + - logos-delivery-simulator_nwaku_186:8008 + - logos-delivery-simulator_nwaku_187:8008 + - logos-delivery-simulator_nwaku_188:8008 + - logos-delivery-simulator_nwaku_189:8008 + - logos-delivery-simulator_nwaku_190:8008 + - logos-delivery-simulator_nwaku_191:8008 + - logos-delivery-simulator_nwaku_192:8008 + - logos-delivery-simulator_nwaku_193:8008 + - logos-delivery-simulator_nwaku_194:8008 + - logos-delivery-simulator_nwaku_195:8008 + - logos-delivery-simulator_nwaku_196:8008 + - logos-delivery-simulator_nwaku_197:8008 + - logos-delivery-simulator_nwaku_198:8008 + - logos-delivery-simulator_nwaku_199:8008 + - logos-delivery-simulator_nwaku_200:8008 \ No newline at end of file diff --git a/src/SUMMARY.md b/src/SUMMARY.md index ada3e74..ae26224 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,7 +1,7 @@ # Summary -- [Introduction to Waku Simulator](./intro-waku-simulator.md) -- [Deploy a waku network](./deploy-waku-network.md) +- [Introduction to Logos Delivery Simulator](./intro-logos-delivery-simulator.md) +- [Deploy a delivery network](./deploy-waku-network.md) - [Inject traffic](./inject-traffic.md) - [Connect external full node](./connect-full-node.md) - [Connect external spam node](./connect-spam-node.md) diff --git a/src/connect-full-node.md b/src/connect-full-node.md index 2e89d61..975c93f 100644 --- a/src/connect-full-node.md +++ b/src/connect-full-node.md @@ -1,12 +1,12 @@ # Connect external full node -If you want to connect to the existing waku network a node with some custom configuration. Perhaps a different image or some other configuration, you can do it as follows. Bear in mind that if this node has other configuration (eg `rln-relay-epoch-sec` or `rln-relay-user-message-limit`) then it won’t behave properly. +If you want to connect a node with some custom configuration to the existing Logos delivery network. Perhaps a different image or some other configuration, you can do it as follows. Bear in mind that if this node has other configuration (eg `rln-relay-epoch-sec` or `rln-relay-user-message-limit`) then it won’t behave properly. - ⚠️set your own `staticnode` ```bash -docker run -it --network waku-simulator_simulation quay.io/wakuorg/nwaku-pr:2759-rln-v2 \ +docker run -it --network logos-delivery-simulator_simulation quay.io/wakuorg/nwaku-pr:2759-rln-v2 \ --relay=true \ --rln-relay=true \ --rln-relay-dynamic=true \ @@ -26,7 +26,7 @@ You can also try to connect multiple nodes with a loop. Note the `&`. Remember t ```bash for i in {1..5}; do - docker run -it --network waku-simulator_simulation quay.io/wakuorg/nwaku-pr:2759-rln-v2 \ + docker run -it --network logos-delivery-simulator_simulation quay.io/wakuorg/nwaku-pr:2759-rln-v2 \ --relay=true \ --rln-relay=true \ --rln-relay-dynamic=true \ diff --git a/src/connect-light-node.md b/src/connect-light-node.md index 5e90fcc..2d91e24 100644 --- a/src/connect-light-node.md +++ b/src/connect-light-node.md @@ -7,7 +7,7 @@ Note that if you spin up multiple services like this using the same `priv-key` s - ⚠️ change `lightpush-peer` to the node you wish. Note that the multiaddress is logged by every peer at startup. ```jsx -docker run --network waku-simulator_simulation alrevuelta/go-waku-light:4fabb22 \ +docker run --network logos-delivery-simulator_simulation alrevuelta/go-waku-light:4fabb22 \ --eth-endpoint=http://foundry:8545 \ --contract-address=0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9 \ send-messages-loop \ @@ -26,7 +26,7 @@ Note that in some examples, it could be interesting to run multiple instances, e ```bash for i in {1..5}; do - docker run --rm --network waku-simulator_simulation alrevuelta/go-waku-light:4fabb22 \ + docker run --rm --network logos-delivery-simulator_simulation alrevuelta/go-waku-light:4fabb22 \ --eth-endpoint=http://foundry:8545 \ --contract-address=0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9 \ send-messages-loop \ diff --git a/src/connect-spam-node.md b/src/connect-spam-node.md index a9524ca..6de4629 100644 --- a/src/connect-spam-node.md +++ b/src/connect-spam-node.md @@ -6,7 +6,7 @@ By using the [nwaku-spammer] (https://github.com/waku-org/nwaku/pull/2821), you - ⚠️ change `staticnode` to the node you wish. Note that the multiaddress is logged by every peer at startup. ```bash -docker run -it --network waku-simulator_simulation quay.io/wakuorg/nwaku-pr:2821 \ +docker run -it --network logos-delivery-simulator_simulation quay.io/wakuorg/nwaku-pr:2821 \ --relay=true \ --rln-relay=true \ --rln-relay-dynamic=true \ @@ -38,7 +38,7 @@ You can also try to connect multiple spamming nodes, but it might be necessary t ```bash for i in {1..5}; do -docker run -it --network waku-simulator_simulation quay.io/wakuorg/nwaku-pr:2821 \ +docker run -it --network logos-delivery-simulator_simulation quay.io/wakuorg/nwaku-pr:2821 \ --relay=true \ --rln-relay=true \ --rln-relay-dynamic=true \ @@ -61,7 +61,7 @@ done The spammer node also provides a method to test burst messaging. It will send the total user-message-limit of messages sequentially without pauses, then rests for the epoch period and repeats. ```bash -docker run -it --network waku-simulator_simulation quay.io/wakuorg/nwaku-pr:2821 \ +docker run -it --network logos-delivery-simulator_simulation quay.io/wakuorg/nwaku-pr:2821 \ --relay=true \ --rln-relay=true \ --rln-relay-dynamic=true \ diff --git a/src/connect-store-node.md b/src/connect-store-node.md index 86b5141..d181eb7 100644 --- a/src/connect-store-node.md +++ b/src/connect-store-node.md @@ -1,7 +1,7 @@ # Connect external store node -One or more external store nodes can be connected to the waku-simulator network by using configuration similar to that shown below. The store node(s) can use the DB as backend from an existing staging or production system DB or a custom one. When connecting to any DB ensure that the `store-message-retention-policy` matches that of the system. -The staticnode that the store node connects to can be any existing node in the waku-simulator network, alternatively use the discv5 configuration. +One or more external store nodes can be connected to the logos-delivery-simulator network by using configuration similar to that shown below. The store node(s) can use the DB as backend from an existing staging or production system DB or a custom one. When connecting to any DB ensure that the `store-message-retention-policy` matches that of the system. +The staticnode that the store node connects to can be any existing node in the logos-delivery-simulator network, alternatively use the discv5 configuration. ```bash --discv5-discovery=true \ @@ -21,7 +21,7 @@ The [message-finder](https://github.com/waku-org/message-finder) tool could also ```bash -docker run -it --network waku-simulator_simulation --name nwaku_storenode_1 -d harbor.status.im/wakuorg/nwaku:latest \ +docker run -it --network logos-delivery-simulator_simulation --name nwaku_storenode_1 -d harbor.status.im/wakuorg/nwaku:latest \ --relay=true\ --rest=true\ --rest-address=0.0.0.0\ diff --git a/src/deploy-waku-network.md b/src/deploy-waku-network.md index 314d4f8..48f7496 100644 --- a/src/deploy-waku-network.md +++ b/src/deploy-waku-network.md @@ -1,6 +1,6 @@ -# Deploy a waku network +# Deploy a delivery network -The network can be deployed in a few commands, and requires `docker` and `docker-compose`. Some of the configuration is exposed via env flags, but if you are missing some, PRs are accepted. +The network can be deployed in a few commands, and requires `docker` and `docker compose`. Some of the configuration is exposed via env flags, but if you are missing some, PRs are accepted. Some of the most important parameters are: @@ -36,20 +36,20 @@ After a couple of minutes, everything should be running at: For greater observability, one can access each node logs as follows: ```bash -docker logs waku-simulator-nwaku-1 -docker logs waku-simulator-nwaku-2 +docker logs logos-delivery-simulator_nwaku_1 +docker logs logos-delivery-simulator_nwaku_2 ``` Or if you want to follow the logs ```bash -docker logs waku-simulator-nwaku-1 --follow +docker logs logos-delivery-simulator_nwaku_1 --follow ``` Once the network of nwaku nodes is up and running we can use it to perform different tests, connecting other nodes that we fully control with some specific characteristics. This ranges from connecting spammer nodes, light clients, and in the future unsynced nodes, etc. -Now that we have the network deployed we can use it. Hereunder we describe how to use the network deployed by `waku-simulator` to perform end-to-end tests of any desired feature. We focus on the following ones: +Now that we have the network deployed we can use it. Hereunder we describe how to use the network deployed by `logos-delivery-simulator` to perform end-to-end tests of any desired feature. We focus on the following ones: - Inject traffic: - Connect external full node: diff --git a/src/inject-traffic.md b/src/inject-traffic.md index 715d6f1..7aa4b6c 100644 --- a/src/inject-traffic.md +++ b/src/inject-traffic.md @@ -1,14 +1,14 @@ # Inject traffic -In order to inject traffic into the network, we can use the REST API of each nwaku node. We have a simple dockerized script in [rest-traffic](https://github.com/alrevuelta/rest-traffic), that can perform this task. In the following command we run a docker container, connected to the waku-simulator network. This script will inject a message every `delay-seconds` with a size of `msg-size-kbytes` into a given `pubsub-topic`. Note that in `multiple-nodes` you can configure the nodes that will publish messages, where `[1..5]` will publish to node 1, 2, 3, 4, 5. You can publish to a single node (e.g. node 1) by using `[1..1]`. +In order to inject traffic into the network, we can use the REST API of each nwaku node. We have a simple dockerized script in [rest-traffic](https://github.com/alrevuelta/rest-traffic), that can perform this task. In the following command we run a docker container, connected to the logos-delivery-simulator network. This script will inject a message every `delay-seconds` with a size of `msg-size-kbytes` into a given `pubsub-topic`. Note that in `multiple-nodes` you can configure the nodes that will publish messages, where `[1..5]` will publish to node 1, 2, 3, 4, 5. You can publish to a single node (e.g. node 1) by using `[1..1]`. ```jsx -docker run -it --network waku-simulator_simulation alrevuelta/rest-traffic:d936446 \ +docker run -it --network logos-delivery-simulator_simulation alrevuelta/rest-traffic:d936446 \ --delay-seconds=10 \ --msg-size-kbytes=5 \ --pubsub-topic=/waku/2/rs/66/0 \ ---multiple-nodes="http://waku-simulator-nwaku-[1..5]:8645" +--multiple-nodes="http://logos-delivery-simulator_nwaku_[1..5]:8645" ``` Note that the REST API doesn’t allow to publish messages exceeding the rate limit, so this tool can’t be used to test beyond the rate limits. diff --git a/src/intro-waku-simulator.md b/src/intro-logos-delivery-simulator.md similarity index 51% rename from src/intro-waku-simulator.md rename to src/intro-logos-delivery-simulator.md index f2abd7a..8628a87 100644 --- a/src/intro-waku-simulator.md +++ b/src/intro-logos-delivery-simulator.md @@ -1,19 +1,19 @@ -# Introduction to Waku Simulator +# Introduction to Logos Delivery Simulator -The [waku-simulator](https://github.com/waku-org/waku-simulator) tool allows simulating a waku network with a set of interconnected [nwaku](https://github.com/waku-org/nwaku) nodes with the following features: +The [logos-delivery-simulator](https://github.com/logos-messaging/logos-delivery-simulator) tool allows simulating a Logos delivery network built on a set of interconnected [nwaku](https://github.com/waku-org/nwaku) nodes with the following features: - Configurable amount of nodes. Limits depend on the machine and are upper bounded at around 200. -- Runs in a single machine, using `docker-compose` to orchestrate the containers. +- Runs in a single machine, using `docker compose` to orchestrate the containers. - It uses discv5 for peer discovery, using a common bootstrap node. -- It runs a custom ad hoc network, isolated from the existing waku networks. +- It runs a custom ad hoc network, isolated from any existing public networks. - It uses a freshly deployed private blockchain, with full control over it and minimum state to track. - It deploys an RLN contract in the said private blockchain and configures it to be used by all nodes. -- It registers an RLN membership for each node in the network, configuring it in the node to publish valid messages. +- It registers an RLN membership for each node in the network, configuring it to publish valid messages. - It exposes each node’s API, so that it can be used to inject traffic into the network. - Simple to run. Everything is automated. Requires two commands to run. -The main goals of `waku-simulator` include but are not limited to: +The main goals of `logos-delivery-simulator` include but are not limited to: * Test new features in an end to end setup with multiple nodes. -* Use as a long-lived running network on latest master, to anticipate breaking changes. -* Explore waku's limits by using different loads and configurations. +* Use as a long-lived running network on the latest master, to anticipate breaking changes. +* Explore the delivery layer's limits under different loads and configurations. * Offer a tool to debug problems in a controlled and easy to replicate environment. diff --git a/src/register-memberships.md b/src/register-memberships.md index 448994a..3e48c8f 100644 --- a/src/register-memberships.md +++ b/src/register-memberships.md @@ -4,7 +4,7 @@ The [go-waku-light](https://github.com/alrevuelta/go-waku-light) tool can be used as well to register multiple RLN memberships. This can be useful to stress test the nodes, forcing a large amount of memberships. Set `amount` to the amount of memberships that you want to register. Note that it takes some time, since memberships are registered one after the other. You can spin up multiple services like this, but in that case you must provide different `priv-key` to each. Note that these memberships are kind of thrown away and not used to send messages. ```jsx -docker run --network waku-simulator_simulation alrevuelta/go-waku-light:07b8f32 \ +docker run --network logos-delivery-simulator_simulation alrevuelta/go-waku-light:07b8f32 \ --eth-endpoint=http://foundry:8545 \ --contract-address=0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9 \ register \ @@ -14,7 +14,7 @@ register \ ``` -The foundry service in the waku-simulator generates deterministic accounts that can be used to register memberships. It is recommended to use different accounts for registering multiple memberships at the same time. The last 20 accounts generated are provided for ad-hoc testing purposes. +The foundry service in the logos-delivery-simulator generates deterministic accounts that can be used to register memberships. It is recommended to use different accounts for registering multiple memberships at the same time. The last 20 accounts generated are provided for ad-hoc testing purposes.
Account and Private-key Pairs diff --git a/tools/rest-traffic/traffic.py b/tools/rest-traffic/traffic.py index 0f8d837..6d8e341 100644 --- a/tools/rest-traffic/traffic.py +++ b/tools/rest-traffic/traffic.py @@ -44,8 +44,8 @@ parser = argparse.ArgumentParser(description='') # these flags are mutually exclusive, one or the other, never at once group = parser.add_mutually_exclusive_group(required=True) -group.add_argument('-sn', '--single-node', type=str, help='example: http://waku-simulator-nwaku-1:8645') -group.add_argument('-mn', '--multiple-nodes', type=str, help='example: http://waku-simulator-nwaku-[1..10]:8645') +group.add_argument('-sn', '--single-node', type=str, help='example: http://logos-delivery-simulator_nwaku_1:8645') +group.add_argument('-mn', '--multiple-nodes', type=str, help='example: http://logos-delivery-simulator_nwaku_[1..10]:8645') # rest of araguments parser.add_argument('-c', '--content-topic', type=str, help='content topic', default="my-ctopic")