sigma_rb 0.1.3 → 0.1.4

data/lib/sigma/tx_builder.rb

@@ -3,6 +3,7 @@ require_relative './util.rb'
 require 'ffi-compiler/loader'
 
 module Sigma
+  # UnsignedTransaction builder
   class TxBuilder
     extend FFI::Library
     ffi_lib FFI::Compiler::Loader.find('csigma')
@@ -24,6 +25,14 @@ module Sigma
 
     attr_accessor :pointer
 
+    # Create new TxBuilder
+    # @param box_selection [BoxSelection] selected input boxes
+    # @param output_candidates [ErgoBoxCandidates] output boxes to be "created" in this transaction
+    # @param current_height [Integer] chain height that will be used in additionally created boxes (change, miner's fee, etc.)
+    # @param fee_amount [BoxValue] miner's fee
+    # @param change_address [Address] change (inputs - outputs) will be sent to this address
+    # @param min_change_value [BoxValue] minimal value of the change to be sent to `change_address`, value less than that will be given to miners
+    # @return [TxBuilder]
     def self.create(box_selection:, output_candidates:, current_height:, fee_amount:, change_address:, min_change_value:)
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_new(
@@ -38,26 +47,37 @@ module Sigma
       init(pointer)
     end
 
+    # Suggested transaction fee (semi-default value used across wallets and dApps as of Oct 2020) 
+    # @return [BoxValue]
     def self.suggested_tx_fee
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_suggested_tx_fee(pointer)
       Sigma::BoxValue.with_raw_pointer(pointer)
     end
 
+    # Set transaction's data inputs
+    # @param data_inputs [DataInputs]
     def set_data_inputs(data_inputs)
       ergo_lib_tx_builder_set_data_inputs(self.pointer, data_inputs.pointer)
     end
 
+    # Set context extension for given input
+    # @param box_id [BoxId]
+    # @param context_extension [ContextExension]
     def set_context_extension(box_id, context_extension)
       ergo_lib_tx_builder_set_context_extension(self.pointer, box_id.pointer, context_extension.pointer)
     end
 
+    # Get data inputs
+    # @return [DataInputs]
     def get_data_inputs
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_data_inputs(self.pointer, pointer)
       Sigma::DataInputs.with_raw_pointer(pointer)
     end
 
+    # Build the UnsignedTransaction
+    # @return [UnsignedTransaction]
     def build
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_tx_builder_build(self.pointer, pointer)
@@ -65,34 +85,46 @@ module Sigma
       Sigma::UnsignedTransaction.with_raw_pointer(pointer)
     end
 
+    # Get box selection
+    # @return [BoxSelection]
     def get_box_selection
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_box_selection(self.pointer, pointer)
       Sigma::BoxSelection.with_raw_pointer(pointer)
     end
 
+    # Get output candidates
+    # @return [ErgoBoxCandidates]
     def get_output_candidates
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_output_candidates(self.pointer, pointer)
       Sigma::ErgoBoxCandidates.with_raw_pointer(pointer)
     end
 
+    # Get current height
+    # @return [Integer]
     def get_current_height
       ergo_lib_tx_builder_current_height(self.pointer)
     end
 
+    # Get fee amount
+    # @return [BoxValue]
     def get_fee_amount
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_fee_amount(self.pointer, pointer)
       Sigma::BoxValue.with_raw_pointer(pointer)
     end
 
+    # Get change address
+    # @return [Address]
     def get_change_address
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_change_address(self.pointer, pointer)
       Sigma::Address.with_raw_pointer(pointer)
     end
 
+    # Get min change value
+    # @return [BoxValue]
     def get_min_change_value
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_tx_builder_min_change_value(self.pointer, pointer)

data/lib/sigma/wallet.rb

@@ -19,6 +19,11 @@ module Sigma
     attach_function :ergo_lib_wallet_add_secret, [:pointer, :pointer], :error_pointer
     attr_accessor :pointer
 
+    # Create Wallet instance loading secret key from mnemonic. Throws error if a DlogSecretKey cannot be
+    # parsed from the provided phrase
+    # @param mnemonic_phrase [String]
+    # @param mnemonic_pass [String]
+    # @return [Wallet]
     def self.create_from_mnemonic(mnemonic_phrase, mnemonic_pass)
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_wallet_from_mnemonic(mnemonic_phrase, mnemonic_pass, pointer)
@@ -26,17 +31,28 @@ module Sigma
       init(pointer)
     end
 
+    # Create Wallet from secrets
+    # @param secrets [SecretKeys]
+    # @return [Wallet]
     def self.create_from_secrets(secrets)
       pointer = FFI::MemoryPointer.new(:pointer)
       ergo_lib_wallet_from_secrets(secrets.pointer, pointer)
       init(pointer)
     end
 
+    # Add a secret to the wallet's prover
+    # @param secret [SecretKey]
     def add_secret(secret)
       error = ergo_lib_wallet_add_secret(self.pointer, secret.pointer)
       Util.check_error!(error)
     end
   
+    # Sign a transaction
+    # @param state_context: [ErgoStateContext]
+    # @param unsigned_tx: [UnsignedTransaction]
+    # @param boxes_to_spend: [ErgoBoxes]
+    # @param data_boxes: [ErgoBoxes]
+    # @return [Transaction]
     def sign_transaction(state_context:, unsigned_tx:, boxes_to_spend:, data_boxes:)
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_wallet_sign_transaction(self.pointer, state_context.pointer, unsigned_tx.pointer, boxes_to_spend.pointer, data_boxes.pointer, pointer)
@@ -44,6 +60,13 @@ module Sigma
       Sigma::Transaction.with_raw_pointer(pointer)
     end
 
+    # Sign a multi-signature transaction
+    # @param state_context: [ErgoStateContext]
+    # @param unsigned_tx: [UnsignedTransaction]
+    # @param boxes_to_spend: [ErgoBoxes]
+    # @param data_boxes: [ErgoBoxes]
+    # @param tx_hints: [TransactionHintsBag]
+    # @return [Transaction]
     def sign_transaction_multi(state_context:, unsigned_tx:, boxes_to_spend:, data_boxes:, tx_hints:)
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_wallet_sign_transaction_multi(self.pointer, state_context.pointer, unsigned_tx.pointer, boxes_to_spend.pointer, data_boxes.pointer, tx_hints.pointer, pointer)
@@ -51,6 +74,9 @@ module Sigma
       Sigma::Transaction.with_raw_pointer(pointer)
     end
 
+    # Signs a reduced transaction (generating proofs for inputs)
+    # @param reduced_tx [ReducedTransaction]
+    # @return [Transaction]
     def sign_reduced_transaction(reduced_tx)
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_wallet_sign_reduced_transaction(self.pointer, reduced_tx.pointer, pointer)
@@ -58,6 +84,10 @@ module Sigma
       Sigma::Transaction.with_raw_pointer(pointer)
     end
 
+    # Signs a multi signature reduced transaction
+    # @param reduced_tx [ReducedTransaction]
+    # @param tx_hints: [TransactionHintsBag]
+    # @return [Transaction]
     def sign_reduced_transaction_multi(reduced_tx:, tx_hints:)
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_wallet_sign_reduced_transaction_multi(self.pointer, reduced_tx.pointer, tx_hints.pointer, pointer)
@@ -65,6 +95,12 @@ module Sigma
       Sigma::Transaction.with_raw_pointer(pointer)
     end
 
+    # Generate Commitments for unsigned tx
+    # @param state_context: [ErgoStateContext]
+    # @param unsigned_tx: [UnsignedTransaction]
+    # @param boxes_to_spend: [ErgoBoxes]
+    # @param data_boxes: [ErgoBoxes]
+    # @return [TransactionHintsBag]
     def generate_commitments(state_context:, unsigned_tx:, boxes_to_spend:, data_boxes:)
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_wallet_generate_commitments(self.pointer, state_context.pointer, unsigned_tx.pointer, boxes_to_spend.pointer, data_boxes.pointer, pointer)
@@ -72,6 +108,9 @@ module Sigma
       Sigma::TransactionHintsBag.with_raw_pointer(pointer)
     end
 
+    # Generate Commitments for reduced transaction
+    # @param reduced_tx [ReducedTransaction]
+    # @return [TransactionHintsBag]
     def generate_commitments_for_reduced_transaction(reduced_tx)
       pointer = FFI::MemoryPointer.new(:pointer)
       error = ergo_lib_wallet_generate_commitments_for_reduced_transaction(self.pointer, reduced_tx.pointer, pointer)

data/sigma.gemspec

@@ -1,18 +1,19 @@
 Gem::Specification.new do |s|
   s.name        = 'sigma_rb'
-  s.version     = '0.1.3'
+  s.version     = '0.1.4'
   s.summary     = "Ruby bindings for Ergo types, abstractions, and interfaces provided by Sigma-Rust."
   s.description = "Ruby bindings for the Ergo-Lib crate of Sigma-Rust. Specifically for chain types and abstractions, json serialization, box selection for tx inputs, tx creation, and signing."
   s.authors     = ["Dark Lord of Programming"]
   s.email       = 'thedlop@sent.com'
   s.homepage    = 'https://github.com/thedlop/sigma_rb'
   s.license       = 'MIT'
-  s.files = Dir.glob("{lib}/**/*") 
+  s.files = Dir.glob("{lib}/**/*")
   s.files += %w(sigma.gemspec README.md LICENSE ext/Rakefile ext/csigma.c)
   s.add_dependency 'ffi-compiler', '1.0.1'
   s.add_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'ffi', '1.15.5'
   s.add_development_dependency 'test-unit', '~> 3.5'
+  s.add_development_dependency 'yard', '~> 0.6'
   s.extensions << "ext/Rakefile"
   s.test_files = Dir["tests/**/*.rb"]
   s.require_paths = ["lib"]

data/tests/sigma/ergo_tree_test.rb

@@ -11,9 +11,11 @@ class Sigma::ErgoTree::Test < Test::Unit::TestCase
     base_16 = "100204a00b08cd021dde34603426402615658f1d970cfa7c7bd92ac81a8b16eeebff264d59ce4604ea02d192a39a8cc7a70173007301"
     tree = Sigma::ErgoTree.from_base16_encoded_string(base_16)
     assert_equal(base_16, tree.to_base16_encoded_string)
-    assert_nothing_raised do
+    bytes = assert_nothing_raised do
       tree.to_bytes
     end
+    tree_from_bytes = Sigma::ErgoTree.from_bytes(bytes)
+    assert_equal(tree_from_bytes, tree)
     assert_nothing_raised do
       tree.to_template_bytes
     end

data/tests/sigma/merkle_proof_test.rb

@@ -1,7 +1,7 @@
-
 require 'rubygems'
 require 'bundler/setup'
 require 'test/unit'
+require 'json'
 
 require_relative '../../lib/sigma.rb'
 require_relative '../test_utils.rb'

data/tests/sigma/nipopow_test.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'test/unit'
+require 'json'
 
 require_relative '../../lib/sigma.rb'
 require_relative '../test_utils.rb'

data/tests/test_seeds.rb

@@ -1,4 +1,5 @@
 require_relative '../lib/sigma'
+require 'json'
 
 module TestSeeds
   def self.block_header_json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sigma_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Dark Lord of Programming
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-compiler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: Ruby bindings for the Ergo-Lib crate of Sigma-Rust. Specifically for
   chain types and abstractions, json serialization, box selection for tx inputs, tx
   creation, and signing.