darkside.proto doc improvements
This commit is contained in:
parent
1dd63f2ca8
commit
1dbe4691a5
|
@ -710,7 +710,8 @@ staged blocks and transactions) and lightwalletd state (cache) to empty,
|
||||||
the same as the initial state. This occurs synchronously and instantaneously;
|
the same as the initial state. This occurs synchronously and instantaneously;
|
||||||
no reorg happens in lightwalletd. This is good to do before each independent
|
no reorg happens in lightwalletd. This is good to do before each independent
|
||||||
test so that no state leaks from one test to another.
|
test so that no state leaks from one test to another.
|
||||||
Also sets (some of) the values returned by GetLightdInfo().</p></td>
|
Also sets (some of) the values returned by GetLightdInfo(). The Sapling
|
||||||
|
activation height specified here must be where the block range starts.</p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
@ -719,7 +720,7 @@ Also sets (some of) the values returned by GetLightdInfo().</p></td>
|
||||||
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
|
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
|
||||||
<td><p>StageBlocksStream accepts a list of blocks and saves them into the blocks
|
<td><p>StageBlocksStream accepts a list of blocks and saves them into the blocks
|
||||||
staging area until ApplyStaged() is called; there is no immediate effect on
|
staging area until ApplyStaged() is called; there is no immediate effect on
|
||||||
the mock zcashd. Blocks are hex-encoded.</p></td>
|
the mock zcashd. Blocks are hex-encoded. Order is important, see ApplyStaged.</p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
@ -745,7 +746,7 @@ transactions) and same height, with two different hashes.</p></td>
|
||||||
<td>StageTransactionsStream</td>
|
<td>StageTransactionsStream</td>
|
||||||
<td><a href="#cash.z.wallet.sdk.rpc.RawTransaction">RawTransaction</a> stream</td>
|
<td><a href="#cash.z.wallet.sdk.rpc.RawTransaction">RawTransaction</a> stream</td>
|
||||||
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
|
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
|
||||||
<td><p>StageTransactions stores the given transaction-height pairs in the
|
<td><p>StageTransactionsStream stores the given transaction-height pairs in the
|
||||||
staging area until ApplyStaged() is called. Note that these transactions
|
staging area until ApplyStaged() is called. Note that these transactions
|
||||||
are not returned by the production GetTransaction() gRPC until they
|
are not returned by the production GetTransaction() gRPC until they
|
||||||
appear in a "mined" block (contained in the active blockchain presented
|
appear in a "mined" block (contained in the active blockchain presented
|
||||||
|
@ -756,7 +757,10 @@ by the mock zcashd).</p></td>
|
||||||
<td>StageTransactions</td>
|
<td>StageTransactions</td>
|
||||||
<td><a href="#cash.z.wallet.sdk.rpc.DarksideTransactionsURL">DarksideTransactionsURL</a></td>
|
<td><a href="#cash.z.wallet.sdk.rpc.DarksideTransactionsURL">DarksideTransactionsURL</a></td>
|
||||||
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
|
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
|
||||||
<td><p></p></td>
|
<td><p>StageTransactions is the same except the transactions are fetched
|
||||||
|
from the given url. They are all staged into the block at the given
|
||||||
|
height. Staging transactions at multiple different heights requires
|
||||||
|
multiple calls.</p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
|
|
@ -617,11 +617,12 @@ type DarksideStreamerClient interface {
|
||||||
// the same as the initial state. This occurs synchronously and instantaneously;
|
// the same as the initial state. This occurs synchronously and instantaneously;
|
||||||
// no reorg happens in lightwalletd. This is good to do before each independent
|
// no reorg happens in lightwalletd. This is good to do before each independent
|
||||||
// test so that no state leaks from one test to another.
|
// test so that no state leaks from one test to another.
|
||||||
// Also sets (some of) the values returned by GetLightdInfo().
|
// Also sets (some of) the values returned by GetLightdInfo(). The Sapling
|
||||||
|
// activation height specified here must be where the block range starts.
|
||||||
Reset(ctx context.Context, in *DarksideMetaState, opts ...grpc.CallOption) (*Empty, error)
|
Reset(ctx context.Context, in *DarksideMetaState, opts ...grpc.CallOption) (*Empty, error)
|
||||||
// StageBlocksStream accepts a list of blocks and saves them into the blocks
|
// StageBlocksStream accepts a list of blocks and saves them into the blocks
|
||||||
// staging area until ApplyStaged() is called; there is no immediate effect on
|
// staging area until ApplyStaged() is called; there is no immediate effect on
|
||||||
// the mock zcashd. Blocks are hex-encoded.
|
// the mock zcashd. Blocks are hex-encoded. Order is important, see ApplyStaged.
|
||||||
StageBlocksStream(ctx context.Context, opts ...grpc.CallOption) (DarksideStreamer_StageBlocksStreamClient, error)
|
StageBlocksStream(ctx context.Context, opts ...grpc.CallOption) (DarksideStreamer_StageBlocksStreamClient, error)
|
||||||
// StageBlocks is the same as StageBlocksStream() except the blocks are fetched
|
// StageBlocks is the same as StageBlocksStream() except the blocks are fetched
|
||||||
// from the given URL. Blocks are one per line, hex-encoded (not JSON).
|
// from the given URL. Blocks are one per line, hex-encoded (not JSON).
|
||||||
|
@ -632,12 +633,16 @@ type DarksideStreamerClient interface {
|
||||||
// lets you create two fake blocks with the same transactions (or no
|
// lets you create two fake blocks with the same transactions (or no
|
||||||
// transactions) and same height, with two different hashes.
|
// transactions) and same height, with two different hashes.
|
||||||
StageBlocksCreate(ctx context.Context, in *DarksideEmptyBlocks, opts ...grpc.CallOption) (*Empty, error)
|
StageBlocksCreate(ctx context.Context, in *DarksideEmptyBlocks, opts ...grpc.CallOption) (*Empty, error)
|
||||||
// StageTransactions stores the given transaction-height pairs in the
|
// StageTransactionsStream stores the given transaction-height pairs in the
|
||||||
// staging area until ApplyStaged() is called. Note that these transactions
|
// staging area until ApplyStaged() is called. Note that these transactions
|
||||||
// are not returned by the production GetTransaction() gRPC until they
|
// are not returned by the production GetTransaction() gRPC until they
|
||||||
// appear in a "mined" block (contained in the active blockchain presented
|
// appear in a "mined" block (contained in the active blockchain presented
|
||||||
// by the mock zcashd).
|
// by the mock zcashd).
|
||||||
StageTransactionsStream(ctx context.Context, opts ...grpc.CallOption) (DarksideStreamer_StageTransactionsStreamClient, error)
|
StageTransactionsStream(ctx context.Context, opts ...grpc.CallOption) (DarksideStreamer_StageTransactionsStreamClient, error)
|
||||||
|
// StageTransactions is the same except the transactions are fetched
|
||||||
|
// from the given url. They are all staged into the block at the given
|
||||||
|
// height. Staging transactions at multiple different heights requires
|
||||||
|
// multiple calls.
|
||||||
StageTransactions(ctx context.Context, in *DarksideTransactionsURL, opts ...grpc.CallOption) (*Empty, error)
|
StageTransactions(ctx context.Context, in *DarksideTransactionsURL, opts ...grpc.CallOption) (*Empty, error)
|
||||||
// ApplyStaged iterates the list of blocks that were staged by the
|
// ApplyStaged iterates the list of blocks that were staged by the
|
||||||
// StageBlocks*() gRPCs, in the order they were staged, and "merges" each
|
// StageBlocks*() gRPCs, in the order they were staged, and "merges" each
|
||||||
|
@ -835,11 +840,12 @@ type DarksideStreamerServer interface {
|
||||||
// the same as the initial state. This occurs synchronously and instantaneously;
|
// the same as the initial state. This occurs synchronously and instantaneously;
|
||||||
// no reorg happens in lightwalletd. This is good to do before each independent
|
// no reorg happens in lightwalletd. This is good to do before each independent
|
||||||
// test so that no state leaks from one test to another.
|
// test so that no state leaks from one test to another.
|
||||||
// Also sets (some of) the values returned by GetLightdInfo().
|
// Also sets (some of) the values returned by GetLightdInfo(). The Sapling
|
||||||
|
// activation height specified here must be where the block range starts.
|
||||||
Reset(context.Context, *DarksideMetaState) (*Empty, error)
|
Reset(context.Context, *DarksideMetaState) (*Empty, error)
|
||||||
// StageBlocksStream accepts a list of blocks and saves them into the blocks
|
// StageBlocksStream accepts a list of blocks and saves them into the blocks
|
||||||
// staging area until ApplyStaged() is called; there is no immediate effect on
|
// staging area until ApplyStaged() is called; there is no immediate effect on
|
||||||
// the mock zcashd. Blocks are hex-encoded.
|
// the mock zcashd. Blocks are hex-encoded. Order is important, see ApplyStaged.
|
||||||
StageBlocksStream(DarksideStreamer_StageBlocksStreamServer) error
|
StageBlocksStream(DarksideStreamer_StageBlocksStreamServer) error
|
||||||
// StageBlocks is the same as StageBlocksStream() except the blocks are fetched
|
// StageBlocks is the same as StageBlocksStream() except the blocks are fetched
|
||||||
// from the given URL. Blocks are one per line, hex-encoded (not JSON).
|
// from the given URL. Blocks are one per line, hex-encoded (not JSON).
|
||||||
|
@ -850,12 +856,16 @@ type DarksideStreamerServer interface {
|
||||||
// lets you create two fake blocks with the same transactions (or no
|
// lets you create two fake blocks with the same transactions (or no
|
||||||
// transactions) and same height, with two different hashes.
|
// transactions) and same height, with two different hashes.
|
||||||
StageBlocksCreate(context.Context, *DarksideEmptyBlocks) (*Empty, error)
|
StageBlocksCreate(context.Context, *DarksideEmptyBlocks) (*Empty, error)
|
||||||
// StageTransactions stores the given transaction-height pairs in the
|
// StageTransactionsStream stores the given transaction-height pairs in the
|
||||||
// staging area until ApplyStaged() is called. Note that these transactions
|
// staging area until ApplyStaged() is called. Note that these transactions
|
||||||
// are not returned by the production GetTransaction() gRPC until they
|
// are not returned by the production GetTransaction() gRPC until they
|
||||||
// appear in a "mined" block (contained in the active blockchain presented
|
// appear in a "mined" block (contained in the active blockchain presented
|
||||||
// by the mock zcashd).
|
// by the mock zcashd).
|
||||||
StageTransactionsStream(DarksideStreamer_StageTransactionsStreamServer) error
|
StageTransactionsStream(DarksideStreamer_StageTransactionsStreamServer) error
|
||||||
|
// StageTransactions is the same except the transactions are fetched
|
||||||
|
// from the given url. They are all staged into the block at the given
|
||||||
|
// height. Staging transactions at multiple different heights requires
|
||||||
|
// multiple calls.
|
||||||
StageTransactions(context.Context, *DarksideTransactionsURL) (*Empty, error)
|
StageTransactions(context.Context, *DarksideTransactionsURL) (*Empty, error)
|
||||||
// ApplyStaged iterates the list of blocks that were staged by the
|
// ApplyStaged iterates the list of blocks that were staged by the
|
||||||
// StageBlocks*() gRPCs, in the order they were staged, and "merges" each
|
// StageBlocks*() gRPCs, in the order they were staged, and "merges" each
|
||||||
|
|
|
@ -53,12 +53,13 @@ service DarksideStreamer {
|
||||||
// the same as the initial state. This occurs synchronously and instantaneously;
|
// the same as the initial state. This occurs synchronously and instantaneously;
|
||||||
// no reorg happens in lightwalletd. This is good to do before each independent
|
// no reorg happens in lightwalletd. This is good to do before each independent
|
||||||
// test so that no state leaks from one test to another.
|
// test so that no state leaks from one test to another.
|
||||||
// Also sets (some of) the values returned by GetLightdInfo().
|
// Also sets (some of) the values returned by GetLightdInfo(). The Sapling
|
||||||
|
// activation height specified here must be where the block range starts.
|
||||||
rpc Reset(DarksideMetaState) returns (Empty) {}
|
rpc Reset(DarksideMetaState) returns (Empty) {}
|
||||||
|
|
||||||
// StageBlocksStream accepts a list of blocks and saves them into the blocks
|
// StageBlocksStream accepts a list of blocks and saves them into the blocks
|
||||||
// staging area until ApplyStaged() is called; there is no immediate effect on
|
// staging area until ApplyStaged() is called; there is no immediate effect on
|
||||||
// the mock zcashd. Blocks are hex-encoded.
|
// the mock zcashd. Blocks are hex-encoded. Order is important, see ApplyStaged.
|
||||||
rpc StageBlocksStream(stream DarksideBlock) returns (Empty) {}
|
rpc StageBlocksStream(stream DarksideBlock) returns (Empty) {}
|
||||||
|
|
||||||
// StageBlocks is the same as StageBlocksStream() except the blocks are fetched
|
// StageBlocks is the same as StageBlocksStream() except the blocks are fetched
|
||||||
|
@ -72,16 +73,19 @@ service DarksideStreamer {
|
||||||
// transactions) and same height, with two different hashes.
|
// transactions) and same height, with two different hashes.
|
||||||
rpc StageBlocksCreate(DarksideEmptyBlocks) returns (Empty) {}
|
rpc StageBlocksCreate(DarksideEmptyBlocks) returns (Empty) {}
|
||||||
|
|
||||||
// StageTransactions stores the given transaction-height pairs in the
|
// StageTransactionsStream stores the given transaction-height pairs in the
|
||||||
// staging area until ApplyStaged() is called. Note that these transactions
|
// staging area until ApplyStaged() is called. Note that these transactions
|
||||||
// are not returned by the production GetTransaction() gRPC until they
|
// are not returned by the production GetTransaction() gRPC until they
|
||||||
// appear in a "mined" block (contained in the active blockchain presented
|
// appear in a "mined" block (contained in the active blockchain presented
|
||||||
// by the mock zcashd).
|
// by the mock zcashd).
|
||||||
rpc StageTransactionsStream(stream RawTransaction) returns (Empty) {}
|
rpc StageTransactionsStream(stream RawTransaction) returns (Empty) {}
|
||||||
|
|
||||||
|
// StageTransactions is the same except the transactions are fetched
|
||||||
|
// from the given url. They are all staged into the block at the given
|
||||||
|
// height. Staging transactions at multiple different heights requires
|
||||||
|
// multiple calls.
|
||||||
rpc StageTransactions(DarksideTransactionsURL) returns (Empty) {}
|
rpc StageTransactions(DarksideTransactionsURL) returns (Empty) {}
|
||||||
|
|
||||||
|
|
||||||
// ApplyStaged iterates the list of blocks that were staged by the
|
// ApplyStaged iterates the list of blocks that were staged by the
|
||||||
// StageBlocks*() gRPCs, in the order they were staged, and "merges" each
|
// StageBlocks*() gRPCs, in the order they were staged, and "merges" each
|
||||||
// into the active, working blocks list that the mock zcashd is presenting
|
// into the active, working blocks list that the mock zcashd is presenting
|
||||||
|
|
Loading…
Reference in New Issue