relay

Documentation

Index

• Constants
• type Config
• type RegistrationConfig
• type RelayMailboxRequestData
• type RelayRegistrationBody
• type RelayRegistrationRequestData
• type RelayRegistrationService
  • func NewRelayRegistrationService(cfg RegistrationConfig) (RelayRegistrationService, error)
• type RelayService
  • func NewRelayService(cfg Config) (RelayService, error)

Constants

const RELAY_MAILBOX_REQUEST_TYPE = "mailbox"

const RELAY_REGISTRATION_DID_TYPE = "https://impervious.ai/didcomm/relay-registration/1.0"

const RELAY_REGISTRATION_REQUEST_TYPE = "registration"

Types

type Config

type Config struct {
	DidComm comm.DIDComm
	Db      state.DBManager
}

type RegistrationConfig

type RegistrationConfig struct {
	DidComm comm.DIDComm
	Db      state.DBManager
}

type RelayMailboxRequestData

type RelayMailboxRequestData struct {
	PrivateServiceEndpoints []id.Service `json:"privateServiceEndpoints"`
}

type RelayRegistrationBody

type RelayRegistrationBody struct {
	Type string      `json:"type"`
	Data interface{} `json:"data"`
}

type RelayRegistrationRequestData

type RelayRegistrationRequestData struct {
	PrivateServiceEndpoints []id.Service `json:"privateServiceEndpoints"`
}

type RelayRegistrationService

type RelayRegistrationService interface {
	service.Service

	// SendRegistrationRequest reqeusts a relay node to delegate them as a relay
	SendRegistrationRequest(toDID string, amt int64, data *RelayRegistrationRequestData) (string, error)
	// SendMailboxRequest requests a relay node to send stored messages to them now
	SendMailboxRequest(toDID string, amt int64, data *RelayMailboxRequestData) (string, error)
}

func NewRelayRegistrationService

func NewRelayRegistrationService(cfg RegistrationConfig) (RelayRegistrationService, error)

type RelayService

type RelayService interface {
	service.Service
}

func NewRelayService

func NewRelayService(cfg Config) (RelayService, error)