Class: ScaleChain::TransactionController

Inherits:
Object
  • Object
show all
Defined in:
lib/scalechain/controllers/transaction_controller.rb

Instance Method Summary collapse

Instance Method Details

#get_raw_transaction_hex(hash, network) ⇒ Object

Returns the raw transaction hex data for a given transaction hash.

Parameters:

  • hash (String) —

    Required parameter: A transaction hash

  • network (String) —

    Required parameter: Blockchain network

Returns:

  • mixed response from the API call



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/scalechain/controllers/transaction_controller.rb', line 48

def get_raw_transaction_hex hash, network
  # the base uri for api requests
  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call
  query_builder << "/transactions/{hash}/hex"

  # process optional query parameters
  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "hash" => hash,
  }

  # validate and preprocess url
  query_url = APIHelper.clean_url query_builder

  # prepare headers
  headers = {
    "user-agent" => "APIMATIC 2.0",
    "accept" => "application/json",
    "Authorization" => "Bearer %s" % (Configuration.o_auth_access_token),
    "network" => network
  }

  # invoke the API call request to fetch the response
  response = Unirest.get query_url, headers:headers

  #Error handling using HTTP status codes
  if !(response.code.between?(200,206)) # [200,206] = HTTP OK
    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end

#get_transaction(hash, network) ⇒ Object

Returns details about a transaction, including inputs and outputs.

Parameters:

  • hash (String) —

    Required parameter: A transaction hash

  • network (String) —

    Required parameter: Blockchain network

Returns:

  • mixed response from the API call



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/scalechain/controllers/transaction_controller.rb', line 10

def get_transaction hash, network
  # the base uri for api requests
  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call
  query_builder << "/transactions/{hash}"

  # process optional query parameters
  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "hash" => hash,
  }

  # validate and preprocess url
  query_url = APIHelper.clean_url query_builder

  # prepare headers
  headers = {
    "user-agent" => "APIMATIC 2.0",
    "accept" => "application/json",
    "Authorization" => "Bearer %s" % (Configuration.o_auth_access_token),
    "network" => network
  }

  # invoke the API call request to fetch the response
  response = Unirest.get query_url, headers:headers

  #Error handling using HTTP status codes
  if !(response.code.between?(200,206)) # [200,206] = HTTP OK
    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end

#send_signed_transaction(signed_hex, network) ⇒ Object

Accepts a raw signed transaction in hex format and submits to the blockchain network and returns the transaction hash in hex.

Parameters:

  • network (String) —

    Required parameter: Blockchain network

  • signed_hex (String) —

    Required parameter: A signed transaction in hex format

Returns:

  • mixed response from the API call



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/scalechain/controllers/transaction_controller.rb', line 124

def send_signed_transaction signed_hex, network
  # the base uri for api requests
  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call
  query_builder << "/transactions/send"

  # validate and preprocess url
  query_url = APIHelper.clean_url query_builder

  # prepare headers
  headers = {
    "user-agent" => "APIMATIC 2.0",
    "accept" => "application/json",
    "Authorization" => "Bearer %s" % (Configuration.o_auth_access_token),
    "network" => network
  }

  # prepare parameters
  parameters = {
    "signed_hex" => signed_hex
  }

  # invoke the API call request to fetch the response
  response = Unirest.post query_url, headers:headers, parameters:parameters

  #Error handling using HTTP status codes
  if !(response.code.between?(200,206)) # [200,206] = HTTP OK
    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end

#sign_raw_transaction(unsigned_tx_hex, network) ⇒ Object

Returns a signed transaction in hex.

Parameters:

  • network (String) —

    Required parameter: Blockchain network

  • unsigned_tx_hex (String) —

    Required parameter: A raw transaction in hex

Returns:

  • mixed response from the API call



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/scalechain/controllers/transaction_controller.rb', line 86

def sign_raw_transaction unsigned_tx_hex, network
  # the base uri for api requests
  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call
  query_builder << "/transactions/sign"

  # validate and preprocess url
  query_url = APIHelper.clean_url query_builder

  # prepare headers
  headers = {
    "user-agent" => "APIMATIC 2.0",
    "accept" => "application/json",
    "Authorization" => "Bearer %s" % (Configuration.o_auth_access_token),
    "network" => network
  }

  # prepare parameters
  parameters = {
    "unsigned_tx_hex" => unsigned_tx_hex
  }

  # invoke the API call request to fetch the response
  response = Unirest.post query_url, headers:headers, parameters:parameters

  #Error handling using HTTP status codes
  if !(response.code.between?(200,206)) # [200,206] = HTTP OK
    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end