Struct ConnectionOptions

pub struct ConnectionOptions {
    pub address: String,
    pub project_id: ProjectId,
    pub auth: Authorization,
    pub origin: Option<String>,
    pub user_agent: Option<UserAgent>,
}

Relay connection options.

Fields

address: String

The Relay websocket address. The default address is wss://relay.walletconnect.com.

project_id: ProjectId

The project-specific secret key. Can be generated in the Cloud Dashboard at the following URL: https://cloud.walletconnect.com/app

auth: Authorization

The authorization method and auth token to use.

origin: Option<String>

Optional origin of the request. Subject to allow-list validation.

user_agent: Option<UserAgent>

Optional user agent parameters.

Implementations

impl ConnectionOptions

pub fn new(project_id: impl Into<ProjectId>, auth: SerializedAuthToken) -> Self

pub fn with_address(self, address: impl Into<String>) -> Self

pub fn with_origin(self, origin: impl Into<Option<String>>) -> Self

pub fn with_user_agent(self, user_agent: impl Into<Option<UserAgent>>) -> Self

pub fn as_url(&self) -> Result<Url, RequestBuildError>

Trait Implementations

impl Clone for ConnectionOptions

fn clone(&self) -> ConnectionOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.