nitro/execution/rpcclient/client.go at d9e76098cbf92a2d654fa934d21ad6775f807a7b · OffchainLabs/nitro · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// Copyright 2025-2026, Offchain Labs, Inc.
// For license information, see https://github.com/OffchainLabs/nitro/blob/master/LICENSE.md

package rpcclient

import (
	"context"

	"github.com/ethereum/go-ethereum/core/rawdb"
	"github.com/ethereum/go-ethereum/node"

	"github.com/offchainlabs/nitro/arbos/arbostypes"
	"github.com/offchainlabs/nitro/arbutil"
	"github.com/offchainlabs/nitro/execution"
	"github.com/offchainlabs/nitro/util/containers"
	"github.com/offchainlabs/nitro/util/rpcclient"
	"github.com/offchainlabs/nitro/util/stopwaiter"
)

type Client struct {
	stopwaiter.StopWaiter
	client *rpcclient.RpcClient
}

func NewClient(config rpcclient.ClientConfigFetcher, stack *node.Node) *Client {
	return &Client{
		client: rpcclient.NewRpcClient(config, stack),
	}
}

func (c *Client) Start(ctx_in context.Context) error {
	c.StopWaiter.Start(ctx_in, c)
	ctx := c.GetContext()
	return c.client.Start(ctx)
}

func (c *Client) StopAndWait() {
	c.client.Close()
	c.StopWaiter.StopAndWait()
}

func sendRequest[T any](c *Client, method string, args ...any) containers.PromiseInterface[T] {
	return stopwaiter.LaunchPromiseThread(c, func(ctx context.Context) (T, error) {
		var res T
		err := c.client.CallContext(ctx, &res, execution.RPCNamespace+method, args...)
		return res, err
	})
}

func (c *Client) DigestMessage(msgIdx arbutil.MessageIndex, msg *arbostypes.MessageWithMetadata, msgForPrefetch *arbostypes.MessageWithMetadata) containers.PromiseInterface[*execution.MessageResult] {
	return sendRequest[*execution.MessageResult](c, "_digestMessage", msgIdx, msg, msgForPrefetch)
}

func (c *Client) Reorg(msgIdxOfFirstMsgToAdd arbutil.MessageIndex, newMessages []arbostypes.MessageWithMetadataAndBlockInfo, oldMessages []*arbostypes.MessageWithMetadata) containers.PromiseInterface[[]*execution.MessageResult] {
	return sendRequest[[]*execution.MessageResult](c, "_reorg", msgIdxOfFirstMsgToAdd, newMessages, oldMessages)
}

func (c *Client) HeadMessageIndex() containers.PromiseInterface[arbutil.MessageIndex] {
	return sendRequest[arbutil.MessageIndex](c, "_headMessageIndex")
}

func (c *Client) ResultAtMessageIndex(msgIdx arbutil.MessageIndex) containers.PromiseInterface[*execution.MessageResult] {
	return sendRequest[*execution.MessageResult](c, "_resultAtMessageIndex", msgIdx)
}

func (c *Client) SetFinalityData(safeFinalityData *arbutil.FinalityData, finalizedFinalityData *arbutil.FinalityData, validatedFinalityData *arbutil.FinalityData) containers.PromiseInterface[struct{}] {
	return sendRequest[struct{}](c, "_setFinalityData", safeFinalityData, finalizedFinalityData, validatedFinalityData)
}

func (c *Client) SetConsensusSyncData(syncData *execution.ConsensusSyncData) containers.PromiseInterface[struct{}] {
	return sendRequest[struct{}](c, "_setConsensusSyncData", syncData)
}

func (c *Client) MarkFeedStart(to arbutil.MessageIndex) containers.PromiseInterface[struct{}] {
	return sendRequest[struct{}](c, "_markFeedStart", to)
}

func (c *Client) TriggerMaintenance() containers.PromiseInterface[struct{}] {
	return sendRequest[struct{}](c, "_triggerMaintenance")
}

func (c *Client) ShouldTriggerMaintenance() containers.PromiseInterface[bool] {
	return sendRequest[bool](c, "_shouldTriggerMaintenance")
}

func (c *Client) MaintenanceStatus() containers.PromiseInterface[*execution.MaintenanceStatus] {
	return sendRequest[*execution.MaintenanceStatus](c, "_maintenanceStatus")
}

func (c *Client) ArbOSVersionForMessageIndex(msgIdx arbutil.MessageIndex) containers.PromiseInterface[uint64] {
	return sendRequest[uint64](c, "_arbOSVersionForMessageIndex", msgIdx)
}

func (c *Client) RecordBlockCreation(pos arbutil.MessageIndex, msg *arbostypes.MessageWithMetadata, wasmTargets []rawdb.WasmTarget) containers.PromiseInterface[*execution.RecordResult] {
	return sendRequest[*execution.RecordResult](c, "_recordBlockCreation", pos, msg, wasmTargets)
}

func (c *Client) PrepareForRecord(start, end arbutil.MessageIndex) containers.PromiseInterface[struct{}] {
	return sendRequest[struct{}](c, "_prepareForRecord", start, end)
}