@proto-kit/stack • Docs

Documentation / @proto-kit/stack / DefaultConfigs

Class: DefaultConfigs

Constructors

new DefaultConfigs()

new DefaultConfigs(): DefaultConfigs

Returns

DefaultConfigs

Methods

api()

static api(options?): object

Parameters

• options?

• options.overrides?: Partial<GraphqlServerEnv>

• options.preset?: Environment

Returns

object

Graphql

Graphql: object

Graphql.BatchStorageResolver

Graphql.BatchStorageResolver: object

Graphql.BlockResolver

Graphql.BlockResolver: object

Graphql.graphiql

Graphql.graphiql: boolean = config.graphiqlEnabled

Graphql.host

Graphql.host: string = config.graphqlHost

Graphql.MempoolResolver

Graphql.MempoolResolver: object

Graphql.MerkleWitnessResolver

Graphql.MerkleWitnessResolver: object

Graphql.NodeStatusResolver

Graphql.NodeStatusResolver: object

Graphql.port

Graphql.port: number = config.graphqlPort

Graphql.QueryGraphqlModule

Graphql.QueryGraphqlModule: object

Defined in

stack/src/presets/modules/index.ts:197

appChainBase()

static appChainBase(): object

Returns

object

NetworkStateTransportModule

NetworkStateTransportModule: object = {}

QueryTransportModule

QueryTransportModule: object = {}

TransactionSender

TransactionSender: object = {}

Defined in

stack/src/presets/modules/index.ts:501

core()

static core(options?): object

Parameters

• options?

• options.overrides?: Partial<CoreEnv> & Partial<GraphqlServerEnv> & Partial<SettlementEnv>

• options.preset?: Environment

• options.settlementEnabled?: boolean

Returns

object

BlockProducerModule

BlockProducerModule: object = {}

BlockTrigger

BlockTrigger: object | object = blockTriggerConfig

Graphql

Graphql: object

Graphql.BatchStorageResolver

Graphql.BatchStorageResolver: object

Graphql.BlockResolver

Graphql.BlockResolver: object

Graphql.graphiql

Graphql.graphiql: boolean = config.graphiqlEnabled

Graphql.host

Graphql.host: string = config.graphqlHost

Graphql.MempoolResolver

Graphql.MempoolResolver: object

Graphql.MerkleWitnessResolver

Graphql.MerkleWitnessResolver: object

Graphql.NodeStatusResolver

Graphql.NodeStatusResolver: object

Graphql.port

Graphql.port: number = config.graphqlPort

Graphql.QueryGraphqlModule

Graphql.QueryGraphqlModule: object

Mempool

Mempool: object = {}

SequencerStartupModule

SequencerStartupModule: object = {}

WorkerModule

WorkerModule: object

WorkerModule.BlockReductionTask

WorkerModule.BlockReductionTask: object

WorkerModule.NewBlockTask

WorkerModule.NewBlockTask: object

WorkerModule.RuntimeProvingTask

WorkerModule.RuntimeProvingTask: object

WorkerModule.SettlementProvingTask

WorkerModule.SettlementProvingTask: object

WorkerModule.StateTransitionReductionTask

WorkerModule.StateTransitionReductionTask: object

WorkerModule.StateTransitionTask

WorkerModule.StateTransitionTask: object

WorkerModule.TransactionProvingTask

WorkerModule.TransactionProvingTask: object

WorkerModule.TransactionReductionTask

WorkerModule.TransactionReductionTask: object

WorkerModule.WorkerRegistrationTask

WorkerModule.WorkerRegistrationTask: object

Defined in

stack/src/presets/modules/index.ts:213

graphqlServer()

static graphqlServer(options?): object

Parameters

• options?

• options.overrides?: Partial<GraphqlServerEnv>

• options.preset?: Environment

Returns

object

GraphqlServer

GraphqlServer: object

GraphqlServer.graphiql

GraphqlServer.graphiql: boolean = config.graphiqlEnabled

GraphqlServer.host

GraphqlServer.host: string = config.graphqlHost

GraphqlServer.port

GraphqlServer.port: number = config.graphqlPort

Defined in

stack/src/presets/modules/index.ts:468

indexer()

static indexer(options?): object

Parameters

• options?

• options.overrides?: Partial<IndexerEnv>

• options.preset?: Environment

Returns

object

Database

Database: object

Database.databasePruneModule

Database.databasePruneModule: object

Database.databasePruneModule.pruneOnStartup

Database.databasePruneModule.pruneOnStartup: undefined | boolean = config.pruneOnStartup

Database.prisma

Database.prisma: object

Database.prisma.connection

Database.prisma.connection: string = config.databaseUrl

Database.redis

Database.redis: object

Database.redis.host

Database.redis.host: string = config.redisHost

Database.redis.password

Database.redis.password: string = config.redisPassword

Database.redis.port

Database.redis.port: number = config.redisPort

Graphql

Graphql: object

Graphql.GeneratedResolverFactory

Graphql.GeneratedResolverFactory: object = {}

Graphql.graphiql

Graphql.graphiql: boolean = config.graphiqlEnabled

Graphql.host

Graphql.host: string = config.graphqlHost

Graphql.port

Graphql.port: number = config.graphqlPort

TaskQueue

TaskQueue: object

TaskQueue.redis

TaskQueue.redis: object

TaskQueue.redis.db

TaskQueue.redis.db: undefined | number = config.redisDb

TaskQueue.redis.host

TaskQueue.redis.host: string = config.redisHost

TaskQueue.redis.password

TaskQueue.redis.password: string = config.redisPassword

TaskQueue.redis.port

TaskQueue.redis.port: number = config.redisPort

TaskQueue.retryAttempts

TaskQueue.retryAttempts: undefined | number = config.retryAttempts

TaskWorker

TaskWorker: object

TaskWorker.IndexBatchTask

TaskWorker.IndexBatchTask: object = {}

TaskWorker.IndexBlockTask

TaskWorker.IndexBlockTask: object = {}

TaskWorker.IndexPendingTxTask

TaskWorker.IndexPendingTxTask: object = {}

TaskWorker.IndexSettlementTask

TaskWorker.IndexSettlementTask: object = {}

Defined in

stack/src/presets/modules/index.ts:290

inMemoryDatabase()

static inMemoryDatabase(): object

Returns

object

Database

Database: object = {}

Defined in

stack/src/presets/modules/index.ts:410

localWorker()

static localWorker(): object

Returns

object

TaskQueue

TaskQueue: object = {}

WorkerModule

WorkerModule: object

WorkerModule.BlockReductionTask

WorkerModule.BlockReductionTask: object

WorkerModule.NewBlockTask

WorkerModule.NewBlockTask: object

WorkerModule.RuntimeProvingTask

WorkerModule.RuntimeProvingTask: object

WorkerModule.SettlementProvingTask

WorkerModule.SettlementProvingTask: object

WorkerModule.StateTransitionReductionTask

WorkerModule.StateTransitionReductionTask: object

WorkerModule.StateTransitionTask

WorkerModule.StateTransitionTask: object

WorkerModule.TransactionProvingTask

WorkerModule.TransactionProvingTask: object

WorkerModule.TransactionReductionTask

WorkerModule.TransactionReductionTask: object

WorkerModule.WorkerRegistrationTask

WorkerModule.WorkerRegistrationTask: object

Defined in

stack/src/presets/modules/index.ts:437

metrics()

static metrics(options?): object

Parameters

• options?

• options.overrides?: Partial<MetricsEnv>

• options.preset?: Environment

Returns

object

OpenTelemetryServer

OpenTelemetryServer: object

OpenTelemetryServer.metrics

OpenTelemetryServer.metrics: object

OpenTelemetryServer.metrics.enabled

OpenTelemetryServer.metrics.enabled: boolean = config.metricsEnabled

OpenTelemetryServer.metrics.nodeScrapeInterval

OpenTelemetryServer.metrics.nodeScrapeInterval: number = config.metricsScrapingFrequency

OpenTelemetryServer.metrics.prometheus

OpenTelemetryServer.metrics.prometheus: object

OpenTelemetryServer.metrics.prometheus.appendTimestamp

OpenTelemetryServer.metrics.prometheus.appendTimestamp: boolean = true

OpenTelemetryServer.metrics.prometheus.host

OpenTelemetryServer.metrics.prometheus.host: string = config.metricsHost

OpenTelemetryServer.metrics.prometheus.port

OpenTelemetryServer.metrics.prometheus.port: number = config.metricsPort

OpenTelemetryServer.tracing

OpenTelemetryServer.tracing: object

OpenTelemetryServer.tracing.enabled

OpenTelemetryServer.tracing.enabled: boolean = config.tracingEnabled

OpenTelemetryServer.tracing.otlp

OpenTelemetryServer.tracing.otlp: object

OpenTelemetryServer.tracing.otlp.url

OpenTelemetryServer.tracing.otlp.url: string = config.tracingUrl

Defined in

stack/src/presets/modules/index.ts:260

prismaRedisDatabase()

static prismaRedisDatabase(options?): object

Parameters

• options?

• options.overrides?: Partial<DatabaseEnv>

• options.preset?: Environment

Returns

object

Database

Database: object

Database.databasePruneModule

Database.databasePruneModule: object

Database.databasePruneModule.pruneOnStartup

Database.databasePruneModule.pruneOnStartup: undefined | boolean = config.pruneOnStartup

Database.prisma

Database.prisma: object

Database.prisma.connection

Database.prisma.connection: string = config.databaseUrl

Database.redis

Database.redis: object

Database.redis.host

Database.redis.host: string = config.redisHost

Database.redis.password

Database.redis.password: string = config.redisPassword

Database.redis.port

Database.redis.port: number = config.redisPort

Defined in

stack/src/presets/modules/index.ts:414

processor()

static processor(options?): object

Parameters

• options?

• options.overrides?: Partial<ProcessorEnv>

• options.preset?: Environment

Returns

object

BlockFetching

BlockFetching: object

BlockFetching.url

BlockFetching.url: string

GraphqlSequencerModule

GraphqlSequencerModule: object

GraphqlSequencerModule.graphiql

GraphqlSequencerModule.graphiql: boolean = config.graphiqlEnabled

GraphqlSequencerModule.host

GraphqlSequencerModule.host: string = config.graphqlHost

GraphqlSequencerModule.port

GraphqlSequencerModule.port: number = config.graphqlPort

GraphqlSequencerModule.ResolverFactory

GraphqlSequencerModule.ResolverFactory: object = {}

HandlersExecutor

HandlersExecutor: object = {}

Trigger

Trigger: object

Trigger.interval

Trigger.interval: number

Defined in

stack/src/presets/modules/index.ts:332

redis()

static redis(options?): object

Parameters

• options?

• options.overrides?: Partial<RedisEnv>

• options.preset?: Environment

Returns

object

redis

redis: object

redis.host

redis.host: string = config.redisHost

redis.password

redis.password: string = config.redisPassword

redis.port

redis.port: number = config.redisPort

Defined in

stack/src/presets/modules/index.ts:486

redisTaskQueue()

static redisTaskQueue(options?): object

Parameters

• options?

• options.overrides?: Partial<RedisTaskQueueEnv>

• options.preset?: Environment

Returns

object

TaskQueue

TaskQueue: object

TaskQueue.redis

TaskQueue.redis: object

TaskQueue.redis.db

TaskQueue.redis.db: undefined | number = config.redisDb

TaskQueue.redis.host

TaskQueue.redis.host: string = config.redisHost

TaskQueue.redis.password

TaskQueue.redis.password: string = config.redisPassword

TaskQueue.redis.port

TaskQueue.redis.port: number = config.redisPort

TaskQueue.retryAttempts

TaskQueue.retryAttempts: undefined | number = config.retryAttempts

Defined in

stack/src/presets/modules/index.ts:446

sequencerIndexer()

static sequencerIndexer(): object

Returns

object

IndexerNotifier

IndexerNotifier: object = {}

Defined in

stack/src/presets/modules/index.ts:286

settlement()

static settlement(options?): object

Parameters

• options?

• options.overrides?: Partial<SettlementEnv>

• options.preset?: Environment

Returns

object

BaseLayer

BaseLayer: object

BaseLayer.network

BaseLayer.network: object

BaseLayer.network.accountManager

BaseLayer.network.accountManager: string

BaseLayer.network.archive

BaseLayer.network.archive: string

BaseLayer.network.graphql

BaseLayer.network.graphql: string

BaseLayer.network.type

BaseLayer.network.type: "lightnet" | "remote" = config.minaNetwork

BatchProducerModule

BatchProducerModule: object = {}

BridgingModule

BridgingModule: object

BridgingModule.addresses

BridgingModule.addresses: object

BridgingModule.addresses.DispatchContract

BridgingModule.addresses.DispatchContract: PublicKey

FeeStrategy

FeeStrategy: object = {}

SettlementModule

SettlementModule: object

SettlementModule.addresses

SettlementModule.addresses: object

SettlementModule.addresses.SettlementContract

SettlementModule.addresses.SettlementContract: PublicKey

SettlementSigner

SettlementSigner: object

SettlementSigner.contractKeys

SettlementSigner.contractKeys: PrivateKey[]

SettlementSigner.feepayer

SettlementSigner.feepayer: PrivateKey

WorkerModule

WorkerModule: object

WorkerModule.BlockReductionTask

WorkerModule.BlockReductionTask: object

WorkerModule.NewBlockTask

WorkerModule.NewBlockTask: object

WorkerModule.RuntimeProvingTask

WorkerModule.RuntimeProvingTask: object

WorkerModule.SettlementProvingTask

WorkerModule.SettlementProvingTask: object

WorkerModule.StateTransitionReductionTask

WorkerModule.StateTransitionReductionTask: object

WorkerModule.StateTransitionTask

WorkerModule.StateTransitionTask: object

WorkerModule.TransactionProvingTask

WorkerModule.TransactionProvingTask: object

WorkerModule.TransactionReductionTask

WorkerModule.TransactionReductionTask: object

WorkerModule.WorkerRegistrationTask

WorkerModule.WorkerRegistrationTask: object

Defined in

stack/src/presets/modules/index.ts:364

settlementScript()

static settlementScript(options?): object

Parameters

• options?

• options.overrides?: Partial<SettlementEnv>

• options.preset?: Environment

Returns

object

BaseLayer

BaseLayer: object

BaseLayer.network

BaseLayer.network: object

BaseLayer.network.accountManager

BaseLayer.network.accountManager: string

BaseLayer.network.archive

BaseLayer.network.archive: string

BaseLayer.network.graphql

BaseLayer.network.graphql: string

BaseLayer.network.type

BaseLayer.network.type: "lightnet" | "remote" = config.minaNetwork

BatchProducerModule

BatchProducerModule: object = {}

BridgingModule

BridgingModule: object = {}

FeeStrategy

FeeStrategy: object = {}

LocalTaskWorker

LocalTaskWorker: object

LocalTaskWorker.BlockReductionTask

LocalTaskWorker.BlockReductionTask: object

LocalTaskWorker.NewBlockTask

LocalTaskWorker.NewBlockTask: object

LocalTaskWorker.RuntimeProvingTask

LocalTaskWorker.RuntimeProvingTask: object

LocalTaskWorker.SettlementProvingTask

LocalTaskWorker.SettlementProvingTask: object

LocalTaskWorker.StateTransitionReductionTask

LocalTaskWorker.StateTransitionReductionTask: object

LocalTaskWorker.StateTransitionTask

LocalTaskWorker.StateTransitionTask: object

LocalTaskWorker.TransactionProvingTask

LocalTaskWorker.TransactionProvingTask: object

LocalTaskWorker.TransactionReductionTask

LocalTaskWorker.TransactionReductionTask: object

LocalTaskWorker.WorkerRegistrationTask

LocalTaskWorker.WorkerRegistrationTask: object

Mempool

Mempool: object = {}

SequencerStartupModule

SequencerStartupModule: object = {}

SettlementModule

SettlementModule: object

SettlementModule.addresses

SettlementModule.addresses: object

SettlementModule.addresses.SettlementContract

SettlementModule.addresses.SettlementContract: PublicKey

SettlementSigner

SettlementSigner: object

SettlementSigner.contractKeys

SettlementSigner.contractKeys: PrivateKey[]

SettlementSigner.feepayer

SettlementSigner.feepayer: PrivateKey

TaskQueue

TaskQueue: object

TaskQueue.simulatedDuration

TaskQueue.simulatedDuration: number = 0

WorkerModule

WorkerModule: object

WorkerModule.BlockReductionTask

WorkerModule.BlockReductionTask: object

WorkerModule.NewBlockTask

WorkerModule.NewBlockTask: object

WorkerModule.RuntimeProvingTask

WorkerModule.RuntimeProvingTask: object

WorkerModule.SettlementProvingTask

WorkerModule.SettlementProvingTask: object

WorkerModule.StateTransitionReductionTask

WorkerModule.StateTransitionReductionTask: object

WorkerModule.StateTransitionTask

WorkerModule.StateTransitionTask: object

WorkerModule.TransactionProvingTask

WorkerModule.TransactionProvingTask: object

WorkerModule.TransactionReductionTask

WorkerModule.TransactionReductionTask: object

WorkerModule.WorkerRegistrationTask

WorkerModule.WorkerRegistrationTask: object

Defined in

stack/src/presets/modules/index.ts:524

worker()

static worker(options?): object

Parameters

• options?

• options.overrides?: Partial<RedisTaskQueueEnv>

• options.preset?: Environment

Returns

object

TaskQueue

TaskQueue: object

TaskQueue.redis

TaskQueue.redis: object

TaskQueue.redis.db

TaskQueue.redis.db: undefined | number = config.redisDb

TaskQueue.redis.host

TaskQueue.redis.host: string = config.redisHost

TaskQueue.redis.password

TaskQueue.redis.password: string = config.redisPassword

TaskQueue.redis.port

TaskQueue.redis.port: number = config.redisPort

TaskQueue.retryAttempts

TaskQueue.retryAttempts: undefined | number = config.retryAttempts

WorkerModule

WorkerModule: object

WorkerModule.BlockReductionTask

WorkerModule.BlockReductionTask: object

WorkerModule.NewBlockTask

WorkerModule.NewBlockTask: object

WorkerModule.RuntimeProvingTask

WorkerModule.RuntimeProvingTask: object

WorkerModule.SettlementProvingTask

WorkerModule.SettlementProvingTask: object

WorkerModule.StateTransitionReductionTask

WorkerModule.StateTransitionReductionTask: object

WorkerModule.StateTransitionTask

WorkerModule.StateTransitionTask: object

WorkerModule.TransactionProvingTask

WorkerModule.TransactionProvingTask: object

WorkerModule.TransactionReductionTask

WorkerModule.TransactionReductionTask: object

WorkerModule.WorkerRegistrationTask

WorkerModule.WorkerRegistrationTask: object

Defined in

stack/src/presets/modules/index.ts:509