helius-labs · meta-light · Aug 4, 2024 · Aug 4, 2024 · Aug 4, 2024 · Aug 4, 2024
diff --git a/.env.example b/.env.example
@@ -1,3 +1,2 @@
-HELIUS_KEY=""
-HELIUS_API_KEY=""
-BIRDEYE_API_KEY=""
+ECLIPSE_RPC_URL=https://mainnetbeta-rpc.eclipse.xyz
+DUNE_KEY=<YOUR_DUNE_KEY>
diff --git a/.eslintignore b/.eslintignore
@@ -7,4 +7,5 @@ tsconfig.esm.json
 tsconfig.json
 package-lock.json
 packages
-_packages
+_packages
+*/* 
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+18
diff --git a/.prettierignore b/.prettierignore
@@ -2,4 +2,12 @@
 packages/**/dist/**/*
 apps/**/.sveltekit/**/*
 tsconfig.json
-packages
+packages
+
+**/*
+
+*.ts
+*.tsx
+*.js
+*.jsx
+*.svelte
diff --git a/.todo b/.todo
@@ -0,0 +1,6 @@
+[ ] Metaplex Integration
+[ ] Nifty Asset Integration
+[ ] Libreplex Integration
+[ ] Contribitions Guide
+[ ] Token Metadata
+[ ] Begin labeling program IDs
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/README.md b/README.md
@@ -1,67 +1,13 @@
-![https://xray.helius.xyz/](/doc/xray-cover-gh.jpg)
+# 🧱Eclipse XRAY
+🔗 **Forked from**: https://github.com/helius-labs/xray
+Eclipse XRAY is a modified fork of the Helius Labs Solana Explorer adapted to work with Eclipse Mainnet. 
 
-## Relevant Links
+Eclipse XRAY leverages only the Eclipse public [RPC](https://docs.eclipse.xyz/developers/rpc-and-block-explorers) endpoints, [Pyth](https://docs.eclipse.xyz/developers/oracles/pyth-network) for price feeds, [All Domains](https://docs.eclipse.xyz/developers/web3-domains/alldomains) for username discovery, and [Dune](https://dune.com/hkey/eclipse-mainnet-bridge) to gather statistics from the [Eclipse Mainnet Bridge](https://etherscan.io/address/0x83cB71D80078bf670b3EfeC6AD9E5E6407cD0fd1).
 
-🔗 **Link**: https://xray.helius.xyz/
-
-🎥 **Demo**: https://www.loom.com/share/402a4397ebd1403f8f4b7df8f024e9b8
-
-🐤 **Twitter**: https://twitter.com/xray_explorer
-
-💬 **Discord**: https://discord.gg/HjummjUXgq
-
-## Support
-
--   📝 [Start Discussion](https://github.com/helius-labs/xray/discussions)
--   💡 [Submit Feature Request](https://github.com/helius-labs/xray/issues/new?assignees=&labels=question&template=FEATURE-REQUEST.yml&title=%F0%9F%92%A1+%5BREQUEST%5D+-+%3Ctitle%3E)
--   🐛 [Submit Bug Report](https://github.com/helius-labs/xray/issues/new?assignees=&labels=bug&template=BUG-REPORT.yml&title=%F0%9F%90%9B+%5BBUG%5D+-+%3Ctitle%3E)
-
-## 🤝 Contribute
-
--   Fork XRAY onto your own GitHub
--   Clone it and make sure you're on the `dev` branch.
--   Create a new branch named `[initials]/[feature]` off of `dev`. Example `q/added-a-cool-thing`.
-
-### Create PR
-
-When you're ready for your changes to be reviewed, create a PR with your new branch to be merged into the `dev` branch on the official repo.
-
-### Pro Tip (Draft PR)
-
-If you're working on something and want to share the progress but aren't ready for merge, click the little arrow next to "Create PR" and chose "draft".
-
-![draft](/doc/draft.png)
-
-Then when you're ready to create the PR, click "Ready for review".
-
-![ready](/doc/ready.png)
-
-### Test
-
-To save time, run tests locally, but they will also run on all PRs to `dev` and `main`. Tests will need to be passing for your changes to be merged.
-
-### Auto merge `dev` -> `main`\*\*
-
-Once changes are approved and merged into `dev`, they will be assumed as good and auto merged to `main`. From here they can be deployed by merging to either the `vercel/staging` or `vercel/prod` branches.
-
-#### [Temp] Auto merge `main` -> `vercel/staging`
-
-For now we are auto deploying everything in main to staging.
-
-## 🏃🏽‍♂️ Runbook
-
-This is a TurboRepo monorepo that can run and build all apps/packages in parallel. Apps like the UI are located in `/apps`. Packages used across apps are located in `/packages`.
-
-### Recommended VSCode Extensions
-
--   [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
--   [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
--   [Prisma](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma)
--   [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode)
--   [Better Comments](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
+## To-Do List
+- [ ] Gather on-chain metadata
 
 ### Tech Stack
-
 -   [Node](https://nodejs.org/en/)
 -   [TurboRepo](https://turbo.build/repo)
 -   [TypeScript](https://www.typescriptlang.org/)
@@ -74,86 +20,31 @@ This is a TurboRepo monorepo that can run and build all apps/packages in paralle
 -   [DaisyUI Components](https://daisyui.com/)
 
 ### Setup Environment
+In the root of the project, create a `.env` file with the following contents:
+```
+DUNE_KEY=<dune_api_key>
+```
+This is only required for Mainnet Bridge stats.
 
-In the root of the project, create a `.env` file with the values mentioned in `.env.template`.
 
 ### Install
-
 Run the install command from the root of the project to install dependencies for all apps and packages.
-
 ```
 npm install
 ```
-
 ### Dev
-
 Start all packages and apps in dev mode which watches for changes and adds your local environment.
-
 ```sh
 npm run dev
 ```
 
-### Lint
-
-It's recommended you use VSCode beacuase if you do, ESLint is setup to auto fix/format as you're working.
-
-```sh
-npm run lint
-```
-
-### Format
-
-Formats files based on the Prettier and ESlint settings.
-
-```sh
-npm run format
-```
-
-### Test
-
-Tests the code, determines if it should be allowed to merge. We recommend running this locally before creating PRs.
-
-```sh
-npm run test
-```
-
 ### Build
-
 Build all apps and packages for production.
-
 ```sh
 npm run build
 ```
 
-### Build Local Environment
-
-Build all apps and packages for production using your `.env` file.
-
-```sh
-npm run build:env
-```
-
-## 🚀 Deployments
-
-| Environment | Description                                               | Directory                                              |
-| ----------- | --------------------------------------------------------- | ------------------------------------------------------ |
-| Production  | The main deployment attached to the domain. `vercel/prod` | https://xray.helius.xyz/                               |
-| Staging     | Staging branch based on contents of `vercel/staging`      | https://xray-web-git-vercel-staging-helius.vercel.app/ |
-
-## 📦 Packages
-
-| Name                                                  | Description                                         | Directory                |
-| ----------------------------------------------------- | --------------------------------------------------- | ------------------------ |
-| [@helius-labs/xray-web](#@helius-labs/xray-app)       | SvelteKit app with UI and backend endpoints.        | `apps/web`               |
-| [@helius-labs/xray-proton](#@helius-labs/xray-proton) | Parses transaction data to produce UI state.        | `packages/xray-proton`   |
-| `@helius-labs/xray-database` [WIP]                    | Prisma client used for communicating with database. | `packages/xray-database` |
-
-# 📱 @helius-labs/xray-web
-
-A SvelteKit app that contains the main XRAY UI.
-
 ## Important Files & Folders
-
 |                           |                                                                                                                                                                                                             |
 | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | 📁 `./src/lib`            | Common components, utilities, and libraries used throughout the app. Import things from this directory using the `$lib/` alias.                                                                             |
@@ -165,74 +56,7 @@ A SvelteKit app that contains the main XRAY UI.
 | 📁`./src/routes`          | Any `+page` or `+server` file in this directory becomes a page or an endpoint based on the folder structure.                                                                                                |
 | 📁`./static`              | A place to put any static assets. The files in this directory are hosted at the root of the domain. When using images, try to import them in the `<script>` vs put them in `./static` when you can help it. |
 | 📄`./app.postcss`         | Initialize/config Tailwind + global styles.                                                                                                                                                                 |
-| 📄`./app.html`            | The top level HTML template that wraps all pages. Routes are injected into the `%sveltekit.body%` tag.                                                                                                     |
-
-## Routes
-
-|                    |                                                                                                                                                                                                    |
-| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `/`                | Home                                                                                                                                                                                               |
-| `/api`             | REST endpoints (This is mostly replaces by tRPC now)                                                                                                                                               |
-| `/[search]`        | From the home page, users can navigate to `/anything` which attempts to resolve the search and then redirect them to `/[search]/tx`, `/[search]/wallet`, or `/[search]/token` based on the search. |
-| `/[search]/tx`     | Details about a particular transaction where `[search]` is a transaction signature.                                                                                                                |
-| `/[search]/wallet` | Details about a particular wallet where `[search]` is a public key.                                                                                                                                |
-| `/[search]/token`  | Details about a particular token where `[search]` is a token mint address.                                                                                                                         |
-
-## Vercel Config
-
-|                 |                                                   |
-| --------------- | ------------------------------------------------- |
-| Build Command   | `cd ../.. && npx turbo run build --filter=web...` |
-| Output Director | `apps/web/.svelte-kit`                            |
-| Install Command | `npm install --prefix=../..`                      |
+| 📄`./app.html`            | The top level HTML template that wraps all pages. Routes are injected into the `%sveltekit.body%` tag.                                                                                                      |
 
 ## Styles
-
 [TailwindCSS](https://tailwindcss.com/) is used for base utilies and [DaisyUI](https://daisyui.com/) contains helpful UI components.
-
-## Icons
-
-See list of available icons in `$lib/config`.
-
-### Use Icons
-
-```js
-<script>
-    import Icon from "$lib/components/icon.svelte";
-</script>
-
-<Icon id="paper-plane">
-```
-
-### Add Icons
-
-1. Find the icon you want on [IconMon](https://iconmonstr.com/). Most of these should render fine.
-2. Click "Embed" -> "Inline" and copy only the `<path>`.
-3. Add a new key to `$lib/config.ts` that is similar to the Icon Monsters name for the icon and add your `<path>`.
-
-## State Management
-
-WIP
-
--   [TanstackQuery](https://tanstack.com/query/latest)
--   [SvelteKit tRPC SvelteQuery Adapter](https://github.com/vishalbalaji/trpc-svelte-query-adapter)
-
-# 📦 @helius-labs/xray
-
-A package that includes our parser, which helps make blockchain data pretty for the UI, and search function.
-
-## Important Files & Folders
-
-|                                         |                                                                                                                                                                      |
-| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 📄`./src/lib/parser/index.ts`           | UI calls the function in this file to parse transactions                                                                                                             |
-| 📄`./src/lib/parser/types.ts`           | Contains the types, interfaces, and enums needed to understand to work on the parser.                                                                                |
-| 📁`./src/lib/parser/parsers`            | Contains all parser methods.                                                                                                                                         |
-| 📄`./src/lib/parser/parsers/index.ts`   | Exports parser files in `./src/parsers`.                                                                                                                             |
-| 📄`./src/lib/parser/parsers/unknown.ts` | If there is no dedicated parser file for a Helius transaction type, they are parsed in this file. Changing the label on the UI is in `./apps/web/src/lib/config.ts`. |
-| 📁`./src/lib/parser/utils`              | Utility functions for the parser functions                                                                                                                           |
-| 📄`./src/lib/search.ts`                 | The function that resolves search inputs to a URL parameter.                                                                                                         |
-
-# 📦 @helius-labs/xray-database [WIP]
-
-A database for saving metadata like transaction views or user details.