Merge pull request #374 from immutable/feat/swap

[DX-3524] feat: swap, marketplace docs

Author: nattb8

src/Packages/Marketplace/CHANGELOG.md.meta

@@ -1,43 +1,60 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using Cysharp.Threading.Tasks;
 
 namespace Immutable.Marketplace.OnRamp
 {
+    /// <summary>
+    /// Provides functionality for generating an on-ramp link, allowing players to purchase tokens 
+    /// using fiat currency and transfer them directly to the Immutable zkEVM network.
+    /// </summary>
     public class OnRamp
     {
         private readonly string _environment;
         private readonly string _email;
         private readonly string _address;
-        private static readonly Dictionary<string, string> TransakBaseUrls = new Dictionary<string, string>
+        private static readonly Dictionary<string, string> BaseUrls = new()
         {
             { "sandbox", "https://global-stg.transak.com" },
-            { "production", "https://global.transak.com/" }
+            { "production", "https://global.transak.com" }
         };
 
-        private static readonly Dictionary<string, string> TransakApiKeys = new Dictionary<string, string>
+        private static readonly Dictionary<string, string> ApiKeys = new()
         {
             { "sandbox", "d14b44fb-0f84-4db5-affb-e044040d724b" }, // This can be hardcoded as it is a public API key
             { "production", "ad1bca70-d917-4628-bb0f-5609537498bc" }
         };
 
+        /// <summary>
+        /// Initialises a new instance of the <see cref="OnRamp"/> class.
+        /// </summary>
+        /// <param name="environment">Specifies the environment (<c>sandbox</c> or <c>production</c>).</param>
+        /// <param name="email">The user's email address, pre-filled in the on-ramp flow.</param>
+        /// <param name="address">The user's wallet address, where tokens will be sent.</param>
         public OnRamp(string environment, string email, string address)
         {
             _environment = environment;
             _email = email;
             _address = address;
         }
 
-        public async UniTask<string> GetLink(
+        /// <summary>
+        /// Generates a link for the on-ramp flow.
+        /// </summary>
+        /// <param name="fiatCurrency">The fiat currency to be used (default is "USD").</param>
+        /// <param name="defaultFiatAmount">The default amount of fiat currency (default is "50").</param>
+        /// <param name="defaultCryptoCurrency">The default cryptocurrency (default is "IMX")..</param>
+        /// <param name="defaultCryptoCurrencyList">A comma-separated list of available cryptocurrencies to purchase (default is "imx,eth,usdc").</param>
+        /// <returns>An on-ramp URL</returns>
+        public string GetLink(
             string fiatCurrency = "USD",
             string defaultFiatAmount = "50",
             string defaultCryptoCurrency = "IMX",
             string defaultCryptoCurrencyList = "imx,eth,usdc"
         )
         {
-            string baseUrl = TransakBaseUrls[_environment];
-            string apiKey = TransakApiKeys[_environment];
+            var baseUrl = BaseUrls[_environment];
+            var apiKey = ApiKeys[_environment];
 
             var queryParams = new Dictionary<string, string>
         {
@@ -58,7 +75,7 @@ public async UniTask<string> GetLink(
             {"cryptoCurrencyList", defaultCryptoCurrencyList}
         };
 
-            string queryString = string.Join("&", queryParams.Select(kvp => $"{kvp.Key}={Uri.EscapeDataString(kvp.Value)}").ToArray());
+            var queryString = string.Join("&", queryParams.Select(kvp => $"{kvp.Key}={Uri.EscapeDataString(kvp.Value)}").ToArray());
             return $"{baseUrl}?{queryString}";
         }
     }

src/Packages/Marketplace/LICENSE.md.meta

@@ -0,0 +1,57 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Immutable.Marketplace.Swap
+{
+    /// <summary>
+    /// Provides functionality for generating a link to the swap flow, 
+    /// simplifying the process of swapping tokens on the Immutable zkEVM network.
+    /// </summary>
+    public class Swap
+    {
+        private readonly string _environment;
+        private static readonly Dictionary<string, string> BaseUrls = new()
+        {
+            { "sandbox", "https://checkout-playground.sandbox.immutable.com/checkout/swap" },
+            { "production", "https://toolkit.immutable.com/checkout/swap" }
+        };
+
+        private static readonly Dictionary<string, string> ApiKeys = new()
+        {
+            { "sandbox", "pk_imapik-test-7-hfC5T$W$eEDE8Mc5mp" }, // This can be hardcoded as it is a public API key
+            { "production", "pk_imapik-WGd9orNd8mLdtTCTb3CP" }
+        };
+
+        /// <summary>
+        /// Initialises a new instance of the <see cref="Swap"/> class.
+        /// </summary>
+        /// <param name="environment">Specifies the environment (<c>sandbox</c> or <c>production</c>).</param>
+        public Swap(string environment)
+        {
+            _environment = environment;
+        }
+
+        /// <summary>
+        /// Generates a link for the swap flow.
+        /// </summary>
+        /// <param name="fromTokenAddress">The address of the token being swapped from.</param>
+        /// <param name="toTokenAddress">The address of the token being swapped to.</param>
+        /// <returns>A swap URL</returns>
+        public string GetLink(string fromTokenAddress, string toTokenAddress)
+        {
+            var baseUrl = BaseUrls[_environment];
+            var apiKey = ApiKeys[_environment];
+
+            var queryParams = new Dictionary<string, string>
+        {
+            {"publishableKey", apiKey},
+            {"fromTokenAddress", fromTokenAddress},
+            {"toTokenAddress", toTokenAddress}
+        };
+
+            var queryString = string.Join("&", queryParams.Select(kvp => $"{kvp.Key}={Uri.EscapeDataString(kvp.Value)}").ToArray());
+            return $"{baseUrl}?{queryString}";
+        }
+    }
+}