Merge pull request #139 from IOTA-NET/67-feat-sendmicrotransaction

wireless90 · web-flow · commit c40719bb00a5 · 2023-01-01T15:49:49.000+08:00
67 feat sendmicrotransaction
diff --git a/README.md b/README.md
@@ -166,6 +166,8 @@ For more examples, see the [Examples](https://github.com/wireless90/IotaWallet.N
 - [x] MintNativeTokens
 - [x] MintNfts
 - [x] RequestFromFaucet
+- [x] SendAmount
+- [x] SendMicroAmount
 - [x] SendNativeTokens
 - [x] SendNfts
 - [x] SyncAccount
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/Account.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/Account.cs
@@ -10,6 +10,7 @@
 using IotaWalletNet.Application.AccountContext.Commands.MintNfts;
 using IotaWalletNet.Application.AccountContext.Commands.RequestFromFaucet;
 using IotaWalletNet.Application.AccountContext.Commands.SendAmount;
+using IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount;
 using IotaWalletNet.Application.AccountContext.Commands.SendNativeTokens;
 using IotaWalletNet.Application.AccountContext.Commands.SendNfts;
 using IotaWalletNet.Application.AccountContext.Commands.SyncAccount;
@@ -53,6 +54,11 @@ public Account(IMediator mediator, string username, IWallet wallet)
         public IWallet Wallet { get; }
 
 
+        public async Task<SendMicroAmountResponse> SendMicroAmountAsync(List<AddressWithMicroAmount> addressWithMicroAmounts, TaggedDataPayload? taggedDataPayload = null)
+        {
+            return await _mediator.Send(new SendMicroAmountCommand(addressWithMicroAmounts, taggedDataPayload, Username, this));
+        }
+
         public async Task<DestroyFoundryResponse> DestroyFoundryAsync(string foundryId)
         {
             return await _mediator.Send(new DestroyFoundryCommand(foundryId, Username, this));
@@ -174,6 +180,8 @@ public async Task<SendAmountResponse> SendAmountAsync(List<AddressWithAmount> ad
 
         public SendAmountBuilder SendAmountUsingBuilder() => new SendAmountBuilder(_mediator, this, Username);
 
+        public SendMicroAmountBuilder SendMicroAmountUsingBuilder() => new SendMicroAmountBuilder(_mediator, this, Username);
+
         public async Task<SyncAccountResponse> SyncAccountAsync()
         {
             return await _mediator.Send(new SyncAccountCommand(this, Username));
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommand.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommand.cs
@@ -0,0 +1,26 @@
+﻿using IotaWalletNet.Application.Common.Interfaces;
+using IotaWalletNet.Domain.Common.Models.Address;
+using IotaWalletNet.Domain.Common.Models.Transaction.PayloadTypes;
+using MediatR;
+
+namespace IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount
+{
+    public class SendMicroAmountCommand : IRequest<SendMicroAmountResponse>
+    {
+        public SendMicroAmountCommand(List<AddressWithMicroAmount> addressesWithMicroAmount, TaggedDataPayload? taggedDataPayload, string username, IAccount account)
+        {
+            AddressesWithMicroAmount = addressesWithMicroAmount;
+            Username = username;
+            Account = account;
+            TaggedDataPayload = taggedDataPayload;
+        }
+
+        public List<AddressWithMicroAmount> AddressesWithMicroAmount { get; set; }
+
+        public TaggedDataPayload? TaggedDataPayload { get; set; }
+
+        public string Username { get; set; }
+
+        public IAccount Account { get; set; }
+    }
+}
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommandHandler.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommandHandler.cs
@@ -0,0 +1,23 @@
+﻿using IotaWalletNet.Domain.Common.Models.Transaction;
+using IotaWalletNet.Domain.PlatformInvoke;
+using MediatR;
+using Newtonsoft.Json;
+
+namespace IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount
+{
+    public class SendMicroAmountCommandHandler : IRequestHandler<SendMicroAmountCommand, SendMicroAmountResponse>
+    {
+        public async Task<SendMicroAmountResponse> Handle(SendMicroAmountCommand request, CancellationToken cancellationToken)
+        {
+            SendMicroAmountCommandMessageData messageData = new SendMicroAmountCommandMessageData(request.AddressesWithMicroAmount, new TransactionOptions() { TaggedDataPayload = request.TaggedDataPayload });
+            SendMicroAmountCommandMessage message = new SendMicroAmountCommandMessage(request.Username, messageData);
+            string messageJson = JsonConvert.SerializeObject(message);
+
+            RustBridgeGenericResponse genericResponse = await request.Account.SendMessageAsync(messageJson);
+
+            SendMicroAmountResponse response = genericResponse.As<SendMicroAmountResponse>()!;
+
+            return response;
+        }
+    }
+}
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommandMessage.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommandMessage.cs
@@ -0,0 +1,13 @@
+﻿using IotaWalletNet.Domain.Common.Models;
+
+namespace IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount
+{
+    public class SendMicroAmountCommandMessage : AccountMessage<SendMicroAmountCommandMessageData>
+    {
+        private const string METHOD_NAME = "sendMicroTransaction";
+        public SendMicroAmountCommandMessage(string username, SendMicroAmountCommandMessageData? methodData)
+            : base(username, METHOD_NAME, methodData)
+        {
+        }
+    }
+}
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommandMessageData.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountCommandMessageData.cs
@@ -0,0 +1,18 @@
+﻿using IotaWalletNet.Domain.Common.Models.Address;
+using IotaWalletNet.Domain.Common.Models.Transaction;
+
+namespace IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount
+{
+    public class SendMicroAmountCommandMessageData
+    {
+        public SendMicroAmountCommandMessageData(List<AddressWithMicroAmount> addressesWithMicroAmount, TransactionOptions options)
+        {
+            AddressesWithMicroAmount = addressesWithMicroAmount;
+            Options = options;
+        }
+
+        public List<AddressWithMicroAmount> AddressesWithMicroAmount { get; set; }
+
+        public TransactionOptions Options { get; set; }
+    }
+}
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountResponse.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/AccountContext/Commands/SendMicroAmount/SendMicroAmountResponse.cs
@@ -0,0 +1,10 @@
+﻿using IotaWalletNet.Domain.Common.Models.Transaction;
+using IotaWalletNet.Domain.PlatformInvoke;
+
+namespace IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount
+{
+    public class SendMicroAmountResponse : RustBridgeResponseBase<Transaction>
+    {
+
+    }
+}
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/Common/Builders/SendMicroAmountBuilder.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/Common/Builders/SendMicroAmountBuilder.cs
@@ -0,0 +1,43 @@
+﻿using IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount;
+using IotaWalletNet.Application.Common.Interfaces;
+using IotaWalletNet.Domain.Common.Models.Address;
+using IotaWalletNet.Domain.Common.Models.Transaction.PayloadTypes;
+using MediatR;
+
+namespace IotaWalletNet.Application.Common.Builders
+{
+    public class SendMicroAmountBuilder
+    {
+        private readonly List<AddressWithMicroAmount> _addressWithMicroAmounts;
+        private readonly IMediator _mediator;
+        private readonly IAccount _account;
+        private readonly string _username;
+        private TaggedDataPayload? _taggedDataPayload;
+
+        public SendMicroAmountBuilder(IMediator mediator, IAccount account, string username)
+        {
+            _addressWithMicroAmounts = new List<AddressWithMicroAmount>();
+            _mediator = mediator;
+            _account = account;
+            _username = username;
+        }
+
+        public SendMicroAmountBuilder AddAddressAndAmount(string receiverAddress, ulong amountInGlow, ulong expirationInSeconds)
+        {
+            AddressWithMicroAmount addressWithMicroAmount = new AddressWithMicroAmount(receiverAddress, amountInGlow.ToString(), expirationInSeconds);
+            _addressWithMicroAmounts.Add(addressWithMicroAmount);
+
+            return this;
+        }
+
+        public SendMicroAmountBuilder SetTaggedDataPayload(string tag, string data)
+        {
+            _taggedDataPayload = new TaggedDataPayload(tag, data);
+            return this;
+        }
+        public async Task<SendMicroAmountResponse> SendMicroAmountAsync()
+        {
+            return await _mediator.Send(new SendMicroAmountCommand(_addressWithMicroAmounts, _taggedDataPayload, _username, _account));
+        }
+    }
+}
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Application/Common/Interfaces/IAccount.cs b/csharp/IotaWalletNet/IotaWalletNet.Application/Common/Interfaces/IAccount.cs
@@ -9,6 +9,7 @@
 using IotaWalletNet.Application.AccountContext.Commands.MintNativeTokens;
 using IotaWalletNet.Application.AccountContext.Commands.MintNfts;
 using IotaWalletNet.Application.AccountContext.Commands.SendAmount;
+using IotaWalletNet.Application.AccountContext.Commands.SendMicroAmount;
 using IotaWalletNet.Application.AccountContext.Commands.SendNativeTokens;
 using IotaWalletNet.Application.AccountContext.Commands.SendNfts;
 using IotaWalletNet.Application.AccountContext.Commands.SyncAccount;
@@ -66,5 +67,7 @@ public interface IAccount : IRustBridgeCommunicator
         Task<GetFoundryOutputResponse> GetFoundryOutputAsync(string tokenId);
         Task<DestroyFoundryResponse> DestroyFoundryAsync(string foundryId);
         SendAmountBuilder SendAmountUsingBuilder();
+        Task<SendMicroAmountResponse> SendMicroAmountAsync(List<AddressWithMicroAmount> addressWithMicroAmounts, TaggedDataPayload? taggedDataPayload = null);
+        SendMicroAmountBuilder SendMicroAmountUsingBuilder();
     }
 }
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Domain/Common/Models/Address/AddressWithMicroAmount.cs b/csharp/IotaWalletNet/IotaWalletNet.Domain/Common/Models/Address/AddressWithMicroAmount.cs
@@ -0,0 +1,23 @@
+﻿namespace IotaWalletNet.Domain.Common.Models.Address
+{
+    public class AddressWithMicroAmount
+    {
+        public AddressWithMicroAmount(string address, string amount, ulong expiration, string? returnAddress = null)
+        {
+            Address = address;
+            Amount = amount;
+            ReturnAddress = returnAddress;
+            Expiration = expiration;
+        }
+
+        public string Address { get; set; }
+
+        public string Amount { get; set; }
+
+        public string? ReturnAddress { get; set; }
+
+        public ulong Expiration { get; set; }
+    }
+
+
+}
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/NFTs/Mint/MintNftExample.cs b/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/NFTs/Mint/MintNftExample.cs
@@ -65,13 +65,14 @@ public static async Task Run()
                 List<string> urlsOfUploadedFiles = new List<string>();
 
                 //We will be leveraging Sia for free ipfs storage for 90 days
-                SiaSkynetClient siaSkynetClient = new SiaSkynetClient(baseUrl: "https://web3portal.com/");
+                string siaSkynetPortalUrl = "https://web3portal.com/";
+                SiaSkynetClient siaSkynetClient = new SiaSkynetClient(baseUrl: siaSkynetPortalUrl);
                 foreach (string fileToUpload in filesToUpload)
                 {
                     using (FileStream fileStream = File.OpenRead(fileToUpload))
                     {
                         SkyfileResponse skyfileResponse = await siaSkynetClient.UploadFileAsync(fileToUpload, fileStream);
-                        urlsOfUploadedFiles.Add($"https://siasky.net/{skyfileResponse.Skylink}");
+                        urlsOfUploadedFiles.Add($"{siaSkynetPortalUrl}{skyfileResponse.Skylink}");
                     }
                 }
 
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/NFTs/Mint/README.md b/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/NFTs/Mint/README.md
@@ -63,13 +63,14 @@ The following example will:
                 List<string> urlsOfUploadedFiles = new List<string>();
 
                 //We will be leveraging Sia for free ipfs storage for 90 days
-                SiaSkynetClient siaSkynetClient = new SiaSkynetClient(baseUrl: "https://web3portal.com/");
+                string siaSkynetPortalUrl = "https://web3portal.com/";
+                SiaSkynetClient siaSkynetClient = new SiaSkynetClient(baseUrl: siaSkynetPortalUrl);
                 foreach (string fileToUpload in filesToUpload)
                 {
                     using (FileStream fileStream = File.OpenRead(fileToUpload))
                     {
                         SkyfileResponse skyfileResponse = await siaSkynetClient.UploadFileAsync(fileToUpload, fileStream);
-                        urlsOfUploadedFiles.Add($"https://siasky.net/{skyfileResponse.Skylink}");
+                        urlsOfUploadedFiles.Add($"{siaSkynetPortalUrl}{skyfileResponse.Skylink}");
                     }
                 }
 
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Micro Transaction/README.md b/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Micro Transaction/README.md
@@ -0,0 +1,85 @@
+# Send a Micro Transaction
+
+## Code Example
+
+The following example will:
+
+1. Initialize your wallet
+2. Retrieve an account
+3. Send your micro transaction!
+
+```cs
+    public static class SendMicroTransactionExample
+    {
+        public static async Task Run()
+        {
+            //Register all of the dependencies into a collection of services
+            IServiceCollection services = new ServiceCollection().AddIotaWalletServices();
+
+            //Install services to service provider which is used for dependency injection
+            IServiceProvider serviceProvider = services.BuildServiceProvider();
+
+            //Use serviceprovider to create a scope, which disposes of all services at end of scope
+            using (IServiceScope scope = serviceProvider.CreateScope())
+            {
+                //Request IWallet service from service provider
+                IWallet wallet = scope.ServiceProvider.GetRequiredService<IWallet>();
+
+                //Build wallet using a fluent-style configuration api
+                wallet = wallet
+                            .ConfigureWalletOptions()
+                                .SetCoinType(TypeOfCoin.Shimmer)
+                                .SetStoragePath("./walletdb")
+                                .Then()
+                            .ConfigureClientOptions()
+                                .AddNodeUrl("https://api.testnet.shimmer.network")
+                                .SetFaucetUrl("https://faucet.testnet.shimmer.network")
+                                .IsFallbackToLocalPow()
+                                .IsLocalPow()
+                                .Then()
+                            .ConfigureSecretManagerOptions()
+                                .SetPassword("password")
+                                .SetSnapshotPath("./mystronghold")
+                                .Then()
+                            .Initialize();
+
+
+                //Let's retrieve our cookiemonster account
+                (GetAccountResponse accountResponse, IAccount? account) = await wallet.GetAccountAsync("cookiemonster");
+                Console.WriteLine($"GetAccountAsync: {accountResponse}");
+
+                if (account == null)
+                {
+                    Console.WriteLine("There was a problem retreiving the account.");
+                    return;
+                }
+
+                await account.SyncAccountAsync();
+
+                //Let's send 1 Glow, followed by 2 glow, via a single transaction
+                //The below creates 2 outputs to the receiver address and 1 more output for your balance.
+                //Since a micro transaction creates dust for the receiver, the sender first pays a temporary storage deposit along with the sending micro amount.
+                // The receiver now bears the burden of whether to accept this transaction, as if he accepts it he needs to pay storage deposit and the sender's storage deposit
+                // would be returned back to the sender.
+                //Thus the receiver is given a choice of whether to acccept this transaction within the stipulated time as indicated
+                //by [expirationInSeconds].
+                //[1]If it expired, both the amount sent and storage deposit sent is returned back to the sender.
+                //[2]If receiver rejects the transaction,  both the amount sent and storage deposit sent is returned back to the sender.
+                //[3]If the receiver accepts the transaction, the sender's storage deposit is returned. In turn, the receiver now has to put in the storage deposit
+                //   to claim the micro amount.
+                string receiverAddress = "rms1qp8rknypruss89dkqnnuedm87y7xmnmdj2tk3rrpcy3sw3ev52q0vzl42tr";
+
+                SendMicroAmountResponse sendMicroAmountResponse = await account.SendMicroAmountUsingBuilder()
+                                                                        .AddAddressAndAmount(receiverAddress, 1, expirationInSeconds:120)
+                                                                        .AddAddressAndAmount(receiverAddress, 2, expirationInSeconds:60)
+                                                                        .SendMicroAmountAsync();
+
+
+                Console.WriteLine($"SendMicroAmountAsync: {sendMicroAmountResponse}");
+
+            }
+        }
+
+
+    }
+```
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Micro Transaction/SendMicroTransactionExample.cs b/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Micro Transaction/SendMicroTransactionExample.cs
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Transaction/README.md b/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Transaction/README.md
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Transaction/SendTransactionExample.cs b/csharp/IotaWalletNet/IotaWalletNet.Main/Examples/Outputs and Transactions/Send a Transaction/SendTransactionExample.cs
diff --git a/csharp/IotaWalletNet/IotaWalletNet.Main/Program.cs b/csharp/IotaWalletNet/IotaWalletNet.Main/Program.cs
