refactor: shorter name for resolvers

chore: more comments
chore: remove unneeded fields in tsconfig

Author: PaulRBerg

TODOs.md

@@ -0,0 +1,12 @@
+# Priority 1
+
+- [ ] Add instructions in the README
+- [ ] Consider what to do with `admin` and `fee`
+- [ ] Refactor `data` broadcasts to get rid of `mainnets` and `testnets` dichotomy
+
+# Priority 2
+
+- [ ] Test to ensure that all indexed contracts have a deployment block
+- [ ] Check why Sophon tests don't work
+- [ ] Add just script for printing available chain names
+- [ ] Add `@unimplemented` tag for `compilerSettings`

justfile

@@ -28,8 +28,8 @@ full-check: biome-check prettier-check tsc-check
 full-write: biome-write prettier-write
 
 # Install dependencies
-install *ARGS:
-    bun install {{ ARGS }}
+install *args:
+    bun install {{ args }}
 
 # Check markdown and yaml files with Prettier
 prettier-check:

src/chains/config.ts

@@ -11,16 +11,19 @@ export const config = {
     [viem.zksyncSepoliaTestnet.id]: "zksync-sepolia",
   } as ConfigString,
   ui: {
+    // By default, testnets are not supported by the UI.
     supportedTestnets: {
       [viem.baseSepolia.id]: true,
       [viem.sepolia.id]: true,
     } as ConfigBool,
+    // By default, mainnets are supported by the UI.
     unsupportedMainnets: {
       [viem.meld.id]: true,
       [viem.ronin.id]: true,
       [viem.taiko.id]: true,
     } as ConfigBool,
   },
+  // These chains have the artifacts under the `artifacts-zk` directory
   zk: {
     [viem.abstract.id]: true,
     [viem.sophon.id]: true,

src/chains/mainnets.ts

@@ -33,6 +33,10 @@ export const unichain = fill("unichain", viem.unichain);
 export const xdc = fill("xdc", viem.xdc);
 export const zksync = fill("zksync", viem.zksync);
 
+/* -------------------------------------------------------------------------- */
+/*                                CUSTOM CHAINS                               */
+/* -------------------------------------------------------------------------- */
+
 export const tangle: Sablier.Chain = fill(
   "tangle",
   defineChain({

src/indexers/airdrops/graph.ts

@@ -4,56 +4,48 @@ import type { Sablier } from "@src/types";
 import type { TheGraphCustomChainId } from "../config";
 import { resolveCustomSubgraph, resolveOfficialSubgraph } from "../helpers";
 
-function resolveCustom(chainId: TheGraphCustomChainId, name: string): Sablier.Indexer.TheGraph {
+function custom(chainId: TheGraphCustomChainId, name: string): Sablier.Indexer.TheGraph {
   return resolveCustomSubgraph(Protocol.Airdrops, chainId, name);
 }
 
-function resolveOfficial(chainId: number, name: string, id: string): Sablier.Indexer.TheGraph {
+function official(chainId: number, name: string, id: string): Sablier.Indexer.TheGraph {
   return resolveOfficialSubgraph(Protocol.Airdrops, chainId, name, id);
 }
 
 const graph = [
   /* -------------------------------------------------------------------------- */
   /*                                  MAINNETS                                  */
   /* -------------------------------------------------------------------------- */
-  resolveOfficial(chains.ethereum.id, "sablier-airdrops-ethereum", "DFD73EcSue44R7mpHvXeyvcgaT8tR1iKakZFjBsiFpjs"),
-  resolveOfficial(chains.abstract.id, "sablier-airdrops-abstract", "DRrf6mYEhRt9QieKvTjDHnSWcBm3GW96hpedMKVxLABx"),
-  resolveOfficial(chains.arbitrum.id, "sablier-airdrops-arbitrum", "HkHDg6NVVVeobhpcU4pTPMktyC25zd6xAQBGpYrWDgRr"),
-  resolveOfficial(chains.avalanche.id, "sablier-airdrops-avalanche", "CpbN5Ps25UzqfdoqYdrjoSK4Him6nwDvdLK6a2sGS1PA"),
-  resolveOfficial(chains.base.id, "sablier-airdrops-base", "4SxPXkQNifgBYqje2C4yP5gz69erZwtD7GuLWgXHSLGe"),
-  resolveOfficial(chains.berachain.id, "sablier-airdrops-berachain", "CnYsdmzuY3Mebwywvqv1WrXw9UZuPMTrxoGgR2UdThJE"),
-  resolveOfficial(chains.blast.id, "sablier-airdrops-blast", "657bogqYaDSSeqsoJcJ1kRqGnc3jC15UmcVLzsYxyxKK"),
-  resolveOfficial(chains.bsc.id, "sablier-airdrops-bsc", "FXQT42kQPvpMJgsF5Bs6CqpxVvPP1LBqEhWThCCLMeGL"),
-  resolveOfficial(chains.chiliz.id, "sablier-airdrops-chiliz", "6LK1aqrhzZCp6c88MEBDAR1VDLpZQiXpBKkceJ5Lu4LU"),
-  resolveOfficial(chains.gnosis.id, "sablier-airdrops-gnosis", "kQEY5PYbjx4SMKyMUwqJHRLDzKH1aUqGsf1cnibU7Kn"),
-  resolveOfficial(chains.iotex.id, "sablier-airdrops-iotex", "G39uCzr1FDY7pBFe8DwShAxhMeC6dbZetutVg6wjtks3"),
-  resolveCustom(chains.lightlink.id, "sablier-airdrops-lightlink"),
-  resolveOfficial(chains.linea.id, "sablier-airdrops-linea", "6koYFSd8FQizdQWLTdRpL1yTmAbpMgN1vZN5W6ajZiTN"),
-  resolveOfficial(chains.mode.id, "sablier-airdrops-mode", "HZMkVX5c2qf7BqbidwpcQMsHGWTDdEKwVjnwenzo9s6m"),
-  resolveOfficial(chains.optimism.id, "sablier-airdrops-optimism", "CHJtCNDzPqngpa1YJoaVrjuufZL6k6VkEkG9ZFUMQzF7"),
-  resolveOfficial(chains.polygon.id, "sablier-airdrops-polygon", "FRbBKiDyM5YpFAqHLXRfQWwQdMGzFL82hqoPXPpXzAHE"),
-  resolveOfficial(chains.scroll.id, "sablier-airdrops-scroll", "Ev4xS8VxuoUcpgqz5A2BkTgQxQeskm4Fg41XzVJ2DX9"),
-  resolveCustom(chains.xdc.id, "sablier-airdrops-xdc"),
-  resolveOfficial(chains.zksync.id, "sablier-airdrops-zksync", "64iDUwNVWKukw67nqTXif5taEfLug4Qf1c2suAv5hrqN"),
+  official(chains.ethereum.id, "sablier-airdrops-ethereum", "DFD73EcSue44R7mpHvXeyvcgaT8tR1iKakZFjBsiFpjs"),
+  official(chains.abstract.id, "sablier-airdrops-abstract", "DRrf6mYEhRt9QieKvTjDHnSWcBm3GW96hpedMKVxLABx"),
+  official(chains.arbitrum.id, "sablier-airdrops-arbitrum", "HkHDg6NVVVeobhpcU4pTPMktyC25zd6xAQBGpYrWDgRr"),
+  official(chains.avalanche.id, "sablier-airdrops-avalanche", "CpbN5Ps25UzqfdoqYdrjoSK4Him6nwDvdLK6a2sGS1PA"),
+  official(chains.base.id, "sablier-airdrops-base", "4SxPXkQNifgBYqje2C4yP5gz69erZwtD7GuLWgXHSLGe"),
+  official(chains.berachain.id, "sablier-airdrops-berachain", "CnYsdmzuY3Mebwywvqv1WrXw9UZuPMTrxoGgR2UdThJE"),
+  official(chains.blast.id, "sablier-airdrops-blast", "657bogqYaDSSeqsoJcJ1kRqGnc3jC15UmcVLzsYxyxKK"),
+  official(chains.bsc.id, "sablier-airdrops-bsc", "FXQT42kQPvpMJgsF5Bs6CqpxVvPP1LBqEhWThCCLMeGL"),
+  official(chains.chiliz.id, "sablier-airdrops-chiliz", "6LK1aqrhzZCp6c88MEBDAR1VDLpZQiXpBKkceJ5Lu4LU"),
+  official(chains.gnosis.id, "sablier-airdrops-gnosis", "kQEY5PYbjx4SMKyMUwqJHRLDzKH1aUqGsf1cnibU7Kn"),
+  official(chains.iotex.id, "sablier-airdrops-iotex", "G39uCzr1FDY7pBFe8DwShAxhMeC6dbZetutVg6wjtks3"),
+  custom(chains.lightlink.id, "sablier-airdrops-lightlink"),
+  official(chains.linea.id, "sablier-airdrops-linea", "6koYFSd8FQizdQWLTdRpL1yTmAbpMgN1vZN5W6ajZiTN"),
+  official(chains.mode.id, "sablier-airdrops-mode", "HZMkVX5c2qf7BqbidwpcQMsHGWTDdEKwVjnwenzo9s6m"),
+  official(chains.optimism.id, "sablier-airdrops-optimism", "CHJtCNDzPqngpa1YJoaVrjuufZL6k6VkEkG9ZFUMQzF7"),
+  official(chains.polygon.id, "sablier-airdrops-polygon", "FRbBKiDyM5YpFAqHLXRfQWwQdMGzFL82hqoPXPpXzAHE"),
+  official(chains.scroll.id, "sablier-airdrops-scroll", "Ev4xS8VxuoUcpgqz5A2BkTgQxQeskm4Fg41XzVJ2DX9"),
+  custom(chains.xdc.id, "sablier-airdrops-xdc"),
+  official(chains.zksync.id, "sablier-airdrops-zksync", "64iDUwNVWKukw67nqTXif5taEfLug4Qf1c2suAv5hrqN"),
   /* -------------------------------------------------------------------------- */
   /*                                  TESTNETS                                  */
   /* -------------------------------------------------------------------------- */
-  resolveOfficial(
+  official(
     chains.arbitrumSepolia.id,
     "sablier-airdrops-arbitrum-sepolia",
     "3S7v3VkDq8XMBd8EFVhKur2Vk44xScaW8a4BRjoPuYWk",
   ),
-  resolveOfficial(
-    chains.baseSepolia.id,
-    "sablier-airdrops-base-sepolia",
-    "4R2hm27YJ7CVEJ97BbBJz2r4KTKYc8sTqqzrD8UzEfJt",
-  ),
-  resolveOfficial(
-    chains.ethereumSepolia.id,
-    "sablier-airdrops-sepolia",
-    "8PLGDyXEsPgRTAnozL7MAjmTUFY4TBzs8i4F9Pq3wwSh",
-  ),
-  resolveOfficial(
+  official(chains.baseSepolia.id, "sablier-airdrops-base-sepolia", "4R2hm27YJ7CVEJ97BbBJz2r4KTKYc8sTqqzrD8UzEfJt"),
+  official(chains.ethereumSepolia.id, "sablier-airdrops-sepolia", "8PLGDyXEsPgRTAnozL7MAjmTUFY4TBzs8i4F9Pq3wwSh"),
+  official(
     chains.optimismSepolia.id,
     "sablier-airdrops-optimism-sepolia",
     "3kp1eR2T1XpvvLkSZ7Wtt45DbDaiykTes478RZ7zwTz",

src/indexers/flow/graph.ts

@@ -4,52 +4,44 @@ import type { Sablier } from "@src/types";
 import type { TheGraphCustomChainId } from "../config";
 import { resolveCustomSubgraph, resolveOfficialSubgraph } from "../helpers";
 
-function resolveCustom(chainId: TheGraphCustomChainId, name: string): Sablier.Indexer.TheGraph {
+function custom(chainId: TheGraphCustomChainId, name: string): Sablier.Indexer.TheGraph {
   return resolveCustomSubgraph(Protocol.Flow, chainId, name);
 }
 
-function resolveOfficial(chainId: number, name: string, id: string): Sablier.Indexer.TheGraph {
+function official(chainId: number, name: string, id: string): Sablier.Indexer.TheGraph {
   return resolveOfficialSubgraph(Protocol.Flow, chainId, name, id);
 }
 
 const graph = [
   // ────────────────────────────────────────────────────────────────────────────────
   // Mainnets
   // ────────────────────────────────────────────────────────────────────────────────
-  resolveOfficial(chains.ethereum.id, "sablier-flow-ethereum", "ECxBJhKceBGaVvK6vqmK3VQAncKwPeAQutEb8TeiUiod"),
-  resolveOfficial(chains.abstract.id, "sablier-flow-abstract", "Gq3e1gihMoSynURwGXQnPoKGVZzdsyomdrMH934vQHuG"),
-  resolveOfficial(chains.arbitrum.id, "sablier-flow-arbitrum", "C3kBBUVtW2rxqGpAgSgEuSaT49izkH6Q8UibRt7XFTyW"),
-  resolveOfficial(chains.avalanche.id, "sablier-flow-avalanche", "6PAizjTALVqLLB7Ycq6XnpTeck8Z8QUpDFnVznMnisUh"),
-  resolveOfficial(chains.base.id, "sablier-flow-base", "4XSxXh8ZgkzaA35nrbQG9Ry3FYz3ZFD8QBdWwVg5pF9W"),
-  resolveOfficial(chains.berachain.id, "sablier-flow-berachain", "J87eaBLfTe7kKWgUGqe5TxntNCzA4pyWmqJowMddehuh"),
-  resolveOfficial(chains.blast.id, "sablier-flow-blast", "8joiC9LpUbSV6eGRr3RWXDArM8p9Q65FKiFekAakkyia"),
-  resolveOfficial(chains.bsc.id, "sablier-flow-bsc", "2vU8KF4yWh3vvFjtg7MrRXMnYF3hPX2T3cvVBdaiXhNb"),
-  resolveOfficial(chains.chiliz.id, "sablier-flow-chiliz", "7QX7tJsANNFpxFLLjqzmXRzfY1wPGp3Lty5xGbhgADa6"),
-  resolveOfficial(chains.gnosis.id, "sablier-flow-gnosis", "4KiJ53cTNKdFWPBPmDNQ55tYj8hn1WQg8R4UcTY2STLL"),
-  resolveOfficial(chains.iotex.id, "sablier-flow-iotex", "6No3QmRiC8HXLEerDFoBpF47jUPRjhntmv28HHEMxcA2"),
-  resolveCustom(chains.lightlink.id, "sablier-flow-lightlink"),
-  resolveOfficial(chains.linea.id, "sablier-flow-linea", "DV9XgcCCPKzUn6pgetg4yPetpW2fNoRKBUQC43aNeLG6"),
-  resolveOfficial(chains.mode.id, "sablier-flow-mode", "9TwfoUZoxYUyxzDgspCPyxW6uMUKetWQDaTGsZjY1qJZ"),
-  resolveOfficial(chains.optimism.id, "sablier-flow-optimism", "AygPgsehNGSB4K7DYYtvBPhTpEiU4dCu3nt95bh9FhRf"),
-  resolveOfficial(chains.polygon.id, "sablier-flow-polygon", "ykp38sLarwz3cpmjSSPqo7UuTjYtkZ1KiL4PM2qwmT8"),
-  resolveOfficial(chains.scroll.id, "sablier-flow-scroll", "HFpTrPzJyrHKWZ9ebb4VFRQSxRwpepyfz5wd138daFkF"),
-  resolveCustom(chains.xdc.id, "sablier-flow-xdc"),
-  resolveOfficial(chains.zksync.id, "sablier-flow-zksync", "9DRgWhDAMovpkej3eT8izum6jxEKHE62ciArffsTAScx"),
+  official(chains.ethereum.id, "sablier-flow-ethereum", "ECxBJhKceBGaVvK6vqmK3VQAncKwPeAQutEb8TeiUiod"),
+  official(chains.abstract.id, "sablier-flow-abstract", "Gq3e1gihMoSynURwGXQnPoKGVZzdsyomdrMH934vQHuG"),
+  official(chains.arbitrum.id, "sablier-flow-arbitrum", "C3kBBUVtW2rxqGpAgSgEuSaT49izkH6Q8UibRt7XFTyW"),
+  official(chains.avalanche.id, "sablier-flow-avalanche", "6PAizjTALVqLLB7Ycq6XnpTeck8Z8QUpDFnVznMnisUh"),
+  official(chains.base.id, "sablier-flow-base", "4XSxXh8ZgkzaA35nrbQG9Ry3FYz3ZFD8QBdWwVg5pF9W"),
+  official(chains.berachain.id, "sablier-flow-berachain", "J87eaBLfTe7kKWgUGqe5TxntNCzA4pyWmqJowMddehuh"),
+  official(chains.blast.id, "sablier-flow-blast", "8joiC9LpUbSV6eGRr3RWXDArM8p9Q65FKiFekAakkyia"),
+  official(chains.bsc.id, "sablier-flow-bsc", "2vU8KF4yWh3vvFjtg7MrRXMnYF3hPX2T3cvVBdaiXhNb"),
+  official(chains.chiliz.id, "sablier-flow-chiliz", "7QX7tJsANNFpxFLLjqzmXRzfY1wPGp3Lty5xGbhgADa6"),
+  official(chains.gnosis.id, "sablier-flow-gnosis", "4KiJ53cTNKdFWPBPmDNQ55tYj8hn1WQg8R4UcTY2STLL"),
+  official(chains.iotex.id, "sablier-flow-iotex", "6No3QmRiC8HXLEerDFoBpF47jUPRjhntmv28HHEMxcA2"),
+  custom(chains.lightlink.id, "sablier-flow-lightlink"),
+  official(chains.linea.id, "sablier-flow-linea", "DV9XgcCCPKzUn6pgetg4yPetpW2fNoRKBUQC43aNeLG6"),
+  official(chains.mode.id, "sablier-flow-mode", "9TwfoUZoxYUyxzDgspCPyxW6uMUKetWQDaTGsZjY1qJZ"),
+  official(chains.optimism.id, "sablier-flow-optimism", "AygPgsehNGSB4K7DYYtvBPhTpEiU4dCu3nt95bh9FhRf"),
+  official(chains.polygon.id, "sablier-flow-polygon", "ykp38sLarwz3cpmjSSPqo7UuTjYtkZ1KiL4PM2qwmT8"),
+  official(chains.scroll.id, "sablier-flow-scroll", "HFpTrPzJyrHKWZ9ebb4VFRQSxRwpepyfz5wd138daFkF"),
+  custom(chains.xdc.id, "sablier-flow-xdc"),
+  official(chains.zksync.id, "sablier-flow-zksync", "9DRgWhDAMovpkej3eT8izum6jxEKHE62ciArffsTAScx"),
   // ────────────────────────────────────────────────────────────────────────────────
   // Testnets
   // ────────────────────────────────────────────────────────────────────────────────
-  resolveOfficial(
-    chains.arbitrumSepolia.id,
-    "sablier-flow-arbitrum-sepolia",
-    "2uWnxpYiDMkEMu1urxqt925mLfuax9XbvfcBoD97AU6d",
-  ),
-  resolveOfficial(chains.baseSepolia.id, "sablier-flow-base-sepolia", "AsnKT1waQMvuQxZAqfFuYwtRtAfN8uekDu75jPttfyLh"),
-  resolveOfficial(chains.ethereumSepolia.id, "sablier-flow-sepolia", "EU9AWmJjrjMRkjxcdHfuWPZvPTNAL3hiXfNGN5MwUpvm"),
-  resolveOfficial(
-    chains.optimismSepolia.id,
-    "sablier-flow-optimism-sepolia",
-    "EFKqBB6TeH6etGuHCffnbMbETEgDZ6U29Lgpc4gpYvdB",
-  ),
+  official(chains.arbitrumSepolia.id, "sablier-flow-arbitrum-sepolia", "2uWnxpYiDMkEMu1urxqt925mLfuax9XbvfcBoD97AU6d"),
+  official(chains.baseSepolia.id, "sablier-flow-base-sepolia", "AsnKT1waQMvuQxZAqfFuYwtRtAfN8uekDu75jPttfyLh"),
+  official(chains.ethereumSepolia.id, "sablier-flow-sepolia", "EU9AWmJjrjMRkjxcdHfuWPZvPTNAL3hiXfNGN5MwUpvm"),
+  official(chains.optimismSepolia.id, "sablier-flow-optimism-sepolia", "EFKqBB6TeH6etGuHCffnbMbETEgDZ6U29Lgpc4gpYvdB"),
 ];
 
 export default graph;