Add Wallet domain model and abstractions (#262)

SuperJMN · web-flow · commit 198fba776bd4 · 2025-02-19T18:10:07.000Z
* Add Angor.Wallet

* Simplify things a bit

* Switch to long
diff --git a/src/Angor.Avalonia.sln b/src/Angor.Avalonia.sln
@@ -22,6 +22,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Angor.UI.Model.Implementati
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Core", "Core", "{5B7EE527-242E-4C87-9BB7-AD4E05EABC4C}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Angor.Wallet", "Angor\Avalonia\Angor.Wallet\Angor.Wallet.csproj", "{287F370D-D680-4BE5-8577-7A180BD0A0E3}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -52,6 +54,10 @@ Global
 		{B84751C6-1B82-4DE8-9FBE-F0A67D981C43}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B84751C6-1B82-4DE8-9FBE-F0A67D981C43}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B84751C6-1B82-4DE8-9FBE-F0A67D981C43}.Release|Any CPU.Build.0 = Release|Any CPU
+		{287F370D-D680-4BE5-8577-7A180BD0A0E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{287F370D-D680-4BE5-8577-7A180BD0A0E3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{287F370D-D680-4BE5-8577-7A180BD0A0E3}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{287F370D-D680-4BE5-8577-7A180BD0A0E3}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -64,5 +70,6 @@ Global
 		{539B4D21-F2A9-46A6-84F1-9A51884A62E9} = {5B7EE527-242E-4C87-9BB7-AD4E05EABC4C}
 		{B84751C6-1B82-4DE8-9FBE-F0A67D981C43} = {5B7EE527-242E-4C87-9BB7-AD4E05EABC4C}
 		{700DF0C4-C965-4662-A91F-CD3BE043AC9E} = {5B7EE527-242E-4C87-9BB7-AD4E05EABC4C}
+		{287F370D-D680-4BE5-8577-7A180BD0A0E3} = {5B7EE527-242E-4C87-9BB7-AD4E05EABC4C}
 	EndGlobalSection
 EndGlobal
diff --git a/src/Angor/Avalonia/Angor.Wallet/Angor.Wallet.csproj b/src/Angor/Avalonia/Angor.Wallet/Angor.Wallet.csproj
@@ -0,0 +1,13 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net9.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+    
+    <ItemGroup>
+        <PackageReference Include="CSharpFunctionalExtensions" />
+    </ItemGroup>
+
+</Project>
diff --git a/src/Angor/Avalonia/Angor.Wallet/Application/ITransactionWatcher.cs b/src/Angor/Avalonia/Angor.Wallet/Application/ITransactionWatcher.cs
@@ -0,0 +1,8 @@
+using Angor.Wallet.Domain;
+
+namespace Angor.Wallet.Application;
+
+public interface ITransactionWatcher
+{
+    IObservable<BroadcastedTransaction> Watch(WalletId id);
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Application/IWalletAppService.cs b/src/Angor/Avalonia/Angor.Wallet/Application/IWalletAppService.cs
@@ -0,0 +1,15 @@
+using Angor.Wallet.Domain;
+using CSharpFunctionalExtensions;
+
+namespace Angor.Wallet.Application;
+
+public interface IWalletAppService
+{
+    Task<Result<TxId>> SendAmount(WalletId walletId, Amount amount, Address address, DomainFeeRate feeRate);
+    Task<Result<IEnumerable<(WalletId Id, string Name)>>> GetWallets();
+    Task<Result<IEnumerable<BroadcastedTransaction>>> GetTransactions(WalletId walletId);
+    Task<Result<Balance>> GetBalance(WalletId walletId);
+    Task<Result<Fee>> EstimateFee(WalletId walletId, Amount amount, Address address, DomainFeeRate feeRate);
+    Task<Result<Address>> GetNextReceiveAddress(WalletId id);
+    Task<Result<WalletId>> ImportWallet(string name, string seedwords, Maybe<string> passphrase, string encryptionKey, BitcoinNetwork network);
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/Address.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/Address.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public record Address(string Value);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/Amount.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/Amount.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public record Amount(long Value);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/Balance.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/Balance.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public record Balance(long Value);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/BitcoinNetwork.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/BitcoinNetwork.cs
@@ -0,0 +1,7 @@
+namespace Angor.Wallet.Domain;
+
+public enum BitcoinNetwork
+{
+    Mainnet,
+    Testnet
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/BroadcastedTransaction.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/BroadcastedTransaction.cs
@@ -0,0 +1,15 @@
+namespace Angor.Wallet.Domain;
+
+public record BroadcastedTransaction(
+    Balance Balance,
+    string Id,
+    IEnumerable<TransactionInputInfo> WalletInputs, 
+    IEnumerable<TransactionOutputInfo> WalletOutputs, 
+    IEnumerable<TransactionAddressInfo> AllInputs, 
+    IEnumerable<TransactionAddressInfo> AllOutputs, 
+    long Fee,
+    bool IsConfirmed,
+    int? BlockHeight,
+    DateTimeOffset? BlockTime,
+    string RawJson
+);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/DerivationPath.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/DerivationPath.cs
@@ -0,0 +1,20 @@
+namespace Angor.Wallet.Domain;
+
+public record DerivationPath
+{
+    public uint Purpose { get; }
+    public uint CoinType { get; }
+    public uint Account { get; }
+
+    private DerivationPath(uint purpose, uint coinType, uint account)
+    {
+        Purpose = purpose;
+        CoinType = coinType;
+        Account = account;
+    }
+
+    public static DerivationPath Create(uint purpose, uint coinType, uint account) =>
+        new(purpose, coinType, account);
+
+    public override string ToString() => $"{Purpose}'{CoinType}'{Account}'";
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/DerivationType.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/DerivationType.cs
@@ -0,0 +1,7 @@
+namespace Angor.Wallet.Domain;
+
+public enum DerivationType
+{
+    Receive = 0,
+    Change = 1
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/DomainException.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/DomainException.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public class DomainException(string message) : Exception(message);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/DomainFeeRate.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/DomainFeeRate.cs
@@ -0,0 +1,3 @@
+﻿namespace Angor.Wallet.Domain;
+
+public record DomainFeeRate(long Value);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/DomainScriptType.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/DomainScriptType.cs
@@ -0,0 +1,11 @@
+namespace Angor.Wallet.Domain;
+
+public enum DomainScriptType
+{
+    Invalid,
+    SegWit,
+    Taproot,
+    Legacy,
+    P2SH,
+    P2WSH
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/Fee.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/Fee.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public record Fee(long Value);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/IWalletRepository.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/IWalletRepository.cs
@@ -0,0 +1,9 @@
+using CSharpFunctionalExtensions;
+
+namespace Angor.Wallet.Domain;
+
+public interface IWalletRepository
+{
+    Task<Result<IEnumerable<(WalletId Id, string Name)>>> ListWallets();
+    Task<Result<Wallet>> Get(WalletId id);
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/TransactionAddressInfo.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/TransactionAddressInfo.cs
@@ -0,0 +1,6 @@
+namespace Angor.Wallet.Domain;
+
+public record TransactionAddressInfo(
+    string Address,
+    ulong TotalAmount
+);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/TransactionInputInfo.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/TransactionInputInfo.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public record TransactionInputInfo(TransactionAddressInfo Address);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/TransactionOutputInfo.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/TransactionOutputInfo.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public record TransactionOutputInfo(TransactionAddressInfo Address);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/TxId.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/TxId.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public record TxId(string Value);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/Wallet.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/Wallet.cs
@@ -0,0 +1,13 @@
+namespace Angor.Wallet.Domain;
+
+public class Wallet
+{
+    public Wallet(WalletId id, WalletDescriptor descriptor)
+    {
+        Id = id;
+        Descriptor = descriptor;
+    }
+
+    public WalletId Id { get; }
+    public WalletDescriptor Descriptor { get; }
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/WalletDescriptor.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/WalletDescriptor.cs
@@ -0,0 +1,3 @@
+namespace Angor.Wallet.Domain;
+
+public sealed record WalletDescriptor(BitcoinNetwork Network, XPubCollection Xpubs);
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/WalletId.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/WalletId.cs
@@ -0,0 +1,9 @@
+namespace Angor.Wallet.Domain;
+
+public record WalletId(Guid Id)
+{
+    public static WalletId New()
+    {
+        return new WalletId(Guid.NewGuid());
+    }
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/XPub.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/XPub.cs
@@ -0,0 +1,23 @@
+namespace Angor.Wallet.Domain;
+
+public sealed record XPub
+{
+    public string Value { get; }
+    public DomainScriptType ScriptType { get; }
+    public DerivationPath Path { get; }
+
+    private XPub(string value, DomainScriptType scriptType, DerivationPath path)
+    {
+        Value = value;
+        ScriptType = scriptType;
+        Path = path;
+    }
+
+    public static XPub Create(string value, DomainScriptType scriptType, DerivationPath path)
+    {
+        if (string.IsNullOrWhiteSpace(value))
+            throw new DomainException("XPub value cannot be empty");
+
+        return new XPub(value, scriptType, path);
+    }
+}
diff --git a/src/Angor/Avalonia/Angor.Wallet/Domain/XPubCollection.cs b/src/Angor/Avalonia/Angor.Wallet/Domain/XPubCollection.cs
@@ -0,0 +1,5 @@
+using System.Collections.ObjectModel;
+
+namespace Angor.Wallet.Domain;
+
+public class XPubCollection : Collection<XPub>;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+namespace Angor.Wallet.Domain;`
	`2`	`+`
	`3`	`+public record Address(string Value);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+namespace Angor.Wallet.Domain;`
	`2`	`+`
	`3`	`+public record Amount(long Value);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+namespace Angor.Wallet.Domain;`
	`2`	`+`
	`3`	`+public record Balance(long Value);`