Tiltfile 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586
  1. # This Tiltfile contains the deployment and build config for the Wormhole devnet.
  2. #
  3. # We use Buildkit cache mounts and careful layering to avoid unnecessary rebuilds - almost
  4. # all source code changes result in small, incremental rebuilds. Dockerfiles are written such
  5. # that, for example, changing the contract source code won't cause Solana itself to be rebuilt.
  6. #
  7. load("ext://namespace", "namespace_create", "namespace_inject")
  8. load("ext://secret", "secret_yaml_generic")
  9. allow_k8s_contexts("ci")
  10. # Disable telemetry by default
  11. analytics_settings(False)
  12. # Moar updates (default is 3)
  13. update_settings(max_parallel_updates = 10)
  14. # Runtime configuration
  15. config.define_bool("ci", False, "We are running in CI")
  16. config.define_bool("manual", False, "Set TRIGGER_MODE_MANUAL by default")
  17. config.define_string("num", False, "Number of guardian nodes to run")
  18. # You do not usually need to set this argument - this argument is for debugging only. If you do use a different
  19. # namespace, note that the "wormhole" namespace is hardcoded in tests and don't forget specifying the argument
  20. # when running "tilt down".
  21. #
  22. config.define_string("namespace", False, "Kubernetes namespace to use")
  23. # These arguments will enable writing Guardian events to a cloud BigTable instance.
  24. # Writing to a cloud BigTable is optional. These arguments are not required to run the devnet.
  25. config.define_string("gcpProject", False, "GCP project ID for BigTable persistence")
  26. config.define_string("bigTableKeyPath", False, "Path to BigTable json key file")
  27. # When running Tilt on a server, this can be used to set the public hostname Tilt runs on
  28. # for service links in the UI to work.
  29. config.define_string("webHost", False, "Public hostname for port forwards")
  30. # Components
  31. config.define_bool("algorand", False, "Enable Algorand component")
  32. config.define_bool("solana", False, "Enable Solana component")
  33. config.define_bool("explorer", False, "Enable explorer component")
  34. config.define_bool("bridge_ui", False, "Enable bridge UI component")
  35. config.define_bool("spy_relayer", False, "Enable spy relayer")
  36. config.define_bool("e2e", False, "Enable E2E testing stack")
  37. config.define_bool("ci_tests", False, "Enable tests runner component")
  38. config.define_bool("bridge_ui_hot", False, "Enable hot loading bridge_ui")
  39. config.define_bool("guardiand_debug", False, "Enable dlv endpoint for guardiand")
  40. cfg = config.parse()
  41. num_guardians = int(cfg.get("num", "1"))
  42. namespace = cfg.get("namespace", "wormhole")
  43. gcpProject = cfg.get("gcpProject", "local-dev")
  44. bigTableKeyPath = cfg.get("bigTableKeyPath", "./event_database/devnet_key.json")
  45. webHost = cfg.get("webHost", "localhost")
  46. algorand = cfg.get("algorand", True)
  47. solana = cfg.get("solana", True)
  48. ci = cfg.get("ci", False)
  49. explorer = cfg.get("explorer", ci)
  50. bridge_ui = cfg.get("bridge_ui", ci)
  51. spy_relayer = cfg.get("spy_relayer", ci)
  52. e2e = cfg.get("e2e", ci)
  53. ci_tests = cfg.get("ci_tests", ci)
  54. guardiand_debug = cfg.get("guardiand_debug", False)
  55. bridge_ui_hot = not ci
  56. if cfg.get("manual", False):
  57. trigger_mode = TRIGGER_MODE_MANUAL
  58. else:
  59. trigger_mode = TRIGGER_MODE_AUTO
  60. # namespace
  61. if not ci:
  62. namespace_create(namespace)
  63. def k8s_yaml_with_ns(objects):
  64. return k8s_yaml(namespace_inject(objects, namespace))
  65. # protos
  66. proto_deps = ["./proto", "buf.yaml", "buf.gen.yaml"]
  67. local_resource(
  68. name = "proto-gen",
  69. deps = proto_deps,
  70. cmd = "tilt docker build -- --target go-export -f Dockerfile.proto -o type=local,dest=node .",
  71. env = {"DOCKER_BUILDKIT": "1"},
  72. labels = ["protobuf"],
  73. allow_parallel = True,
  74. trigger_mode = trigger_mode,
  75. )
  76. local_resource(
  77. name = "proto-gen-web",
  78. deps = proto_deps + ["buf.gen.web.yaml"],
  79. resource_deps = ["proto-gen"],
  80. cmd = "tilt docker build -- --target node-export -f Dockerfile.proto -o type=local,dest=. .",
  81. env = {"DOCKER_BUILDKIT": "1"},
  82. labels = ["protobuf"],
  83. allow_parallel = True,
  84. trigger_mode = trigger_mode,
  85. )
  86. local_resource(
  87. name = "const-gen",
  88. deps = ["scripts", "clients", "ethereum/.env.test"],
  89. cmd = 'tilt docker build -- --target const-export -f Dockerfile.const -o type=local,dest=. --build-arg num_guardians=%s .' % (num_guardians),
  90. env = {"DOCKER_BUILDKIT": "1"},
  91. allow_parallel = True,
  92. trigger_mode = trigger_mode,
  93. )
  94. # wasm
  95. if solana:
  96. local_resource(
  97. name = "wasm-gen",
  98. deps = ["solana"],
  99. dir = "solana",
  100. cmd = "tilt docker build -- -f Dockerfile.wasm -o type=local,dest=.. .",
  101. env = {"DOCKER_BUILDKIT": "1"},
  102. labels = ["solana"],
  103. allow_parallel = True,
  104. trigger_mode = trigger_mode,
  105. )
  106. # node
  107. if explorer:
  108. k8s_yaml_with_ns(
  109. secret_yaml_generic(
  110. "node-bigtable-key",
  111. from_file = "bigtable-key.json=" + bigTableKeyPath,
  112. ),
  113. )
  114. docker_build(
  115. ref = "guardiand-image",
  116. context = "node",
  117. dockerfile = "node/Dockerfile",
  118. )
  119. def command_with_dlv(argv):
  120. return [
  121. "/dlv",
  122. "--listen=0.0.0.0:2345",
  123. "--accept-multiclient",
  124. "--headless=true",
  125. "--api-version=2",
  126. "--continue=true",
  127. "exec",
  128. argv[0],
  129. "--",
  130. ] + argv[1:]
  131. def build_node_yaml():
  132. node_yaml = read_yaml_stream("devnet/node.yaml")
  133. for obj in node_yaml:
  134. if obj["kind"] == "StatefulSet" and obj["metadata"]["name"] == "guardian":
  135. obj["spec"]["replicas"] = num_guardians
  136. container = obj["spec"]["template"]["spec"]["containers"][0]
  137. if container["name"] != "guardiand":
  138. fail("container 0 is not guardiand")
  139. container["command"] += ["--devNumGuardians", str(num_guardians)]
  140. if guardiand_debug:
  141. container["command"] = command_with_dlv(container["command"])
  142. container["command"] += ["--logLevel=debug"]
  143. print(container["command"])
  144. if explorer:
  145. container["command"] += [
  146. "--bigTablePersistenceEnabled",
  147. "--bigTableInstanceName",
  148. "wormhole",
  149. "--bigTableTableName",
  150. "v2Events",
  151. "--bigTableTopicName",
  152. "new-vaa-devnet",
  153. "--bigTableKeyPath",
  154. "/tmp/mounted-keys/bigtable-key.json",
  155. "--bigTableGCPProject",
  156. gcpProject,
  157. ]
  158. return encode_yaml_stream(node_yaml)
  159. k8s_yaml_with_ns(build_node_yaml())
  160. guardian_resource_deps = ["proto-gen", "eth-devnet", "eth-devnet2", "terra-terrad"]
  161. if solana:
  162. guardian_resource_deps = guardian_resource_deps + ["solana-devnet"]
  163. k8s_resource(
  164. "guardian",
  165. resource_deps = guardian_resource_deps,
  166. port_forwards = [
  167. port_forward(6060, name = "Debug/Status Server [:6060]", host = webHost),
  168. port_forward(7070, name = "Public gRPC [:7070]", host = webHost),
  169. port_forward(7071, name = "Public REST [:7071]", host = webHost),
  170. port_forward(2345, name = "Debugger [:2345]", host = webHost),
  171. ],
  172. labels = ["guardian"],
  173. trigger_mode = trigger_mode,
  174. )
  175. # guardian set update - triggered by "tilt args" changes
  176. if num_guardians >= 2 and ci == False:
  177. local_resource(
  178. name = "guardian-set-update",
  179. resource_deps = guardian_resource_deps + ["guardian"],
  180. deps = ["scripts/send-vaa.sh", "clients/eth"],
  181. cmd = './scripts/update-guardian-set.sh %s %s %s' % (num_guardians, webHost, namespace),
  182. labels = ["guardian"],
  183. trigger_mode = trigger_mode,
  184. )
  185. # spy
  186. k8s_yaml_with_ns("devnet/spy.yaml")
  187. k8s_resource(
  188. "spy",
  189. resource_deps = ["proto-gen", "guardian"],
  190. port_forwards = [
  191. port_forward(6061, container_port = 6060, name = "Debug/Status Server [:6061]", host = webHost),
  192. port_forward(7072, name = "Spy gRPC [:7072]", host = webHost),
  193. ],
  194. labels = ["guardian"],
  195. trigger_mode = trigger_mode,
  196. )
  197. if solana:
  198. # solana client cli (used for devnet setup)
  199. docker_build(
  200. ref = "bridge-client",
  201. context = ".",
  202. only = ["./proto", "./solana", "./clients"],
  203. dockerfile = "Dockerfile.client",
  204. # Ignore target folders from local (non-container) development.
  205. ignore = ["./solana/*/target"],
  206. )
  207. # solana smart contract
  208. docker_build(
  209. ref = "solana-contract",
  210. context = "solana",
  211. dockerfile = "solana/Dockerfile",
  212. target = "builder",
  213. build_args = {"BRIDGE_ADDRESS": "Bridge1p5gheXUvJ6jGWGeCsgPKgnE3YgdGKRVCMY9o"}
  214. )
  215. # solana local devnet
  216. k8s_yaml_with_ns("devnet/solana-devnet.yaml")
  217. k8s_resource(
  218. "solana-devnet",
  219. port_forwards = [
  220. port_forward(8899, name = "Solana RPC [:8899]", host = webHost),
  221. port_forward(8900, name = "Solana WS [:8900]", host = webHost),
  222. port_forward(9000, name = "Solana PubSub [:9000]", host = webHost),
  223. ],
  224. resource_deps = ["const-gen"],
  225. labels = ["solana"],
  226. trigger_mode = trigger_mode,
  227. )
  228. # eth devnet
  229. docker_build(
  230. ref = "eth-node",
  231. context = "./ethereum",
  232. dockerfile = "./ethereum/Dockerfile",
  233. # ignore local node_modules (in case they're present)
  234. ignore = ["./ethereum/node_modules"],
  235. # sync external scripts for incremental development
  236. # (everything else needs to be restarted from scratch for determinism)
  237. #
  238. # This relies on --update-mode=exec to work properly with a non-root user.
  239. # https://github.com/tilt-dev/tilt/issues/3708
  240. live_update = [
  241. sync("./ethereum/src", "/home/node/app/src"),
  242. ],
  243. )
  244. if spy_relayer:
  245. docker_build(
  246. ref = "redis",
  247. context = ".",
  248. only = ["./third_party"],
  249. dockerfile = "third_party/redis/Dockerfile",
  250. )
  251. k8s_yaml_with_ns("devnet/redis.yaml")
  252. k8s_resource(
  253. "redis",
  254. port_forwards = [
  255. port_forward(6379, name = "Redis Default [:6379]", host = webHost),
  256. ],
  257. labels = ["spy-relayer"],
  258. trigger_mode = trigger_mode,
  259. )
  260. docker_build(
  261. ref = "spy-relay-image",
  262. context = ".",
  263. only = ["./relayer/spy_relayer"],
  264. dockerfile = "relayer/spy_relayer/Dockerfile",
  265. live_update = []
  266. )
  267. k8s_yaml_with_ns("devnet/spy-listener.yaml")
  268. k8s_resource(
  269. "spy-listener",
  270. resource_deps = ["proto-gen", "guardian", "redis"],
  271. port_forwards = [
  272. port_forward(6062, container_port = 6060, name = "Debug/Status Server [:6062]", host = webHost),
  273. port_forward(4201, name = "REST [:4201]", host = webHost),
  274. port_forward(8082, name = "Prometheus [:8082]", host = webHost),
  275. ],
  276. labels = ["spy-relayer"],
  277. trigger_mode = trigger_mode,
  278. )
  279. k8s_yaml_with_ns("devnet/spy-relayer.yaml")
  280. k8s_resource(
  281. "spy-relayer",
  282. resource_deps = ["proto-gen", "guardian", "redis"],
  283. port_forwards = [
  284. port_forward(8083, name = "Prometheus [:8083]", host = webHost),
  285. ],
  286. labels = ["spy-relayer"],
  287. trigger_mode = trigger_mode,
  288. )
  289. k8s_yaml_with_ns("devnet/spy-wallet-monitor.yaml")
  290. k8s_resource(
  291. "spy-wallet-monitor",
  292. resource_deps = ["proto-gen", "guardian", "redis"],
  293. port_forwards = [
  294. port_forward(8084, name = "Prometheus [:8084]", host = webHost),
  295. ],
  296. labels = ["spy-relayer"],
  297. trigger_mode = trigger_mode,
  298. )
  299. k8s_yaml_with_ns("devnet/eth-devnet.yaml")
  300. k8s_resource(
  301. "eth-devnet",
  302. port_forwards = [
  303. port_forward(8545, name = "Ganache RPC [:8545]", host = webHost),
  304. ],
  305. resource_deps = ["const-gen"],
  306. labels = ["evm"],
  307. trigger_mode = trigger_mode,
  308. )
  309. k8s_resource(
  310. "eth-devnet2",
  311. port_forwards = [
  312. port_forward(8546, name = "Ganache RPC [:8546]", host = webHost),
  313. ],
  314. resource_deps = ["const-gen"],
  315. labels = ["evm"],
  316. trigger_mode = trigger_mode,
  317. )
  318. if bridge_ui:
  319. entrypoint = "npm run build && /app/node_modules/.bin/serve -s build -n"
  320. live_update = []
  321. if bridge_ui_hot:
  322. entrypoint = "npm start"
  323. live_update = [
  324. sync("./bridge_ui/public", "/app/public"),
  325. sync("./bridge_ui/src", "/app/src"),
  326. ]
  327. docker_build(
  328. ref = "bridge-ui",
  329. context = ".",
  330. only = ["./bridge_ui"],
  331. dockerfile = "bridge_ui/Dockerfile",
  332. entrypoint = entrypoint,
  333. live_update = live_update,
  334. )
  335. k8s_yaml_with_ns("devnet/bridge-ui.yaml")
  336. k8s_resource(
  337. "bridge-ui",
  338. resource_deps = [],
  339. port_forwards = [
  340. port_forward(3000, name = "Bridge UI [:3000]", host = webHost),
  341. ],
  342. labels = ["portal"],
  343. trigger_mode = trigger_mode,
  344. )
  345. if ci_tests:
  346. docker_build(
  347. ref = "tests-image",
  348. context = ".",
  349. dockerfile = "testing/Dockerfile.tests",
  350. only = [],
  351. live_update = [
  352. sync("./spydk/js/src", "/app/spydk/js/src"),
  353. sync("./sdk/js/src", "/app/sdk/js/src"),
  354. sync("./testing", "/app/testing"),
  355. sync("./bridge_ui/src", "/app/bridge_ui/src"),
  356. ],
  357. )
  358. k8s_yaml_with_ns("devnet/tests.yaml")
  359. k8s_resource(
  360. "ci-tests",
  361. resource_deps = ["proto-gen-web", "wasm-gen", "eth-devnet", "eth-devnet2", "terra-terrad", "terra-fcd", "solana-devnet", "spy", "guardian"],
  362. labels = ["ci"],
  363. trigger_mode = trigger_mode,
  364. )
  365. # e2e
  366. if e2e:
  367. k8s_yaml_with_ns("devnet/e2e.yaml")
  368. docker_build(
  369. ref = "e2e",
  370. context = "e2e",
  371. dockerfile = "e2e/Dockerfile",
  372. network = "host",
  373. )
  374. k8s_resource(
  375. "e2e",
  376. port_forwards = [
  377. port_forward(6080, name = "VNC [:6080]", host = webHost, link_path = "/vnc_auto.html"),
  378. ],
  379. labels = ["ci"],
  380. trigger_mode = trigger_mode,
  381. )
  382. # bigtable
  383. if explorer:
  384. k8s_yaml_with_ns("devnet/bigtable.yaml")
  385. k8s_resource(
  386. "bigtable-emulator",
  387. port_forwards = [port_forward(8086, name = "BigTable clients [:8086]")],
  388. labels = ["explorer"],
  389. trigger_mode = trigger_mode,
  390. )
  391. k8s_resource(
  392. "pubsub-emulator",
  393. port_forwards = [port_forward(8085, name = "PubSub listeners [:8085]")],
  394. labels = ["explorer"],
  395. )
  396. docker_build(
  397. ref = "cloud-functions",
  398. context = "./event_database",
  399. dockerfile = "./event_database/functions_server/Dockerfile",
  400. live_update = [
  401. sync("./event_database/cloud_functions", "/app/cloud_functions"),
  402. ],
  403. )
  404. k8s_resource(
  405. "cloud-functions",
  406. resource_deps = ["proto-gen", "bigtable-emulator", "pubsub-emulator"],
  407. port_forwards = [port_forward(8090, name = "Cloud Functions [:8090]", host = webHost)],
  408. labels = ["explorer"],
  409. trigger_mode = trigger_mode,
  410. )
  411. # explorer web app
  412. docker_build(
  413. ref = "explorer",
  414. context = "./explorer",
  415. dockerfile = "./explorer/Dockerfile",
  416. ignore = ["./explorer/node_modules"],
  417. live_update = [
  418. sync("./explorer/src", "/home/node/app/src"),
  419. sync("./explorer/public", "/home/node/app/public"),
  420. ],
  421. )
  422. k8s_yaml_with_ns("devnet/explorer.yaml")
  423. k8s_resource(
  424. "explorer",
  425. port_forwards = [
  426. port_forward(8001, name = "Explorer Web UI [:8001]", host = webHost),
  427. ],
  428. labels = ["explorer"],
  429. trigger_mode = trigger_mode,
  430. )
  431. # terra devnet
  432. docker_build(
  433. ref = "terra-image",
  434. context = "./terra/devnet",
  435. dockerfile = "terra/devnet/Dockerfile",
  436. )
  437. docker_build(
  438. ref = "terra-contracts",
  439. context = "./terra",
  440. dockerfile = "./terra/Dockerfile",
  441. )
  442. k8s_yaml_with_ns("devnet/terra-devnet.yaml")
  443. k8s_resource(
  444. "terra-terrad",
  445. port_forwards = [
  446. port_forward(26657, name = "Terra RPC [:26657]", host = webHost),
  447. port_forward(1317, name = "Terra LCD [:1317]", host = webHost),
  448. ],
  449. resource_deps = ["const-gen"],
  450. labels = ["terra"],
  451. trigger_mode = trigger_mode,
  452. )
  453. k8s_resource(
  454. "terra-postgres",
  455. labels = ["terra"],
  456. trigger_mode = trigger_mode,
  457. )
  458. k8s_resource(
  459. "terra-fcd",
  460. resource_deps = ["terra-terrad", "terra-postgres"],
  461. port_forwards = [port_forward(3060, name = "Terra FCD [:3060]", host = webHost)],
  462. labels = ["terra"],
  463. trigger_mode = trigger_mode,
  464. )
  465. if algorand:
  466. k8s_yaml_with_ns("devnet/algorand-devnet.yaml")
  467. docker_build(
  468. ref = "algorand-algod",
  469. context = "algorand/sandbox-algorand",
  470. dockerfile = "algorand/sandbox-algorand/images/algod/Dockerfile"
  471. )
  472. docker_build(
  473. ref = "algorand-indexer",
  474. context = "algorand/sandbox-algorand",
  475. dockerfile = "algorand/sandbox-algorand/images/indexer/Dockerfile"
  476. )
  477. docker_build(
  478. ref = "algorand-contracts",
  479. context = "algorand",
  480. dockerfile = "algorand/Dockerfile",
  481. ignore = ["algorand/test/*.*"]
  482. )
  483. k8s_resource(
  484. "algorand",
  485. port_forwards = [
  486. port_forward(4001, name = "Algod [:4001]", host = webHost),
  487. port_forward(4002, name = "KMD [:4002]", host = webHost),
  488. port_forward(8980, name = "Indexer [:8980]", host = webHost),
  489. ],
  490. resource_deps = ["const-gen"],
  491. labels = ["algorand"],
  492. trigger_mode = trigger_mode,
  493. )