Class: Stellar::TransactionBuilder

Inherits:
Object
  • Object
show all
Includes:
DSL
Defined in:
lib/stellar/transaction_builder.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DSL

Account, Asset, ClaimPredicate, Claimant, KeyPair, SignerKey

Constructor Details

#initialize(source_account:, sequence_number:, base_fee: 100, time_bounds: nil, memo: nil, enable_muxed_accounts: false, **_) ⇒ TransactionBuilder

Returns a new instance of TransactionBuilder.

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/stellar/transaction_builder.rb', line 31

def initialize(
  source_account:,
  sequence_number:,
  base_fee: 100,
  time_bounds: nil,
  memo: nil,
  enable_muxed_accounts: false,
  **_ # ignore any additional parameters without errors
)
  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 = Account()
  @sequence_number = sequence_number
  @base_fee = base_fee
  @time_bounds = time_bounds
  @enable_muxed_accounts = enable_muxed_accounts

  set_timeout(0) if time_bounds.nil?

  @memo = make_memo(memo)
  @operations = []
end

Instance Attribute Details

#base_fee ⇒ Object (readonly)

Returns the value of attribute base_fee.



5
6
7
 
# File 'lib/stellar/transaction_builder.rb', line 5

def base_fee
  @base_fee
end

#memo ⇒ Object (readonly)

Returns the value of attribute memo.



5
6
7
 
# File 'lib/stellar/transaction_builder.rb', line 5

def memo
  @memo
end

#operations ⇒ Object (readonly)

Returns the value of attribute operations.



5
6
7
 
# File 'lib/stellar/transaction_builder.rb', line 5

def operations
  @operations
end

#sequence_number ⇒ Object (readonly)

Returns the value of attribute sequence_number.



5
6
7
 
# File 'lib/stellar/transaction_builder.rb', line 5

def sequence_number
  @sequence_number
end

#source_account ⇒ Object (readonly)

Returns the value of attribute source_account.



5
6
7
 
# File 'lib/stellar/transaction_builder.rb', line 5

def 
  @source_account
end

#time_bounds ⇒ Object (readonly)

Returns the value of attribute time_bounds.



5
6
7
 
# File 'lib/stellar/transaction_builder.rb', line 5

def time_bounds
  @time_bounds
end

Class Method Details

.method_missing(method_name, *args, **kwargs) ⇒ Object

This enable user to call shortcut methods, like TransactionBuilder.payment(…), TransactionBuilder.manage_data(…) and etc. It reduces the boilerplate, when you just need to shoot a single operation in transaction



13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/stellar/transaction_builder.rb', line 13

def method_missing(method_name, *args, **kwargs)
  return super unless Operation.respond_to?(method_name)

  op = Operation.send(
    method_name,
    **kwargs.except(
      :source_account, :sequence_number, :base_fee, :time_bounds, :memo, :enable_muxed_accounts
    )
  )

  new(**kwargs).add_operation(op).build
end

.respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/stellar/transaction_builder.rb', line 26

def respond_to_missing?(method_name, include_private = false)
  Stellar::Operation.respond_to?(method_name) || super
end

Instance Method Details

#add_operation(operation) ⇒ Object

Raises:

  • (ArgumentError) 


104
105
106
107
108
 
# File 'lib/stellar/transaction_builder.rb', line 104

def add_operation(operation)
  raise ArgumentError, "Bad operation" unless operation.is_a? Stellar::Operation
  @operations.push(operation)
  self
end

#build ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/stellar/transaction_builder.rb', line 56

def build
  if @time_bounds.nil?
    raise "TransactionBuilder.time_bounds must be set during initialization or by calling set_timeout"
  elsif !@time_bounds.min_time.is_a?(Integer) || !@time_bounds.max_time.is_a?(Integer)
    raise "TimeBounds.min_time and max_time must be Integers"
  elsif @time_bounds.max_time != 0 && @time_bounds.min_time > @time_bounds.max_time
    raise "Timebounds.max_time must be greater than min_time"
  end

  attrs = {
    source_account: ,
    fee: @base_fee * @operations.length,
    seq_num: @sequence_number,
    time_bounds: @time_bounds,
    memo: @memo,
    operations: @operations,
    ext: Stellar::Transaction::Ext.new(0)
  }

  @sequence_number += 1

  Stellar::Transaction.new(attrs)
end

#build_fee_bump(inner_txe:) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/stellar/transaction_builder.rb', line 80

def build_fee_bump(inner_txe:)
  if inner_txe.switch == Stellar::EnvelopeType.envelope_type_tx_v0
    inner_txe = Stellar::TransactionEnvelope.v1(tx: inner_txe.tx.to_v1, signatures: inner_txe.signatures)
  elsif inner_txe.switch != Stellar::EnvelopeType.envelope_type_tx
    raise ArgumentError, "Invalid inner transaction type #{inner_txe.switch}"
  end

  inner_tx = inner_txe.tx
  inner_ops = inner_tx.operations
  inner_base_fee_rate = inner_tx.fee.fdiv(inner_ops.length)

  # The fee rate for fee bump is at least the fee rate of the inner transaction
  if @base_fee < inner_base_fee_rate
    raise "Insufficient base_fee, it should be at least #{inner_base_fee_rate} stroops."
  end

  Stellar::FeeBumpTransaction.new(
    fee_source: ,
    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)
  )
end

#clear_operations ⇒ Object 



110
111
112
113
 
# File 'lib/stellar/transaction_builder.rb', line 110

def clear_operations
  @operations.clear
  self
end

#make_memo(memo) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/stellar/transaction_builder.rb', line 152

def make_memo(memo)
  case memo
  when Stellar::Memo
    memo
  when nil
    Memo.new(:memo_none)
  when Integer
    Memo.new(:memo_id, memo)
  when String
    Memo.new(:memo_text, memo)
  when Array
    t, val = *memo
    Memo.new(:"memo_#{t}", val)
  else
    raise ArgumentError, "Bad :memo"
  end
end

#set_base_fee(base_fee) ⇒ Object

Raises:

  • (ArgumentError) 


146
147
148
149
150
 
# File 'lib/stellar/transaction_builder.rb', line 146

def set_base_fee(base_fee)
  raise ArgumentError, "Bad base fee" unless base_fee.is_a?(Integer) && base_fee >= 100
  @base_fee = base_fee
  self
end

#set_memo(memo) ⇒ Object 



141
142
143
144
 
# File 'lib/stellar/transaction_builder.rb', line 141

def set_memo(memo)
  @memo = make_memo(memo)
  self
end

#set_sequence_number(seq_num) ⇒ Object

Raises:

  • (ArgumentError) 


121
122
123
124
125
 
# File 'lib/stellar/transaction_builder.rb', line 121

def set_sequence_number(seq_num)
  raise ArgumentError, "Bad sequence number" unless seq_num.is_a?(Integer) && seq_num >= 0
  @sequence_number = seq_num
  self
end

#set_source_account(account_kp) ⇒ Object

Raises:

  • (ArgumentError) 


115
116
117
118
119
 
# File 'lib/stellar/transaction_builder.rb', line 115

def ()
  raise ArgumentError, "Bad source account" unless .is_a?(Stellar::KeyPair)
  @source_account = 
  self
end

#set_timeout(timeout) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/stellar/transaction_builder.rb', line 127

def set_timeout(timeout)
  if !timeout.is_a?(Integer) || timeout < 0
    raise ArgumentError, "Timeout must be a non-negative integer"
  end

  if @time_bounds.nil?
    @time_bounds = Stellar::TimeBounds.new(min_time: 0, max_time: nil)
  end

  @time_bounds.max_time = timeout == 0 ? timeout : Time.now.to_i + timeout

  self
end

#source_muxed_account ⇒ Object 



170
171
172
173
174
175
176
 
# File 'lib/stellar/transaction_builder.rb', line 170

def 
  if with_muxed_accounts?
    @source_account.
  else
    @source_account.
  end
end

#with_muxed_accounts? ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/stellar/transaction_builder.rb', line 178

def with_muxed_accounts?
  @enable_muxed_accounts
end