Skip to content

Commit

Permalink
docs: generate solidity params docs (#1920)
Browse files Browse the repository at this point in the history
  • Loading branch information
@holic
holic authored Nov 12, 2023
1 parent ccc7b9e commit 369ef41
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
37 changes: 37 additions & 0 deletions next-docs/pages/store/reference/store-core.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -774,6 +774,16 @@ event Store_SetRecord(
);
```

**Parameters**

| Name | Type | Description |
| ---------------- | --------------- | ------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the record is set. |
| `keyTuple` | `bytes32[]` | An array representing the composite key for the record. |
| `staticData` | `bytes` | The static data of the record. |
| `encodedLengths` | `PackedCounter` | The encoded lengths of the dynamic data of the record. |
| `dynamicData` | `bytes` | The dynamic data of the record. |

### Store_SpliceStaticData

Emitted when static data in the store is spliced.
Expand All @@ -785,6 +795,15 @@ so the total length of the data remains the same and no data is shifted._
event Store_SpliceStaticData(ResourceId indexed tableId, bytes32[] keyTuple, uint48 start, bytes data);
```

**Parameters**

| Name | Type | Description |
| ---------- | ------------ | --------------------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the data is spliced. |
| `keyTuple` | `bytes32[]` | An array representing the key for the record. |
| `start` | `uint48` | The start position in bytes for the splice operation. |
| `data` | `bytes` | The data to write to the static data of the record at the start byte. |

### Store_SpliceDynamicData

Emitted when dynamic data in the store is spliced.
Expand All @@ -800,10 +819,28 @@ event Store_SpliceDynamicData(
);
```

**Parameters**

| Name | Type | Description |
| ---------------- | --------------- | ------------------------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the data is spliced. |
| `keyTuple` | `bytes32[]` | An array representing the composite key for the record. |
| `start` | `uint48` | The start position in bytes for the splice operation. |
| `deleteCount` | `uint40` | The number of bytes to delete in the splice operation. |
| `encodedLengths` | `PackedCounter` | The encoded lengths of the dynamic data of the record. |
| `data` | `bytes` | The data to insert into the dynamic data of the record at the start byte. |

### Store_DeleteRecord

Emitted when a record is deleted from the store.

```solidity
event Store_DeleteRecord(ResourceId indexed tableId, bytes32[] keyTuple);
```

**Parameters**

| Name | Type | Description |
| ---------- | ------------ | ------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the record is deleted. |
| `keyTuple` | `bytes32[]` | An array representing the composite key for the record. |
43 changes: 43 additions & 0 deletions next-docs/pages/store/reference/store.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ event Store_SetRecord(
);
```

**Parameters**

| Name | Type | Description |
| ---------------- | --------------- | ------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the record is set. |
| `keyTuple` | `bytes32[]` | An array representing the composite key for the record. |
| `staticData` | `bytes` | The static data of the record. |
| `encodedLengths` | `PackedCounter` | The encoded lengths of the dynamic data of the record. |
| `dynamicData` | `bytes` | The dynamic data of the record. |

### Store_SpliceStaticData

Emitted when static data in the store is spliced.
Expand All @@ -34,6 +44,15 @@ so the total length of the data remains the same and no data is shifted._
event Store_SpliceStaticData(ResourceId indexed tableId, bytes32[] keyTuple, uint48 start, bytes data);
```

**Parameters**

| Name | Type | Description |
| ---------- | ------------ | --------------------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the data is spliced. |
| `keyTuple` | `bytes32[]` | An array representing the key for the record. |
| `start` | `uint48` | The start position in bytes for the splice operation. |
| `data` | `bytes` | The data to write to the static data of the record at the start byte. |

### Store_SpliceDynamicData

Emitted when dynamic data in the store is spliced.
Expand All @@ -49,6 +68,17 @@ event Store_SpliceDynamicData(
);
```

**Parameters**

| Name | Type | Description |
| ---------------- | --------------- | ------------------------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the data is spliced. |
| `keyTuple` | `bytes32[]` | An array representing the composite key for the record. |
| `start` | `uint48` | The start position in bytes for the splice operation. |
| `deleteCount` | `uint40` | The number of bytes to delete in the splice operation. |
| `encodedLengths` | `PackedCounter` | The encoded lengths of the dynamic data of the record. |
| `data` | `bytes` | The data to insert into the dynamic data of the record at the start byte. |

### Store_DeleteRecord

Emitted when a record is deleted from the store.
Expand All @@ -57,6 +87,13 @@ Emitted when a record is deleted from the store.
event Store_DeleteRecord(ResourceId indexed tableId, bytes32[] keyTuple);
```

**Parameters**

| Name | Type | Description |
| ---------- | ------------ | ------------------------------------------------------- |
| `tableId` | `ResourceId` | The ID of the table where the record is deleted. |
| `keyTuple` | `bytes32[]` | An array representing the composite key for the record. |

## IStoreErrors

[Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/IStoreErrors.sol)
Expand Down Expand Up @@ -154,6 +191,12 @@ Emitted when the store is initialized.
event HelloStore(bytes32 indexed storeVersion);
```

**Parameters**

| Name | Type | Description |
| -------------- | --------- | ---------------------------------- |
| `storeVersion` | `bytes32` | The version of the Store contract. |

## IStoreRead

[Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/IStoreRead.sol)
Expand Down

0 comments on commit 369ef41

Please sign in to comment.