scribe

command module

v0.1.2 Latest Latest Go to latest Published: Dec 21, 2023 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

Documentation ¶

Overview ¶

Package main provides the main entry point for the scribe service.

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 contains the api used by scribe	Package api contains the api used by scribe
backend Package backend handles the scribe backend.	Package backend handles the scribe backend.
client Package client handles a gRPC connection to a Scribe.	Package client handles a gRPC connection to a Scribe.
cmd Package cmd contains a command line interface for runnign scribe	Package cmd contains a command line interface for runnign scribe
config Package config contains the config for the Scribe	Package config contains the config for the Scribe
db Package db implements the data store	Package db implements the data store
datastore/sql Package sql accesses a db	Package sql accesses a db
datastore/sql/base Package base contains the base sql implementation	Package base contains the base sql implementation
datastore/sql/mysql Package mysql implements the mysql package	Package mysql implements the mysql package
datastore/sql/sqlite Package sqlite implements the sqlite package	Package sqlite implements the sqlite package
mocks
graphql Package graphql provides the graphql server for the scribe service.	Package graphql provides the graphql server for the scribe service.
client
contrib generate gql schema	generate gql schema
server Package server provides the GraphQL server.	Package server provides the GraphQL server.
server/graph Package graph provides the GraphQL resolvers.	Package graph provides the GraphQL resolvers.
server/graph/model Package model defines models returned by the graphql server	Package model defines models returned by the graphql server
server/graph/resolver Package resolvers resolves data from gqlgen	Package resolvers resolves data from gqlgen
server/types Package types provides the GraphQL types for the Scribe service.	Package types provides the GraphQL types for the Scribe service.
grpc
client Package client contains the grpc client	Package client contains the grpc client
client/rest * types/v1/service.proto * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: version not set * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)	* types/v1/service.proto * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: version not set * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
server Package server contains the grpc server	Package server contains the grpc server
types/types/v1 Package pbscribe is the gRPC service definition for the scribe service.	Package pbscribe is the gRPC service definition for the scribe service.
internal Package internal contains dev dependencies required for running developer tasks (coverage testing, etc) that are not required by the project itself.	Package internal contains dev dependencies required for running developer tasks (coverage testing, etc) that are not required by the project itself.
logger Package logger handles logging various scribe events and errors.	Package logger handles logging various scribe events and errors.
metadata Package metadata provides a metadata service for Scribe.	Package metadata provides a metadata service for Scribe.
service Package service runs the scribe service	Package service runs the scribe service
indexer Package indexer takes a range of blocks, fetches logs, gets txs, receipts, and block headers, and stores them.	Package indexer takes a range of blocks, fetches logs, gets txs, receipts, and block headers, and stores them.
testhelper Package testhelper makes it easy for other packages requiring scribe to construct one using simulated backends.	Package testhelper makes it easy for other packages requiring scribe to construct one using simulated backends.
testutil Package testutil contains mock deployers for interacting with the mock backend	Package testutil contains mock deployers for interacting with the mock backend
testcontract Package testcontract contains a contract used for testing event and transaction emission.	Package testcontract contains a contract used for testing event and transaction emission.
types Package types holds various types used throughout the scribe package.	Package types holds various types used throughout the scribe package.