mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-11-27 15:53:57 +00:00
update listener protos
This commit is contained in:
D-Stacks
parent
a905e34c8f
commit
22aeb048d1
File diff suppressed because it is too large
Load Diff
@ -164,23 +164,24 @@ message KaspadMessage {
|
||||
GetTxConfirmationsResponseMessage getTxConfirmationsResponse = 1109;
|
||||
GetTxsConfirmationsRequestMessage getTxsConfirmationsRequest = 1110;
|
||||
GetTxsConfirmationsResponseMessage getTxsConfirmationsResponse = 1111;
|
||||
NotifyTxsConfirmationChangedRequstMessage notifyTxsConfirmationChangedRequstMessage = 1112;
|
||||
NotifyTxsConfirmationChangedResponseMessage notifyTxsConfirmationChangedResponseMessage = 1113;
|
||||
StopNotifyTxsConfirmationChangedRequestMessage stopNotifyTxsConfirmationChangedRequestMessage = 1114;
|
||||
StopNotifyTxsConfirmationChangedResponseMessage stopNotifyTxsConfirmationChangedResponseMessage = 1115;
|
||||
StartNotifyTxsConfirmationChangedRequestMessage startNotifyTxsConfirmationChangedRequestMessage= 1116;
|
||||
StartNotifyTxsConfirmationChangedResponseMessage startNotifyTxsConfirmationChangedResponseMessage = 1117;
|
||||
ChangeNotifyTxsConfirmationChangedRequiredConfirmationsResponseMessage changeNotifyTxsConfirmationChangedRequiredConfirmationsResponseMessage = 1118;
|
||||
TxsConfirmationChangedNotficationMessage txsConfirmationChangedNotficationMessage = 1119;
|
||||
NotifyTxListenerRequestMessage notifyTxListenerRequestMessage = 1120;
|
||||
StopNotifyTxListenerRequestMessage stopNotifyTxListenerRequestMessage = 1121;
|
||||
StopNotifyTxListenerResponseMessage stopNotifyTxListenerResponseMessage = 1122;
|
||||
StartNotifyTxListenerRequestMessage startNotifyTxListenerRequestMessage = 1123;
|
||||
StartNotifyTxListenerResponseMessage startNotifyTxListenerResponseMessage = 1124;
|
||||
ChangeNotifyTxListenerRequiredConfirmationsRequestMessage changeNotifyTxListenerRequiredConfirmationsRequestMessage = 1125;
|
||||
ChangeNotifyTxListenerRequiredConfirmationsResponseMessage changeNotifyTxListenerRequiredConfirmationsResponseMessage = 1126;
|
||||
TxListenerNotificationMessage txListenerNotificationMessage = 1127;
|
||||
|
||||
NotifyTxsConfirmationChangedRequstMessage notifyTxsConfirmationChangedRequst = 1112;
|
||||
NotifyTxsConfirmationChangedResponseMessage notifyTxsConfirmationChangedResponse = 1113;
|
||||
StopNotifyTxsConfirmationChangedRequestMessage stopNotifyTxsConfirmationChangedRequest = 1114;
|
||||
StopNotifyTxsConfirmationChangedResponseMessage stopNotifyTxsConfirmationChangedResponse = 1115;
|
||||
StartNotifyTxsConfirmationChangedRequestMessage startNotifyTxsConfirmationChangedRequest = 1116;
|
||||
StartNotifyTxsConfirmationChangedResponseMessage startNotifyTxsConfirmationChangedResponse = 1117;
|
||||
ModifyNotifyTxsConfirmationChangedParamsRequestMessage modifyNotifyTxsConfirmationChangedParamsRequest = 1118;
|
||||
ModifyNotifyTxsConfirmationChangedParamsResponseMessage modifyNotifyTxsConfirmationChangedParamsResponse = 1119;
|
||||
TxsConfirmationChangedNotificationMessage txsConfirmationChangedNotification = 1120;
|
||||
NotifyAddressesTxsRequestMessage notifyNotifyAddressesTxsRequest = 1121;
|
||||
NotifyAddressesTxsResponseMessage notifyNotifyAddressesTxsResponse = 1122;
|
||||
StopNotifyAddressesTxsRequestMessage stopNotifyAddressesTxsRequest = 1123;
|
||||
StopNotifyAddressesTxsResponseMessage stopNotifyAddressesTxsResponse = 1124;
|
||||
StartNotifyAddressesTxsRequestMessage startNotifyAddressesTxsRequest = 1125;
|
||||
StartNotifyAddressesTxsResponseMessage startNotifyAddressesTxsResponse = 1126;
|
||||
ModifyNotifyAddressesTxsParamsRequestMessage modifyNotifyAddressesTxsParamsRequest = 1127;
|
||||
ModifyNotifyAddressesTxsParamsResponseMessage modifyNotifyAddressesTxsParamsResponse = 1128;
|
||||
AddressesTxsNotificationMessage AddressesTxsNotification = 1129;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -140,28 +140,27 @@
|
||||
- [GetTxsConfirmationsRequestMessage](#protowire.GetTxsConfirmationsRequestMessage)
|
||||
- [GetTxsConfirmationsResponseMessage](#protowire.GetTxsConfirmationsResponseMessage)
|
||||
- [NotifyTxsConfirmationChangedRequstMessage](#protowire.NotifyTxsConfirmationChangedRequstMessage)
|
||||
- [NotifyTxsConfirmationChangedRequstMessage.Params](#protowire.NotifyTxsConfirmationChangedRequstMessage.Params)
|
||||
- [NotifyTxsConfirmationChangedResponseMessage](#protowire.NotifyTxsConfirmationChangedResponseMessage)
|
||||
- [TxsConfirmationChangedNotficationMessage](#protowire.TxsConfirmationChangedNotficationMessage)
|
||||
- [TxsConfirmationChangedNotficationMessage.Pending](#protowire.TxsConfirmationChangedNotficationMessage.Pending)
|
||||
- [TxsConfirmationChangedNotficationMessage.Confirmed](#protowire.TxsConfirmationChangedNotficationMessage.Confirmed)
|
||||
- [TxsConfirmationChangedNotificationMessage](#protowire.TxsConfirmationChangedNotificationMessage)
|
||||
- [StopNotifyTxsConfirmationChangedRequestMessage](#protowire.StopNotifyTxsConfirmationChangedRequestMessage)
|
||||
- [StopNotifyTxsConfirmationChangedResponseMessage](#protowire.StopNotifyTxsConfirmationChangedResponseMessage)
|
||||
- [StartNotifyTxsConfirmationChangedRequestMessage](#protowire.StartNotifyTxsConfirmationChangedRequestMessage)
|
||||
- [StartNotifyTxsConfirmationChangedResponseMessage](#protowire.StartNotifyTxsConfirmationChangedResponseMessage)
|
||||
- [ChangeNotifyTxsConfirmationChangedRequiredConfirmationsRequestMessage](#protowire.ChangeNotifyTxsConfirmationChangedRequiredConfirmationsRequestMessage)
|
||||
- [ChangeNotifyTxsConfirmationChangedRequiredConfirmationsResponseMessage](#protowire.ChangeNotifyTxsConfirmationChangedRequiredConfirmationsResponseMessage)
|
||||
- [ModifyNotifyTxsConfirmationChangedParamsRequestMessage](#protowire.ModifyNotifyTxsConfirmationChangedParamsRequestMessage)
|
||||
- [ModifyNotifyTxsConfirmationChangedParamsResponseMessage](#protowire.ModifyNotifyTxsConfirmationChangedParamsResponseMessage)
|
||||
- [TxEntryByAddress](#protowire.TxEntryByAddress)
|
||||
- [NotifyTxListenerRequestMessage](#protowire.NotifyTxListenerRequestMessage)
|
||||
- [NotifyTxListenerResponseMessage](#protowire.NotifyTxListenerResponseMessage)
|
||||
- [StopNotifyTxListenerRequestMessage](#protowire.StopNotifyTxListenerRequestMessage)
|
||||
- [StopNotifyTxListenerResponseMessage](#protowire.StopNotifyTxListenerResponseMessage)
|
||||
- [StartNotifyTxListenerRequestMessage](#protowire.StartNotifyTxListenerRequestMessage)
|
||||
- [StartNotifyTxListenerResponseMessage](#protowire.StartNotifyTxListenerResponseMessage)
|
||||
- [ChangeNotifyTxListenerRequiredConfirmationsRequestMessage](#protowire.ChangeNotifyTxListenerRequiredConfirmationsRequestMessage)
|
||||
- [ChangeNotifyTxListenerRequiredConfirmationsResponseMessage](#protowire.ChangeNotifyTxListenerRequiredConfirmationsResponseMessage)
|
||||
- [TxListenerNotificationMessage](#protowire.TxListenerNotificationMessage)
|
||||
- [TxListenerNotificationMessage.Pending](#protowire.TxListenerNotificationMessage.Pending)
|
||||
- [TxListenerNotificationMessage.Confirmed](#protowire.TxListenerNotificationMessage.Confirmed)
|
||||
- [TxEntriesByAddresses](#protowire.TxEntriesByAddresses)
|
||||
- [NotifyAddressesTxsRequestMessage](#protowire.NotifyAddressesTxsRequestMessage)
|
||||
- [NotifyAddressesTxsRequestMessage.Params](#protowire.NotifyAddressesTxsRequestMessage.Params)
|
||||
- [NotifyAddressesTxsResponseMessage](#protowire.NotifyAddressesTxsResponseMessage)
|
||||
- [StopNotifyAddressesTxsRequestMessage](#protowire.StopNotifyAddressesTxsRequestMessage)
|
||||
- [StopNotifyAddressesTxsResponseMessage](#protowire.StopNotifyAddressesTxsResponseMessage)
|
||||
- [StartNotifyAddressesTxsRequestMessage](#protowire.StartNotifyAddressesTxsRequestMessage)
|
||||
- [StartNotifyAddressesTxsResponseMessage](#protowire.StartNotifyAddressesTxsResponseMessage)
|
||||
- [ModifyNotifyAddressesTxsParamsRequestMessage](#protowire.ModifyNotifyAddressesTxsParamsRequestMessage)
|
||||
- [ModifyNotifyAddressesTxsParamsResponseMessage](#protowire.ModifyNotifyAddressesTxsParamsResponseMessage)
|
||||
- [AddressesTxsNotificationMessage](#protowire.AddressesTxsNotificationMessage)
|
||||
|
||||
- [SubmitBlockResponseMessage.RejectReason](#protowire.SubmitBlockResponseMessage.RejectReason)
|
||||
|
||||
@ -1990,7 +1989,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetAcceptingBlockHashesOfTxsRequestMessage"></a>
|
||||
|
||||
### GetAcceptingBlockHashesOfTxsRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2021,7 +2020,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetAcceptingBlockOfTxRequestMessage"></a>
|
||||
|
||||
### GetAcceptingBlockOfTxRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2053,7 +2052,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetAcceptingBlocksOfTxsRequestMessage"></a>
|
||||
|
||||
### GetAcceptingBlocksOfTxsRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2085,7 +2084,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetIncludingBlockHashOfTxRequestMessage"></a>
|
||||
|
||||
### GetIncludingBlockHashOfTxRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2116,7 +2115,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetIncludingBlockHashesOfTxsRequestMessage"></a>
|
||||
|
||||
### GetIncludingBlockHashesOfTxsRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2147,7 +2146,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetIncludingBlockOfTxRequestMessage"></a>
|
||||
|
||||
### GetIncludingBlockOfTxRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2179,7 +2178,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetIncludingBlocksOfTxsRequestMessage"></a>
|
||||
|
||||
### GetIncludingBlocksOfTxsRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2211,7 +2210,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetTxRequestMessage"></a>
|
||||
|
||||
### GetTxRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2242,7 +2241,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetTxsRequestMessage"></a>
|
||||
|
||||
### GetTxsRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2273,7 +2272,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetTxConfirmationsRequestMessage"></a>
|
||||
|
||||
### GetTxConfirmationsRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2304,7 +2303,7 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.GetTxsConfirmationsRequestMessage"></a>
|
||||
|
||||
### GetTxsConfirmationsRequestMessage
|
||||
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2335,14 +2334,30 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.NotifyTxsConfirmationChangedRequstMessage"></a>
|
||||
|
||||
### NotifyTxsConfirmationChangedRequstMessage
|
||||
NotifyTxsConfirmationChangedRequstMessage is a listener that registers confirmations from supplied TxIDs
|
||||
Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| TxIDs | [string](#string) | repeated | initial TxIds to listen for when regestering for notifications |
|
||||
| params | [NotifyTxsConfirmationChangedRequstMessage.Params](#protowire.NotifyTxsConfirmationChangedRequstMessage.Params) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.NotifyTxsConfirmationChangedRequstMessage.Params"></a>
|
||||
|
||||
### NotifyTxsConfirmationChangedRequstMessage.Params
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| TxIDs | [string](#string) | repeated | |
|
||||
| requiredConfirmations | [uint32](#uint32) | | |
|
||||
| includePending | [bool](#bool) | | |
|
||||
| requiredConfirmations | [uint32](#uint32) | | number of confirmations until a transaction is considered confirmed |
|
||||
| includePending | [bool](#bool) | | weather to notify confirmation changes during pre-Confirmed states |
|
||||
|
||||
|
||||
|
||||
@ -2359,16 +2374,18 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
|
||||
|
||||
|
||||
<a name="protowire.TxsConfirmationChangedNotficationMessage"></a>
|
||||
|
||||
### TxsConfirmationChangedNotficationMessage
|
||||
<a name="protowire.TxsConfirmationChangedNotificationMessage"></a>
|
||||
|
||||
### TxsConfirmationChangedNotificationMessage
|
||||
TxsConfirmationChangedNotificationMessage is the notification about txs pertaining to specified TxIDs
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| pending | [TxsConfirmationChangedNotficationMessage.Pending](#protowire.TxsConfirmationChangedNotficationMessage.Pending) | repeated | |
|
||||
| confirmed | [TxsConfirmationChangedNotficationMessage.Confirmed](#protowire.TxsConfirmationChangedNotficationMessage.Confirmed) | repeated | |
|
||||
| requiredConfirmations | [uint32](#uint32) | | the required confirmations set when notification was sent |
|
||||
| pending | [RpcTxIDConfirmationsPair](#protowire.RpcTxIDConfirmationsPair) | repeated | RpcTxIDConfirmationsPairs which have entered the virtual chain but not passed the required confirmations |
|
||||
| confirmed | [RpcTxIDConfirmationsPair](#protowire.RpcTxIDConfirmationsPair) | repeated | RpcTxIDConfirmationsPairs which have entered the virtual chain and passed the required confirmations |
|
||||
| unconfirmedTxIds | [string](#string) | repeated | TxIds which were not confirmed within the required confirmations. |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
@ -2376,40 +2393,10 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
|
||||
|
||||
|
||||
<a name="protowire.TxsConfirmationChangedNotficationMessage.Pending"></a>
|
||||
|
||||
### TxsConfirmationChangedNotficationMessage.Pending
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| txIDConfirmationsPairs | [RpcTxIDConfirmationsPair](#protowire.RpcTxIDConfirmationsPair) | repeated | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.TxsConfirmationChangedNotficationMessage.Confirmed"></a>
|
||||
|
||||
### TxsConfirmationChangedNotficationMessage.Confirmed
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| txIDConfirmationsPairs | [RpcTxIDConfirmationsPair](#protowire.RpcTxIDConfirmationsPair) | repeated | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StopNotifyTxsConfirmationChangedRequestMessage"></a>
|
||||
|
||||
### StopNotifyTxsConfirmationChangedRequestMessage
|
||||
|
||||
most be registered to NotifyTxsConfirmationChangedRequstMessage for this command to work
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2427,6 +2414,11 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2434,7 +2426,8 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
<a name="protowire.StartNotifyTxsConfirmationChangedRequestMessage"></a>
|
||||
|
||||
### StartNotifyTxsConfirmationChangedRequestMessage
|
||||
|
||||
StartNotifyTxsConfirmationChangedRequestMessage starts listening for Transaction confirmations with the specified TxIDs
|
||||
Most be registered to NotifyTxsConfirmationChangedRequstMessage for this command to work
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
@ -2452,31 +2445,43 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.ChangeNotifyTxsConfirmationChangedRequiredConfirmationsRequestMessage"></a>
|
||||
|
||||
### ChangeNotifyTxsConfirmationChangedRequiredConfirmationsRequestMessage
|
||||
|
||||
<a name="protowire.ModifyNotifyTxsConfirmationChangedParamsRequestMessage"></a>
|
||||
|
||||
### ModifyNotifyTxsConfirmationChangedParamsRequestMessage
|
||||
ModifyNotifyTxsConfirmationChangedParamsRequestMessage modfies the params of a registered `NotifyTxsConfirmationChangedRequstMessage`
|
||||
most be registered to NotifyTxsConfirmationChangedRequstMessage for this command to work
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| requiredConfirmations | [uint32](#uint32) | | |
|
||||
| includePending | [bool](#bool) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.ChangeNotifyTxsConfirmationChangedRequiredConfirmationsResponseMessage"></a>
|
||||
<a name="protowire.ModifyNotifyTxsConfirmationChangedParamsResponseMessage"></a>
|
||||
|
||||
### ChangeNotifyTxsConfirmationChangedRequiredConfirmationsResponseMessage
|
||||
### ModifyNotifyTxsConfirmationChangedParamsResponseMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2498,151 +2503,179 @@ See NotifyNewBlockTemplateRequestMessage
|
||||
|
||||
|
||||
|
||||
<a name="protowire.NotifyTxListenerRequestMessage"></a>
|
||||
<a name="protowire.TxEntriesByAddresses"></a>
|
||||
|
||||
### NotifyTxListenerRequestMessage
|
||||
### TxEntriesByAddresses
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| sent | [TxEntryByAddress](#protowire.TxEntryByAddress) | repeated | |
|
||||
| received | [TxEntryByAddress](#protowire.TxEntryByAddress) | repeated | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.NotifyAddressesTxsRequestMessage"></a>
|
||||
|
||||
### NotifyAddressesTxsRequestMessage
|
||||
NotifyAddressesTxsChangedRequestMessage Listens for Txs pertaining to specified addresses according to the params specified
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| addresses | [string](#string) | repeated | initial addresses to listen for Tx changes when regestering for notifications |
|
||||
| params | [NotifyAddressesTxsRequestMessage.Params](#protowire.NotifyAddressesTxsRequestMessage.Params) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.NotifyAddressesTxsRequestMessage.Params"></a>
|
||||
|
||||
### NotifyAddressesTxsRequestMessage.Params
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| requiredConfirmations | [uint32](#uint32) | | number of confirmations until a transaction is considered confirmed |
|
||||
| includePending | [bool](#bool) | | whether to notify confirmation changes during pre-Confirmed states |
|
||||
| includeSending | [bool](#bool) | | whether to listen on addresses sending txs |
|
||||
| includeReceiving | [bool](#bool) | | whether to listen on addresses reciving txs |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.NotifyAddressesTxsResponseMessage"></a>
|
||||
|
||||
### NotifyAddressesTxsResponseMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StopNotifyAddressesTxsRequestMessage"></a>
|
||||
|
||||
### StopNotifyAddressesTxsRequestMessage
|
||||
StopNotifyAddressesTxsRequestMessage stops listening for Txs pertaining to specified addresses
|
||||
Most be registered to NotifyAddressTxChangedRequestMessage for this command to work
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| addresses | [string](#string) | repeated | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StopNotifyAddressesTxsResponseMessage"></a>
|
||||
|
||||
### StopNotifyAddressesTxsResponseMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StartNotifyAddressesTxsRequestMessage"></a>
|
||||
|
||||
### StartNotifyAddressesTxsRequestMessage
|
||||
StartNotifyAddressesTxsRequestMessage starts listening for Txs pertaining to specified addresses
|
||||
Most be registered to NotifyAddressTxChangedRequestMessage for this command to work
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| addresses | [string](#string) | repeated | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StartNotifyAddressesTxsResponseMessage"></a>
|
||||
|
||||
### StartNotifyAddressesTxsResponseMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.ModifyNotifyAddressesTxsParamsRequestMessage"></a>
|
||||
|
||||
### ModifyNotifyAddressesTxsParamsRequestMessage
|
||||
ModifyNotifyAddressesTxsParamsRequestMessage modifies the params used for a regesitered `NotifyAddressesTxsRequest`
|
||||
Most be registered to NotifyAddressTxChangedRequestMessage for this command to work
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| requiredConfirmations | [uint32](#uint32) | | |
|
||||
| includePending | [bool](#bool) | | |
|
||||
| includeSending | [bool](#bool) | | |
|
||||
| includeReceiving | [bool](#bool) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.NotifyTxListenerResponseMessage"></a>
|
||||
<a name="protowire.ModifyNotifyAddressesTxsParamsResponseMessage"></a>
|
||||
|
||||
### NotifyTxListenerResponseMessage
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StopNotifyTxListenerRequestMessage"></a>
|
||||
|
||||
### StopNotifyTxListenerRequestMessage
|
||||
### ModifyNotifyAddressesTxsParamsResponseMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| addresses | [string](#string) | repeated | |
|
||||
| error | [RPCError](#protowire.RPCError) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StopNotifyTxListenerResponseMessage"></a>
|
||||
|
||||
### StopNotifyTxListenerResponseMessage
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StartNotifyTxListenerRequestMessage"></a>
|
||||
|
||||
### StartNotifyTxListenerRequestMessage
|
||||
<a name="protowire.AddressesTxsNotificationMessage"></a>
|
||||
|
||||
### AddressesTxsNotificationMessage
|
||||
AddressesTxsNotificationMessage is the notification about txs pertaining to specified addresses
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| addresses | [string](#string) | repeated | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.StartNotifyTxListenerResponseMessage"></a>
|
||||
|
||||
### StartNotifyTxListenerResponseMessage
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.ChangeNotifyTxListenerRequiredConfirmationsRequestMessage"></a>
|
||||
|
||||
### ChangeNotifyTxListenerRequiredConfirmationsRequestMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| requiredConfirmations | [uint32](#uint32) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.ChangeNotifyTxListenerRequiredConfirmationsResponseMessage"></a>
|
||||
|
||||
### ChangeNotifyTxListenerRequiredConfirmationsResponseMessage
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.TxListenerNotificationMessage"></a>
|
||||
|
||||
### TxListenerNotificationMessage
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| pending | [TxListenerNotificationMessage.Pending](#protowire.TxListenerNotificationMessage.Pending) | | |
|
||||
| confirmed | [TxListenerNotificationMessage.Confirmed](#protowire.TxListenerNotificationMessage.Confirmed) | | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.TxListenerNotificationMessage.Pending"></a>
|
||||
|
||||
### TxListenerNotificationMessage.Pending
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| sent | [TxEntryByAddress](#protowire.TxEntryByAddress) | repeated | |
|
||||
| received | [TxEntryByAddress](#protowire.TxEntryByAddress) | repeated | |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="protowire.TxListenerNotificationMessage.Confirmed"></a>
|
||||
|
||||
### TxListenerNotificationMessage.Confirmed
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| requiredConfirmations | [uint32](#uint32) | | |
|
||||
| sent | [TxEntryByAddress](#protowire.TxEntryByAddress) | repeated | |
|
||||
| received | [TxEntryByAddress](#protowire.TxEntryByAddress) | repeated | |
|
||||
| requiredConfirmations | [uint32](#uint32) | | the required confirmations set when notification was sent |
|
||||
| pending | [TxEntriesByAddresses](#protowire.TxEntriesByAddresses) | | TxEntriesByAddresses which have entered the blockdag but not passed the required confirmations |
|
||||
| confirmed | [TxEntriesByAddresses](#protowire.TxEntriesByAddresses) | | TxEntriesByAddresses which have entered the blockdag and passed the required confirmations |
|
||||
| unconfirmed | [TxEntriesByAddresses](#protowire.TxEntriesByAddresses) | | TxEntriesByAddresses which have been pending, but removed via a reorg within the number of required confirmations. |
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -749,16 +749,17 @@ message RpcTxIDBlockPair {
|
||||
RpcBlock block = 2;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetAcceptingBlockHashesOfTxsRequestMessage{
|
||||
repeated string txIDs = 1;
|
||||
}
|
||||
|
||||
message GetAcceptingBlockHashesOfTxsResponseMessage{
|
||||
repeated RpcTxIDBlockHashPair txIDBlockHashPairs = 1;
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetAcceptingBlockOfTxRequestMessage{
|
||||
string txID = 1;
|
||||
bool includeTransactions = 2;
|
||||
@ -770,6 +771,7 @@ message GetAcceptingBlockOfTxResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetAcceptingBlocksOfTxsRequestMessage{
|
||||
repeated string txIDs = 1;
|
||||
bool includeTransactions = 2;
|
||||
@ -781,6 +783,7 @@ message GetAcceptingBlocksOfTxsResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetIncludingBlockHashOfTxRequestMessage{
|
||||
string txID = 1;
|
||||
}
|
||||
@ -791,6 +794,8 @@ message GetIncludingBlockHashOfTxResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetIncludingBlockHashesOfTxsRequestMessage{
|
||||
repeated string txIDs = 1;
|
||||
}
|
||||
@ -801,6 +806,8 @@ message GetIncludingBlockHashesOfTxsResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetIncludingBlockOfTxRequestMessage{
|
||||
string txID = 1;
|
||||
bool includeTransactions = 2;
|
||||
@ -812,6 +819,8 @@ message GetIncludingBlockOfTxResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetIncludingBlocksOfTxsRequestMessage{
|
||||
repeated string txIDs = 1;
|
||||
bool includeTransactions = 2;
|
||||
@ -823,6 +832,7 @@ message GetIncludingBlocksOfTxsResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetTxRequestMessage{
|
||||
string txID = 1;
|
||||
}
|
||||
@ -834,6 +844,7 @@ message GetTxResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetTxsRequestMessage{
|
||||
repeated string txIDs = 1;
|
||||
}
|
||||
@ -845,6 +856,7 @@ message GetTxsResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetTxConfirmationsRequestMessage{
|
||||
string txID = 1;
|
||||
}
|
||||
@ -855,6 +867,7 @@ message GetTxConfirmationsResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
//Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message GetTxsConfirmationsRequestMessage{
|
||||
repeated string txIDs = 1;
|
||||
}
|
||||
@ -865,51 +878,61 @@ message GetTxsConfirmationsResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
// NotifyTxsConfirmationChangedRequstMessage is a listener that registers confirmations from supplied TxIDs
|
||||
// Kaspad most be started with the `--txindex` flag for this Request to work.
|
||||
message NotifyTxsConfirmationChangedRequstMessage{
|
||||
repeated string TxIDs = 1;
|
||||
uint32 requiredConfirmations = 2;
|
||||
bool includePending = 3;
|
||||
repeated string TxIDs = 1; //initial TxIds to listen for when regestering for notifications
|
||||
message Params {
|
||||
uint32 requiredConfirmations = 1; // number of confirmations until a transaction is considered confirmed
|
||||
bool includePending = 2; // weather to notify confirmation changes during pre-Confirmed states
|
||||
}
|
||||
Params params = 2;
|
||||
}
|
||||
|
||||
message NotifyTxsConfirmationChangedResponseMessage{
|
||||
|
||||
}
|
||||
|
||||
message TxsConfirmationChangedNotficationMessage{
|
||||
message Pending{
|
||||
repeated RpcTxIDConfirmationsPair txIDConfirmationsPairs = 1;
|
||||
}
|
||||
message Confirmed{
|
||||
repeated RpcTxIDConfirmationsPair txIDConfirmationsPairs = 1;
|
||||
}
|
||||
repeated Pending pending = 1;
|
||||
repeated Confirmed confirmed = 2;
|
||||
// TxsConfirmationChangedNotificationMessage is the notification about txs pertaining to specified TxIDs
|
||||
message TxsConfirmationChangedNotificationMessage{
|
||||
uint32 requiredConfirmations = 1; //the required confirmations set when notification was sent
|
||||
repeated RpcTxIDConfirmationsPair pending = 2; // RpcTxIDConfirmationsPairs which have entered the virtual chain but not passed the required confirmations
|
||||
repeated RpcTxIDConfirmationsPair confirmed = 3; // RpcTxIDConfirmationsPairs which have entered the virtual chain and passed the required confirmations
|
||||
repeated string unconfirmedTxIds = 4; // TxIds which were not confirmed within the required confirmations.
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
// most be registered to NotifyTxsConfirmationChangedRequstMessage for this command to work
|
||||
message StopNotifyTxsConfirmationChangedRequestMessage{
|
||||
repeated string TxIDs = 1;
|
||||
}
|
||||
|
||||
message StopNotifyTxsConfirmationChangedResponseMessage{
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
// StartNotifyTxsConfirmationChangedRequestMessage starts listening for Transaction confirmations with the specified TxIDs
|
||||
// Most be registered to NotifyTxsConfirmationChangedRequstMessage for this command to work
|
||||
message StartNotifyTxsConfirmationChangedRequestMessage{
|
||||
repeated string TxIDs = 1;
|
||||
}
|
||||
|
||||
message StartNotifyTxsConfirmationChangedResponseMessage{
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
message ChangeNotifyTxsConfirmationChangedRequiredConfirmationsRequestMessage{
|
||||
// ModifyNotifyTxsConfirmationChangedParamsRequestMessage modfies the params of a registered `NotifyTxsConfirmationChangedRequstMessage`
|
||||
// most be registered to NotifyTxsConfirmationChangedRequstMessage for this command to work
|
||||
message ModifyNotifyTxsConfirmationChangedParamsRequestMessage{
|
||||
uint32 requiredConfirmations = 1;
|
||||
bool includePending = 2;
|
||||
}
|
||||
|
||||
message ChangeNotifyTxsConfirmationChangedRequiredConfirmationsResponseMessage{
|
||||
|
||||
message ModifyNotifyTxsConfirmationChangedParamsResponseMessage{
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
message TxEntryByAddress{
|
||||
@ -918,51 +941,68 @@ message TxEntryByAddress{
|
||||
uint32 confirmations = 3;
|
||||
}
|
||||
|
||||
message NotifyTxListenerRequestMessage{
|
||||
repeated string addresses = 1;
|
||||
uint32 requiredConfirmations = 2;
|
||||
bool includePending = 3;
|
||||
message TxEntriesByAddresses{
|
||||
repeated TxEntryByAddress sent = 1;
|
||||
repeated TxEntryByAddress received = 2;
|
||||
}
|
||||
|
||||
// NotifyAddressesTxsChangedRequestMessage Listens for Txs pertaining to specified addresses according to the params specified
|
||||
message NotifyAddressesTxsRequestMessage{
|
||||
repeated string addresses = 1; //initial addresses to listen for Tx changes when regestering for notifications
|
||||
message Params {
|
||||
uint32 requiredConfirmations = 2; // number of confirmations until a transaction is considered confirmed
|
||||
bool includePending = 3; //whether to notify confirmation changes during pre-Confirmed states
|
||||
bool includeSending = 4; //whether to listen on addresses sending txs
|
||||
bool includeReceiving = 5; //whether to listen on addresses reciving txs
|
||||
}
|
||||
Params params = 2;
|
||||
}
|
||||
|
||||
message NotifyTxListenerResponseMessage{
|
||||
message NotifyAddressesTxsResponseMessage{
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
message StopNotifyTxListenerRequestMessage{
|
||||
// StopNotifyAddressesTxsRequestMessage stops listening for Txs pertaining to specified addresses
|
||||
// Most be registered to NotifyAddressTxChangedRequestMessage for this command to work
|
||||
message StopNotifyAddressesTxsRequestMessage{
|
||||
repeated string addresses = 1;
|
||||
}
|
||||
|
||||
message StopNotifyTxListenerResponseMessage{
|
||||
message StopNotifyAddressesTxsResponseMessage{
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
message StartNotifyTxListenerRequestMessage{
|
||||
// StartNotifyAddressesTxsRequestMessage starts listening for Txs pertaining to specified addresses
|
||||
// Most be registered to NotifyAddressTxChangedRequestMessage for this command to work
|
||||
message StartNotifyAddressesTxsRequestMessage{
|
||||
repeated string addresses = 1;
|
||||
}
|
||||
|
||||
message StartNotifyTxListenerResponseMessage{
|
||||
message StartNotifyAddressesTxsResponseMessage{
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
|
||||
message ChangeNotifyTxListenerRequiredConfirmationsRequestMessage{
|
||||
// ModifyNotifyAddressesTxsParamsRequestMessage modifies the params used for a regesitered `NotifyAddressesTxsRequest`
|
||||
// Most be registered to NotifyAddressTxChangedRequestMessage for this command to work
|
||||
message ModifyNotifyAddressesTxsParamsRequestMessage{
|
||||
uint32 requiredConfirmations = 1;
|
||||
bool includePending = 3;
|
||||
bool includeSending = 4;
|
||||
bool includeReceiving = 5;
|
||||
}
|
||||
|
||||
message ChangeNotifyTxListenerRequiredConfirmationsResponseMessage{
|
||||
message ModifyNotifyAddressesTxsParamsResponseMessage{
|
||||
|
||||
RPCError error = 1000;
|
||||
}
|
||||
|
||||
message TxListenerNotificationMessage{
|
||||
message Pending{
|
||||
repeated TxEntryByAddress sent = 1;
|
||||
repeated TxEntryByAddress received = 2;
|
||||
}
|
||||
message Confirmed{
|
||||
uint32 requiredConfirmations = 1;
|
||||
repeated TxEntryByAddress sent = 2;
|
||||
repeated TxEntryByAddress received = 3;
|
||||
}
|
||||
Pending pending = 1;
|
||||
Confirmed confirmed = 2;
|
||||
// AddressesTxsNotificationMessage is the notification about txs pertaining to specified addresses
|
||||
message AddressesTxsNotificationMessage{
|
||||
uint32 requiredConfirmations = 1; //the required confirmations set when notification was sent
|
||||
TxEntriesByAddresses pending = 2; // TxEntriesByAddresses which have entered the blockdag but not passed the required confirmations
|
||||
TxEntriesByAddresses confirmed = 3; // TxEntriesByAddresses which have entered the blockdag and passed the required confirmations
|
||||
TxEntriesByAddresses unconfirmed = 4; // TxEntriesByAddresses which have been pending, but removed via a reorg within the number of required confirmations.
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user