Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start of adding XML comments #2

Open
wants to merge 2 commits into
base: feat/eth-sign-transaction
Choose a base branch
from
Open

Start of adding XML comments #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d904abd
Adding XML comments to classes in WalletConnectSharp.Core.
caldwell0414 Apr 30, 2022
c7a9ce6
Merge branch 'feat/eth-sign-transaction' into feat/add-xml-comments
caldwell0414 May 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions WalletConnectSharp.Core/Chains.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace WalletConnectSharp.Core
{

/// <summary>
/// A static class containing common Chain Ids
/// </summary>
Expand Down Expand Up @@ -54,5 +55,7 @@ public static class Chains
{
chainId = "0x6"
};

}

}
193 changes: 151 additions & 42 deletions WalletConnectSharp.Core/WalletConnectProtocol.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,16 @@

namespace WalletConnectSharp.Core
{

/// <summary>
/// Defines the core protocols for establishing a communication channel using a network transport such as HTTPS or WSS.
/// </summary>
public class WalletConnectProtocol : IDisposable
{

/// <summary>
/// JSON RPC endpoints for signing.
/// </summary>
public static readonly string[] SigningMethods = new[]
{
"eth_sendTransaction",
Expand All @@ -25,31 +33,56 @@ public class WalletConnectProtocol : IDisposable
"personal_sign",
};

/// <summary>
/// An <see cref="EventDelegator"/> to provide custom implementation of the events defined by this protocol.
/// </summary>
public readonly EventDelegator Events;

protected string Version = "1";
protected string _bridgeUrl;
protected string _key;
protected byte[] _keyRaw;
protected List<string> _activeTopics = new List<string>();

/// <summary>
/// An <see cref="EventHandler{WalletConnectProtocol}"/> that will be called when a connection is established.
/// </summary>
public event EventHandler<WalletConnectProtocol> OnTransportConnect;

/// <summary>
/// An <see cref="EventHandler{WalletConnectProtocol}"/> that will be called when a connection is closed.
/// </summary>
public event EventHandler<WalletConnectProtocol> OnTransportDisconnect;

/// <summary>
/// Indicates if a session has been connected.
/// </summary>
public bool SessionConnected { get; protected set; }


/// <summary>
/// Indicates if the current session is disconnected.
/// </summary>
public bool Disconnected { get; protected set; }

/// <summary>
/// Indicates if both the session is connected and a transport method is connected.
/// </summary>
public bool Connected
{
get
{
return SessionConnected && TransportConnected;
}
}


/// <summary>
/// Indicates that an attempt to connect is in progress.
/// </summary>
public bool Connecting { get; protected set; }

/// <summary>
/// Indicates if a network transport is connected.
/// </summary>
public bool TransportConnected
{
get
Expand All @@ -60,14 +93,34 @@ public bool TransportConnected
}
}

/// <summary>
/// An <see cref="ITransport"/> instance for managing communication over a network channel.
/// </summary>
public ITransport Transport { get; private set; }

/// <summary>
/// An <see cref="ICipher"/> instance for encrypting and decrypting payloads.
/// </summary>
public ICipher Cipher { get; private set; }


/// <summary>
/// A <see cref="ClientMeta"/> describing the details of the host application.
/// </summary>
public ClientMeta DappMetadata { get; set; }


/// <summary>
/// A <see cref="ClientMeta"/> describing the details of the connected peer.
/// </summary>
public ClientMeta WalletMetadata { get; set; }

/// <summary>
/// A <see cref="ReadOnlyCollection{string}"/> of ActiveTopics.
/// </summary>
/// <remarks>
/// @caldwell0414: Topics are a way of grouping specific messages that are moving over the network connection and provide a way to perform specific actions
/// related to that communication. WalletConnectSharp creates a topic for each connected client to ensure that communication can be directed specifically
/// to that client and messages from that client have their own handling.
/// </remarks>
public ReadOnlyCollection<string> ActiveTopics
{
get
Expand All @@ -76,6 +129,9 @@ public ReadOnlyCollection<string> ActiveTopics
}
}

/// <summary>
/// The PeerID value received when a network connection is established.
/// </summary>
public string PeerId
{
get;
Expand All @@ -84,20 +140,19 @@ public string PeerId


/// <summary>
/// Create a new WalletConnectProtocol object using a SavedSession as the session data. This will effectively resume
/// the session, as long as the session data is valid
/// Create a new <see cref="WalletConnectProtocol"/> using a <see cref="SavedSession"/>.
/// </summary>
/// <param name="savedSession">The SavedSession data to use. Cannot be null</param>
/// <param name="transport">The transport interface to use for sending/receiving messages, null will result in the default transport being used</param>
/// <param name="cipher">The cipher to use for encrypting and decrypting payload data, null will result in AESCipher being used</param>
/// <param name="eventDelegator">The EventDelegator class to use, null will result in the default being used</param>
/// <exception cref="ArgumentException">If a null SavedSession object was given</exception>
public WalletConnectProtocol(SavedSession savedSession, ITransport transport = null,
ICipher cipher = null, EventDelegator eventDelegator = null)
/// <param name="savedSession">The SavedSession data to use. Cannot be null.</param>
/// <param name="transport">The transport interface to use for sending/receiving messages, null will result in the default transport being used.</param>
/// <param name="cipher">The cipher to use for encrypting and decrypting payload data, null will result in AESCipher being used.</param>
/// <param name="eventDelegator">The EventDelegator class to use, null will result in the default being used.</param>
/// <exception cref="ArgumentException">If a null SavedSession object was given.</exception>
/// <remarks>This will effectively resume the session, as long as the session data is valid.</remarks>
public WalletConnectProtocol(SavedSession savedSession, ITransport transport = null, ICipher cipher = null, EventDelegator eventDelegator = null)
{
if (savedSession == null)
throw new ArgumentException("savedSession cannot be null");

if (eventDelegator == null)
eventDelegator = new EventDelegator();

Expand All @@ -116,12 +171,12 @@ public WalletConnectProtocol(SavedSession savedSession, ITransport transport = n
cipher = new AESCipher();

this.Cipher = cipher;

this._keyRaw = savedSession.KeyRaw;

//Convert hex
this._key = savedSession.Key;

this.PeerId = savedSession.PeerID;

/*Transport.Open(this._bridgeUrl).ContinueWith(delegate(Task task)
Expand All @@ -133,19 +188,16 @@ public WalletConnectProtocol(SavedSession savedSession, ITransport transport = n
}

/// <summary>
/// Create a new WalletConnectProtocol object and create a new dApp session.
/// Create a new <see cref="WalletConnectProtocol"/> and establish a new session.
/// </summary>
/// <param name="clientMeta">The metadata to send to wallets</param>
/// <param name="transport">The transport interface to use for sending/receiving messages, null will result in the default transport being used</param>
/// <param name="cipher">The cipher to use for encrypting and decrypting payload data, null will result in AESCipher being used</param>
/// <param name="chainId">The chainId this dApp is using</param>
/// <param name="bridgeUrl">The bridgeURL to use to communicate with the wallet</param>
/// <param name="eventDelegator">The EventDelegator class to use, null will result in the default being used</param>
/// <exception cref="ArgumentException">If an invalid ClientMeta object was given</exception>
public WalletConnectProtocol(ITransport transport = null,
ICipher cipher = null,
EventDelegator eventDelegator = null
)
/// <param name="clientMeta">The metadata to send to the peer.</param>
/// <param name="transport">The transport interface to use for sending/receiving messages, null will result in the default transport being used.</param>
/// <param name="cipher">The cipher to use for encrypting and decrypting payload data, null will result in AESCipher being used.</param>
/// <param name="chainId">The chainId this dApp is using.</param>
/// <param name="bridgeUrl">The bridgeURL to use to communicate with the peer.</param>
/// <param name="eventDelegator">The EventDelegator class to use, null will result in the default being used.</param>
/// <exception cref="ArgumentException">If an invalid ClientMeta object was given.</exception>
public WalletConnectProtocol(ITransport transport = null, ICipher cipher = null, EventDelegator eventDelegator = null)
{
if (eventDelegator == null)
eventDelegator = new EventDelegator();
Expand All @@ -154,7 +206,7 @@ public WalletConnectProtocol(ITransport transport = null,

if (transport == null)
transport = TransportFactory.Instance.BuildDefaultTransport(eventDelegator);

this.Transport = transport;

if (cipher == null)
Expand All @@ -163,45 +215,73 @@ public WalletConnectProtocol(ITransport transport = null,
this.Cipher = cipher;
}

/// <summary>
/// Attaches a <see cref="TransportOnMessageReceived"/> handler and opens a network connection.
/// </summary>
/// <returns></returns>
protected async Task SetupTransport()
{
Transport.MessageReceived += TransportOnMessageReceived;

await Transport.Open(this._bridgeUrl);

//Debug.Log("[WalletConnect] Transport Opened");

TriggerOnTransportConnect();
}

/// <summary>
/// Disconnects a <see cref="TransportOnMessageReceived"/> handler and closes a network connection.
/// </summary>
/// <returns></returns>
/// <remarks>
/// Calls the <see cref="EventHandler{WalletConnectProtocol}"/> for OnTransportConnected if available.
/// </remarks>
protected async Task DisconnectTransport()
{
await Transport.Close();

Transport.MessageReceived -= TransportOnMessageReceived;

if (OnTransportDisconnect != null)
OnTransportDisconnect(this, this);
}

/// <summary>
/// Calls the <see cref="EventHandler{WalletConnectProtocol}"/> for OnTransportConnected if available.
/// </summary>
protected virtual void TriggerOnTransportConnect()
{
if (OnTransportConnect != null)
OnTransportConnect(this, this);
}


/// <summary>
/// Opens a network communication channel and monitors it for communication.
/// </summary>
/// <returns></returns>
public virtual async Task Connect()
{
await SetupTransport();
}


/// <summary>
/// Attaches to the active <see cref="ITransport"/> and listens for communication directed at a specific topic.
/// </summary>
/// <param name="topic">The topic to listen for on the <see cref="ITransport"/> instance.</param>
/// <returns></returns>
public async Task SubscribeAndListenToTopic(string topic)
{
await Transport.Subscribe(topic);

ListenToTopic(topic);
}

/// <summary>
/// Adds the specified topic to <see cref="ActiveTopics"/>.
/// </summary>
/// <param name="topic">The topic to listen for on the <see cref="ITransport"/> instance.</param>
/// <returns></returns>
public void ListenToTopic(string topic)
{
if (!_activeTopics.Contains(topic))
Expand All @@ -210,6 +290,11 @@ public void ListenToTopic(string topic)
}
}

/// <summary>
/// Handles an incoming message from the <see cref="ITransport"/>.
/// </summary>
/// <param name="sender">Origination source for the event.</param>
/// <param name="e">A <see cref="MessageReceivedEventArgs"/> instance providing details of the event.</param>
private async void TransportOnMessageReceived(object sender, MessageReceivedEventArgs e)
{
var networkMessage = e.Message;
Expand All @@ -236,11 +321,20 @@ private async void TransportOnMessageReceived(object sender, MessageReceivedEven
}
}

public async Task<TR> SendRequestAwaitResponse<T, TR>(T requestObject, object requestId, string sendingTopic = null,
bool? forcePushNotification = null)
/// <summary>
/// Sends a <see cref="typeof{T}"/> request object over the network and listens for a <see cref="typeof{TR}"/> response.
/// </summary>
/// <typeparam name="T">Request payload type.</typeparam>
/// <typeparam name="TR">Response payload type.</typeparam>
/// <param name="requestObject">The payload to send.</param>
/// <param name="requestId">Identifier for the request.</param>
/// <param name="sendingTopic">Topic defining the channel on which the request should be sent.</param>
/// <param name="forcePushNotification">Indicator if a force push should be sent.</param>
/// <returns></returns>
public async Task<TR> SendRequestAwaitResponse<T, TR>(T requestObject, object requestId, string sendingTopic = null, bool? forcePushNotification = null)
{
TaskCompletionSource<TR> response = new TaskCompletionSource<TR>(TaskCreationOptions.None);

Events.ListenForGenericResponse<TR>(requestId, (sender, args) =>
{
response.SetResult(args.Response);
Expand All @@ -251,12 +345,20 @@ public async Task<TR> SendRequestAwaitResponse<T, TR>(T requestObject, object re
return await response.Task;
}

/// <summary>
/// Sends a <see cref="typeof{T}"/> request object over the network but does not wait for a response.
/// </summary>
/// <typeparam name="T">Request payload type.</typeparam>
/// <param name="requestObject">The payload to send.</param>
/// <param name="sendingTopic">Topic defining the channel on which the request should be sent.</param>
/// <param name="forcePushNotification">Indicator if a force push should be sent.</param>
/// <returns></returns>
public async Task SendRequest<T>(T requestObject, string sendingTopic = null, bool? forcePushNotification = null)
{
bool silent;
if (forcePushNotification != null)
{
silent = (bool) !forcePushNotification;
silent = (bool)!forcePushNotification;
}
else if (requestObject is JsonRpcRequest request)
{
Expand Down Expand Up @@ -284,7 +386,10 @@ public async Task SendRequest<T>(T requestObject, string sendingTopic = null, bo

await this.Transport.SendMessage(message);
}


/// <summary>
/// Required implementation for <see cref="IDisposable"/>.
/// </summary>
public void Dispose()
{
if (Transport != null)
Expand All @@ -294,6 +399,10 @@ public void Dispose()
}
}

/// <summary>
/// Disconnects the <see cref="ITransport"/>.
/// </summary>
/// <returns></returns>
public virtual async Task Disconnect()
{
await DisconnectTransport();
Expand Down
Loading