definitions-definitions-relayer.md

0 Type

object (Relayer)

0 Constraints

URI reference: the string must be a URI reference, according to RFC 3986

0 Properties

Property	Type	Required	Nullable	Defined by
name	string	Required	cannot be null	Definitions
network	Merged	Required	cannot be null	Definitions
min-balance	integer	Required	cannot be null	Definitions
address-from-relayer	Merged	Optional	cannot be null	Definitions
policy	object	Optional	cannot be null	Definitions
api-keys	array	Optional	cannot be null	Definitions
relayer-group-id	string	Optional	cannot be null	Definitions
notification-channels	object	Optional	cannot be null	Definitions

name

name

• is required

• Type: string

• cannot be null

• defined in: Definitions

name Type

string

network

network

• is required

• Type: merged type (Network)

• cannot be null

• defined in: Definitions

network Type

merged type (Network)

any of

• one (and only one) of

  • PublicNetwork

  • CustomNetwork

• TenantNetwork

network Constraints

URI reference: the string must be a URI reference, according to RFC 3986

min-balance

min-balance

• is required

• Type: integer

• cannot be null

• defined in: Definitions

min-balance Type

integer

address-from-relayer

address-from-relayer

• is optional

• Type: merged type (AddressFromRelayer)

• cannot be null

• defined in: Definitions

address-from-relayer Type

merged type (AddressFromRelayer)

any of

• Untitled object in Definitions

• Untitled string in Definitions

policy

policy

• is optional

• Type: object (Policy)

• cannot be null

• defined in: Definitions

policy Type

object (Policy)

policy Constraints

URI reference: the string must be a URI reference, according to RFC 3986

api-keys

api-keys

• is optional

• Type: string[]

• cannot be null

• defined in: Definitions

api-keys Type

string[]

relayer-group-id

relayer-group-id

• is optional

• Type: string (DefenderID)

• cannot be null

• defined in: Definitions

relayer-group-id Type

string (DefenderID)

relayer-group-id Constraints

pattern: the string must match the following regular expression:

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-(8|9|a|b)[0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

try pattern

URI reference: the string must be a URI reference, according to RFC 3986

notification-channels

notification-channels

• is optional

• Type: object (NotificationChannels)

• cannot be null

• defined in: Definitions

notification-channels Type

object (NotificationChannels)

notification-channels Constraints

URI reference: the string must be a URI reference, according to RFC 3986