update to v0.3.1 (#19)

* update from cryptogarageinc v0.3.2

Author: k-matsuzawa

.github/workflows/check_pre-merge.yml

@@ -6,11 +6,13 @@ on:
     - master
     - develop
     - features/sprint*
+    - stable_v*
   pull_request:
     branches:
     - master
     - develop
     - features/sprint*
+    - stable_v*
 
 jobs:
   test-dotnet5:

.github/workflows/code_scanner.yml

@@ -43,10 +43,6 @@ jobs:
       with:
         dotnet-version: 5.0.x
 
-    # If this run was triggered by a pull request event, then checkout the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
-
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1

.github/workflows/workflow_modify_checker.yml

@@ -46,7 +46,7 @@ if(CFD_TARGET_VERSION)
 set(CFD_TARGET_TAG  ${CFD_TARGET_VERSION})
 message(STATUS "[external project local] cfd target=${CFD_TARGET_VERSION}")
 else()
-set(CFD_TARGET_TAG  v0.3.0)
+set(CFD_TARGET_TAG  v0.3.1)
 endif()
 if(CFD_TARGET_URL)
 set(CFD_TARGET_REP  ${CFD_TARGET_URL})

external/CMakeLists.txt

@@ -162,6 +162,56 @@ public enum CfdSighashType
 #pragma warning restore CA1720 // Identifier contains type name
   };
 
+  /// <summary>
+  /// Elements pegin data struct.
+  /// </summary>
+  public struct PeginData : IEquatable<PeginData>
+  {
+    public Address Address { get; }
+    public Script ClaimScript { get; }
+    public Script TweakedFedpegScript { get; }
+
+    public PeginData(Address peginAddress, Script claimScript, Script tweakedFedpegScript)
+    {
+      Address = peginAddress;
+      ClaimScript = claimScript;
+      TweakedFedpegScript = tweakedFedpegScript;
+    }
+
+    public bool Equals(PeginData other)
+    {
+      return Address == other.Address;
+    }
+
+    public override bool Equals(object obj)
+    {
+      if (obj is null)
+      {
+        return false;
+      }
+      if (obj is PeginData)
+      {
+        return Equals((PeginData)obj);
+      }
+      return false;
+    }
+
+    public override int GetHashCode()
+    {
+      return Address.GetHashCode();
+    }
+
+    public static bool operator ==(PeginData left, PeginData right)
+    {
+      return left.Equals(right);
+    }
+
+    public static bool operator !=(PeginData left, PeginData right)
+    {
+      return !(left == right);
+    }
+  };
+
   /// <summary>
   /// Bitcoin Address class.
   /// </summary>
@@ -203,6 +253,78 @@ public static Address GetAddressByLockingScript(Script inputLockingScript, CfdNe
       }
     }
 
+    /// <summary>
+    /// Get pegin address.
+    /// </summary>
+    /// <param name="fedpegScript">fedpeg script</param>
+    /// <param name="pubkey">pubkey</param>
+    /// <param name="hashType">hash type</param>
+    /// <param name="network">network type</param>
+    /// <returns>pegin address data</returns>
+    public static PeginData GetPeginAddress(Script fedpegScript, Pubkey pubkey, CfdHashType hashType, CfdNetworkType network)
+    {
+      if (fedpegScript is null)
+      {
+        throw new ArgumentNullException(nameof(fedpegScript));
+      }
+      if (pubkey is null)
+      {
+        throw new ArgumentNullException(nameof(pubkey));
+      }
+      using (var handle = new ErrorHandle())
+      {
+        var ret = NativeMethods.CfdGetPeginAddress(
+          handle.GetHandle(), (int)network, fedpegScript.ToHexString(), (int)hashType,
+          pubkey.ToHexString(), "",
+          out IntPtr outputPeginAddress, out IntPtr outputClaimScript, out IntPtr outputFedpegScript);
+        if (ret != CfdErrorCode.Success)
+        {
+          handle.ThrowError(ret);
+        }
+        string peginAddress = CCommon.ConvertToString(outputPeginAddress);
+        string claimScript = CCommon.ConvertToString(outputClaimScript);
+        string tweakedFedpegScript = CCommon.ConvertToString(outputFedpegScript);
+        return new PeginData(new Address(peginAddress), new Script(claimScript),
+          new Script(tweakedFedpegScript));
+      }
+    }
+
+    /// <summary>
+    /// Get pegin address.
+    /// </summary>
+    /// <param name="fedpegScript">fedpeg script</param>
+    /// <param name="redeemScript">redeem script</param>
+    /// <param name="hashType">hash type</param>
+    /// <param name="network">network type</param>
+    /// <returns>pegin address data</returns>
+    public static PeginData GetPeginAddress(Script fedpegScript, Script redeemScript, CfdHashType hashType, CfdNetworkType network)
+    {
+      if (fedpegScript is null)
+      {
+        throw new ArgumentNullException(nameof(fedpegScript));
+      }
+      if (redeemScript is null)
+      {
+        throw new ArgumentNullException(nameof(redeemScript));
+      }
+      using (var handle = new ErrorHandle())
+      {
+        var ret = NativeMethods.CfdGetPeginAddress(
+          handle.GetHandle(), (int)network, fedpegScript.ToHexString(), (int)hashType,
+          "", redeemScript.ToHexString(),
+          out IntPtr outputPeginAddress, out IntPtr outputClaimScript, out IntPtr outputFedpegScript);
+        if (ret != CfdErrorCode.Success)
+        {
+          handle.ThrowError(ret);
+        }
+        string peginAddress = CCommon.ConvertToString(outputPeginAddress);
+        string claimScript = CCommon.ConvertToString(outputClaimScript);
+        string tweakedFedpegScript = CCommon.ConvertToString(outputFedpegScript);
+        return new PeginData(new Address(peginAddress), new Script(claimScript),
+          new Script(tweakedFedpegScript));
+      }
+    }
+
     /// <summary>
     /// empty constructor.
     /// </summary>

src/Address.cs

@@ -0,0 +1,25 @@
+using System;
+
+namespace Cfd
+{
+  /// <summary>
+  /// block hash class.
+  /// </summary>
+  public class BlockHash : Txid
+  {
+    /// <summary>
+    /// Constructor. (empty)
+    /// </summary>
+    public BlockHash() : base()
+    {
+    }
+
+    public BlockHash(string hash) : base(hash)
+    {
+    }
+
+    public BlockHash(byte[] bytes) : base(bytes)
+    {
+    }
+  }
+}