Merge pull request #242 from kommitters/v0.9

Release v0.9.0

Author: miguelnietoa

.github/workflows/cd.yml

@@ -20,7 +20,7 @@ jobs:
       HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@18bf8ad2ca49c14cbb28b91346d626ccfb00c518 # v2.1.0
+        uses: step-security/harden-runner@1f99358870fe1c846a3ccba386cc2b2246836776 # v2.2.1
         with:
           disable-sudo: true
           egress-policy: block
@@ -29,12 +29,12 @@ jobs:
             hex.pm:443
             repo.hex.pm:443
 
-      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+      - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0
       - uses: erlef/setup-elixir@e3f6ffe2878180f57318bf13febd3933ee81f664 # v1.15.2
         with:
           otp-version: ${{ matrix.otp }}
           elixir-version: ${{ matrix.elixir }}
-      - uses: actions/cache@58c146cc91c5b9e778e71775dfe9bf1442ad9a12 # v3.2.3
+      - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
         with:
           path: deps
           key: ${{ runner.os }}-mix-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
       MIX_ENV: test
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@18bf8ad2ca49c14cbb28b91346d626ccfb00c518 # v2.1.0
+        uses: step-security/harden-runner@1f99358870fe1c846a3ccba386cc2b2246836776 # v2.2.1
         with:
           disable-sudo: true
           egress-policy: block
@@ -32,7 +32,7 @@ jobs:
             repo.hex.pm:443
 
       - name: Checkout Github repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0
 
       - name: Sets up an Erlang/OTP environment
         uses: erlef/setup-elixir@e3f6ffe2878180f57318bf13febd3933ee81f664 # v1.15.2
@@ -47,7 +47,7 @@ jobs:
           echo "::set-output name=mix_hash::$mix_hash"
 
       - name: Cache dependecies
-        uses: actions/cache@58c146cc91c5b9e778e71775dfe9bf1442ad9a12 # v3.2.3
+        uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
         with:
           path: deps
           key: ${{ runner.os }}-mix-${{ steps.set_vars.outputs.mix_hash }}
@@ -56,7 +56,7 @@ jobs:
 
       - name: Cache PLT files
         id: plt-cache
-        uses: actions/cache@58c146cc91c5b9e778e71775dfe9bf1442ad9a12 # v3.2.3
+        uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
         with:
           path: |
             _build
@@ -90,7 +90,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@18bf8ad2ca49c14cbb28b91346d626ccfb00c518 # v2.1.0
+        uses: step-security/harden-runner@1f99358870fe1c846a3ccba386cc2b2246836776 # v2.2.1
         with:
           disable-sudo: true
           egress-policy: block

.github/workflows/scorecards.yml

@@ -22,7 +22,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@18bf8ad2ca49c14cbb28b91346d626ccfb00c518 # v2.1.0
+        uses: step-security/harden-runner@1f99358870fe1c846a3ccba386cc2b2246836776 # v2.2.1
         with:
           disable-sudo: true
           egress-policy: block
@@ -37,7 +37,7 @@ jobs:
             sigstore-tuf-root.storage.googleapis.com:443
 
       - name: "Checkout code"
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0
         with:
           persist-credentials: false
 
@@ -69,6 +69,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@959cbb7472c4d4ad70cdfe6f4976053fe48ab394 # v2.1.37
+        uses: github/codeql-action/upload-sarif@04df1262e6247151b5ac09cd2c303ac36ad3f62b # v2.2.9
         with:
           sarif_file: results.sarif

.gitignore

@@ -28,3 +28,5 @@ stellar_sdk-*.tar
 
 # DS_Store
 .DS_Store
+
+.elixir_ls

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.9.0 (29.03.2023)
+* Add [CAP-0046 support](https://github.com/kommitters/stellar_base/issues/223) in the XDR version: [df18148747e807618acf4639db41c4fd6f0be9fc](https://github.com/stellar/stellar-xdr/commit/df18148747e807618acf4639db41c4fd6f0be9fc) which corresponds to the [Soroban Preview 7](https://soroban.stellar.org/docs/reference/releases#preview-7-february-16th-2023).
+* Update all dependencies.
+* Fix LICENSE badge URL.
+
 ## 0.8.11 (16.01.2023)
 * Update all dependencies.
 * Block egress traffic in GitHub Actions.

README.md

@@ -5,7 +5,7 @@
 [![Coverage Status](https://img.shields.io/coveralls/github/kommitters/stellar_base?style=for-the-badge)](https://coveralls.io/github/kommitters/stellar_base)
 [![Version Badge](https://img.shields.io/hexpm/v/stellar_base?style=for-the-badge)](https://hexdocs.pm/stellar_base)
 ![Downloads Badge](https://img.shields.io/hexpm/dt/stellar_base?style=for-the-badge)
-[![License badge](https://img.shields.io/hexpm/l/stellar_base.svg?style=for-the-badge)](https://github.com/kommitters/stellar_base/blob/main/LICENSE.md)
+[![License badge](https://img.shields.io/hexpm/l/stellar_base.svg?style=for-the-badge)](https://github.com/kommitters/stellar_base/blob/main/LICENSE)
 [![OpenSSF Best Practices](https://img.shields.io/cii/summary/6461?label=openssf%20best%20practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/6461)
 [![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/kommitters/stellar_base?label=openssf%20scorecard&style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/stellar_base)
 
@@ -26,7 +26,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.11"}
+    {:stellar_base, "~> 0.9.0"}
   ]
 end
 ```

lib/xdr/contract/env_meta/sc_env_meta_entry.ex

@@ -0,0 +1,61 @@
+defmodule StellarBase.XDR.SCEnvMetaEntry do
+  @moduledoc """
+  Representation of Stellar `SCEnvMetaEntry` type.
+  """
+
+  alias StellarBase.XDR.{UInt64, SCEnvMetaKind}
+
+  @behaviour XDR.Declaration
+
+  @arms [
+    SC_ENV_META_KIND_INTERFACE_VERSION: UInt64
+  ]
+
+  @type entry :: UInt64.t()
+
+  @type t :: %__MODULE__{entry: entry(), kind: SCEnvMetaKind.t()}
+
+  defstruct [:entry, :kind]
+
+  @spec new(entry :: entry(), kind :: SCEnvMetaKind.t()) :: t()
+  def new(entry, %SCEnvMetaKind{} = kind), do: %__MODULE__{entry: entry, kind: kind}
+
+  @impl true
+  def encode_xdr(%__MODULE__{entry: entry, kind: kind}) do
+    kind
+    |> XDR.Union.new(@arms, entry)
+    |> XDR.Union.encode_xdr()
+  end
+
+  @impl true
+  def encode_xdr!(%__MODULE__{entry: entry, kind: kind}) do
+    kind
+    |> XDR.Union.new(@arms, entry)
+    |> XDR.Union.encode_xdr!()
+  end
+
+  @impl true
+  def decode_xdr(bytes, spec \\ union_spec())
+
+  def decode_xdr(bytes, spec) do
+    case XDR.Union.decode_xdr(bytes, spec) do
+      {:ok, {{kind, entry}, rest}} -> {:ok, {new(entry, kind), rest}}
+      error -> error
+    end
+  end
+
+  @impl true
+  def decode_xdr!(bytes, spec \\ union_spec())
+
+  def decode_xdr!(bytes, spec) do
+    {{kind, entry}, rest} = XDR.Union.decode_xdr!(bytes, spec)
+    {new(entry, kind), rest}
+  end
+
+  @spec union_spec() :: XDR.Union.t()
+  defp union_spec do
+    nil
+    |> SCEnvMetaKind.new()
+    |> XDR.Union.new(@arms)
+  end
+end

lib/xdr/contract/env_meta/sc_env_meta_kind.ex

@@ -0,0 +1,52 @@
+defmodule StellarBase.XDR.SCEnvMetaKind do
+  @moduledoc """
+  Representation of Stellar `SCEnvMetaKind` type.
+  """
+
+  @behaviour XDR.Declaration
+
+  @declarations [
+    SC_ENV_META_KIND_INTERFACE_VERSION: 0
+  ]
+
+  @enum_spec %XDR.Enum{declarations: @declarations, identifier: nil}
+
+  @type t :: %__MODULE__{identifier: atom()}
+
+  defstruct [:identifier]
+
+  @spec new(type :: atom()) :: t()
+  def new(type \\ :SC_ENV_META_KIND_INTERFACE_VERSION), do: %__MODULE__{identifier: type}
+
+  @impl true
+  def encode_xdr(%__MODULE__{identifier: type}) do
+    @declarations
+    |> XDR.Enum.new(type)
+    |> XDR.Enum.encode_xdr()
+  end
+
+  @impl true
+  def encode_xdr!(%__MODULE__{identifier: type}) do
+    @declarations
+    |> XDR.Enum.new(type)
+    |> XDR.Enum.encode_xdr!()
+  end
+
+  @impl true
+  def decode_xdr(bytes, spec \\ @enum_spec)
+
+  def decode_xdr(bytes, spec) do
+    case XDR.Enum.decode_xdr(bytes, spec) do
+      {:ok, {%XDR.Enum{identifier: type}, rest}} -> {:ok, {new(type), rest}}
+      error -> error
+    end
+  end
+
+  @impl true
+  def decode_xdr!(bytes, spec \\ @enum_spec)
+
+  def decode_xdr!(bytes, spec) do
+    {%XDR.Enum{identifier: type}, rest} = XDR.Enum.decode_xdr!(bytes, spec)
+    {new(type), rest}
+  end
+end

lib/xdr/contract/int128_parts.ex

@@ -0,0 +1,54 @@
+defmodule StellarBase.XDR.Int128Parts do
+  @moduledoc """
+  Representation of Stellar `Int128Parts` type.
+  """
+
+  alias StellarBase.XDR.UInt64
+
+  @behaviour XDR.Declaration
+
+  @struct_spec XDR.Struct.new(lo: UInt64, hi: UInt64)
+
+  @type t :: %__MODULE__{lo: UInt64.t(), hi: UInt64.t()}
+
+  defstruct [:lo, :hi]
+
+  @spec new(lo :: UInt64.t(), hi :: UInt64.t()) :: t()
+  def new(%UInt64{} = lo, %UInt64{} = hi), do: %__MODULE__{lo: lo, hi: hi}
+
+  @impl true
+  def encode_xdr(%__MODULE__{lo: lo, hi: hi}) do
+    [lo: lo, hi: hi]
+    |> XDR.Struct.new()
+    |> XDR.Struct.encode_xdr()
+  end
+
+  @impl true
+  def encode_xdr!(%__MODULE__{lo: lo, hi: hi}) do
+    [lo: lo, hi: hi]
+    |> XDR.Struct.new()
+    |> XDR.Struct.encode_xdr!()
+  end
+
+  @impl true
+  def decode_xdr(bytes, struct \\ @struct_spec)
+
+  def decode_xdr(bytes, struct) do
+    case XDR.Struct.decode_xdr(bytes, struct) do
+      {:ok, {%XDR.Struct{components: [lo: lo, hi: hi]}, rest}} ->
+        {:ok, {new(lo, hi), rest}}
+
+      error ->
+        error
+    end
+  end
+
+  @impl true
+  def decode_xdr!(bytes, struct \\ @struct_spec)
+
+  def decode_xdr!(bytes, struct) do
+    {%XDR.Struct{components: [lo: lo, hi: hi]}, rest} = XDR.Struct.decode_xdr!(bytes, struct)
+
+    {new(lo, hi), rest}
+  end
+end

lib/xdr/contract/optional_sc_object.ex

@@ -0,0 +1,60 @@
+defmodule StellarBase.XDR.OptionalSCObject do
+  @moduledoc """
+  Representation of Stellar `OptionalSCObject` type.
+  """
+
+  alias StellarBase.XDR.SCObject
+
+  @behaviour XDR.Declaration
+
+  @optional_spec XDR.Optional.new(SCObject)
+
+  @type sc_object :: SCObject.t() | nil
+
+  @type t :: %__MODULE__{sc_object: sc_object()}
+
+  defstruct [:sc_object]
+
+  @spec new(sc_object :: sc_object()) :: t()
+  def new(sc_object \\ nil), do: %__MODULE__{sc_object: sc_object}
+
+  @impl true
+  def encode_xdr(%__MODULE__{sc_object: sc_object}) do
+    sc_object
+    |> XDR.Optional.new()
+    |> XDR.Optional.encode_xdr()
+  end
+
+  @impl true
+  def encode_xdr!(%__MODULE__{sc_object: sc_object}) do
+    sc_object
+    |> XDR.Optional.new()
+    |> XDR.Optional.encode_xdr!()
+  end
+
+  @impl true
+  def decode_xdr(bytes, optional_spec \\ @optional_spec)
+
+  def decode_xdr(bytes, optional_spec) do
+    case XDR.Optional.decode_xdr(bytes, optional_spec) do
+      {:ok, {%XDR.Optional{type: sc_object}, rest}} ->
+        {:ok, {new(sc_object), rest}}
+
+      {:ok, {nil, rest}} ->
+        {:ok, {new(), rest}}
+
+      error ->
+        error
+    end
+  end
+
+  @impl true
+  def decode_xdr!(bytes, optional_spec \\ @optional_spec)
+
+  def decode_xdr!(bytes, optional_spec) do
+    case XDR.Optional.decode_xdr!(bytes, optional_spec) do
+      {%XDR.Optional{type: sc_object}, rest} -> {new(sc_object), rest}
+      {nil, rest} -> {new(), rest}
+    end
+  end
+end