Skip to content

Commit 6375a04

Browse files
committed
Re gen that doc
1 parent 83733ac commit 6375a04

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

build/openrpc/v2/full.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -951,7 +951,7 @@
951951
{
952952
"name": "Filecoin.StateSimulate",
953953
"description": "```go\nfunc (s *FullNodeStruct) StateSimulate(p0 context.Context, p1 []*types.Message, p2 types.TipSetSelector, p3 types.TipSetLimit) (*api.ComputeStateOutput, error) {\n\tif s.Internal.StateSimulate == nil {\n\t\treturn nil, ErrNotSupported\n\t}\n\treturn s.Internal.StateSimulate(p0, p1, p2, p3)\n}\n```",
954-
"summary": "",
954+
"summary": "StateSimulate computes the state at the specified tipset and applies the provided messages\nusing the network version determined by a TipSetLimit.\n\nThis function:\n- Loads the tipset identified by the TipSetSelector\n- Calculates the complete state by applying all chain messages within that tipset\n- Applies any pending state upgrades up to the epoch determined by TipSetLimit\n- Applies the user-provided messages on top of that state using the network version\n corresponding to the target epoch\n\nThis function is particularly useful for testing how messages would behave in\nfuture network versions or for simulating execution at specific protocol versions.\n\nThe TipSetLimit parameter controls the simulation target and must specify exactly\none of the following:\n- Height: an absolute chain epoch at which to simulate execution\n- Distance: a relative number of epochs ahead of the selected tipset\n\nFor example, to simulate at exactly epoch 1000, use Height=1000. To simulate\n120 epochs ahead of the selected tipset, use Distance=120.\n\nIf the target epoch determined by TipSetLimit is lower than the tipset's epoch,\nan error will be returned as backward simulation is not supported.\n\nMessages must have the correct nonces and gas values set.\n\nThe TipSetSelector parameter provides flexible options for selecting the base tipset.\nSee StateCompute and TipSetSelector documentation for details on selection options.\n\nExperimental: This API is experimental and may change without notice.\n",
955955
"paramStructure": "by-position",
956956
"params": [
957957
{

documentation/en/api-v2-unstable-methods.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,9 +411,39 @@ Inputs:
411411
Response: `"f01234"`
412412

413413
### StateSimulate
414+
StateSimulate computes the state at the specified tipset and applies the provided messages
415+
using the network version determined by a TipSetLimit.
414416

417+
This function:
418+
- Loads the tipset identified by the TipSetSelector
419+
- Calculates the complete state by applying all chain messages within that tipset
420+
- Applies any pending state upgrades up to the epoch determined by TipSetLimit
421+
- Applies the user-provided messages on top of that state using the network version
422+
corresponding to the target epoch
423+
424+
This function is particularly useful for testing how messages would behave in
425+
future network versions or for simulating execution at specific protocol versions.
426+
427+
The TipSetLimit parameter controls the simulation target and must specify exactly
428+
one of the following:
429+
- Height: an absolute chain epoch at which to simulate execution
430+
- Distance: a relative number of epochs ahead of the selected tipset
431+
432+
For example, to simulate at exactly epoch 1000, use Height=1000. To simulate
433+
120 epochs ahead of the selected tipset, use Distance=120.
434+
435+
If the target epoch determined by TipSetLimit is lower than the tipset's epoch,
436+
an error will be returned as backward simulation is not supported.
415437

416-
Perms:
438+
Messages must have the correct nonces and gas values set.
439+
440+
The TipSetSelector parameter provides flexible options for selecting the base tipset.
441+
See StateCompute and TipSetSelector documentation for details on selection options.
442+
443+
Experimental: This API is experimental and may change without notice.
444+
445+
446+
Perms: read
417447

418448
Inputs:
419449
```json

0 commit comments

Comments
 (0)