explorer

command module

v0.1.10 Latest Latest Go to latest Published: Jan 8, 2024 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/synapsecns/sanguine

README ¶

Explorer

See #167 to learn more.

To access the clickhouse database, you can use the following command from the docker image:

$ clickhouse-client --database=clickhouse_test --user=clickhouse_test --password=clickhouse_test

Directory Structure.

explorer
├── api: API server
├── backfill: Chain level backfilling service to populate the database
├── cmd: CLI commands
├── config: Configuration files
├── consumer: Consumes data from Scribe and populates the Explorer database
│   ├── client: Client for the Scribe consumer
│   ├── fetcher: Fetches data from Scribe, BridgeConfig contract, and Swap contract
│   └── parser: Parses and stores events
├── contracts: Smart contracts and their generated interfaces/utils
│   ├── bridge: Bridge smart contract applications
│   ├── bridgeconfig: BridgeConfig smart contract applications
│   ├── contracts: Raw flattened smart contracts and test contracts
│   └── swap: Swap smart contract applications
├── db: Database interface
│   └── sql: Database writer, reader, and migrations
├── graphql: GraphQL implementation for the Explorer's recorded data
│   ├── client: The client interface for the GraphQL server
│   ├── contrib: Generator for the GraphQL schema
│   └── server: The server implementation for GraphQL
│       └── graph: The server's models, resolvers, and schemas
├── node: Live Explorer node
├── testutil: Test utilities
└── types: Explorer specific types

Documentation ¶

Overview ¶

Package main: entry point for the cli.

Source Files ¶

View all Source files

main.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
api Package api provides the api for the explorer service.	Package api provides the api for the explorer service.
cache Package cache caches data for the frontend	Package cache caches data for the frontend
backfill Package backfill provides a command to backfill the consumer database.	Package backfill provides a command to backfill the consumer database.
cmd Package cmd CLI infra	Package cmd CLI infra
config Package config holds the config for both the server and indexer.	Package config holds the config for both the server and indexer.
indexer Package indexerconfig is the config loader for the indexer	Package indexerconfig is the config loader for the indexer
server Package serverconfig is the config loader for the server	Package serverconfig is the config loader for the server
consumer Package consumer deals with consuming logs from scribe and then parsing and storing events.	Package consumer deals with consuming logs from scribe and then parsing and storing events.
client Package client provides a GraphQL client for consuming logs.	Package client provides a GraphQL client for consuming logs.
client/contrib Package main generates a GQL client.	Package main generates a GQL client.
client/resolver-client
fetcher Package fetcher provides fetchers to fetch data from Scribe, BridgeConfig, and Swap.	Package fetcher provides fetchers to fetch data from Scribe, BridgeConfig, and Swap.
fetcher/mocks
fetcher/tokenprice Package tokenprice contains the historical price data	Package tokenprice contains the historical price data
parser Package parser provides the logic to parse and store events.	Package parser provides the logic to parse and store events.
parser/tokendata Package tokendata contains the token data service	Package tokendata contains the token data service
parser/tokenpool Package tokenpool contains the token pool data service	Package tokenpool contains the token pool data service
contracts
bridge Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
bridge/bridgev1 Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
bridge/testbridge Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
bridge/testbridgev1 Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
bridgeconfig Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
cctp Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
cctp/testcctp Package testcctp Go interface for synapse-contracts/.../TestSynapseCCTPV1.sol	Package testcctp Go interface for synapse-contracts/.../TestSynapseCCTPV1.sol
messagebus Package messagebus Go interface for synapse-contracts/.../MessageBusUpgradeable.sol	Package messagebus Go interface for synapse-contracts/.../MessageBusUpgradeable.sol
messagebus/testmessagebus Package testmessagebus generates test abis for synapse-contracts/.../MessageBusUpgradeable.sol	Package testmessagebus generates test abis for synapse-contracts/.../MessageBusUpgradeable.sol
metaswap Package metaswap Go interface for synapse-contracts/.../MetaSwap.sol	Package metaswap Go interface for synapse-contracts/.../MetaSwap.sol
metaswap/testmetaswap Package testmetaswap Go interface for synapse-contracts/.../MetaSwap.sol	Package testmetaswap Go interface for synapse-contracts/.../MetaSwap.sol
swap Package swap Go interface for synapse-contracts/.../SwapFlashLoan.sol	Package swap Go interface for synapse-contracts/.../SwapFlashLoan.sol
swap/testswap Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
user Package user defines all end-user defined messages we resolve to in the explorer	Package user defines all end-user defined messages we resolve to in the explorer
user/dfk/dfkhero Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
user/dfk/dfkpet Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
user/dfk/dfktear Code generated by synapse abigen DO NOT EDIT.	Code generated by synapse abigen DO NOT EDIT.
db Package db provides the database for the consumer service.	Package db provides the database for the consumer service.
mocks
sql Package sql contains the sql store.	Package sql contains the sql store.
graphql Package graphql provides a GraphQL API for the explorer service.	Package graphql provides a GraphQL API for the explorer service.
client
contrib/client generate gql schema	generate gql schema
server Package server provides the GraphQL server.	Package server provides the GraphQL server.
server/graph Package graph implements the GraphQL schema and resolvers.	Package graph implements the GraphQL schema and resolvers.
server/graph/interceptor Package interceptor contains a santizier for the graphql server It santitizes strings uing MysqlRealEscapeString.	Package interceptor contains a santizier for the graphql server It santitizes strings uing MysqlRealEscapeString.
server/graph/model Package model provides the GraphQL model for the explorer service.	Package model provides the GraphQL model for the explorer service.
server/graph/resolver Package resolvers provides the GraphQL resolver for the explorer service.	Package resolvers provides the GraphQL resolver for the explorer service.
metadata Package metadata provides a metadata service for explorer.	Package metadata provides a metadata service for explorer.
node Package node contains the node for the explorer service.	Package node contains the node for the explorer service.
static Package static contains static config files	Package static contains static config files
testutil Package testutil is used for deploying test contracts and generic testing functions	Package testutil is used for deploying test contracts and generic testing functions
clickhouse Package clickhouse spins up a temp clickhouse db with docker.	Package clickhouse spins up a temp clickhouse db with docker.
testcontracts Package testcontracts provides a set of test contracts for use in tests.	Package testcontracts provides a set of test contracts for use in tests.
types Package types hold supplementary types for the explorer service.	Package types hold supplementary types for the explorer service.
bridge Package bridge provides types for Bridge events.	Package bridge provides types for Bridge events.
cctp Package cctp contains the contract bindings for the SynapseCCTP contract.	Package cctp contains the contract bindings for the SynapseCCTP contract.
messagebus Package messagebus provides types for Message events.	Package messagebus provides types for Message events.
swap Package swap provides types for Swap events.	Package swap provides types for Swap events.