ReceiveMessages

Initiates a bidirectional stream to receive messages for a specific receiver. This stream implements the challenge-response handshake required for receiver authentication before messages are delivered.

Expected flow:

1. Client -> Server: ReceiveMessagesRequest(init = InitReceive{...})
2. Server -> Client: ReceiveMessagesResponse(challenge = Challenge{...})
3. Client -> Server: ReceiveMessagesRequest(auth_sig = AuthSignature{...})
4. Server -> Client: [Stream of ReceiveMessagesResponse( message = MailboxMessage{...} )]
5. Server -> Client: ReceiveMessagesResponse(eos = EndOfStream{})

Source: authmailboxrpc/mailbox.proto

gRPC

info

This is a bidirectional-streaming RPC

rpc ReceiveMessages (stream ReceiveMessagesRequest) returns (stream ReceiveMessagesResponse);

REST

Code Samples

gRPC

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10029'
const MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
const TLS_PATH = 'TAPD_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('authmailboxrpc/mailbox.proto', loaderOptions);
const authmailboxrpc = grpc.loadPackageDefinition(packageDefinition).authmailboxrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
  let metadata = new grpc.Metadata();
  metadata.add('macaroon', macaroon);
  callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new authmailboxrpc.Mailbox(GRPC_HOST, creds);
let request = {
  init: <InitReceive>,
  auth_sig: <AuthSignature>,
};
let call = client.receiveMessages({});
call.on('data', function(response) {
  console.log(response);
});
call.on('status', function(status) {
});
call.on('end', function() {
});
call.write(request);

Python

import codecs, grpc, os
import mailbox_pb2 as authmailboxrpc, mailbox_pb2_grpc as mailboxstub

GRPC_HOST = 'localhost:10029'
MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
TLS_PATH = 'TAPD_DIR/tls.cert'

macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = mailboxstub.MailboxStub(channel)

def request_generator():
    while True:
        request = authmailboxrpc.ReceiveMessagesRequest(
            init=<InitReceive>,
            auth_sig=<AuthSignature>,
        )
        yield request
request_iterable = request_generator()
for response in stub.ReceiveMessages(request_iterable):
  print(response)

curl

# Client streaming or bidirectional streaming RPCs are not easily supported by grpcurl. Please use a programming language client for this RPC.

Messages

authmailboxrpc.ReceiveMessagesRequest

authmailboxrpc.ReceiveMessagesResponse

Nested Messages

authmailboxrpc.AuthSignature

authmailboxrpc.Challenge

authmailboxrpc.EndOfStream

note

This response has no parameters.

authmailboxrpc.InitReceive

authmailboxrpc.MailboxMessage

authmailboxrpc.MailboxMessages