https://github.com/subsquid-labs/eth-scriptions
Indexing Ethscriptions
https://github.com/subsquid-labs/eth-scriptions
blockchain data-uri ethereum ethscriptions graphql indexer sqd squid-sdk typescript web3
Last synced: 1 day ago
JSON representation
Indexing Ethscriptions
- Host: GitHub
- URL: https://github.com/subsquid-labs/eth-scriptions
- Owner: subsquid-labs
- License: mit
- Created: 2023-12-19T15:06:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-06-16T15:54:25.000Z (17 days ago)
- Last Synced: 2026-06-16T17:27:19.951Z (16 days ago)
- Topics: blockchain, data-uri, ethereum, ethscriptions, graphql, indexer, sqd, squid-sdk, typescript, web3
- Language: TypeScript
- Homepage: https://docs.sqd.dev/en/sdk
- Size: 396 KB
- Stars: 19
- Watchers: 1
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://gitpod.io/#https://github.com/subsquid/squid-evm-template)
# Ethscriptions squid
https://github.com/subsquid-labs/eth-scriptions/assets/25107309/61580919-c6ec-4386-b7cf-a68a3fe627f5
## Overview
This repository contains the EthScriptions Indexer, a tool designed to index Ethereum transactions specifically for 'ethscriptions', using the Squid SDK. It features functionality to decode transaction inputs, verify Data URIs for correctness and uniqueness, and efficiently manage and query indexed data.
## Features
1. **Transaction Decoding**:
- Decodes Ethereum transaction inputs to extract relevant data.
2. **Data URI Verification**:
- Validates the format and uniqueness of Data URIs in the transactions.
3. **Uniqueness Check**:
- Ensures that each inscription is unique within the blockchain context.
## Quickstart
```bash
# 0. Install @subsquid/cli a.k.a. the sqd command globally
npm i -g @subsquid/cli
# 1. Retrieve the template
git clone https://github.com/[your-username]/eth-scriptions.git
cd eth-scriptions
# 2. Install dependencies
npm ci
# 3. Start a Postgres database container and detach
sqd up
# 4. Build the squid
sqd build
# 5. Start both the squid processor and the GraphQL server
sqd run .
```
A GraphiQL playground will be available at [localhost:4350/graphql](http://localhost:4350/graphql).
You can also start squid services one by one:
```bash
sqd process
sqd serve
```
## Project conventions
Squid tools assume a certain [project layout](https://docs.sqd.dev/en/sdk):
* All compiled js files must reside in `lib` and all TypeScript sources in `src`.
The layout of `lib` must reflect `src`.
* All TypeORM classes must be exported by `src/model/index.ts` (`lib/model` module).
* Database schema must be defined in `schema.graphql`.
* Database migrations must reside in `db/migrations` and must be plain js files.
* `sqd(1)` and `squid-*(1)` executables consult `.env` file for environment variables.