← Back to packages

Default package

Service PoolConnector

Message JobParam

Message JobInput

Message Log

Message JobResult

Message Payment

Message JobState

Message Job

Message RpcRequestJob

Message RpcGetJob

Message RpcGetPendingJobs

Message PendingJobs

Message RpcIsJobDone

Message RpcAcceptJob

Message RpcCancelJob

Message RpcJobOutput

Message RpcJobComplete

Message RpcRequestPayment

Message RpcRequestPaymentResponse

Message RpcWaitForPaymentsRequest

Message RpcWaitForPaymentsResponse

Message RpcJobLog

Message RpcSendSignedEventRequest

Message RpcSubscribeToEventsRequest

Message RpcSubscribeToEventsResponse

Message RpcGetEventsRequest

Message RpcGetEventsResponse

Message RpcSendSignedEventResponse

Message RpcUnsubscribeFromEventsRequest

Message RpcUnsubscribeFromEventsResponse

Message RpcAnnounceNodeRequest

Message RpcAnnounceNodeResponse

Message RpcAnnounceTemplateRequest

Message RpcAnnounceTemplateResponse

Message RpcCreateDiskRequest

Message RpcCreateDiskResponse

Message RpcOpenDiskRequest

Message RpcOpenDiskResponse

Message RpcCloseDiskRequest

Message RpcCloseDiskResponse

Message RpcDiskDeleteFileRequest

Message RpcDiskDeleteFileResponse

Message RpcDiskListFilesRequest

Message RpcDiskListFilesResponse

Message RpcDiskReadFileRequest

Message RpcDiskReadFileResponse

Message RpcDiskWriteFileRequest

Message RpcDiskWriteFileResponse

Message RpcCacheSetRequest

Message RpcCacheSetResponse

Message RpcCacheGetRequest

Message RpcCacheGetResponse

Message RpcDiscoverPoolsRequest

Message RpcDiscoverPoolsResponse

Message RpcDiscoverNodesRequest

Message RpcDiscoverNodesResponse

Message RpcDiscoverActionsRequest

Message RpcDiscoverActionsResponse

Message RpcDiscoverNearbyNodesRequest

Message RpcDiscoverNearbyNodesResponse

Message RpcDiscoverNearbyActionsRequest

Message RpcDiscoverNearbyActionsResponse

Message RpcJobRequest

Message RpcPayJobRequest

Enum JobStatus

Enum PaymentStatus

Services

service PoolConnector

rpc requestJob
Request: RpcRequestJob
Response: Job

job management

rpc sendJobRequest
Request: RpcJobRequest
Response: Job
rpc getJob
Request: RpcGetJob
Response: Job
rpc getPendingJobs
Request: RpcGetPendingJobs
Response: PendingJobs
rpc isJobDone
Request: RpcGetJob
Response: RpcIsJobDone
rpc acceptJob
Request: RpcAcceptJob
Response: Job
rpc cancelJob
Request: RpcCancelJob
Response: Job
rpc outputForJob
Request: RpcJobOutput
Response: Job
rpc completeJob
Request: RpcJobComplete
Response: Job
rpc logForJob
Request: RpcJobLog
Response: Job
rpc payJob
Request: RpcPayJobRequest
Response: Job
rpc requestPayment
Request: RpcRequestPayment
Response: RpcRequestPaymentResponse
rpc waitForPayments
Request: RpcWaitForPaymentsRequest
Response: RpcWaitForPaymentsResponse
rpc announceNode
Request: RpcAnnounceNodeRequest
Response: RpcAnnounceNodeResponse

discovery

rpc announceEventTemplate
Request: RpcAnnounceTemplateRequest
Response: RpcAnnounceTemplateResponse
rpc discoverPools
Request: RpcDiscoverPoolsRequest
Response: RpcDiscoverPoolsResponse
rpc discoverNodes
Request: RpcDiscoverNodesRequest
Response: RpcDiscoverNodesResponse
rpc discoverActions
Request: RpcDiscoverActionsRequest
Response: RpcDiscoverActionsResponse
rpc discoverNearbyNodes
Request: RpcDiscoverNearbyNodesRequest
Response: RpcDiscoverNearbyNodesResponse
rpc discoverNearbyActions
Request: RpcDiscoverNearbyActionsRequest
Response: RpcDiscoverNearbyActionsResponse
rpc sendSignedEvent
Request: RpcSendSignedEventRequest
Response: RpcSendSignedEventResponse

generic nostr events

rpc subscribeToEvents
Request: RpcSubscribeToEventsRequest
Response: RpcSubscribeToEventsResponse
rpc unsubscribeFromEvents
Request: RpcUnsubscribeFromEventsRequest
Response: RpcUnsubscribeFromEventsResponse
rpc getEvents
Request: RpcGetEventsRequest
Response: RpcGetEventsResponse
rpc createDisk
Request: RpcCreateDiskRequest
Response: RpcCreateDiskResponse

blob storage

rpc openDisk
Request: RpcOpenDiskRequest
Response: RpcOpenDiskResponse
rpc closeDisk
Request: RpcCloseDiskRequest
Response: RpcCloseDiskResponse
rpc diskDeleteFile
Request: RpcDiskDeleteFileRequest
Response: RpcDiskDeleteFileResponse
rpc diskListFiles
Request: RpcDiskListFilesRequest
Response: RpcDiskListFilesResponse
rpc diskReadFile
Request: RpcDiskReadFileRequest
Response: RpcDiskReadFileResponse
rpc diskReadSmallFile
Request: RpcDiskReadFileRequest
Response: RpcDiskReadFileResponse
rpc diskWriteFile
Request: RpcDiskWriteFileRequest
Response: RpcDiskWriteFileResponse
rpc diskWriteSmallFile
Request: RpcDiskWriteFileRequest
Response: RpcDiskWriteFileResponse
rpc cacheSet
Request: RpcCacheSetRequest
Response: RpcCacheSetResponse

cache

rpc cacheGet
Request: RpcCacheGetRequest
Response: RpcCacheGetResponse

Messages

message JobParam

Field Type Description
1 key string
2 value repeated string

message JobInput

Field Type Description
1 data optional string
2 ref optional string
3 type string
4 marker string
5 source optional string

message Log

Field Type Description
1 id string
2 log string
3 level string
4 timestamp uint64
5 source string
6 nodeId string

message JobResult

Field Type Description
1 content string
2 timestamp uint64
3 id string

message Payment

Field Type Description
1 id optional string
2 amount uint64
3 currency string
4 protocol string
5 status optional PaymentStatus
6 data optional string
7 proof optional string
8 waitForPayment optional bool

message JobState

Field Type Description
13 acceptedAt uint64
14 acceptedBy string
15 status JobStatus
17 logs repeated Log
18 timestamp uint64
19 result JobResult
20 acceptedByNode string
21 paymentRequests repeated Payment

message Job

Field Type Description
1 id string
14 kind uint32
2 runOn string
3 expiration uint64
4 timestamp uint64
5 input repeated JobInput

primary input
6 param repeated JobParam

additional parameters
7 customerPublicKey string
8 description string
9 provider string
10 relays repeated string
18 results repeated JobState
13 maxExecutionTime uint64

enforced by the provider
15 nodeId string
16 outputFormat string
17 encrypted optional bool
19 bid optional Payment

message RpcRequestJob

Field Type Description
1 runOn string
2 expireAfter uint64
3 input repeated JobInput
4 param repeated JobParam
6 description string
7 kind optional uint32
8 outputFormat optional string
9 requestProvider optional string
10 encrypted optional bool
11 userId optional string

deprecated: pass as header instead
12 minWorkers optional uint32
13 bid optional Payment

message RpcGetJob

Field Type Description
1 jobId string
99 wait optional uint32

max time to wait in ms , 0 or unset means no wait
100 nResultsToWait optional uint32

max number of results to wait for
2 streamPayment optional uint64

millisats to pay
3 streamPaymentCurrency optional string

currency to pay
4 streamPaymentProtocol optional string

protocol to pay

message RpcGetPendingJobs

Field Type Description
1 filterByRunOn optional string
2 filterByCustomer optional string
3 filterByDescription optional string
4 filterById optional string
5 filterByKind optional string
6 filterByBids repeated Payment
98 excludeId repeated string

which job ids to exclude, optional
99 wait optional uint32

max time to wait in ms , 0 or unset means no wait

message PendingJobs

Field Type Description
1 jobs repeated Job

message RpcIsJobDone

Field Type Description
1 isDone bool

message RpcAcceptJob

Field Type Description
1 jobId string

message RpcCancelJob

Field Type Description
1 jobId string
2 reason string

message RpcJobOutput

Field Type Description
1 jobId string
2 output string

message RpcJobComplete

Field Type Description
1 jobId string
2 output string
3 info optional string
4 cost optional Payment

message RpcRequestPayment

Field Type Description
3 jobId string
1 payment optional Payment

message RpcRequestPaymentResponse

Field Type Description
1 status bool

message RpcWaitForPaymentsRequest

Field Type Description
1 jobId string
2 wait optional uint32

max time to wait in ms , 0 or unset means no wait

message RpcWaitForPaymentsResponse

Field Type Description
1 status bool

message RpcJobLog

Field Type Description
1 jobId string
2 log string

message RpcSendSignedEventRequest

Field Type Description
1 groupId string

the group id of the event, will be used for gc, etc. If generated by a job it should be set to the job id
2 event string

message RpcSubscribeToEventsRequest

Field Type Description
1 groupId string

the group id of the event, will be used for gc, etc. If generated by a job it should be set to the job id
2 filters repeated string

message RpcSubscribeToEventsResponse

Field Type Description
1 groupId string

the group id of the event, will be used for gc, etc. If generated by a job it should be set to the job id
2 subscriptionId string

message RpcGetEventsRequest

Field Type Description
1 groupId string

the group id of the event, will be used for gc, etc. If generated by a job it should be set to the job id
2 subscriptionId string
3 limit uint32

optional : 0 or unset means no limit

message RpcGetEventsResponse

Field Type Description
1 groupId string

the group id of the event, will be used for gc, etc. If generated by a job it should be set to the job id
2 count uint32
3 subscriptionId string
4 events repeated string

message RpcSendSignedEventResponse

Field Type Description
1 groupId string

the group id of the event, will be used for gc, etc. If generated by a job it should be set to the job id
2 success bool

message RpcUnsubscribeFromEventsRequest

Field Type Description
1 groupId string

the group id of the event, will be used for gc, etc. If generated by a job it should be set to the job id
2 subscriptionId string

message RpcUnsubscribeFromEventsResponse

Field Type Description
1 success bool

message RpcAnnounceNodeRequest

Field Type Description
3 iconUrl string
4 name string
5 description string

message RpcAnnounceNodeResponse

Field Type Description
1 success bool
4 refreshInterval uint64

message RpcAnnounceTemplateRequest

Field Type Description
1 meta string
2 template string
3 sockets string

message RpcAnnounceTemplateResponse

Field Type Description
1 success bool
4 refreshInterval uint64

message RpcCreateDiskRequest

Field Type Description
1 name optional string
2 encryptionKey optional string
3 includeEncryptionKeyInUrl optional bool

message RpcCreateDiskResponse

Field Type Description
1 url string

message RpcOpenDiskRequest

Field Type Description
1 url string
2 encryptionKey optional string

message RpcOpenDiskResponse

Field Type Description
1 success bool
2 diskId string
3 version uint64

message RpcCloseDiskRequest

Field Type Description
1 diskId string

message RpcCloseDiskResponse

Field Type Description
1 success bool

message RpcDiskDeleteFileRequest

Field Type Description
1 diskId string
2 path string

message RpcDiskDeleteFileResponse

Field Type Description
1 success bool

message RpcDiskListFilesRequest

Field Type Description
1 diskId string
2 path string

message RpcDiskListFilesResponse

Field Type Description
1 files repeated string

message RpcDiskReadFileRequest

Field Type Description
1 diskId string
2 path string

message RpcDiskReadFileResponse

Field Type Description
1 data bytes
2 exists bool

message RpcDiskWriteFileRequest

Field Type Description
1 diskId string
2 path string
3 data bytes

message RpcDiskWriteFileResponse

Field Type Description
1 success bool

message RpcCacheSetRequest

Field Type Description
1 key string
2 data bytes
3 version optional uint64
4 expireAt optional uint64

message RpcCacheSetResponse

Field Type Description
1 success bool

message RpcCacheGetRequest

Field Type Description
1 key string
2 lastVersion optional uint64

message RpcCacheGetResponse

Field Type Description
1 data bytes
2 exists bool

message RpcDiscoverPoolsRequest

Field Type Description

message RpcDiscoverPoolsResponse

Field Type Description
1 pools repeated string

message RpcDiscoverNodesRequest

Field Type Description
1 filterByKinds repeated int32
2 filterByPools repeated string
3 filterByNodes repeated string
4 filterByKindRanges repeated string

message RpcDiscoverNodesResponse

Field Type Description
1 nodes repeated string

message RpcDiscoverActionsRequest

Field Type Description
1 filterByKinds repeated int32
2 filterByPools repeated string
3 filterByNodes repeated string
4 filterByTags repeated string
5 filterByKindRanges repeated string

message RpcDiscoverActionsResponse

Field Type Description
1 actions repeated string

message RpcDiscoverNearbyNodesRequest

Field Type Description
1 filterByKinds repeated int32
3 filterByNodes repeated string
5 filterByKindRanges repeated string

message RpcDiscoverNearbyNodesResponse

Field Type Description
1 nodes repeated string

message RpcDiscoverNearbyActionsRequest

Field Type Description
1 filterByKinds repeated int32
3 filterByNodes repeated string
4 filterByTags repeated string
5 filterByKindRanges repeated string

message RpcDiscoverNearbyActionsResponse

Field Type Description
1 actions repeated string

message RpcJobRequest

Field Type Description
1 event string
2 provider optional string
3 encrypted optional bool

message RpcPayJobRequest

Field Type Description
1 jobId string
2 amount uint64
3 currency string
4 protocol string

Enums

enum JobStatus

Name Number Description
PENDING 0
PROCESSING 1
ERROR 2
SUCCESS 3
PARTIAL 4
PAYMENT_REQUIRED 7
UNKNOWN 99

enum PaymentStatus

Name Number Description
PAYMENT_REQUESTED 0
PAYMENT_SENT 1
PAYMENT_RECEIVED 2
PAYMENT_REFUNDED 3
PAYMENT_FAILED 4
PAYMENT_PENDING 5
PAYMENT_UNKNOWN_STATUS 99