flake-module.nix

{self, ...}: {
  perSystem = {
    config,
    self',
    inputs',
    pkgs,
    system,
    ...
  }: let
    # this change on each change of dependencies, unfortunately this hash not yet automatically updated from SRI of package.lock
    npmDepsHash = "sha256-j4M/Tdt28AnXmfaJZT1MHMWvtB+9+Ap24ncwofXcTWs=";
    ####

    # there is officia polkadot on nixpkgs, but it has no local rococo wasm to run
    polkadot = pkgs.stdenv.mkDerivation rec {
      name = "polkadot";
      pname = name;
      src = builtins.fetchurl {
        url = "https://github.com/paritytech/polkadot/releases/download/v1.0.0/polkadot";
        sha256 = "sha256:0pl4c93xyf35hwr03c810ig1dbbyhg7jfzl3mb9j6r273siszh5s";
      };
      phases = ["installPhase"];
      installPhase = ''
        mkdir -p $out/bin
        cp $src $out/bin/${name}
        chmod +x $out/bin/${name}
      '';
    };
    polkadot-parachain = pkgs.stdenv.mkDerivation rec {
      name = "polkadot-parachain";
      pname = name;
      src = builtins.fetchurl {
        url = "https://github.com/paritytech/cumulus/releases/download/v1.0.0/polkadot-parachain";
        sha256 = "sha256:10i5vlfsxlb0y51bk69s9llfgnpwxkzrr8rvwhrgrjmjiwjpy6kn";
      };
      phases = ["installPhase"];
      installPhase = ''
        mkdir -p $out/bin
        cp $src $out/bin/${name}
        chmod +x $out/bin/${name}
      '';
    };
    example-a = let
      config = {
        settings = {
          timeout = 2000;
        };
        relaychain = {
          command = "polkadot";
          chain = "rococo-local";
          nodes = [
            {
              name = "alice";
              ws_port = 9944;
              prometheus_port = 39944;
            }
            {name = "bob";}
          ];
          default_args = [
            "--blocks-pruning=archive"
            "--state-pruning=archive"
            "--offchain-worker=always"
            "--enable-offchain-indexing=true"
            "--discover-local"
          ];
        };
        parachains = [
          {
            id = 1002;
            chain = "contracts-rococo-dev";
            collator = {
              name = "contracts";
              command = "polkadot-parachain";
              ws_port = 9988;
              args = [
                "-lparachain=debug"
                "--discover-local"
              ];
            };
          }
        ];
      };
    in
      pkgs.writeShellApplication rec {
        name = "example-a";
        runtimeInputs = [self'.packages.default polkadot polkadot-parachain];
        text = ''
          printf '${
            builtins.toJSON config
          }' > /tmp/zombie-${name}.json
          zombienet spawn /tmp/zombie-${name}.json --provider native --dir /tmp/zombie-${name}
        '';
      };
    example-b = let
      config = {
        settings = {
          timeout = 2000;
        };
        relaychain = {
          command = "polkadot";
          chain = "westend-local";
          nodes = [
            {
              name = "alice";
              ws_port = 9954;
              prometheus_port = 39954;
            }
            {name = "bob";}
          ];
          default_args = [
            "--blocks-pruning=archive"
            "--state-pruning=archive"
            "--offchain-worker=always"
            "--enable-offchain-indexing=true"
            "--discover-local"
          ];
        };
        parachains = [
          {
            id = 1002;
            chain = "asset-hub-westend-dev";
            collator = {
              name = "asset-hub";
              command = "polkadot-parachain";
              ws_port = 9998;
              args = [
                "-lparachain=debug"
                "--discover-local"
              ];
            };
          }
        ];
      };
    in
      pkgs.writeShellApplication rec {
        name = "example-b";
        runtimeInputs = [self'.packages.default polkadot polkadot-parachain];
        text = ''
          printf '${
            builtins.toJSON config
          }' > /tmp/zombie-${name}.json
          zombienet spawn /tmp/zombie-${name}.json --provider native --dir /tmp/zombie-${name}
        '';
      };

    runtimeDeps = with pkgs;
    # these are used behind the scenes
    # can provide nix `devenv` with running podman based kubernetes as process/service
      [bash coreutils procps findutils podman kubectl gcc-unwrapped]
      ++ lib.optional stdenv.isLinux glibc.bin;
    name = (builtins.fromJSON (builtins.readFile ./javascript/package.json)).name;
    # reuse existing ignores to avoid rebuild on accidental changes
    cleaned-javascript-src = pkgs.lib.cleanSourceWith {
      src = pkgs.lib.cleanSource ./javascript;
      filter =
        pkgs.nix-gitignore.gitignoreFilterPure
        (
          name: type: (
            # nix files are not used as part of build
            (pkgs.lib.strings.hasSuffix ".nix" name == false)
            &&
            # not need to validate as part of nix build
            (pkgs.lib.strings.hasSuffix ".husky" name == false)
          )
        )
        [./.gitignore]
        ./javascript;
    };
  in {
    formatter = pkgs.alejandra;
    devShells.default = pkgs.mkShell {
      packages =
        runtimeDeps
        ++ [self'.packages.default]
        # nix-tree is used to see raw bash/yaml/json files form nix
        # for example `nix-tree .#example-bridge --derivation`
        ++ [pkgs.nix-tree];
    };

    # example of running several relays and parachains in one command to allow bridge deb/debug
    # https://github.com/paritytech/zombienet/discussions/645
    process-compose.example-bridge = {
      settings = {
        log_location = "/tmp/zombie-example-bridge.log";
        log_level = "debug";
        processes = {
          kusama = {
            command = example-a;
            log_location = "/tmp/zombie-example-a.log";
            readiness_probe = {
              initial_delay_seconds = 16;
              period_seconds = 8;
              failure_threshold = 32;
              timeout_seconds = 2;
              exec.command = ''
                curl http://127.0.0.1:39944/metrics | grep polkadot_parachain_chain_api_block_headers_count | tr -s " " | cut --delimiter " " --fields=2 | tee /tmp/zombie-example-a/polkadot_parachain_chain_api_block_headers_count
                exit $(( $(cat /tmp/zombie-example-a/polkadot_parachain_chain_api_block_headers_count) > 4 ? 0 : 1 ))
              '';
            };
          };
          polkadot = {
            command = example-b;
            log_location = "/tmp/zombie-example-b.log";
            readiness_probe = {
              initial_delay_seconds = 16;
              period_seconds = 8;
              failure_threshold = 32;
              timeout_seconds = 2;
              exec.command = ''
                curl http://127.0.0.1:39954/metrics | grep polkadot_parachain_chain_api_block_headers_count | tr -s " " | cut --delimiter " " --fields=2 | tee /tmp/zombie-example-b/polkadot_parachain_chain_api_block_headers_count
                exit $(( $(cat /tmp/zombie-example-b/polkadot_parachain_chain_api_block_headers_count) > 4 ? 0 : 1 ))
              '';
            };
          };
          # https://github.com/paritytech/parity-bridges-common/issues/2539
        };
      };
    };

    packages =
      rec {
        # output is something like what npm 'pkg` does, but more sandboxed
        default = pkgs.buildNpmPackage rec {
          # generally Node should be same as in CI build config
          # root hash (hash of hashes of each dependencies)
          # this should be updated on each dependency change (use `prefetch-npm-deps` to get new hash)
          inherit name npmDepsHash runtimeDeps;
          pname = name;
          src = cleaned-javascript-src;
          npmBuildScript = "build";
          npmBuildFlag = "--workspaces";
          # just for safety of mac as it is used here often
          nativeBuildInputs = with pkgs;
            [
              python3
              nodePackages.node-gyp-build
              nodePackages.node-gyp
            ]
            ++ pkgs.lib.optional pkgs.stdenv.isDarwin (with pkgs;
              with darwin.apple_sdk.frameworks; [
                Security
                SystemConfiguration
              ]);

          # write logs only into isolated temp home, instead of any folder
          npmFlags = ["--logs-dir=$HOME" "--verbose" "--legacy-peer-deps"];
          makeCacheWritable = true;
        };

        update = pkgs.writeShellApplication {
          name = "update";
          runtimeInputs = [pkgs.prefetch-npm-deps];
          text = ''
            prefetch-npm-deps ./javascript/package-lock.json
          '';
        };
      }
      // pkgs.lib.optionalAttrs (system == "x86_64-linux") {example = example-a;};
  };
}