digitalbits-base 0.27.1

data/lib/digitalbits/util/strkey.rb

@@ -0,0 +1,70 @@
+module DigitalBits
+  module Util
+    require "base32"
+    require "digest/crc16_xmodem"
+
+    class StrKey
+      VERSION_BYTES = {
+        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...'
+      }
+
+      def self.check_encode(version, byte_str)
+        version_byte = VERSION_BYTES[version]
+        raise ArgumentError, "Invalid version: #{version}" if version_byte.blank?
+        payload = version_byte + byte_str.dup.force_encoding("BINARY")
+        check = checksum(payload)
+        # TODO: sort out, is it 100% safe to remove padding
+        # SEP-23 says yes, but shit happens
+        Base32.encode(payload + check).tr("=", "")
+      end
+
+      # Converts an DigitalBits::MuxedAccount to its string representation, forcing the ed25519 representation.
+      # @param muxed_account [DigitalBits::MuxedAccount] account
+      # @return [String] "G.."-like address
+      def self.encode_muxed_account(muxed_account)
+        ed25519 = if muxed_account.switch == DigitalBits::CryptoKeyType.key_type_ed25519
+          muxed_account.ed25519!
+        else
+          muxed_account.med25519!.ed25519
+        end
+
+        check_encode(:account_id, ed25519)
+      end
+
+      # Returns a DigitalBits::MuxedAccount, forcing the ed25519 discriminant
+      #
+      # @param strkey [String] address string to decode
+      # @return [DigitalBits::MuxedAccount] MuxedAccount with ed25519 discriminant
+      def self.decode_muxed_account(strkey)
+        DigitalBits::MuxedAccount.new(:key_type_ed25519, check_decode(:account_id, strkey))
+      end
+
+      def self.check_decode(expected_version, str)
+        decoded = begin
+          Base32.decode(str)
+        rescue
+          raise ArgumentError, "Invalid base32 string"
+        end
+        version_byte = decoded[0]
+        payload = decoded[1...-2]
+        check = decoded[-2..-1]
+        version = VERSION_BYTES.key(version_byte)
+
+        raise ArgumentError, "invalid encoded string" if str != Base32.encode(decoded).tr("=", "")
+        raise ArgumentError, "Unexpected version: #{version.inspect}" if version != expected_version
+        raise ArgumentError, "Invalid checksum" if check != checksum(decoded[0...-2])
+        payload
+      end
+
+      # return the "XModem CRC16" (CCITT-like, but with 0-init and MSB first)
+      # packed into a string in little-endian order
+      def self.checksum(bytes)
+        crc = Digest::CRC16XModem.checksum(bytes)
+        [crc].pack("S<")
+      end
+    end
+  end
+end

data/lib/digitalbits/version.rb

@@ -0,0 +1,3 @@
+module DigitalBits
+  VERSION = "0.27.1"
+end

metadata

@@ -0,0 +1,459 @@
+--- !ruby/object:Gem::Specification
+name: digitalbits-base
+version: !ruby/object:Gem::Version
+  version: 0.27.1
+platform: ruby
+authors:
+- XDB Foundation
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: digest-crc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: xdr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |
+  The digitalbits-base library is the lowest-level digitalbits helper library. It consists of classes to read, write,
+  hash, and sign the xdr structures that are used in digitalbits-core.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- generated/digitalbits-base-generated.rb
+- generated/digitalbits/account_entry.rb
+- generated/digitalbits/account_entry/ext.rb
+- generated/digitalbits/account_entry_extension_v1.rb
+- generated/digitalbits/account_entry_extension_v1/ext.rb
+- generated/digitalbits/account_entry_extension_v2.rb
+- generated/digitalbits/account_entry_extension_v2/ext.rb
+- generated/digitalbits/account_flags.rb
+- generated/digitalbits/account_merge_result.rb
+- generated/digitalbits/account_merge_result_code.rb
+- generated/digitalbits/allow_trust_op.rb
+- generated/digitalbits/allow_trust_op/asset.rb
+- generated/digitalbits/allow_trust_result.rb
+- generated/digitalbits/allow_trust_result_code.rb
+- generated/digitalbits/asset.rb
+- generated/digitalbits/asset/alpha_num12.rb
+- generated/digitalbits/asset/alpha_num4.rb
+- generated/digitalbits/asset_type.rb
+- generated/digitalbits/auth.rb
+- generated/digitalbits/auth_cert.rb
+- generated/digitalbits/authenticated_message.rb
+- generated/digitalbits/authenticated_message/v0.rb
+- generated/digitalbits/begin_sponsoring_future_reserves_op.rb
+- generated/digitalbits/begin_sponsoring_future_reserves_result.rb
+- generated/digitalbits/begin_sponsoring_future_reserves_result_code.rb
+- generated/digitalbits/bucket_entry.rb
+- generated/digitalbits/bucket_entry_type.rb
+- generated/digitalbits/bucket_metadata.rb
+- generated/digitalbits/bucket_metadata/ext.rb
+- generated/digitalbits/bump_sequence_op.rb
+- generated/digitalbits/bump_sequence_result.rb
+- generated/digitalbits/bump_sequence_result_code.rb
+- generated/digitalbits/change_trust_op.rb
+- generated/digitalbits/change_trust_result.rb
+- generated/digitalbits/change_trust_result_code.rb
+- generated/digitalbits/claim_claimable_balance_op.rb
+- generated/digitalbits/claim_claimable_balance_result.rb
+- generated/digitalbits/claim_claimable_balance_result_code.rb
+- generated/digitalbits/claim_offer_atom.rb
+- generated/digitalbits/claim_predicate.rb
+- generated/digitalbits/claim_predicate_type.rb
+- generated/digitalbits/claimable_balance_entry.rb
+- generated/digitalbits/claimable_balance_entry/ext.rb
+- generated/digitalbits/claimable_balance_id.rb
+- generated/digitalbits/claimable_balance_id_type.rb
+- generated/digitalbits/claimant.rb
+- generated/digitalbits/claimant/v0.rb
+- generated/digitalbits/claimant_type.rb
+- generated/digitalbits/create_account_op.rb
+- generated/digitalbits/create_account_result.rb
+- generated/digitalbits/create_account_result_code.rb
+- generated/digitalbits/create_claimable_balance_op.rb
+- generated/digitalbits/create_claimable_balance_result.rb
+- generated/digitalbits/create_claimable_balance_result_code.rb
+- generated/digitalbits/create_passive_sell_offer_op.rb
+- generated/digitalbits/crypto_key_type.rb
+- generated/digitalbits/curve25519_public.rb
+- generated/digitalbits/curve25519_secret.rb
+- generated/digitalbits/data_entry.rb
+- generated/digitalbits/data_entry/ext.rb
+- generated/digitalbits/decorated_signature.rb
+- generated/digitalbits/digital_bits_message.rb
+- generated/digitalbits/digital_bits_value.rb
+- generated/digitalbits/digital_bits_value/ext.rb
+- generated/digitalbits/digital_bits_value_type.rb
+- generated/digitalbits/dont_have.rb
+- generated/digitalbits/end_sponsoring_future_reserves_result.rb
+- generated/digitalbits/end_sponsoring_future_reserves_result_code.rb
+- generated/digitalbits/envelope_type.rb
+- generated/digitalbits/error.rb
+- generated/digitalbits/error_code.rb
+- generated/digitalbits/fee_bump_transaction.rb
+- generated/digitalbits/fee_bump_transaction/ext.rb
+- generated/digitalbits/fee_bump_transaction/inner_tx.rb
+- generated/digitalbits/fee_bump_transaction_envelope.rb
+- generated/digitalbits/hello.rb
+- generated/digitalbits/hmac_sha256_key.rb
+- generated/digitalbits/hmac_sha256_mac.rb
+- generated/digitalbits/inflation_payout.rb
+- generated/digitalbits/inflation_result.rb
+- generated/digitalbits/inflation_result_code.rb
+- generated/digitalbits/inner_transaction_result.rb
+- generated/digitalbits/inner_transaction_result/ext.rb
+- generated/digitalbits/inner_transaction_result/result.rb
+- generated/digitalbits/inner_transaction_result_pair.rb
+- generated/digitalbits/ip_addr_type.rb
+- generated/digitalbits/ledger_close_meta.rb
+- generated/digitalbits/ledger_close_meta_v0.rb
+- generated/digitalbits/ledger_close_value_signature.rb
+- generated/digitalbits/ledger_entry.rb
+- generated/digitalbits/ledger_entry/data.rb
+- generated/digitalbits/ledger_entry/ext.rb
+- generated/digitalbits/ledger_entry_change.rb
+- generated/digitalbits/ledger_entry_change_type.rb
+- generated/digitalbits/ledger_entry_extension_v1.rb
+- generated/digitalbits/ledger_entry_extension_v1/ext.rb
+- generated/digitalbits/ledger_entry_type.rb
+- generated/digitalbits/ledger_header.rb
+- generated/digitalbits/ledger_header/ext.rb
+- generated/digitalbits/ledger_header_history_entry.rb
+- generated/digitalbits/ledger_header_history_entry/ext.rb
+- generated/digitalbits/ledger_key.rb
+- generated/digitalbits/ledger_key/account.rb
+- generated/digitalbits/ledger_key/claimable_balance.rb
+- generated/digitalbits/ledger_key/data.rb
+- generated/digitalbits/ledger_key/offer.rb
+- generated/digitalbits/ledger_key/trust_line.rb
+- generated/digitalbits/ledger_scp_messages.rb
+- generated/digitalbits/ledger_upgrade.rb
+- generated/digitalbits/ledger_upgrade_type.rb
+- generated/digitalbits/liabilities.rb
+- generated/digitalbits/manage_buy_offer_op.rb
+- generated/digitalbits/manage_buy_offer_result.rb
+- generated/digitalbits/manage_buy_offer_result_code.rb
+- generated/digitalbits/manage_data_op.rb
+- generated/digitalbits/manage_data_result.rb
+- generated/digitalbits/manage_data_result_code.rb
+- generated/digitalbits/manage_offer_effect.rb
+- generated/digitalbits/manage_offer_success_result.rb
+- generated/digitalbits/manage_offer_success_result/offer.rb
+- generated/digitalbits/manage_sell_offer_op.rb
+- generated/digitalbits/manage_sell_offer_result.rb
+- generated/digitalbits/manage_sell_offer_result_code.rb
+- generated/digitalbits/memo.rb
+- generated/digitalbits/memo_type.rb
+- generated/digitalbits/message_type.rb
+- generated/digitalbits/muxed_account.rb
+- generated/digitalbits/muxed_account/med25519.rb
+- generated/digitalbits/offer_entry.rb
+- generated/digitalbits/offer_entry/ext.rb
+- generated/digitalbits/offer_entry_flags.rb
+- generated/digitalbits/operation.rb
+- generated/digitalbits/operation/body.rb
+- generated/digitalbits/operation_id.rb
+- generated/digitalbits/operation_id/id.rb
+- generated/digitalbits/operation_meta.rb
+- generated/digitalbits/operation_result.rb
+- generated/digitalbits/operation_result/tr.rb
+- generated/digitalbits/operation_result_code.rb
+- generated/digitalbits/operation_type.rb
+- generated/digitalbits/path_payment_strict_receive_op.rb
+- generated/digitalbits/path_payment_strict_receive_result.rb
+- generated/digitalbits/path_payment_strict_receive_result/success.rb
+- generated/digitalbits/path_payment_strict_receive_result_code.rb
+- generated/digitalbits/path_payment_strict_send_op.rb
+- generated/digitalbits/path_payment_strict_send_result.rb
+- generated/digitalbits/path_payment_strict_send_result/success.rb
+- generated/digitalbits/path_payment_strict_send_result_code.rb
+- generated/digitalbits/payment_op.rb
+- generated/digitalbits/payment_result.rb
+- generated/digitalbits/payment_result_code.rb
+- generated/digitalbits/peer_address.rb
+- generated/digitalbits/peer_address/ip.rb
+- generated/digitalbits/peer_stats.rb
+- generated/digitalbits/price.rb
+- generated/digitalbits/public_key.rb
+- generated/digitalbits/public_key_type.rb
+- generated/digitalbits/revoke_sponsorship_op.rb
+- generated/digitalbits/revoke_sponsorship_op/signer.rb
+- generated/digitalbits/revoke_sponsorship_result.rb
+- generated/digitalbits/revoke_sponsorship_result_code.rb
+- generated/digitalbits/revoke_sponsorship_type.rb
+- generated/digitalbits/scp_ballot.rb
+- generated/digitalbits/scp_envelope.rb
+- generated/digitalbits/scp_history_entry.rb
+- generated/digitalbits/scp_history_entry_v0.rb
+- generated/digitalbits/scp_nomination.rb
+- generated/digitalbits/scp_quorum_set.rb
+- generated/digitalbits/scp_statement.rb
+- generated/digitalbits/scp_statement/pledges.rb
+- generated/digitalbits/scp_statement/pledges/confirm.rb
+- generated/digitalbits/scp_statement/pledges/externalize.rb
+- generated/digitalbits/scp_statement/pledges/prepare.rb
+- generated/digitalbits/scp_statement_type.rb
+- generated/digitalbits/set_options_op.rb
+- generated/digitalbits/set_options_result.rb
+- generated/digitalbits/set_options_result_code.rb
+- generated/digitalbits/signed_survey_request_message.rb
+- generated/digitalbits/signed_survey_response_message.rb
+- generated/digitalbits/signer.rb
+- generated/digitalbits/signer_key.rb
+- generated/digitalbits/signer_key_type.rb
+- generated/digitalbits/simple_payment_result.rb
+- generated/digitalbits/survey_message_command_type.rb
+- generated/digitalbits/survey_request_message.rb
+- generated/digitalbits/survey_response_body.rb
+- generated/digitalbits/survey_response_message.rb
+- generated/digitalbits/threshold_indexes.rb
+- generated/digitalbits/time_bounds.rb
+- generated/digitalbits/topology_response_body.rb
+- generated/digitalbits/transaction.rb
+- generated/digitalbits/transaction/ext.rb
+- generated/digitalbits/transaction_envelope.rb
+- generated/digitalbits/transaction_history_entry.rb
+- generated/digitalbits/transaction_history_entry/ext.rb
+- generated/digitalbits/transaction_history_result_entry.rb
+- generated/digitalbits/transaction_history_result_entry/ext.rb
+- generated/digitalbits/transaction_meta.rb
+- generated/digitalbits/transaction_meta_v1.rb
+- generated/digitalbits/transaction_meta_v2.rb
+- generated/digitalbits/transaction_result.rb
+- generated/digitalbits/transaction_result/ext.rb
+- generated/digitalbits/transaction_result/result.rb
+- generated/digitalbits/transaction_result_code.rb
+- generated/digitalbits/transaction_result_meta.rb
+- generated/digitalbits/transaction_result_pair.rb
+- generated/digitalbits/transaction_result_set.rb
+- generated/digitalbits/transaction_set.rb
+- generated/digitalbits/transaction_signature_payload.rb
+- generated/digitalbits/transaction_signature_payload/tagged_transaction.rb
+- generated/digitalbits/transaction_v0.rb
+- generated/digitalbits/transaction_v0/ext.rb
+- generated/digitalbits/transaction_v0_envelope.rb
+- generated/digitalbits/transaction_v1_envelope.rb
+- generated/digitalbits/trust_line_entry.rb
+- generated/digitalbits/trust_line_entry/ext.rb
+- generated/digitalbits/trust_line_entry/ext/v1.rb
+- generated/digitalbits/trust_line_entry/ext/v1/ext.rb
+- generated/digitalbits/trust_line_flags.rb
+- generated/digitalbits/upgrade_entry_meta.rb
+- lib/digitalbits-base.rb
+- lib/digitalbits/account_flags.rb
+- lib/digitalbits/asset.rb
+- lib/digitalbits/base.rb
+- lib/digitalbits/claim_predicate.rb
+- lib/digitalbits/compat.rb
+- lib/digitalbits/concerns/transaction.rb
+- lib/digitalbits/convert.rb
+- lib/digitalbits/dsl.rb
+- lib/digitalbits/ext/xdr.rb
+- lib/digitalbits/factories.rb
+- lib/digitalbits/fee_bump_transaction.rb
+- lib/digitalbits/key_pair.rb
+- lib/digitalbits/ledger_key.rb
+- lib/digitalbits/muxed_account.rb
+- lib/digitalbits/networks.rb
+- lib/digitalbits/operation.rb
+- lib/digitalbits/path_payment_strict_receive_result.rb
+- lib/digitalbits/price.rb
+- lib/digitalbits/signer_key.rb
+- lib/digitalbits/thresholds.rb
+- lib/digitalbits/transaction.rb
+- lib/digitalbits/transaction_builder.rb
+- lib/digitalbits/transaction_envelope.rb
+- lib/digitalbits/transaction_v0.rb
+- lib/digitalbits/trust_line_flags.rb
+- lib/digitalbits/util/strkey.rb
+- lib/digitalbits/version.rb
+homepage: https://github.com/xdbfoundation/ruby-digitalbits-sdk
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/xdbfoundation/ruby-digitalbits-sdk/issues
+  changelog_uri: https://github.com/xdbfoundation/ruby-digitalbits-sdk/blob/v0.27.1/base/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/digitalbits-base/0.27.1/
+  github_repo: ssh://github.com/xdbfoundation/ruby-digitalbits-sdk
+  homepage_uri: https://github.com/xdbfoundation/ruby-digitalbits-sdk/tree/main/base
+  source_code_uri: https://github.com/xdbfoundation/ruby-digitalbits-sdk/tree/v0.27.1/base
+post_install_message: 
+rdoc_options: []
+require_paths:
+- generated
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: 'DigitalBits client library: XDR'
+test_files: []