stellar-base 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3f2262b18e995857495f0209dff368bf75d5ca0fb946a77c890a859e816f916
-  data.tar.gz: ef32817bb66be06efe55f7da2ef204837895f4f6966c4fd55b91e2f1bbff8bb9
+  metadata.gz: 747484cfbd2ecc3339c7f02db339afd3259cbfc438c752b88384437d92b7dd8e
+  data.tar.gz: 85490bd0247c71f517fdc1c66cabe961d4ce8c4b574d42b2f3cddeeb54b2e395
 SHA512:
-  metadata.gz: d6a82d8306b2c62d57b4467fcbfef426d276b7c11612dfed13fb2db13b43c6aa9091f7cfd1c7d6c464b3d93f6faf7d72b7262fdfd9d6dc9dfb7ca7557c9b5254
-  data.tar.gz: ab279d7660378ed94d5d1fdfd2367714c10d78bd7f109dba50dafbcd186de0de97de0893b4b50620029a9189a0ad5d0e98604769ec4a4b0e82c1ceaa8c99278a
+  metadata.gz: d6a0f7794d178e34799db7dad0c64ed37830896b30c7a53b204c055fb71289a535b5044d5340663ccfec96c33317f1754eed6a9ee7eba7aaa37da7431cfd26f2
+  data.tar.gz: 623a2e0bee087f04c3b512c63ccaefdc9d85f9cecc8bde008cdaed01d017577fbbb07910b621809913557d7fff5bb559928b3b341295c544d90a1fda4d584e16

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 As this project is pre 1.0, breaking changes may happen for minor version
 bumps.  A breaking change will get clearly notified in this log.
 
+## [0.28.0](https://www.github.com/astroband/ruby-stellar-sdk/compare/v0.27.0...v0.28.0) (2021-07-17)
+
+### Features
+
+* support muxed accounts in tx builder ([#162](https://www.github.com/astroband/ruby-stellar-sdk/issues/162)) ([37cd954](https://www.github.com/astroband/ruby-stellar-sdk/commit/37cd954f92c7999a74ca779e795dde74a3d71aad))
+
 ## [0.27.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.26.0...v0.27.0) (2021-05-08)
 
 ### Features

data/generated/stellar/operation_id.rb

@@ -10,7 +10,7 @@ require 'xdr'
 #   case ENVELOPE_TYPE_OP_ID:
 #       struct
 #       {
-#           MuxedAccount sourceAccount;
+#           AccountID sourceAccount;
 #           SequenceNumber seqNum;
 #           uint32 opNum;
 #       } id;

data/generated/stellar/operation_id/id.rb

@@ -7,7 +7,7 @@ require 'xdr'
 #
 #   struct
 #       {
-#           MuxedAccount sourceAccount;
+#           AccountID sourceAccount;
 #           SequenceNumber seqNum;
 #           uint32 opNum;
 #       }
@@ -16,7 +16,7 @@ require 'xdr'
 module Stellar
   class OperationID
     class Id < XDR::Struct
-      attribute :source_account, MuxedAccount
+      attribute :source_account, AccountID
       attribute :seq_num,        SequenceNumber
       attribute :op_num,         Uint32
     end

data/lib/stellar-base.rb

@@ -23,6 +23,7 @@ Stellar::Deprecation = ActiveSupport::Deprecation.new("next release", "stellar-b
 
 # extensions onto the generated files must be loaded manually, below
 
+require_relative "./stellar/account"
 require_relative "./stellar/account_flags"
 require_relative "./stellar/asset"
 require_relative "./stellar/claim_predicate"

data/lib/stellar/account.rb

@@ -0,0 +1,59 @@
+module Stellar
+  class Account
+    delegate :address, to: :keypair
+
+    def self.random
+      keypair = Stellar::KeyPair.random
+      new(keypair)
+    end
+
+    def self.from_seed(seed)
+      keypair = Stellar::KeyPair.from_seed(seed)
+      new(keypair)
+    end
+
+    def self.from_address(address)
+      muxed_xdr = Util::StrKey.decode_muxed_account(address)
+
+      if muxed_xdr.ed25519
+        new(KeyPair.from_public_key(muxed_xdr.ed25519))
+      else
+        muxed_xdr = muxed_xdr.med25519!
+        new(KeyPair.from_public_key(muxed_xdr.ed25519), muxed_xdr.id)
+      end
+    end
+
+    def self.master
+      keypair = Stellar::KeyPair.from_raw_seed("allmylifemyhearthasbeensearching")
+      new(keypair)
+    end
+
+    attr_reader :keypair, :id
+
+    # @param [Stellar::KeyPair] keypair
+    # @param [Integer] id
+    def initialize(keypair, id = nil)
+      @keypair = keypair
+      @id = id
+    end
+
+    def base_account
+      Stellar::MuxedAccount.ed25519(keypair.raw_public_key)
+    end
+
+    def muxed_account
+      return base_account unless id
+      Stellar::MuxedAccount.med25519(ed25519: keypair.raw_public_key, id: id)
+    end
+
+    def address(force_account_id: true)
+      return keypair.address if force_account_id
+
+      Util::StrKey.check_encode(:muxed, keypair.raw_public_key + [id].pack("Q>"))
+    end
+
+    def to_keypair
+      keypair
+    end
+  end
+end

data/lib/stellar/compat.rb

@@ -2,8 +2,10 @@ class << Stellar::Operation
   alias_method :manage_offer, :manage_sell_offer
   alias_method :create_passive_offer, :create_passive_sell_offer
 
-  deprecate deprecator: Stellar::Deprecation,
-            manage_offer: :manage_sell_offer,
-            create_passive_offer: :create_passive_sell_offer,
-            allow_trust: :set_trust_line_flags
+  deprecate(
+    deprecator: Stellar::Deprecation,
+    manage_offer: :manage_sell_offer,
+    create_passive_offer: :create_passive_sell_offer,
+    allow_trust: :set_trust_line_flags
+  )
 end

data/lib/stellar/dsl.rb

@@ -27,6 +27,25 @@ module Stellar
       )
     end
 
+    def Account(subject = nil)
+      case subject
+      when Account
+        subject
+      when /^M[A-Z0-9]{68}$/
+        Account.from_address(subject.to_str)
+      when nil
+        Account.random
+      else
+        begin
+          keypair = KeyPair(subject)
+
+          Account.new(keypair)
+        rescue TypeError
+          raise TypeError, "Cannot convert #{subject.inspect} to Stellar::Account"
+        end
+      end
+    end
+
     # @param [Asset, String, nil] subject
     # @return [Stellar::Asset] instance of the Stellar::Asset
     # @raise [TypeError] if subject cannot be converted to Stellar::Asset

data/lib/stellar/transaction_builder.rb

@@ -1,5 +1,7 @@
 module Stellar
   class TransactionBuilder
+    include Stellar::DSL
+
     attr_reader :source_account, :sequence_number, :base_fee, :time_bounds, :memo, :operations
 
     class << self
@@ -29,21 +31,20 @@ module Stellar
       base_fee: 100,
       time_bounds: nil,
       memo: nil,
+      enable_muxed_accounts: false,
       **_ # ignore any additional parameters without errors
     )
-      raise ArgumentError, "Bad :source_account" unless source_account.is_a?(Stellar::KeyPair)
       raise ArgumentError, "Bad :sequence_number" unless sequence_number.is_a?(Integer) && sequence_number >= 0
       raise ArgumentError, "Bad :time_bounds" unless time_bounds.is_a?(Stellar::TimeBounds) || time_bounds.nil?
       raise ArgumentError, "Bad :base_fee" unless base_fee.is_a?(Integer) && base_fee >= 100
 
-      @source_account = source_account
+      @source_account = Account(source_account)
       @sequence_number = sequence_number
       @base_fee = base_fee
       @time_bounds = time_bounds
+      @enable_muxed_accounts = enable_muxed_accounts
 
-      if time_bounds.nil?
-        set_timeout(0)
-      end
+      set_timeout(0) if time_bounds.nil?
 
       @memo = make_memo(memo)
       @operations = []
@@ -59,7 +60,7 @@ module Stellar
       end
 
       attrs = {
-        source_account: @source_account.muxed_account,
+        source_account: source_muxed_account,
         fee: @base_fee * @operations.length,
         seq_num: @sequence_number,
         time_bounds: @time_bounds,
@@ -90,7 +91,7 @@ module Stellar
       end
 
       Stellar::FeeBumpTransaction.new(
-        fee_source: @source_account.muxed_account,
+        fee_source: source_muxed_account,
         fee: @base_fee * (inner_ops.length + 1),
         inner_tx: Stellar::FeeBumpTransaction::InnerTx.new(:envelope_type_tx, inner_txe.v1!),
         ext: Stellar::FeeBumpTransaction::Ext.new(0)
@@ -162,5 +163,17 @@ module Stellar
         raise ArgumentError, "Bad :memo"
       end
     end
+
+    def source_muxed_account
+      if with_muxed_accounts?
+        @source_account.muxed_account
+      else
+        @source_account.base_account
+      end
+    end
+
+    def with_muxed_accounts?
+      @enable_muxed_accounts
+    end
   end
 end

data/lib/stellar/util/strkey.rb

@@ -8,7 +8,8 @@ module Stellar
         account_id: [6 << 3].pack("C"), # Base32-encodes to 'G...'
         seed: [18 << 3].pack("C"), # Base32-encodes to 'S...'
         pre_auth_tx: [19 << 3].pack("C"), # Base32-encodes to 'T...'
-        hash_x: [23 << 3].pack("C") # Base32-encodes to 'X...'
+        hash_x: [23 << 3].pack("C"), # Base32-encodes to 'X...'
+        muxed: [12 << 3].pack("C") # Base32-encodes to 'M...'
       }
 
       def self.check_encode(version, byte_str)
@@ -25,13 +26,11 @@ module Stellar
       # @param muxed_account [Stellar::MuxedAccount] account
       # @return [String] "G.."-like address
       def self.encode_muxed_account(muxed_account)
-        ed25519 = if muxed_account.switch == Stellar::CryptoKeyType.key_type_ed25519
-          muxed_account.ed25519!
+        if muxed_account.ed25519
+          check_encode(:account_id, muxed_account.ed25519)
         else
-          muxed_account.med25519!.ed25519
+          check_encode(:muxed, muxed_account.med25519!.ed25519 + [muxed_account.med25519!.id].pack("Q>"))
         end
-
-        check_encode(:account_id, ed25519)
       end
 
       # Returns a Stellar::MuxedAccount, forcing the ed25519 discriminant
@@ -39,7 +38,16 @@ module Stellar
       # @param strkey [String] address string to decode
       # @return [Stellar::MuxedAccount] MuxedAccount with ed25519 discriminant
       def self.decode_muxed_account(strkey)
-        Stellar::MuxedAccount.new(:key_type_ed25519, check_decode(:account_id, strkey))
+        case strkey
+        when /^G[0-9A-Z]{55}$/
+          ed25519 = check_decode(:account_id, strkey)
+          Stellar::MuxedAccount.ed25519(ed25519)
+        when /^M[0-9A-Z]{68}$/
+          payload = check_decode(:muxed, strkey)
+          Stellar::MuxedAccount.med25519(ed25519: payload[0, 32], id: payload[32, 8].unpack1("Q>"))
+        else
+          raise "cannot decode MuxedAccount from #{strkey}"
+        end
       end
 
       def self.check_decode(expected_version, str)

data/lib/stellar/version.rb

@@ -1,3 +1,3 @@
 module Stellar
-  VERSION = "0.27.0"
+  VERSION = "0.28.0"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: stellar-base
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Scott Fleckenstein
 - Sergey Nebolsin
 - Timur Ramazanov
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,7 +171,7 @@ dependencies:
 description: |
   The stellar-base library is the lowest-level stellar helper library. It consists of classes to read, write,
   hash, and sign the xdr structures that are used in stellar-core.
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -415,6 +415,7 @@ files:
 - generated/stellar/trust_line_flags.rb
 - generated/stellar/upgrade_entry_meta.rb
 - lib/stellar-base.rb
+- lib/stellar/account.rb
 - lib/stellar/account_flags.rb
 - lib/stellar/asset.rb
 - lib/stellar/base.rb
@@ -447,12 +448,12 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/astroband/ruby-stellar-sdk/issues
-  changelog_uri: https://github.com/astroband/ruby-stellar-sdk/blob/v0.27.0/base/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/stellar-base/0.27.0/
+  changelog_uri: https://github.com/astroband/ruby-stellar-sdk/blob/v0.28.0/base/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/stellar-base/0.28.0/
   github_repo: ssh://github.com/astroband/ruby-stellar-sdk
   homepage_uri: https://github.com/astroband/ruby-stellar-sdk/tree/main/base
-  source_code_uri: https://github.com/astroband/ruby-stellar-sdk/tree/v0.27.0/base
-post_install_message:
+  source_code_uri: https://github.com/astroband/ruby-stellar-sdk/tree/v0.28.0/base
+post_install_message: 
 rdoc_options: []
 require_paths:
 - generated
@@ -468,8 +469,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
 summary: 'Stellar client library: XDR'
 test_files: []