defmodule ABI.Mixfile do use Mix.Project @spec project() :: keyword() def project do [ app: :hieroglyph, version: "1.6.0", # 1.18 floor: `lib/` uses `Enum.sum_by/2` (added in Elixir 1.18) on the # tuple/array encode path, so a lower floor would compile with only a # warning and then die at runtime in a consumer's first encode call. elixir: "~> 1.18", elixirc_paths: elixirc_paths(Mix.env()), description: "Solidity ABI encoder/decoder for Elixir. Maintained fork of exthereum/abi with bugfixes and Elixir 1.19+ support.", source_url: "https://github.com/ZenHive/hieroglyph", homepage_url: "https://github.com/ZenHive/hieroglyph", docs: [ main: "ABI", extras: ["README.md", "CHANGELOG.md"], skip_undefined_reference_warnings_on: ["CHANGELOG.md"] ], package: package(), build_embedded: Mix.env() == :prod, start_permanent: Mix.env() == :prod, compilers: [:yecc, :leex] ++ Mix.compilers(), aliases: aliases(), # OOM mitigation: :apps_direct skips transitive dep recursion (default # :app_tree). Tidewave/bandit's HTTP stack (plug, finch, mint, gun, # cowlib, etc.) is not in lib/'s call graph. priv/plts/ survives `mix # clean` / _build wipes. dialyzer: [ plt_add_deps: :apps_direct, plt_add_apps: [:mix, :descripex], plt_local_path: "priv/plts", plt_core_path: "priv/plts" ], deps: deps() ] end @spec package() :: keyword() defp package do [ name: "hieroglyph", maintainers: ["ZenHive"], licenses: ["MIT"], files: ~w(lib src skills mix.exs README.md CHANGELOG.md LICENSE.md .formatter.exs), links: %{ "GitHub" => "https://github.com/ZenHive/hieroglyph", "Changelog" => "https://github.com/ZenHive/hieroglyph/blob/main/CHANGELOG.md", "Upstream (fork-of)" => "https://github.com/exthereum/abi" } ] end @spec cli() :: keyword() def cli do [preferred_envs: ["test.json": :test, "dialyzer.json": :dev]] end # Run "mix help compile.app" to learn about applications. @spec application() :: keyword() def application do [ extra_applications: [:logger] ] end # Specifies which paths to compile per environment. @spec elixirc_paths(atom()) :: [String.t()] defp elixirc_paths(:test), do: ["lib", "test/support"] defp elixirc_paths(_), do: ["lib"] @spec aliases() :: keyword() defp aliases do [ tidewave: [ "run --no-halt -e 'Agent.start(fn -> Bandit.start_link(plug: Tidewave, port: 4006) end)'" ], # TagTODO/TagFIXME stay on in .credo.exs for visibility; the gate excludes # them so it fails only on real regressions, not tracked debt. "check.fast": [ "format --check-formatted", "compile --warnings-as-errors", "credo --strict --ignore TagTODO,TagFIXME" ], # Manual / CI gate (NOT run by the commit hook). Drops dialyzer; keeps # tests + sobelow + doctor. 95% coverage — this is a wire-format/crypto # encoder (critical business logic). precommit: [ "format --check-formatted", "compile --warnings-as-errors", "credo --strict --ignore TagTODO,TagFIXME", "doctor --raise", # `preferred_envs` (cli/0) is ignored for alias steps, and `mix cmd` # runs args via `System.cmd` with no shell (so a `MIX_ENV=test` prefix # is treated as the binary name). Spawn a fresh `mix` in :test instead. &cover_gate/1, "sobelow --skip" ], # CI mirror — adds ex_dna clone detection, reach PDG arch/smell gates, # the security-advisory audit, dialyzer, and AGENTS.md freshness. Matches # the onchain-family canonical gate (see onchain-stack/CLAUDE.md). Order # is append-after-`precommit`, not the family's canonical step order — # this repo's `cover_gate/1` mechanism (below) predates and supersedes # the family's `cmd env MIX_ENV=test mix ...` step form. "precommit.full": [ "precommit", "ex_dna --max-clones 0", "reach.check --arch --smells", "deps.audit.gated", "dialyzer.json --quiet", "agents.check" ], # mix_audit discards its sync exit status (mirego/mix_audit#61), so a # frozen advisory DB still reports green. Prove freshness first, then # audit. This repo's `deps.audit` reports clean — no ignore file needed. "deps.audit.gated": [ &advisory_freshness/1, "deps.audit" ], # Fails when AGENTS.md has drifted from CLAUDE.md. Compares rendered # output, not mtimes, so drift in a transitive @-import is caught too. "agents.check": [ &agents_check/1 ], ci: ["precommit.full"] ] end # 95% coverage gate. Spawns a child `mix` in :test (alias steps ignore # `cli/0` preferred_envs); a non-zero exit — test failure or sub-threshold # coverage — aborts the precommit run. @spec cover_gate([String.t()]) :: nil defp cover_gate(_args) do args = ~w(test.json --quiet --cover --cover-threshold 95 --summary-only --exclude integration) {_out, status} = System.cmd("mix", args, env: [{"MIX_ENV", "test"}], into: IO.stream()) if status != 0, do: Mix.raise("coverage gate failed (mix test exit #{status})") end # Run "mix help deps" to learn about dependencies. @spec deps() :: [{atom(), String.t()} | {atom(), String.t(), keyword()}] defp deps do [ {:jason, "~> 1.4"}, {:ex_sha3, "~> 0.1.4"}, # Three-segment on purpose (caps at < 0.13.0): descripex 0.12.0 changed # `short_name` in describe/1 output from atom to string at a *minor* # bump, which the previous `~> 0.11` would have absorbed silently. A 0.x # package that breaks on minor earns the tighter form; raise the cap # deliberately after reading its CHANGELOG. {:descripex, "~> 0.12.0"}, {:ex_unit_json, "~> 0.4", only: [:dev, :test], runtime: false}, {:dialyzer_json, "~> 0.2", only: [:dev, :test], runtime: false}, {:styler, "~> 1.4", only: [:dev, :test], runtime: false}, {:credo, "~> 1.7", only: [:dev, :test], runtime: false}, {:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}, {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}, {:ex_doc, "~> 0.40", only: :dev, runtime: false}, {:doctor, "~> 0.23", only: [:dev, :test], runtime: false}, {:tidewave, "~> 0.5", only: :dev}, {:bandit, "~> 1.10", only: :dev}, {:ex_dna, "~> 1.5", only: [:dev, :test], runtime: false}, # Three-segment on purpose (caps at < 0.13.0): `reach` requires # `ex_ast ~> 0.12.0`, so a two-segment `~> 0.12` here advertises a 0.13.x # that resolution can never pick — `mix deps.update ex_ast` would fail on # an unsatisfiable constraint with no in-repo explanation. {:ex_ast, "~> 0.12.0", only: [:dev, :test], runtime: false}, {:reach, "~> 2.8", only: [:dev, :test], runtime: false}, {:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false}, {:stream_data, "~> 1.1", only: :test} ] end # Both gates below shell out to scripts that live OUTSIDE this repo, on the # developer host: the AGENTS.md renderer needs the claude-marketplace # checkout plus ~/.claude/includes, and the advisory-freshness prover needs # the local mix_audit mirror. Neither exists on a CI runner, and `mix cmd` # with an absent path exits non-zero — which aborted the whole `mix ci` # alias, and since these steps precede test.json/dialyzer it took the test, # coverage and dialyzer signal down with it. Skip loudly when the script is # absent so CI keeps running the checks it CAN run; the developer host and # the harness reviewer still get the full gate. @spec agents_check([String.t()]) :: :ok defp agents_check(_args) do host_script( "~/_DATA/code/claude-marketplace/scripts/sync-agents-md.sh", ["--check"], "AGENTS.md freshness check" ) end @spec advisory_freshness([String.t()]) :: :ok defp advisory_freshness(_args) do host_script( "~/_DATA/code/onchain-stack/bin/advisory-freshness.sh", [], "advisory-mirror freshness check" ) end @spec host_script(String.t(), [String.t()], String.t()) :: :ok defp host_script(path, args, label) do expanded = Path.expand(path) cond do not File.regular?(expanded) -> Mix.shell().info("[skip] #{label}: #{expanded} not found (developer-host script, absent in CI).") # Present but not runnable is a broken host setup, not a CI runner — say # so instead of letting System.cmd/3 blow up with a raw :eacces. not executable?(expanded) -> Mix.raise("#{label}: #{expanded} exists but is not executable (chmod +x it).") true -> {_out, status} = System.cmd(expanded, args, into: IO.stream(:stdio, :line), stderr_to_stdout: true) if status != 0 do Mix.raise("#{label} failed (#{expanded} exited #{status})") end end :ok end @spec executable?(String.t()) :: boolean() defp executable?(path) do case File.stat(path) do {:ok, %File.Stat{mode: mode}} -> Bitwise.band(mode, 0o111) != 0 _error -> false end end end