Merge pull request #203 from kommitters/v0.8

Release v0.8.6

Author: CristhianRodriguezMolina

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.8.6 (31.10.2022)
+* Fix wrong binary encoding in the `AssetCode12` module.
+
 ## 0.8.5 (25.10.2022)
 * Enable ExCoveralls with parallel builds.
 

README.md

@@ -24,7 +24,7 @@ You should only use **`stellar_base`** if you are planning to build on top of it
 ```elixir
 def deps do
   [
-    {:stellar_base, "~> 0.8.5"}
+    {:stellar_base, "~> 0.8.6"}
   ]
 end
 ```

lib/xdr/ledger_entries/asset_code12.ex

@@ -17,7 +17,7 @@ defmodule StellarBase.XDR.AssetCode12 do
   @impl true
   def encode_xdr(%__MODULE__{code: code, length: length}) when length in @length_range do
     code
-    |> XDR.FixedOpaque.new(length)
+    |> build_opaque(length)
     |> XDR.FixedOpaque.encode_xdr()
   end
 
@@ -26,7 +26,7 @@ defmodule StellarBase.XDR.AssetCode12 do
   @impl true
   def encode_xdr!(%__MODULE__{code: code, length: length}) when length in @length_range do
     code
-    |> XDR.FixedOpaque.new(length)
+    |> build_opaque(length)
     |> XDR.FixedOpaque.encode_xdr!()
   end
 
@@ -45,22 +45,24 @@ defmodule StellarBase.XDR.AssetCode12 do
   @impl true
   def decode_xdr!(bytes, term \\ nil)
 
-  def decode_xdr!(bytes, _term) do
-    {%XDR.FixedOpaque{opaque: code}, rest} =
+  def decode_xdr!(<<bytes::binary-size(12), rest::binary>>, _term) do
+    {%XDR.FixedOpaque{opaque: code}, _rest} =
       XDR.FixedOpaque.decode_xdr!(bytes, opaque_spec(bytes))
 
     {new(code), rest}
   end
 
+  @spec build_opaque(code :: binary(), length :: non_neg_integer()) :: XDR.FixedOpaque.t()
+  defp build_opaque(code, length) do
+    zeros = @max_length - length
+    bin = <<code::binary, 0::zeros*8>>
+    XDR.FixedOpaque.new(bin, @max_length)
+  end
+
   @spec opaque_spec(bytes :: binary()) :: XDR.FixedOpaque.t()
   defp opaque_spec(bytes), do: XDR.FixedOpaque.new(nil, length_from_binary(bytes, 5))
 
   @spec length_from_binary(bytes :: binary(), acc :: non_neg_integer()) :: non_neg_integer()
-  defp length_from_binary(<<bytes::binary-size(8)>>, acc) do
-    opaque = bytes <> <<0, 0, 0, 0>>
-    length_from_binary(opaque, acc)
-  end
-
   defp length_from_binary(<<opaque::binary-size(@max_length), _rest::binary>>, acc)
        when acc in @length_range do
     <<_hd::binary-size(acc), rest::binary>> = opaque

mix.exs

@@ -2,7 +2,7 @@ defmodule StellarBase.MixProject do
   use Mix.Project
 
   @github_url "https://github.com/kommitters/stellar_base"
-  @version "0.8.5"
+  @version "0.8.6"
 
   def project do
     [

test/xdr/ledger_entries/asset_code12_test.exs

@@ -47,8 +47,8 @@ defmodule StellarBase.XDR.AssetCode12Test do
     end
 
     test "decode_xdr/2 with a 8-bytes code" do
-      {:ok, {%AssetCode12{code: "BTCNE"}, ""}} =
-        AssetCode12.decode_xdr(<<66, 84, 67, 78, 69, 0, 0, 0>>)
+      {:ok, {%AssetCode12{code: "BTCNE"}, <<0, 0, 0, 0>>}} =
+        AssetCode12.decode_xdr(<<66, 84, 67, 78, 69, 0, 0, 0, 0, 0, 0, 0>>)
     end
 
     test "decode_xdr/2 with an invalid binary" do

test/xdr/ledger_entries/asset_test.exs

@@ -100,9 +100,9 @@ defmodule StellarBase.XDR.AssetTest do
         asset_type: asset_type,
         asset: Asset.new(alpha_num12, asset_type),
         binary:
-          <<0, 0, 0, 2, 66, 84, 67, 78, 50, 48, 50, 49, 0, 0, 0, 0, 155, 142, 186, 248, 150, 56,
-            85, 29, 207, 158, 164, 247, 67, 32, 113, 16, 107, 135, 171, 14, 45, 179, 214, 155,
-            117, 165, 56, 34, 114, 247, 89, 216>>
+          <<0, 0, 0, 2, 66, 84, 67, 78, 50, 48, 50, 49, 0, 0, 0, 0, 0, 0, 0, 0, 155, 142, 186,
+            248, 150, 56, 85, 29, 207, 158, 164, 247, 67, 32, 113, 16, 107, 135, 171, 14, 45, 179,
+            214, 155, 117, 165, 56, 34, 114, 247, 89, 216>>
       }
     end
 

test/xdr/ledger_entries/trust_line_asset_test.exs

@@ -102,9 +102,9 @@ defmodule StellarBase.XDR.TrustLineAssetTest do
         asset_type: asset_type,
         asset: TrustLineAsset.new(alpha_num12, asset_type),
         binary:
-          <<0, 0, 0, 2, 66, 84, 67, 78, 50, 48, 50, 49, 0, 0, 0, 0, 155, 142, 186, 248, 150, 56,
-            85, 29, 207, 158, 164, 247, 67, 32, 113, 16, 107, 135, 171, 14, 45, 179, 214, 155,
-            117, 165, 56, 34, 114, 247, 89, 216>>
+          <<0, 0, 0, 2, 66, 84, 67, 78, 50, 48, 50, 49, 0, 0, 0, 0, 0, 0, 0, 0, 155, 142, 186,
+            248, 150, 56, 85, 29, 207, 158, 164, 247, 67, 32, 113, 16, 107, 135, 171, 14, 45, 179,
+            214, 155, 117, 165, 56, 34, 114, 247, 89, 216>>
       }
     end