outofband

Documentation

Index

• type ControllerSteps
  • func NewOutofbandControllerSteps() *ControllerSteps
  • func (s *ControllerSteps) AcceptOOBV2Invitation(inviter, invitee string) (string, error)
  • func (s *ControllerSteps) CheckConnection(receiverID, senderID string) error
  • func (s *ControllerSteps) ConnectAll(agents string) error
  • func (s *ControllerSteps) CreateOOBV2(agentID string) error
  • func (s *ControllerSteps) DidExchangeApproveRequest(receiverID, senderID string) error
  • func (s *ControllerSteps) GetConnection(receiver, sender string, opts ...QueryOpt) (*didexchange.Connection, error)
  • func (s *ControllerSteps) NewInvitation(agentID string) (*outofband.Invitation, error)
  • func (s *ControllerSteps) RegisterSteps(suite *godog.Suite)
  • func (s *ControllerSteps) SetContext(ctx *context.BDDContext)
• type QueryOpt
  • func WithInvitationID(id string) QueryOpt
  • func WithParentThreadID(id string) QueryOpt
• type SDKSteps
  • func NewOutOfBandSDKSteps() *SDKSteps
  • func (sdk *SDKSteps) ApproveDIDExchangeRequest(agentID string) error
  • func (sdk *SDKSteps) ApproveHandshakeReuse(agentID string, args interface{})
  • func (sdk *SDKSteps) ApproveOOBInvitation(agentID string, args interface{})
  • func (sdk *SDKSteps) ConfirmConnections(senderID, receiverID, status string) error
  • func (sdk *SDKSteps) ConnectAll(agents string) error
  • func (sdk *SDKSteps) CreateClients(agents string) error
  • func (sdk *SDKSteps) CreateInvitationWithDID(agent string) error
  • func (sdk *SDKSteps) CreateOOBV2Clients(agents string) error
  • func (sdk *SDKSteps) GetConnection(from, to string) (*didexClient.Connection, error)
  • func (sdk *SDKSteps) ReceiveInvitation(to, from string) error
  • func (sdk *SDKSteps) RegisterSteps(suite *godog.Suite)
  • func (sdk *SDKSteps) SetContext(ctx *context.BDDContext)

Types

type ControllerSteps

type ControllerSteps struct {
	// contains filtered or unexported fields
}

ControllerSteps is steps for outofband with controller.

func NewOutofbandControllerSteps

func NewOutofbandControllerSteps() *ControllerSteps

NewOutofbandControllerSteps creates steps for outofband with controller.

func (*ControllerSteps) AcceptOOBV2Invitation

func (s *ControllerSteps) AcceptOOBV2Invitation(inviter, invitee string) (string, error)

AcceptOOBV2Invitation makes invitee accept the OOB V2 invitation from inviter.

func (*ControllerSteps) CheckConnection

func (s *ControllerSteps) CheckConnection(receiverID, senderID string) error

CheckConnection checks a connection between agents.

func (*ControllerSteps) ConnectAll

func (s *ControllerSteps) ConnectAll(agents string) error

ConnectAll connects all agents to each other. 'agents' is a comma-separated string of agent identifiers.

func (*ControllerSteps) CreateOOBV2

func (s *ControllerSteps) CreateOOBV2(agentID string) error

CreateOOBV2 creates an OOBv2 invitation for the given agent.

func (*ControllerSteps) DidExchangeApproveRequest

func (s *ControllerSteps) DidExchangeApproveRequest(receiverID, senderID string) error

DidExchangeApproveRequest approves request (didexchange).

func (*ControllerSteps) GetConnection

func (s *ControllerSteps) GetConnection(receiver, sender string, opts ...QueryOpt) (*didexchange.Connection, error)

GetConnection returns a connection between agents.

func (*ControllerSteps) NewInvitation

func (s *ControllerSteps) NewInvitation(agentID string) (*outofband.Invitation, error)

NewInvitation creates a new request.

func (*ControllerSteps) RegisterSteps

func (s *ControllerSteps) RegisterSteps(suite *godog.Suite)

RegisterSteps registers agent steps.

func (*ControllerSteps) SetContext

func (s *ControllerSteps) SetContext(ctx *context.BDDContext)

SetContext sets every scenario with a fresh context.

type QueryOpt

type QueryOpt func(*queryArgs)

QueryOpt describes query option.

func WithInvitationID

func WithInvitationID(id string) QueryOpt

WithInvitationID allows providing an invitation ID.

func WithParentThreadID

func WithParentThreadID(id string) QueryOpt

WithParentThreadID allows providing a parent threadID.

type SDKSteps

type SDKSteps struct {
	// contains filtered or unexported fields
}

SDKSteps for the out-of-band protocol.

func NewOutOfBandSDKSteps

func NewOutOfBandSDKSteps() *SDKSteps

NewOutOfBandSDKSteps returns the out-of-band protocol's BDD steps using the SDK binding.

func (*SDKSteps) ApproveDIDExchangeRequest

func (sdk *SDKSteps) ApproveDIDExchangeRequest(agentID string) error

ApproveDIDExchangeRequest approves a didexchange request for this agent.

func (*SDKSteps) ApproveHandshakeReuse

func (sdk *SDKSteps) ApproveHandshakeReuse(agentID string, args interface{})

ApproveHandshakeReuse makes the given agent approve a handshake-reuse message.

func (*SDKSteps) ApproveOOBInvitation

func (sdk *SDKSteps) ApproveOOBInvitation(agentID string, args interface{})

ApproveOOBInvitation approves an out-of-band request for this agent.

func (*SDKSteps) ConfirmConnections

func (sdk *SDKSteps) ConfirmConnections(senderID, receiverID, status string) error

ConfirmConnections confirms the connection between the sender and receiver is at the given status.

func (*SDKSteps) ConnectAll

func (sdk *SDKSteps) ConnectAll(agents string) error

ConnectAll connects all agents to each other. 'agents' is a comma-separated string of agent identifiers.

func (*SDKSteps) CreateClients

func (sdk *SDKSteps) CreateClients(agents string) error

CreateClients creates out-of-band clients for the given agents. 'agents' is a comma-separated string of agent identifiers. The out-of-band clients are registered in the BDD context under their respective identifier.

func (*SDKSteps) CreateInvitationWithDID

func (sdk *SDKSteps) CreateInvitationWithDID(agent string) error

CreateInvitationWithDID creates an out-of-band request message and sets its 'service' to a single entry containing a public DID registered in the BDD context. The request is registered internally.

func (*SDKSteps) CreateOOBV2Clients

func (sdk *SDKSteps) CreateOOBV2Clients(agents string) error

CreateOOBV2Clients creates out-of-band v2 clients for the given agents. 'agents' is a comma-separated string of agent identifiers. The out-of-band clients are registered in the BDD context under their respective identifier.

func (*SDKSteps) GetConnection

func (sdk *SDKSteps) GetConnection(from, to string) (*didexClient.Connection, error)

GetConnection returns connection between agents.

func (*SDKSteps) ReceiveInvitation

func (sdk *SDKSteps) ReceiveInvitation(to, from string) error

ReceiveInvitation makes 'to' accept a pre-registered out-of-band invitation created by 'from'.

func (*SDKSteps) RegisterSteps

func (sdk *SDKSteps) RegisterSteps(suite *godog.Suite)

RegisterSteps registers the BDD steps on the suite.

func (*SDKSteps) SetContext

func (sdk *SDKSteps) SetContext(ctx *context.BDDContext)

SetContext is called before every scenario is run with a fresh new context.