digitalbits-base 0.27.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01d8ef68986ef49901cc412969186d4226d2c1d8f0eb25261bebba931a56c0cf
+  data.tar.gz: f2e2905199fcaa6860250d676a60b6a296f2d370571905f71ddb5406f7fc9ccb
+SHA512:
+  metadata.gz: 032a7799de807ba1df906b9078b3cd5b1403adf4921df5f693e536d161f86c6b180cd6bb3b81649060b5bf1c73abe224d4e8a481fa4b950bed9703d91b13ca2c
+  data.tar.gz: c5c109b2ecc3b7cabb803a2507809c2089fa56dd7c9325b674c0ece5f89a064fa915c3c1ecd509ca02cc62f89481651f1b8e292d910317643d6e3d901251007b

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 XDB Foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,84 @@
+# DigitalBits SDK for Ruby: XDR and Low Level Abstractions
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'digitalbits-base'
+```
+
+And then execute:
+
+    $ bundle
+
+Also requires libsodium. Installable via `brew install libsodium` on OS X.
+
+## Supported Ruby Versions
+
+Please see [CI Workflow](https://github.com/xdbfoundation/ruby-digitalbits-sdk/actions/workflows/ci.yml) for what versions of ruby are currently tested by our continuous integration system.  Any ruby in that list is officially supported.
+
+### JRuby
+
+It seems as though jruby is particularly slow when it comes to BigDecimal math; the source behind this slowness has not been investigated, but it is something to be aware of.
+
+## Usage
+
+[Examples are here](examples)
+
+In addition to the code generated from the XDR definition files, this library also provides some digitalbits specific features.  Let's look at some of them.
+
+We wrap rbnacl with `DigitalBits::KeyPair`, providing some digitalbits specific functionality as seen below:
+
+```ruby
+
+# Create a keypair from a digitalbits secret seed
+signer = DigitalBits::KeyPair.from_seed("SCBASSEX34FJNIPLUYQPSMZHHYXXQNWOOV42XYZFXM6EGYX2DPIZVIA3")
+
+# Create a keypair from a digitalbits address
+verifier = DigitalBits::KeyPair.from_address("GBQWWBFLRP3BXD2RI2FH7XNNU2MKIYVUI7QXUAIVG34JY6MQGXVUO3RX")
+
+# Produce a digitalbits compliant "decorated signature" that is compliant with digitalbits transactions
+
+signer.sign_decorated("Hello world!") # => #<DigitalBits::DecoratedSignature ...>
+
+```
+
+This library also provides an impementation of DigitalBits's "StrKey" encoding (RFC-4648 Base32 + CCITT-XModem CRC16):
+
+```ruby
+
+DigitalBits::Util::StrKey.check_encode(:account_id, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF") # => "GD777777777764TU"
+DigitalBits::Util::StrKey.check_encode(:seed, "\x00\x00\x00\x00\x00\x00\x39") # => "SAAAAAAAAAADST3H"
+
+# To prevent interpretation mistakes, you must pass the expected version byte
+# when decoding a check_encoded value
+
+encoded = DigitalBits::Util::StrCheck.check_encode(:account_id, "\x61\x6b\x04\xab\x8b\xf6\x1b")
+DigitalBits::Util::StrKey.check_decode(:account_id, encoded) # => "\x61\x6b\x04\xab\x8b\xf6\x1b"
+DigitalBits::Util::StrKey.check_decode(:seed, encoded) # => throws ArgumentError: Unexpected version: :account_id
+
+```
+
+During development of your app, you may include the [FactoryBot](https://github.com/thoughtbot/factory_bot) definitions in your specs:
+
+```ruby
+require "digitalbits-base/factories"
+```
+
+See the factories file for information on what factories are available.
+
+## Updating Generated Code
+
+The generated code of this library must be refreshed each time the DigitalBits network's protocol is updated.  To perform this task, run `rake xdr:update`, which will download the latest `.x` files into the `xdr` folder and will run `xdrgen` to regenerate the built ruby code.
+
+## Caveats
+
+The current integration of user-written code with auto-generated classes is to put it nicely, weird.  We intend to segregate the auto-generated code into its own namespace and refrain from monkey patching them.  This will happen before 1.0, and hopefully will happen soon.
+
+## Contributing
+
+Please [see CONTRIBUTING.md for details](../CONTRIBUTING.md).

data/generated/digitalbits-base-generated.rb

@@ -0,0 +1,228 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+module Digitalbits
+  include XDR::Namespace
+
+  Hash = XDR::Opaque[32]
+  Uint256 = XDR::Opaque[32]
+  Uint32 = XDR::UnsignedInt
+  Int32 = XDR::Int
+  Uint64 = XDR::UnsignedHyper
+  Int64 = XDR::Hyper
+  autoload :CryptoKeyType
+  autoload :PublicKeyType
+  autoload :SignerKeyType
+  autoload :PublicKey
+  autoload :SignerKey
+  Signature = XDR::VarOpaque[64]
+  SignatureHint = XDR::Opaque[4]
+  NodeID = PublicKey
+  autoload :Curve25519Secret
+  autoload :Curve25519Public
+  autoload :HmacSha256Key
+  autoload :HmacSha256Mac
+end
+module Digitalbits
+  include XDR::Namespace
+
+  AccountID = PublicKey
+  Thresholds = XDR::Opaque[4]
+  String32 = XDR::String[32]
+  String64 = XDR::String[64]
+  SequenceNumber = Int64
+  TimePoint = Uint64
+  DataValue = XDR::VarOpaque[64]
+  AssetCode4 = XDR::Opaque[4]
+  AssetCode12 = XDR::Opaque[12]
+  autoload :AssetType
+  autoload :Asset
+  autoload :Price
+  autoload :Liabilities
+  autoload :ThresholdIndexes
+  autoload :LedgerEntryType
+  autoload :Signer
+  autoload :AccountFlags
+  MASK_ACCOUNT_FLAGS = 0x7
+  MAX_SIGNERS = 20
+  SponsorshipDescriptor = XDR::Option[AccountID]
+  autoload :AccountEntryExtensionV2
+  autoload :AccountEntryExtensionV1
+  autoload :AccountEntry
+  autoload :TrustLineFlags
+  MASK_TRUSTLINE_FLAGS = 1
+  MASK_TRUSTLINE_FLAGS_V13 = 3
+  autoload :TrustLineEntry
+  autoload :OfferEntryFlags
+  MASK_OFFERENTRY_FLAGS = 1
+  autoload :OfferEntry
+  autoload :DataEntry
+  autoload :ClaimPredicateType
+  autoload :ClaimPredicate
+  autoload :ClaimantType
+  autoload :Claimant
+  autoload :ClaimableBalanceIDType
+  autoload :ClaimableBalanceID
+  autoload :ClaimableBalanceEntry
+  autoload :LedgerEntryExtensionV1
+  autoload :LedgerEntry
+  autoload :LedgerKey
+  autoload :EnvelopeType
+end
+module Digitalbits
+  include XDR::Namespace
+
+  autoload :MuxedAccount
+  autoload :DecoratedSignature
+  autoload :OperationType
+  autoload :CreateAccountOp
+  autoload :PaymentOp
+  autoload :PathPaymentStrictReceiveOp
+  autoload :PathPaymentStrictSendOp
+  autoload :ManageSellOfferOp
+  autoload :ManageBuyOfferOp
+  autoload :CreatePassiveSellOfferOp
+  autoload :SetOptionsOp
+  autoload :ChangeTrustOp
+  autoload :AllowTrustOp
+  autoload :ManageDataOp
+  autoload :BumpSequenceOp
+  autoload :CreateClaimableBalanceOp
+  autoload :ClaimClaimableBalanceOp
+  autoload :BeginSponsoringFutureReservesOp
+  autoload :RevokeSponsorshipType
+  autoload :RevokeSponsorshipOp
+  autoload :Operation
+  autoload :OperationID
+  autoload :MemoType
+  autoload :Memo
+  autoload :TimeBounds
+  MAX_OPS_PER_TX = 100
+  autoload :TransactionV0
+  autoload :TransactionV0Envelope
+  autoload :Transaction
+  autoload :TransactionV1Envelope
+  autoload :FeeBumpTransaction
+  autoload :FeeBumpTransactionEnvelope
+  autoload :TransactionEnvelope
+  autoload :TransactionSignaturePayload
+  autoload :ClaimOfferAtom
+  autoload :CreateAccountResultCode
+  autoload :CreateAccountResult
+  autoload :PaymentResultCode
+  autoload :PaymentResult
+  autoload :PathPaymentStrictReceiveResultCode
+  autoload :SimplePaymentResult
+  autoload :PathPaymentStrictReceiveResult
+  autoload :PathPaymentStrictSendResultCode
+  autoload :PathPaymentStrictSendResult
+  autoload :ManageSellOfferResultCode
+  autoload :ManageOfferEffect
+  autoload :ManageOfferSuccessResult
+  autoload :ManageSellOfferResult
+  autoload :ManageBuyOfferResultCode
+  autoload :ManageBuyOfferResult
+  autoload :SetOptionsResultCode
+  autoload :SetOptionsResult
+  autoload :ChangeTrustResultCode
+  autoload :ChangeTrustResult
+  autoload :AllowTrustResultCode
+  autoload :AllowTrustResult
+  autoload :AccountMergeResultCode
+  autoload :AccountMergeResult
+  autoload :InflationResultCode
+  autoload :InflationPayout
+  autoload :InflationResult
+  autoload :ManageDataResultCode
+  autoload :ManageDataResult
+  autoload :BumpSequenceResultCode
+  autoload :BumpSequenceResult
+  autoload :CreateClaimableBalanceResultCode
+  autoload :CreateClaimableBalanceResult
+  autoload :ClaimClaimableBalanceResultCode
+  autoload :ClaimClaimableBalanceResult
+  autoload :BeginSponsoringFutureReservesResultCode
+  autoload :BeginSponsoringFutureReservesResult
+  autoload :EndSponsoringFutureReservesResultCode
+  autoload :EndSponsoringFutureReservesResult
+  autoload :RevokeSponsorshipResultCode
+  autoload :RevokeSponsorshipResult
+  autoload :OperationResultCode
+  autoload :OperationResult
+  autoload :TransactionResultCode
+  autoload :InnerTransactionResult
+  autoload :InnerTransactionResultPair
+  autoload :TransactionResult
+end
+module Digitalbits
+  include XDR::Namespace
+
+  UpgradeType = XDR::VarOpaque[128]
+  autoload :DigitalBitsValueType
+  autoload :LedgerCloseValueSignature
+  autoload :DigitalBitsValue
+  autoload :LedgerHeader
+  autoload :LedgerUpgradeType
+  autoload :LedgerUpgrade
+  autoload :BucketEntryType
+  autoload :BucketMetadata
+  autoload :BucketEntry
+  autoload :TransactionSet
+  autoload :TransactionResultPair
+  autoload :TransactionResultSet
+  autoload :TransactionHistoryEntry
+  autoload :TransactionHistoryResultEntry
+  autoload :LedgerHeaderHistoryEntry
+  autoload :LedgerSCPMessages
+  autoload :SCPHistoryEntryV0
+  autoload :SCPHistoryEntry
+  autoload :LedgerEntryChangeType
+  autoload :LedgerEntryChange
+  LedgerEntryChanges = XDR::VarArray[LedgerEntryChange]
+  autoload :OperationMeta
+  autoload :TransactionMetaV1
+  autoload :TransactionMetaV2
+  autoload :TransactionMeta
+  autoload :TransactionResultMeta
+  autoload :UpgradeEntryMeta
+  autoload :LedgerCloseMetaV0
+  autoload :LedgerCloseMeta
+end
+module Digitalbits
+  include XDR::Namespace
+
+  autoload :ErrorCode
+  autoload :Error
+  autoload :AuthCert
+  autoload :Hello
+  autoload :Auth
+  autoload :IPAddrType
+  autoload :PeerAddress
+  autoload :MessageType
+  autoload :DontHave
+  autoload :SurveyMessageCommandType
+  autoload :SurveyRequestMessage
+  autoload :SignedSurveyRequestMessage
+  EncryptedBody = XDR::VarOpaque[64000]
+  autoload :SurveyResponseMessage
+  autoload :SignedSurveyResponseMessage
+  autoload :PeerStats
+  PeerStatList = XDR::VarArray[PeerStats, 25]
+  autoload :TopologyResponseBody
+  autoload :SurveyResponseBody
+  autoload :DigitalBitsMessage
+  autoload :AuthenticatedMessage
+end
+module Digitalbits
+  include XDR::Namespace
+
+  Value = XDR::VarOpaque[]
+  autoload :SCPBallot
+  autoload :SCPStatementType
+  autoload :SCPNomination
+  autoload :SCPStatement
+  autoload :SCPEnvelope
+  autoload :SCPQuorumSet
+end