Skip to content

Commit 3c9a6bb

Browse files
Apply suggestions from code review
Co-authored-by: Dra Murphy <149679879+kmurphypolygon@users.noreply.github.com>
1 parent 8df552d commit 3c9a6bb

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

docs/zkEVM/architecture/data-streamer/server-source-library.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Interaction between the stream source and each stream server is enabled by the Server-source library, which is a Go library with six main functions for modifying or adding entries to operations.
1+
Interaction between the stream source and each stream server is enabled by the `server-source` library, which is a Go library with six main functions for modifying or adding entries to operations.
22

33
### Send data functions
44

@@ -13,17 +13,14 @@ When each of these functions is called, a corresponding message is generated and
1313

1414
### Query data functions
1515

16-
The stream source can use a few more functions of the stream server-source library, to get information from the stream server.
16+
The stream source uses the following functions of the stream server-source library to get information from the stream server.
1717

18-
It uses the following functions:
1918

2019
- $\texttt{GetHeader()}$: The stream source uses this function to query the header of a particular entry. The function returns, $\texttt{struct HeaderEntry}$.
2120
- $\texttt{GetEntry(u64 entryNumber)}$: This function is used to get an entry that corresponds to a given entry number. It returns, $\texttt{struct FileEntry}$.
2221
- $\texttt{GetBookmark(u8[ ] bookmark)}$: The stream source uses this function to get a bookmark. The function returns, $\texttt{u64 entryNumber}$.
2322
- $\texttt{GetFirstEventAfterBookmark(u8[ ] bookmark)}$: This function is used to get the first entry after a given bookmark. It returns, $\texttt{struct FileEntry}$.
2423

25-
26-
2724
The complete stream source-server library is described, but referred to as the DATA STREAMER INTERFACE (API), [here](https://github.com/0xPolygonHermez/zkevm-data-streamer#data-streamer-interface-api).
2825

2926
It's possible to create, using the stream source-server library, a stream source that connects with a server, opens and commits operations.

0 commit comments

Comments
 (0)