sky_api 0.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +190 -0
- data/Rakefile +10 -0
- data/docs/Address.md +17 -0
- data/docs/ApiV1PendingTxsTransaction.md +29 -0
- data/docs/ApiV1PendingTxsTransactionOutputs.md +23 -0
- data/docs/BlockSchema.md +21 -0
- data/docs/BlockSchemaBody.md +17 -0
- data/docs/BlockVerboseSchema.md +21 -0
- data/docs/BlockVerboseSchemaBody.md +17 -0
- data/docs/BlockVerboseSchemaHeader.md +31 -0
- data/docs/DefaultApi.md +2767 -0
- data/docs/InlineResponse200.md +17 -0
- data/docs/InlineResponse2001.md +17 -0
- data/docs/InlineResponse20010.md +25 -0
- data/docs/InlineResponse2002.md +29 -0
- data/docs/InlineResponse2003.md +17 -0
- data/docs/InlineResponse2004.md +17 -0
- data/docs/InlineResponse2005.md +21 -0
- data/docs/InlineResponse2006.md +17 -0
- data/docs/InlineResponse2007.md +17 -0
- data/docs/InlineResponse2008.md +17 -0
- data/docs/InlineResponse2008Data.md +17 -0
- data/docs/InlineResponse2009.md +17 -0
- data/docs/InlineResponseDefault.md +19 -0
- data/docs/NetworkConnectionSchema.md +41 -0
- data/docs/NetworkConnectionSchemaUnconfirmedVerifyTransaction.md +21 -0
- data/docs/Transaction.md +21 -0
- data/docs/TransactionEncoded.md +25 -0
- data/docs/TransactionEncodedS.md +21 -0
- data/docs/TransactionStatus.md +23 -0
- data/docs/TransactionTxn.md +31 -0
- data/docs/TransactionV2ParamsAddress.md +17 -0
- data/docs/TransactionV2ParamsAddressHoursSelection.md +17 -0
- data/docs/TransactionV2ParamsUnspent.md +23 -0
- data/docs/TransactionV2ParamsUnspentHoursSelection.md +21 -0
- data/docs/TransactionV2ParamsUnspentTo.md +19 -0
- data/docs/TransactionVerbose.md +21 -0
- data/docs/TransactionVerboseTxn.md +35 -0
- data/docs/TransactionVerboseTxnInputs.md +25 -0
- data/docs/TransactionVerifyRequest.md +19 -0
- data/docs/WalletTransactionRequest.md +25 -0
- data/docs/WalletTransactionRequestHoursSelection.md +21 -0
- data/docs/WalletTransactionRequestWallet.md +23 -0
- data/docs/WalletTransactionSignRequest.md +23 -0
- data/git_push.sh +55 -0
- data/lib/sky_api.rb +81 -0
- data/lib/sky_api/api/default_api.rb +3371 -0
- data/lib/sky_api/api_client.rb +387 -0
- data/lib/sky_api/api_error.rb +57 -0
- data/lib/sky_api/configuration.rb +259 -0
- data/lib/sky_api/models/address.rb +201 -0
- data/lib/sky_api/models/api_v1_pending_txs_transaction.rb +256 -0
- data/lib/sky_api/models/api_v1_pending_txs_transaction_outputs.rb +223 -0
- data/lib/sky_api/models/block_schema.rb +214 -0
- data/lib/sky_api/models/block_schema_body.rb +198 -0
- data/lib/sky_api/models/block_verbose_schema.rb +214 -0
- data/lib/sky_api/models/block_verbose_schema_body.rb +198 -0
- data/lib/sky_api/models/block_verbose_schema_header.rb +259 -0
- data/lib/sky_api/models/inline_response200.rb +196 -0
- data/lib/sky_api/models/inline_response2001.rb +198 -0
- data/lib/sky_api/models/inline_response20010.rb +232 -0
- data/lib/sky_api/models/inline_response2002.rb +261 -0
- data/lib/sky_api/models/inline_response2003.rb +196 -0
- data/lib/sky_api/models/inline_response2004.rb +198 -0
- data/lib/sky_api/models/inline_response2005.rb +217 -0
- data/lib/sky_api/models/inline_response2006.rb +198 -0
- data/lib/sky_api/models/inline_response2007.rb +196 -0
- data/lib/sky_api/models/inline_response2008.rb +196 -0
- data/lib/sky_api/models/inline_response2008_data.rb +196 -0
- data/lib/sky_api/models/inline_response2009.rb +196 -0
- data/lib/sky_api/models/inline_response_default.rb +205 -0
- data/lib/sky_api/models/network_connection_schema.rb +338 -0
- data/lib/sky_api/models/network_connection_schema_unconfirmed_verify_transaction.rb +215 -0
- data/lib/sky_api/models/transaction.rb +214 -0
- data/lib/sky_api/models/transaction_encoded.rb +232 -0
- data/lib/sky_api/models/transaction_encoded_s.rb +214 -0
- data/lib/sky_api/models/transaction_status.rb +225 -0
- data/lib/sky_api/models/transaction_txn.rb +266 -0
- data/lib/sky_api/models/transaction_v2_params_address.rb +196 -0
- data/lib/sky_api/models/transaction_v2_params_address_hours_selection.rb +196 -0
- data/lib/sky_api/models/transaction_v2_params_unspent.rb +227 -0
- data/lib/sky_api/models/transaction_v2_params_unspent_hours_selection.rb +214 -0
- data/lib/sky_api/models/transaction_v2_params_unspent_to.rb +205 -0
- data/lib/sky_api/models/transaction_verbose.rb +214 -0
- data/lib/sky_api/models/transaction_verbose_txn.rb +284 -0
- data/lib/sky_api/models/transaction_verbose_txn_inputs.rb +232 -0
- data/lib/sky_api/models/transaction_verify_request.rb +205 -0
- data/lib/sky_api/models/wallet_transaction_request.rb +234 -0
- data/lib/sky_api/models/wallet_transaction_request_hours_selection.rb +214 -0
- data/lib/sky_api/models/wallet_transaction_request_wallet.rb +227 -0
- data/lib/sky_api/models/wallet_transaction_sign_request.rb +225 -0
- data/lib/sky_api/version.rb +15 -0
- data/sky_api.gemspec +45 -0
- data/spec/api/default_api_spec.rb +652 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/address_spec.rb +41 -0
- data/spec/models/api_v1_pending_txs_transaction_outputs_spec.rb +59 -0
- data/spec/models/api_v1_pending_txs_transaction_spec.rb +77 -0
- data/spec/models/block_schema_body_spec.rb +41 -0
- data/spec/models/block_schema_spec.rb +53 -0
- data/spec/models/block_verbose_schema_body_spec.rb +41 -0
- data/spec/models/block_verbose_schema_header_spec.rb +83 -0
- data/spec/models/block_verbose_schema_spec.rb +53 -0
- data/spec/models/inline_response20010_spec.rb +65 -0
- data/spec/models/inline_response2001_spec.rb +41 -0
- data/spec/models/inline_response2002_spec.rb +77 -0
- data/spec/models/inline_response2003_spec.rb +41 -0
- data/spec/models/inline_response2004_spec.rb +41 -0
- data/spec/models/inline_response2005_spec.rb +53 -0
- data/spec/models/inline_response2006_spec.rb +41 -0
- data/spec/models/inline_response2007_spec.rb +41 -0
- data/spec/models/inline_response2008_data_spec.rb +41 -0
- data/spec/models/inline_response2008_spec.rb +41 -0
- data/spec/models/inline_response2009_spec.rb +41 -0
- data/spec/models/inline_response200_spec.rb +41 -0
- data/spec/models/inline_response_default_spec.rb +47 -0
- data/spec/models/network_connection_schema_spec.rb +117 -0
- data/spec/models/network_connection_schema_unconfirmed_verify_transaction_spec.rb +53 -0
- data/spec/models/transaction_encoded_s_spec.rb +53 -0
- data/spec/models/transaction_encoded_spec.rb +65 -0
- data/spec/models/transaction_spec.rb +53 -0
- data/spec/models/transaction_status_spec.rb +59 -0
- data/spec/models/transaction_txn_spec.rb +83 -0
- data/spec/models/transaction_v2_params_address_hours_selection_spec.rb +41 -0
- data/spec/models/transaction_v2_params_address_spec.rb +41 -0
- data/spec/models/transaction_v2_params_unspent_hours_selection_spec.rb +53 -0
- data/spec/models/transaction_v2_params_unspent_spec.rb +59 -0
- data/spec/models/transaction_v2_params_unspent_to_spec.rb +47 -0
- data/spec/models/transaction_verbose_spec.rb +53 -0
- data/spec/models/transaction_verbose_txn_inputs_spec.rb +65 -0
- data/spec/models/transaction_verbose_txn_spec.rb +95 -0
- data/spec/models/transaction_verify_request_spec.rb +47 -0
- data/spec/models/wallet_transaction_request_hours_selection_spec.rb +53 -0
- data/spec/models/wallet_transaction_request_spec.rb +65 -0
- data/spec/models/wallet_transaction_request_wallet_spec.rb +59 -0
- data/spec/models/wallet_transaction_sign_request_spec.rb +59 -0
- data/spec/spec_helper.rb +111 -0
- metadata +407 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ebb3f8a26e6b72a05e8708818cd999de7a454646ad5c3a6ad76d4006c24e6aef
|
4
|
+
data.tar.gz: 2f1745f84dd678441b2040b40a2aa256185b427d06f7ab23a1d5051af2d9dfbc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 3e7f7f84b4a22fc65cbac810f65d2aba602a731d196a9b249a77fcf1657d5f9dcfe33491463836269f4edc9c3e3e6db5f069702654377d561458282606f7f649
|
7
|
+
data.tar.gz: 67abfcec53a068f9b56d774b8149e8d860ed3c915c72abc979747e796551714637ef9fb93588c98ef246a95210d4dd232be65c384dc0f64416578a08712b3ad0
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,190 @@
|
|
1
|
+
# sky_api
|
2
|
+
|
3
|
+
SkyApi - the Ruby gem for the Skycoin REST API.
|
4
|
+
|
5
|
+
Skycoin is a next-generation cryptocurrency.
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 0.26.0
|
10
|
+
- Package version: 0.26.0
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://skycoin.net](https://skycoin.net)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build sky_api.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./sky_api-0.26.0.gem
|
28
|
+
```
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./sky_api-0.26.0.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'sky_api', '~> 0.26.0'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'sky_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Load the gem
|
58
|
+
require 'sky_api'
|
59
|
+
|
60
|
+
api_instance = SkyApi::DefaultApi.new
|
61
|
+
|
62
|
+
begin
|
63
|
+
#Returns the total number of unique address that have coins.
|
64
|
+
result = api_instance.address_count
|
65
|
+
p result
|
66
|
+
rescue SkyApi::ApiError => e
|
67
|
+
puts "Exception when calling DefaultApi->address_count: #{e}"
|
68
|
+
end
|
69
|
+
|
70
|
+
```
|
71
|
+
|
72
|
+
## Documentation for API Endpoints
|
73
|
+
|
74
|
+
All URIs are relative to *http://127.0.0.1:6420*
|
75
|
+
|
76
|
+
Class | Method | HTTP request | Description
|
77
|
+
------------ | ------------- | ------------- | -------------
|
78
|
+
*SkyApi::DefaultApi* | [**address_count**](docs/DefaultApi.md#address_count) | **GET** /api/v1/addresscount | Returns the total number of unique address that have coins.
|
79
|
+
*SkyApi::DefaultApi* | [**address_uxouts**](docs/DefaultApi.md#address_uxouts) | **GET** /api/v1/address_uxouts |
|
80
|
+
*SkyApi::DefaultApi* | [**api_v1_rawtx_get**](docs/DefaultApi.md#api_v1_rawtx_get) | **GET** /api/v1/rawtx |
|
81
|
+
*SkyApi::DefaultApi* | [**api_v2_metrics_get**](docs/DefaultApi.md#api_v2_metrics_get) | **GET** /api/v2/metrics |
|
82
|
+
*SkyApi::DefaultApi* | [**balance_get**](docs/DefaultApi.md#balance_get) | **GET** /api/v1/balance | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
83
|
+
*SkyApi::DefaultApi* | [**balance_post**](docs/DefaultApi.md#balance_post) | **POST** /api/v1/balance | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
84
|
+
*SkyApi::DefaultApi* | [**block**](docs/DefaultApi.md#block) | **GET** /api/v1/block | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
85
|
+
*SkyApi::DefaultApi* | [**blockchain_metadata**](docs/DefaultApi.md#blockchain_metadata) | **GET** /api/v1/blockchain/metadata | Returns the blockchain metadata.
|
86
|
+
*SkyApi::DefaultApi* | [**blockchain_progress**](docs/DefaultApi.md#blockchain_progress) | **GET** /api/v1/blockchain/progress | Returns the blockchain sync progress.
|
87
|
+
*SkyApi::DefaultApi* | [**blocks**](docs/DefaultApi.md#blocks) | **GET** /api/v1/blocks | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
88
|
+
*SkyApi::DefaultApi* | [**coin_supply**](docs/DefaultApi.md#coin_supply) | **GET** /api/v1/coinSupply |
|
89
|
+
*SkyApi::DefaultApi* | [**csrf**](docs/DefaultApi.md#csrf) | **GET** /api/v1/csrf | Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
|
90
|
+
*SkyApi::DefaultApi* | [**data_delete**](docs/DefaultApi.md#data_delete) | **DELETE** /api/v2/data |
|
91
|
+
*SkyApi::DefaultApi* | [**data_get**](docs/DefaultApi.md#data_get) | **GET** /api/v2/data |
|
92
|
+
*SkyApi::DefaultApi* | [**data_post**](docs/DefaultApi.md#data_post) | **POST** /api/v2/data |
|
93
|
+
*SkyApi::DefaultApi* | [**default_connections**](docs/DefaultApi.md#default_connections) | **GET** /api/v1/network/defaultConnections | defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\\n They are not necessarily connected to.
|
94
|
+
*SkyApi::DefaultApi* | [**health**](docs/DefaultApi.md#health) | **GET** /api/v1/health | Returns node health data.
|
95
|
+
*SkyApi::DefaultApi* | [**last_blocks**](docs/DefaultApi.md#last_blocks) | **GET** /api/v1/last_blocks |
|
96
|
+
*SkyApi::DefaultApi* | [**network_connection**](docs/DefaultApi.md#network_connection) | **GET** /api/v1/network/connection | This endpoint returns a specific connection.
|
97
|
+
*SkyApi::DefaultApi* | [**network_connections**](docs/DefaultApi.md#network_connections) | **GET** /api/v1/network/connections | This endpoint returns all outgoings connections.
|
98
|
+
*SkyApi::DefaultApi* | [**network_connections_disconnect**](docs/DefaultApi.md#network_connections_disconnect) | **POST** /api/v1/network/connection/disconnect |
|
99
|
+
*SkyApi::DefaultApi* | [**network_connections_exchange**](docs/DefaultApi.md#network_connections_exchange) | **GET** /api/v1/network/connections/exchange |
|
100
|
+
*SkyApi::DefaultApi* | [**network_connections_trust**](docs/DefaultApi.md#network_connections_trust) | **GET** /api/v1/network/connections/trust | trustConnectionsHandler returns all trusted connections.\\n They are not necessarily connected to. In the default configuration, these will be a subset of the default hardcoded bootstrap addresses.
|
101
|
+
*SkyApi::DefaultApi* | [**outputs_get**](docs/DefaultApi.md#outputs_get) | **GET** /api/v1/outputs | If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
102
|
+
*SkyApi::DefaultApi* | [**outputs_post**](docs/DefaultApi.md#outputs_post) | **POST** /api/v1/outputs | If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
103
|
+
*SkyApi::DefaultApi* | [**pending_txs**](docs/DefaultApi.md#pending_txs) | **GET** /api/v1/pendingTxs |
|
104
|
+
*SkyApi::DefaultApi* | [**resend_unconfirmed_txns**](docs/DefaultApi.md#resend_unconfirmed_txns) | **POST** /api/v1/resendUnconfirmedTxns |
|
105
|
+
*SkyApi::DefaultApi* | [**richlist**](docs/DefaultApi.md#richlist) | **GET** /api/v1/richlist | Returns the top skycoin holders.
|
106
|
+
*SkyApi::DefaultApi* | [**transaction**](docs/DefaultApi.md#transaction) | **GET** /api/v1/transaction |
|
107
|
+
*SkyApi::DefaultApi* | [**transaction_inject**](docs/DefaultApi.md#transaction_inject) | **POST** /api/v1/injectTransaction | Broadcast a hex-encoded, serialized transaction to the network.
|
108
|
+
*SkyApi::DefaultApi* | [**transaction_post**](docs/DefaultApi.md#transaction_post) | **POST** /api/v2/transaction |
|
109
|
+
*SkyApi::DefaultApi* | [**transaction_post_unspent**](docs/DefaultApi.md#transaction_post_unspent) | **POST** /api/v2/transaction/unspent |
|
110
|
+
*SkyApi::DefaultApi* | [**transaction_raw**](docs/DefaultApi.md#transaction_raw) | **GET** /api/v2/transaction/raw | Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
|
111
|
+
*SkyApi::DefaultApi* | [**transaction_verify**](docs/DefaultApi.md#transaction_verify) | **POST** /api/v2/transaction/verify |
|
112
|
+
*SkyApi::DefaultApi* | [**transactions_get**](docs/DefaultApi.md#transactions_get) | **GET** /api/v1/transactions | Returns transactions that match the filters.
|
113
|
+
*SkyApi::DefaultApi* | [**transactions_post**](docs/DefaultApi.md#transactions_post) | **POST** /api/v1/transactions | Returns transactions that match the filters.
|
114
|
+
*SkyApi::DefaultApi* | [**uxout**](docs/DefaultApi.md#uxout) | **GET** /api/v1/uxout | Returns an unspent output by ID.
|
115
|
+
*SkyApi::DefaultApi* | [**verify_address**](docs/DefaultApi.md#verify_address) | **POST** /api/v2/address/verify | Verifies a Skycoin address.
|
116
|
+
*SkyApi::DefaultApi* | [**version**](docs/DefaultApi.md#version) | **GET** /api/v1/version |
|
117
|
+
*SkyApi::DefaultApi* | [**wallet**](docs/DefaultApi.md#wallet) | **GET** /api/v1/wallet | Returns a wallet by id.
|
118
|
+
*SkyApi::DefaultApi* | [**wallet_balance**](docs/DefaultApi.md#wallet_balance) | **GET** /api/v1/wallet/balance | Returns the wallet's balance, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
119
|
+
*SkyApi::DefaultApi* | [**wallet_create**](docs/DefaultApi.md#wallet_create) | **POST** /api/v1/wallet/create |
|
120
|
+
*SkyApi::DefaultApi* | [**wallet_decrypt**](docs/DefaultApi.md#wallet_decrypt) | **POST** /api/v1/wallet/decrypt | Decrypts wallet.
|
121
|
+
*SkyApi::DefaultApi* | [**wallet_encrypt**](docs/DefaultApi.md#wallet_encrypt) | **POST** /api/v1/wallet/encrypt | Encrypt wallet.
|
122
|
+
*SkyApi::DefaultApi* | [**wallet_folder**](docs/DefaultApi.md#wallet_folder) | **GET** /api/v1/wallets/folderName |
|
123
|
+
*SkyApi::DefaultApi* | [**wallet_new_address**](docs/DefaultApi.md#wallet_new_address) | **POST** /api/v1/wallet/newAddress |
|
124
|
+
*SkyApi::DefaultApi* | [**wallet_new_seed**](docs/DefaultApi.md#wallet_new_seed) | **GET** /api/v1/wallet/newSeed |
|
125
|
+
*SkyApi::DefaultApi* | [**wallet_recover**](docs/DefaultApi.md#wallet_recover) | **POST** /api/v2/wallet/recover | Recovers an encrypted wallet by providing the seed. The first address will be generated from seed and compared to the first address of the specified wallet. If they match, the wallet will be regenerated with an optional password. If the wallet is not encrypted, an error is returned.
|
126
|
+
*SkyApi::DefaultApi* | [**wallet_seed**](docs/DefaultApi.md#wallet_seed) | **POST** /api/v1/wallet/seed | This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
|
127
|
+
*SkyApi::DefaultApi* | [**wallet_seed_verify**](docs/DefaultApi.md#wallet_seed_verify) | **POST** /api/v2/wallet/seed/verify | Verifies a wallet seed.
|
128
|
+
*SkyApi::DefaultApi* | [**wallet_transaction**](docs/DefaultApi.md#wallet_transaction) | **POST** /api/v1/wallet/transaction | Creates a signed transaction
|
129
|
+
*SkyApi::DefaultApi* | [**wallet_transaction_sign**](docs/DefaultApi.md#wallet_transaction_sign) | **POST** /api/v2/wallet/transaction/sign | Creates a signed transaction
|
130
|
+
*SkyApi::DefaultApi* | [**wallet_transactions**](docs/DefaultApi.md#wallet_transactions) | **GET** /api/v1/wallet/transactions |
|
131
|
+
*SkyApi::DefaultApi* | [**wallet_unload**](docs/DefaultApi.md#wallet_unload) | **POST** /api/v1/wallet/unload | Unloads wallet from the wallet service.
|
132
|
+
*SkyApi::DefaultApi* | [**wallet_update**](docs/DefaultApi.md#wallet_update) | **POST** /api/v1/wallet/update | Update the wallet.
|
133
|
+
*SkyApi::DefaultApi* | [**wallets**](docs/DefaultApi.md#wallets) | **GET** /api/v1/wallets |
|
134
|
+
|
135
|
+
|
136
|
+
## Documentation for Models
|
137
|
+
|
138
|
+
- [SkyApi::Address](docs/Address.md)
|
139
|
+
- [SkyApi::ApiV1PendingTxsTransaction](docs/ApiV1PendingTxsTransaction.md)
|
140
|
+
- [SkyApi::ApiV1PendingTxsTransactionOutputs](docs/ApiV1PendingTxsTransactionOutputs.md)
|
141
|
+
- [SkyApi::BlockSchema](docs/BlockSchema.md)
|
142
|
+
- [SkyApi::BlockSchemaBody](docs/BlockSchemaBody.md)
|
143
|
+
- [SkyApi::BlockVerboseSchema](docs/BlockVerboseSchema.md)
|
144
|
+
- [SkyApi::BlockVerboseSchemaBody](docs/BlockVerboseSchemaBody.md)
|
145
|
+
- [SkyApi::BlockVerboseSchemaHeader](docs/BlockVerboseSchemaHeader.md)
|
146
|
+
- [SkyApi::InlineResponse200](docs/InlineResponse200.md)
|
147
|
+
- [SkyApi::InlineResponse2001](docs/InlineResponse2001.md)
|
148
|
+
- [SkyApi::InlineResponse20010](docs/InlineResponse20010.md)
|
149
|
+
- [SkyApi::InlineResponse2002](docs/InlineResponse2002.md)
|
150
|
+
- [SkyApi::InlineResponse2003](docs/InlineResponse2003.md)
|
151
|
+
- [SkyApi::InlineResponse2004](docs/InlineResponse2004.md)
|
152
|
+
- [SkyApi::InlineResponse2005](docs/InlineResponse2005.md)
|
153
|
+
- [SkyApi::InlineResponse2006](docs/InlineResponse2006.md)
|
154
|
+
- [SkyApi::InlineResponse2007](docs/InlineResponse2007.md)
|
155
|
+
- [SkyApi::InlineResponse2008](docs/InlineResponse2008.md)
|
156
|
+
- [SkyApi::InlineResponse2008Data](docs/InlineResponse2008Data.md)
|
157
|
+
- [SkyApi::InlineResponse2009](docs/InlineResponse2009.md)
|
158
|
+
- [SkyApi::InlineResponseDefault](docs/InlineResponseDefault.md)
|
159
|
+
- [SkyApi::NetworkConnectionSchema](docs/NetworkConnectionSchema.md)
|
160
|
+
- [SkyApi::NetworkConnectionSchemaUnconfirmedVerifyTransaction](docs/NetworkConnectionSchemaUnconfirmedVerifyTransaction.md)
|
161
|
+
- [SkyApi::Transaction](docs/Transaction.md)
|
162
|
+
- [SkyApi::TransactionEncoded](docs/TransactionEncoded.md)
|
163
|
+
- [SkyApi::TransactionEncodedS](docs/TransactionEncodedS.md)
|
164
|
+
- [SkyApi::TransactionStatus](docs/TransactionStatus.md)
|
165
|
+
- [SkyApi::TransactionTxn](docs/TransactionTxn.md)
|
166
|
+
- [SkyApi::TransactionV2ParamsAddress](docs/TransactionV2ParamsAddress.md)
|
167
|
+
- [SkyApi::TransactionV2ParamsAddressHoursSelection](docs/TransactionV2ParamsAddressHoursSelection.md)
|
168
|
+
- [SkyApi::TransactionV2ParamsUnspent](docs/TransactionV2ParamsUnspent.md)
|
169
|
+
- [SkyApi::TransactionV2ParamsUnspentHoursSelection](docs/TransactionV2ParamsUnspentHoursSelection.md)
|
170
|
+
- [SkyApi::TransactionV2ParamsUnspentTo](docs/TransactionV2ParamsUnspentTo.md)
|
171
|
+
- [SkyApi::TransactionVerbose](docs/TransactionVerbose.md)
|
172
|
+
- [SkyApi::TransactionVerboseTxn](docs/TransactionVerboseTxn.md)
|
173
|
+
- [SkyApi::TransactionVerboseTxnInputs](docs/TransactionVerboseTxnInputs.md)
|
174
|
+
- [SkyApi::TransactionVerifyRequest](docs/TransactionVerifyRequest.md)
|
175
|
+
- [SkyApi::WalletTransactionRequest](docs/WalletTransactionRequest.md)
|
176
|
+
- [SkyApi::WalletTransactionRequestHoursSelection](docs/WalletTransactionRequestHoursSelection.md)
|
177
|
+
- [SkyApi::WalletTransactionRequestWallet](docs/WalletTransactionRequestWallet.md)
|
178
|
+
- [SkyApi::WalletTransactionSignRequest](docs/WalletTransactionSignRequest.md)
|
179
|
+
|
180
|
+
|
181
|
+
## Documentation for Authorization
|
182
|
+
|
183
|
+
|
184
|
+
### csrfAuth
|
185
|
+
|
186
|
+
|
187
|
+
- **Type**: API key
|
188
|
+
- **API key parameter name**: X-CSRF-TOKEN
|
189
|
+
- **Location**: HTTP header
|
190
|
+
|
data/Rakefile
ADDED
data/docs/Address.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# SkyApi::Address
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**address** | **String** | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SkyApi'
|
13
|
+
|
14
|
+
instance = SkyApi::Address.new(address: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# SkyApi::ApiV1PendingTxsTransaction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**length** | **Integer** | | [optional]
|
8
|
+
**type** | **Integer** | | [optional]
|
9
|
+
**txid** | **String** | | [optional]
|
10
|
+
**inner_hash** | **String** | | [optional]
|
11
|
+
**sigs** | **Array<String>** | | [optional]
|
12
|
+
**inputs** | **Array<String>** | | [optional]
|
13
|
+
**outputs** | [**Array<ApiV1PendingTxsTransactionOutputs>**](ApiV1PendingTxsTransactionOutputs.md) | | [optional]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'SkyApi'
|
19
|
+
|
20
|
+
instance = SkyApi::ApiV1PendingTxsTransaction.new(length: null,
|
21
|
+
type: null,
|
22
|
+
txid: null,
|
23
|
+
inner_hash: null,
|
24
|
+
sigs: null,
|
25
|
+
inputs: null,
|
26
|
+
outputs: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# SkyApi::ApiV1PendingTxsTransactionOutputs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**uxid** | **String** | | [optional]
|
8
|
+
**dst** | **String** | | [optional]
|
9
|
+
**coins** | **String** | | [optional]
|
10
|
+
**hours** | **Integer** | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'SkyApi'
|
16
|
+
|
17
|
+
instance = SkyApi::ApiV1PendingTxsTransactionOutputs.new(uxid: null,
|
18
|
+
dst: null,
|
19
|
+
coins: null,
|
20
|
+
hours: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/BlockSchema.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# SkyApi::BlockSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**header** | [**BlockVerboseSchemaHeader**](BlockVerboseSchemaHeader.md) | | [optional]
|
8
|
+
**body** | [**BlockSchemaBody**](BlockSchemaBody.md) | | [optional]
|
9
|
+
**size** | **Integer** | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'SkyApi'
|
15
|
+
|
16
|
+
instance = SkyApi::BlockSchema.new(header: null,
|
17
|
+
body: null,
|
18
|
+
size: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SkyApi::BlockSchemaBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**txns** | **Array<Object>** | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SkyApi'
|
13
|
+
|
14
|
+
instance = SkyApi::BlockSchemaBody.new(txns: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# SkyApi::BlockVerboseSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**header** | [**BlockVerboseSchemaHeader**](BlockVerboseSchemaHeader.md) | | [optional]
|
8
|
+
**body** | [**BlockVerboseSchemaBody**](BlockVerboseSchemaBody.md) | | [optional]
|
9
|
+
**size** | **Integer** | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'SkyApi'
|
15
|
+
|
16
|
+
instance = SkyApi::BlockVerboseSchema.new(header: null,
|
17
|
+
body: null,
|
18
|
+
size: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SkyApi::BlockVerboseSchemaBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**txns** | **Array<Object>** | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'SkyApi'
|
13
|
+
|
14
|
+
instance = SkyApi::BlockVerboseSchemaBody.new(txns: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# SkyApi::BlockVerboseSchemaHeader
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**seq** | **Integer** | | [optional]
|
8
|
+
**timestamp** | **Integer** | | [optional]
|
9
|
+
**fee** | **Integer** | | [optional]
|
10
|
+
**version** | **Integer** | | [optional]
|
11
|
+
**block_hash** | **String** | | [optional]
|
12
|
+
**previous_block_hash** | **String** | | [optional]
|
13
|
+
**tx_body_hash** | **String** | | [optional]
|
14
|
+
**ux_hash** | **String** | | [optional]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'SkyApi'
|
20
|
+
|
21
|
+
instance = SkyApi::BlockVerboseSchemaHeader.new(seq: null,
|
22
|
+
timestamp: null,
|
23
|
+
fee: null,
|
24
|
+
version: null,
|
25
|
+
block_hash: null,
|
26
|
+
previous_block_hash: null,
|
27
|
+
tx_body_hash: null,
|
28
|
+
ux_hash: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
data/docs/DefaultApi.md
ADDED
@@ -0,0 +1,2767 @@
|
|
1
|
+
# SkyApi::DefaultApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://127.0.0.1:6420*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**address_count**](DefaultApi.md#address_count) | **GET** /api/v1/addresscount | Returns the total number of unique address that have coins.
|
8
|
+
[**address_uxouts**](DefaultApi.md#address_uxouts) | **GET** /api/v1/address_uxouts |
|
9
|
+
[**api_v1_rawtx_get**](DefaultApi.md#api_v1_rawtx_get) | **GET** /api/v1/rawtx |
|
10
|
+
[**api_v2_metrics_get**](DefaultApi.md#api_v2_metrics_get) | **GET** /api/v2/metrics |
|
11
|
+
[**balance_get**](DefaultApi.md#balance_get) | **GET** /api/v1/balance | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
12
|
+
[**balance_post**](DefaultApi.md#balance_post) | **POST** /api/v1/balance | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
13
|
+
[**block**](DefaultApi.md#block) | **GET** /api/v1/block | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
14
|
+
[**blockchain_metadata**](DefaultApi.md#blockchain_metadata) | **GET** /api/v1/blockchain/metadata | Returns the blockchain metadata.
|
15
|
+
[**blockchain_progress**](DefaultApi.md#blockchain_progress) | **GET** /api/v1/blockchain/progress | Returns the blockchain sync progress.
|
16
|
+
[**blocks**](DefaultApi.md#blocks) | **GET** /api/v1/blocks | Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
17
|
+
[**coin_supply**](DefaultApi.md#coin_supply) | **GET** /api/v1/coinSupply |
|
18
|
+
[**csrf**](DefaultApi.md#csrf) | **GET** /api/v1/csrf | Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
|
19
|
+
[**data_delete**](DefaultApi.md#data_delete) | **DELETE** /api/v2/data |
|
20
|
+
[**data_get**](DefaultApi.md#data_get) | **GET** /api/v2/data |
|
21
|
+
[**data_post**](DefaultApi.md#data_post) | **POST** /api/v2/data |
|
22
|
+
[**default_connections**](DefaultApi.md#default_connections) | **GET** /api/v1/network/defaultConnections | defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\\n They are not necessarily connected to.
|
23
|
+
[**health**](DefaultApi.md#health) | **GET** /api/v1/health | Returns node health data.
|
24
|
+
[**last_blocks**](DefaultApi.md#last_blocks) | **GET** /api/v1/last_blocks |
|
25
|
+
[**network_connection**](DefaultApi.md#network_connection) | **GET** /api/v1/network/connection | This endpoint returns a specific connection.
|
26
|
+
[**network_connections**](DefaultApi.md#network_connections) | **GET** /api/v1/network/connections | This endpoint returns all outgoings connections.
|
27
|
+
[**network_connections_disconnect**](DefaultApi.md#network_connections_disconnect) | **POST** /api/v1/network/connection/disconnect |
|
28
|
+
[**network_connections_exchange**](DefaultApi.md#network_connections_exchange) | **GET** /api/v1/network/connections/exchange |
|
29
|
+
[**network_connections_trust**](DefaultApi.md#network_connections_trust) | **GET** /api/v1/network/connections/trust | trustConnectionsHandler returns all trusted connections.\\n They are not necessarily connected to. In the default configuration, these will be a subset of the default hardcoded bootstrap addresses.
|
30
|
+
[**outputs_get**](DefaultApi.md#outputs_get) | **GET** /api/v1/outputs | If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
31
|
+
[**outputs_post**](DefaultApi.md#outputs_post) | **POST** /api/v1/outputs | If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
32
|
+
[**pending_txs**](DefaultApi.md#pending_txs) | **GET** /api/v1/pendingTxs |
|
33
|
+
[**resend_unconfirmed_txns**](DefaultApi.md#resend_unconfirmed_txns) | **POST** /api/v1/resendUnconfirmedTxns |
|
34
|
+
[**richlist**](DefaultApi.md#richlist) | **GET** /api/v1/richlist | Returns the top skycoin holders.
|
35
|
+
[**transaction**](DefaultApi.md#transaction) | **GET** /api/v1/transaction |
|
36
|
+
[**transaction_inject**](DefaultApi.md#transaction_inject) | **POST** /api/v1/injectTransaction | Broadcast a hex-encoded, serialized transaction to the network.
|
37
|
+
[**transaction_post**](DefaultApi.md#transaction_post) | **POST** /api/v2/transaction |
|
38
|
+
[**transaction_post_unspent**](DefaultApi.md#transaction_post_unspent) | **POST** /api/v2/transaction/unspent |
|
39
|
+
[**transaction_raw**](DefaultApi.md#transaction_raw) | **GET** /api/v2/transaction/raw | Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
|
40
|
+
[**transaction_verify**](DefaultApi.md#transaction_verify) | **POST** /api/v2/transaction/verify |
|
41
|
+
[**transactions_get**](DefaultApi.md#transactions_get) | **GET** /api/v1/transactions | Returns transactions that match the filters.
|
42
|
+
[**transactions_post**](DefaultApi.md#transactions_post) | **POST** /api/v1/transactions | Returns transactions that match the filters.
|
43
|
+
[**uxout**](DefaultApi.md#uxout) | **GET** /api/v1/uxout | Returns an unspent output by ID.
|
44
|
+
[**verify_address**](DefaultApi.md#verify_address) | **POST** /api/v2/address/verify | Verifies a Skycoin address.
|
45
|
+
[**version**](DefaultApi.md#version) | **GET** /api/v1/version |
|
46
|
+
[**wallet**](DefaultApi.md#wallet) | **GET** /api/v1/wallet | Returns a wallet by id.
|
47
|
+
[**wallet_balance**](DefaultApi.md#wallet_balance) | **GET** /api/v1/wallet/balance | Returns the wallet's balance, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
48
|
+
[**wallet_create**](DefaultApi.md#wallet_create) | **POST** /api/v1/wallet/create |
|
49
|
+
[**wallet_decrypt**](DefaultApi.md#wallet_decrypt) | **POST** /api/v1/wallet/decrypt | Decrypts wallet.
|
50
|
+
[**wallet_encrypt**](DefaultApi.md#wallet_encrypt) | **POST** /api/v1/wallet/encrypt | Encrypt wallet.
|
51
|
+
[**wallet_folder**](DefaultApi.md#wallet_folder) | **GET** /api/v1/wallets/folderName |
|
52
|
+
[**wallet_new_address**](DefaultApi.md#wallet_new_address) | **POST** /api/v1/wallet/newAddress |
|
53
|
+
[**wallet_new_seed**](DefaultApi.md#wallet_new_seed) | **GET** /api/v1/wallet/newSeed |
|
54
|
+
[**wallet_recover**](DefaultApi.md#wallet_recover) | **POST** /api/v2/wallet/recover | Recovers an encrypted wallet by providing the seed. The first address will be generated from seed and compared to the first address of the specified wallet. If they match, the wallet will be regenerated with an optional password. If the wallet is not encrypted, an error is returned.
|
55
|
+
[**wallet_seed**](DefaultApi.md#wallet_seed) | **POST** /api/v1/wallet/seed | This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
|
56
|
+
[**wallet_seed_verify**](DefaultApi.md#wallet_seed_verify) | **POST** /api/v2/wallet/seed/verify | Verifies a wallet seed.
|
57
|
+
[**wallet_transaction**](DefaultApi.md#wallet_transaction) | **POST** /api/v1/wallet/transaction | Creates a signed transaction
|
58
|
+
[**wallet_transaction_sign**](DefaultApi.md#wallet_transaction_sign) | **POST** /api/v2/wallet/transaction/sign | Creates a signed transaction
|
59
|
+
[**wallet_transactions**](DefaultApi.md#wallet_transactions) | **GET** /api/v1/wallet/transactions |
|
60
|
+
[**wallet_unload**](DefaultApi.md#wallet_unload) | **POST** /api/v1/wallet/unload | Unloads wallet from the wallet service.
|
61
|
+
[**wallet_update**](DefaultApi.md#wallet_update) | **POST** /api/v1/wallet/update | Update the wallet.
|
62
|
+
[**wallets**](DefaultApi.md#wallets) | **GET** /api/v1/wallets |
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
## address_count
|
67
|
+
|
68
|
+
> InlineResponse200 address_count
|
69
|
+
|
70
|
+
Returns the total number of unique address that have coins.
|
71
|
+
|
72
|
+
### Example
|
73
|
+
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'sky_api'
|
77
|
+
|
78
|
+
api_instance = SkyApi::DefaultApi.new
|
79
|
+
|
80
|
+
begin
|
81
|
+
#Returns the total number of unique address that have coins.
|
82
|
+
result = api_instance.address_count
|
83
|
+
p result
|
84
|
+
rescue SkyApi::ApiError => e
|
85
|
+
puts "Exception when calling DefaultApi->address_count: #{e}"
|
86
|
+
end
|
87
|
+
```
|
88
|
+
|
89
|
+
### Parameters
|
90
|
+
|
91
|
+
This endpoint does not need any parameter.
|
92
|
+
|
93
|
+
### Return type
|
94
|
+
|
95
|
+
[**InlineResponse200**](InlineResponse200.md)
|
96
|
+
|
97
|
+
### Authorization
|
98
|
+
|
99
|
+
No authorization required
|
100
|
+
|
101
|
+
### HTTP request headers
|
102
|
+
|
103
|
+
- **Content-Type**: Not defined
|
104
|
+
- **Accept**: application/json, application/xml,
|
105
|
+
|
106
|
+
|
107
|
+
## address_uxouts
|
108
|
+
|
109
|
+
> Array<Object> address_uxouts(address)
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
Returns the historical, spent outputs associated with an address
|
114
|
+
|
115
|
+
### Example
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
# load the gem
|
119
|
+
require 'sky_api'
|
120
|
+
|
121
|
+
api_instance = SkyApi::DefaultApi.new
|
122
|
+
address = 'address_example' # String | address to filter by
|
123
|
+
|
124
|
+
begin
|
125
|
+
result = api_instance.address_uxouts(address)
|
126
|
+
p result
|
127
|
+
rescue SkyApi::ApiError => e
|
128
|
+
puts "Exception when calling DefaultApi->address_uxouts: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
|
135
|
+
Name | Type | Description | Notes
|
136
|
+
------------- | ------------- | ------------- | -------------
|
137
|
+
**address** | **String**| address to filter by |
|
138
|
+
|
139
|
+
### Return type
|
140
|
+
|
141
|
+
**Array<Object>**
|
142
|
+
|
143
|
+
### Authorization
|
144
|
+
|
145
|
+
No authorization required
|
146
|
+
|
147
|
+
### HTTP request headers
|
148
|
+
|
149
|
+
- **Content-Type**: Not defined
|
150
|
+
- **Accept**: application/json, application/xml,
|
151
|
+
|
152
|
+
|
153
|
+
## api_v1_rawtx_get
|
154
|
+
|
155
|
+
> String api_v1_rawtx_get
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
### Example
|
160
|
+
|
161
|
+
```ruby
|
162
|
+
# load the gem
|
163
|
+
require 'sky_api'
|
164
|
+
|
165
|
+
api_instance = SkyApi::DefaultApi.new
|
166
|
+
|
167
|
+
begin
|
168
|
+
result = api_instance.api_v1_rawtx_get
|
169
|
+
p result
|
170
|
+
rescue SkyApi::ApiError => e
|
171
|
+
puts "Exception when calling DefaultApi->api_v1_rawtx_get: #{e}"
|
172
|
+
end
|
173
|
+
```
|
174
|
+
|
175
|
+
### Parameters
|
176
|
+
|
177
|
+
This endpoint does not need any parameter.
|
178
|
+
|
179
|
+
### Return type
|
180
|
+
|
181
|
+
**String**
|
182
|
+
|
183
|
+
### Authorization
|
184
|
+
|
185
|
+
No authorization required
|
186
|
+
|
187
|
+
### HTTP request headers
|
188
|
+
|
189
|
+
- **Content-Type**: Not defined
|
190
|
+
- **Accept**: text/plain
|
191
|
+
|
192
|
+
|
193
|
+
## api_v2_metrics_get
|
194
|
+
|
195
|
+
> String api_v2_metrics_get
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
### Example
|
200
|
+
|
201
|
+
```ruby
|
202
|
+
# load the gem
|
203
|
+
require 'sky_api'
|
204
|
+
|
205
|
+
api_instance = SkyApi::DefaultApi.new
|
206
|
+
|
207
|
+
begin
|
208
|
+
result = api_instance.api_v2_metrics_get
|
209
|
+
p result
|
210
|
+
rescue SkyApi::ApiError => e
|
211
|
+
puts "Exception when calling DefaultApi->api_v2_metrics_get: #{e}"
|
212
|
+
end
|
213
|
+
```
|
214
|
+
|
215
|
+
### Parameters
|
216
|
+
|
217
|
+
This endpoint does not need any parameter.
|
218
|
+
|
219
|
+
### Return type
|
220
|
+
|
221
|
+
**String**
|
222
|
+
|
223
|
+
### Authorization
|
224
|
+
|
225
|
+
No authorization required
|
226
|
+
|
227
|
+
### HTTP request headers
|
228
|
+
|
229
|
+
- **Content-Type**: Not defined
|
230
|
+
- **Accept**: text/plain
|
231
|
+
|
232
|
+
|
233
|
+
## balance_get
|
234
|
+
|
235
|
+
> Object balance_get(addrs)
|
236
|
+
|
237
|
+
Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
238
|
+
|
239
|
+
### Example
|
240
|
+
|
241
|
+
```ruby
|
242
|
+
# load the gem
|
243
|
+
require 'sky_api'
|
244
|
+
|
245
|
+
api_instance = SkyApi::DefaultApi.new
|
246
|
+
addrs = 'addrs_example' # String | command separated list of addresses
|
247
|
+
|
248
|
+
begin
|
249
|
+
#Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
250
|
+
result = api_instance.balance_get(addrs)
|
251
|
+
p result
|
252
|
+
rescue SkyApi::ApiError => e
|
253
|
+
puts "Exception when calling DefaultApi->balance_get: #{e}"
|
254
|
+
end
|
255
|
+
```
|
256
|
+
|
257
|
+
### Parameters
|
258
|
+
|
259
|
+
|
260
|
+
Name | Type | Description | Notes
|
261
|
+
------------- | ------------- | ------------- | -------------
|
262
|
+
**addrs** | **String**| command separated list of addresses |
|
263
|
+
|
264
|
+
### Return type
|
265
|
+
|
266
|
+
**Object**
|
267
|
+
|
268
|
+
### Authorization
|
269
|
+
|
270
|
+
No authorization required
|
271
|
+
|
272
|
+
### HTTP request headers
|
273
|
+
|
274
|
+
- **Content-Type**: Not defined
|
275
|
+
- **Accept**: application/json, application/xml,
|
276
|
+
|
277
|
+
|
278
|
+
## balance_post
|
279
|
+
|
280
|
+
> Object balance_post(addrs)
|
281
|
+
|
282
|
+
Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
283
|
+
|
284
|
+
### Example
|
285
|
+
|
286
|
+
```ruby
|
287
|
+
# load the gem
|
288
|
+
require 'sky_api'
|
289
|
+
# setup authorization
|
290
|
+
SkyApi.configure do |config|
|
291
|
+
# Configure API key authorization: csrfAuth
|
292
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
293
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
294
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
295
|
+
end
|
296
|
+
|
297
|
+
api_instance = SkyApi::DefaultApi.new
|
298
|
+
addrs = 'addrs_example' # String | command separated list of addresses
|
299
|
+
|
300
|
+
begin
|
301
|
+
#Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
302
|
+
result = api_instance.balance_post(addrs)
|
303
|
+
p result
|
304
|
+
rescue SkyApi::ApiError => e
|
305
|
+
puts "Exception when calling DefaultApi->balance_post: #{e}"
|
306
|
+
end
|
307
|
+
```
|
308
|
+
|
309
|
+
### Parameters
|
310
|
+
|
311
|
+
|
312
|
+
Name | Type | Description | Notes
|
313
|
+
------------- | ------------- | ------------- | -------------
|
314
|
+
**addrs** | **String**| command separated list of addresses |
|
315
|
+
|
316
|
+
### Return type
|
317
|
+
|
318
|
+
**Object**
|
319
|
+
|
320
|
+
### Authorization
|
321
|
+
|
322
|
+
[csrfAuth](../README.md#csrfAuth)
|
323
|
+
|
324
|
+
### HTTP request headers
|
325
|
+
|
326
|
+
- **Content-Type**: Not defined
|
327
|
+
- **Accept**: application/json, application/xml,
|
328
|
+
|
329
|
+
|
330
|
+
## block
|
331
|
+
|
332
|
+
> Array<BlockSchema> block(opts)
|
333
|
+
|
334
|
+
Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
335
|
+
|
336
|
+
### Example
|
337
|
+
|
338
|
+
```ruby
|
339
|
+
# load the gem
|
340
|
+
require 'sky_api'
|
341
|
+
|
342
|
+
api_instance = SkyApi::DefaultApi.new
|
343
|
+
opts = {
|
344
|
+
hash: 'hash_example', # String | get block by hash
|
345
|
+
seq: 56 # Integer | get block by sequence number
|
346
|
+
}
|
347
|
+
|
348
|
+
begin
|
349
|
+
#Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
350
|
+
result = api_instance.block(opts)
|
351
|
+
p result
|
352
|
+
rescue SkyApi::ApiError => e
|
353
|
+
puts "Exception when calling DefaultApi->block: #{e}"
|
354
|
+
end
|
355
|
+
```
|
356
|
+
|
357
|
+
### Parameters
|
358
|
+
|
359
|
+
|
360
|
+
Name | Type | Description | Notes
|
361
|
+
------------- | ------------- | ------------- | -------------
|
362
|
+
**hash** | **String**| get block by hash | [optional]
|
363
|
+
**seq** | **Integer**| get block by sequence number | [optional]
|
364
|
+
|
365
|
+
### Return type
|
366
|
+
|
367
|
+
[**Array<BlockSchema>**](BlockSchema.md)
|
368
|
+
|
369
|
+
### Authorization
|
370
|
+
|
371
|
+
No authorization required
|
372
|
+
|
373
|
+
### HTTP request headers
|
374
|
+
|
375
|
+
- **Content-Type**: Not defined
|
376
|
+
- **Accept**: application/json, application/xml,
|
377
|
+
|
378
|
+
|
379
|
+
## blockchain_metadata
|
380
|
+
|
381
|
+
> Object blockchain_metadata
|
382
|
+
|
383
|
+
Returns the blockchain metadata.
|
384
|
+
|
385
|
+
### Example
|
386
|
+
|
387
|
+
```ruby
|
388
|
+
# load the gem
|
389
|
+
require 'sky_api'
|
390
|
+
|
391
|
+
api_instance = SkyApi::DefaultApi.new
|
392
|
+
|
393
|
+
begin
|
394
|
+
#Returns the blockchain metadata.
|
395
|
+
result = api_instance.blockchain_metadata
|
396
|
+
p result
|
397
|
+
rescue SkyApi::ApiError => e
|
398
|
+
puts "Exception when calling DefaultApi->blockchain_metadata: #{e}"
|
399
|
+
end
|
400
|
+
```
|
401
|
+
|
402
|
+
### Parameters
|
403
|
+
|
404
|
+
This endpoint does not need any parameter.
|
405
|
+
|
406
|
+
### Return type
|
407
|
+
|
408
|
+
**Object**
|
409
|
+
|
410
|
+
### Authorization
|
411
|
+
|
412
|
+
No authorization required
|
413
|
+
|
414
|
+
### HTTP request headers
|
415
|
+
|
416
|
+
- **Content-Type**: Not defined
|
417
|
+
- **Accept**: application/json, application/xml,
|
418
|
+
|
419
|
+
|
420
|
+
## blockchain_progress
|
421
|
+
|
422
|
+
> Object blockchain_progress
|
423
|
+
|
424
|
+
Returns the blockchain sync progress.
|
425
|
+
|
426
|
+
### Example
|
427
|
+
|
428
|
+
```ruby
|
429
|
+
# load the gem
|
430
|
+
require 'sky_api'
|
431
|
+
|
432
|
+
api_instance = SkyApi::DefaultApi.new
|
433
|
+
|
434
|
+
begin
|
435
|
+
#Returns the blockchain sync progress.
|
436
|
+
result = api_instance.blockchain_progress
|
437
|
+
p result
|
438
|
+
rescue SkyApi::ApiError => e
|
439
|
+
puts "Exception when calling DefaultApi->blockchain_progress: #{e}"
|
440
|
+
end
|
441
|
+
```
|
442
|
+
|
443
|
+
### Parameters
|
444
|
+
|
445
|
+
This endpoint does not need any parameter.
|
446
|
+
|
447
|
+
### Return type
|
448
|
+
|
449
|
+
**Object**
|
450
|
+
|
451
|
+
### Authorization
|
452
|
+
|
453
|
+
No authorization required
|
454
|
+
|
455
|
+
### HTTP request headers
|
456
|
+
|
457
|
+
- **Content-Type**: Not defined
|
458
|
+
- **Accept**: application/json, application/xml,
|
459
|
+
|
460
|
+
|
461
|
+
## blocks
|
462
|
+
|
463
|
+
> InlineResponse2001 blocks(opts)
|
464
|
+
|
465
|
+
Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
466
|
+
|
467
|
+
### Example
|
468
|
+
|
469
|
+
```ruby
|
470
|
+
# load the gem
|
471
|
+
require 'sky_api'
|
472
|
+
|
473
|
+
api_instance = SkyApi::DefaultApi.new
|
474
|
+
opts = {
|
475
|
+
start: 56, # Integer | start seq
|
476
|
+
_end: 56, # Integer | end seq
|
477
|
+
seq: [56] # Array<Integer> | comma-separated list of block seqs
|
478
|
+
}
|
479
|
+
|
480
|
+
begin
|
481
|
+
#Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
482
|
+
result = api_instance.blocks(opts)
|
483
|
+
p result
|
484
|
+
rescue SkyApi::ApiError => e
|
485
|
+
puts "Exception when calling DefaultApi->blocks: #{e}"
|
486
|
+
end
|
487
|
+
```
|
488
|
+
|
489
|
+
### Parameters
|
490
|
+
|
491
|
+
|
492
|
+
Name | Type | Description | Notes
|
493
|
+
------------- | ------------- | ------------- | -------------
|
494
|
+
**start** | **Integer**| start seq | [optional]
|
495
|
+
**_end** | **Integer**| end seq | [optional]
|
496
|
+
**seq** | [**Array<Integer>**](Integer.md)| comma-separated list of block seqs | [optional]
|
497
|
+
|
498
|
+
### Return type
|
499
|
+
|
500
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
501
|
+
|
502
|
+
### Authorization
|
503
|
+
|
504
|
+
No authorization required
|
505
|
+
|
506
|
+
### HTTP request headers
|
507
|
+
|
508
|
+
- **Content-Type**: Not defined
|
509
|
+
- **Accept**: application/json, application/xml,
|
510
|
+
|
511
|
+
|
512
|
+
## coin_supply
|
513
|
+
|
514
|
+
> InlineResponse2002 coin_supply
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
coinSupplyHandler returns coin distribution supply stats
|
519
|
+
|
520
|
+
### Example
|
521
|
+
|
522
|
+
```ruby
|
523
|
+
# load the gem
|
524
|
+
require 'sky_api'
|
525
|
+
|
526
|
+
api_instance = SkyApi::DefaultApi.new
|
527
|
+
|
528
|
+
begin
|
529
|
+
result = api_instance.coin_supply
|
530
|
+
p result
|
531
|
+
rescue SkyApi::ApiError => e
|
532
|
+
puts "Exception when calling DefaultApi->coin_supply: #{e}"
|
533
|
+
end
|
534
|
+
```
|
535
|
+
|
536
|
+
### Parameters
|
537
|
+
|
538
|
+
This endpoint does not need any parameter.
|
539
|
+
|
540
|
+
### Return type
|
541
|
+
|
542
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
543
|
+
|
544
|
+
### Authorization
|
545
|
+
|
546
|
+
No authorization required
|
547
|
+
|
548
|
+
### HTTP request headers
|
549
|
+
|
550
|
+
- **Content-Type**: Not defined
|
551
|
+
- **Accept**: application/json, application/xml,
|
552
|
+
|
553
|
+
|
554
|
+
## csrf
|
555
|
+
|
556
|
+
> InlineResponse2003 csrf
|
557
|
+
|
558
|
+
Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
|
559
|
+
|
560
|
+
### Example
|
561
|
+
|
562
|
+
```ruby
|
563
|
+
# load the gem
|
564
|
+
require 'sky_api'
|
565
|
+
|
566
|
+
api_instance = SkyApi::DefaultApi.new
|
567
|
+
|
568
|
+
begin
|
569
|
+
#Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
|
570
|
+
result = api_instance.csrf
|
571
|
+
p result
|
572
|
+
rescue SkyApi::ApiError => e
|
573
|
+
puts "Exception when calling DefaultApi->csrf: #{e}"
|
574
|
+
end
|
575
|
+
```
|
576
|
+
|
577
|
+
### Parameters
|
578
|
+
|
579
|
+
This endpoint does not need any parameter.
|
580
|
+
|
581
|
+
### Return type
|
582
|
+
|
583
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
584
|
+
|
585
|
+
### Authorization
|
586
|
+
|
587
|
+
No authorization required
|
588
|
+
|
589
|
+
### HTTP request headers
|
590
|
+
|
591
|
+
- **Content-Type**: Not defined
|
592
|
+
- **Accept**: application/json, application/xml,
|
593
|
+
|
594
|
+
|
595
|
+
## data_delete
|
596
|
+
|
597
|
+
> data_delete(opts)
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
### Example
|
602
|
+
|
603
|
+
```ruby
|
604
|
+
# load the gem
|
605
|
+
require 'sky_api'
|
606
|
+
|
607
|
+
api_instance = SkyApi::DefaultApi.new
|
608
|
+
opts = {
|
609
|
+
type: 'type_example', # String | storage type.
|
610
|
+
key: 'key_example' # String | key of the specific value to get.
|
611
|
+
}
|
612
|
+
|
613
|
+
begin
|
614
|
+
api_instance.data_delete(opts)
|
615
|
+
rescue SkyApi::ApiError => e
|
616
|
+
puts "Exception when calling DefaultApi->data_delete: #{e}"
|
617
|
+
end
|
618
|
+
```
|
619
|
+
|
620
|
+
### Parameters
|
621
|
+
|
622
|
+
|
623
|
+
Name | Type | Description | Notes
|
624
|
+
------------- | ------------- | ------------- | -------------
|
625
|
+
**type** | **String**| storage type. | [optional]
|
626
|
+
**key** | **String**| key of the specific value to get. | [optional]
|
627
|
+
|
628
|
+
### Return type
|
629
|
+
|
630
|
+
nil (empty response body)
|
631
|
+
|
632
|
+
### Authorization
|
633
|
+
|
634
|
+
No authorization required
|
635
|
+
|
636
|
+
### HTTP request headers
|
637
|
+
|
638
|
+
- **Content-Type**: Not defined
|
639
|
+
- **Accept**: application/json, application/xml
|
640
|
+
|
641
|
+
|
642
|
+
## data_get
|
643
|
+
|
644
|
+
> Object data_get(opts)
|
645
|
+
|
646
|
+
|
647
|
+
|
648
|
+
### Example
|
649
|
+
|
650
|
+
```ruby
|
651
|
+
# load the gem
|
652
|
+
require 'sky_api'
|
653
|
+
|
654
|
+
api_instance = SkyApi::DefaultApi.new
|
655
|
+
opts = {
|
656
|
+
type: 'type_example', # String | storage type.
|
657
|
+
key: 'key_example' # String | key of the specific value to get.
|
658
|
+
}
|
659
|
+
|
660
|
+
begin
|
661
|
+
result = api_instance.data_get(opts)
|
662
|
+
p result
|
663
|
+
rescue SkyApi::ApiError => e
|
664
|
+
puts "Exception when calling DefaultApi->data_get: #{e}"
|
665
|
+
end
|
666
|
+
```
|
667
|
+
|
668
|
+
### Parameters
|
669
|
+
|
670
|
+
|
671
|
+
Name | Type | Description | Notes
|
672
|
+
------------- | ------------- | ------------- | -------------
|
673
|
+
**type** | **String**| storage type. | [optional]
|
674
|
+
**key** | **String**| key of the specific value to get. | [optional]
|
675
|
+
|
676
|
+
### Return type
|
677
|
+
|
678
|
+
**Object**
|
679
|
+
|
680
|
+
### Authorization
|
681
|
+
|
682
|
+
No authorization required
|
683
|
+
|
684
|
+
### HTTP request headers
|
685
|
+
|
686
|
+
- **Content-Type**: Not defined
|
687
|
+
- **Accept**: application/json, application/xml,
|
688
|
+
|
689
|
+
|
690
|
+
## data_post
|
691
|
+
|
692
|
+
> data_post(opts)
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
### Example
|
697
|
+
|
698
|
+
```ruby
|
699
|
+
# load the gem
|
700
|
+
require 'sky_api'
|
701
|
+
|
702
|
+
api_instance = SkyApi::DefaultApi.new
|
703
|
+
opts = {
|
704
|
+
type: 'type_example', # String | storage type.
|
705
|
+
key: 'key_example', # String | key of the specific value to get.
|
706
|
+
val: 'val_example' # String | additional value.
|
707
|
+
}
|
708
|
+
|
709
|
+
begin
|
710
|
+
api_instance.data_post(opts)
|
711
|
+
rescue SkyApi::ApiError => e
|
712
|
+
puts "Exception when calling DefaultApi->data_post: #{e}"
|
713
|
+
end
|
714
|
+
```
|
715
|
+
|
716
|
+
### Parameters
|
717
|
+
|
718
|
+
|
719
|
+
Name | Type | Description | Notes
|
720
|
+
------------- | ------------- | ------------- | -------------
|
721
|
+
**type** | **String**| storage type. | [optional]
|
722
|
+
**key** | **String**| key of the specific value to get. | [optional]
|
723
|
+
**val** | **String**| additional value. | [optional]
|
724
|
+
|
725
|
+
### Return type
|
726
|
+
|
727
|
+
nil (empty response body)
|
728
|
+
|
729
|
+
### Authorization
|
730
|
+
|
731
|
+
No authorization required
|
732
|
+
|
733
|
+
### HTTP request headers
|
734
|
+
|
735
|
+
- **Content-Type**: Not defined
|
736
|
+
- **Accept**: application/json, application/xml
|
737
|
+
|
738
|
+
|
739
|
+
## default_connections
|
740
|
+
|
741
|
+
> Array<String> default_connections
|
742
|
+
|
743
|
+
defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\\n They are not necessarily connected to.
|
744
|
+
|
745
|
+
### Example
|
746
|
+
|
747
|
+
```ruby
|
748
|
+
# load the gem
|
749
|
+
require 'sky_api'
|
750
|
+
|
751
|
+
api_instance = SkyApi::DefaultApi.new
|
752
|
+
|
753
|
+
begin
|
754
|
+
#defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\\n They are not necessarily connected to.
|
755
|
+
result = api_instance.default_connections
|
756
|
+
p result
|
757
|
+
rescue SkyApi::ApiError => e
|
758
|
+
puts "Exception when calling DefaultApi->default_connections: #{e}"
|
759
|
+
end
|
760
|
+
```
|
761
|
+
|
762
|
+
### Parameters
|
763
|
+
|
764
|
+
This endpoint does not need any parameter.
|
765
|
+
|
766
|
+
### Return type
|
767
|
+
|
768
|
+
**Array<String>**
|
769
|
+
|
770
|
+
### Authorization
|
771
|
+
|
772
|
+
No authorization required
|
773
|
+
|
774
|
+
### HTTP request headers
|
775
|
+
|
776
|
+
- **Content-Type**: Not defined
|
777
|
+
- **Accept**: application/json, application/xml,
|
778
|
+
|
779
|
+
|
780
|
+
## health
|
781
|
+
|
782
|
+
> Object health
|
783
|
+
|
784
|
+
Returns node health data.
|
785
|
+
|
786
|
+
### Example
|
787
|
+
|
788
|
+
```ruby
|
789
|
+
# load the gem
|
790
|
+
require 'sky_api'
|
791
|
+
|
792
|
+
api_instance = SkyApi::DefaultApi.new
|
793
|
+
|
794
|
+
begin
|
795
|
+
#Returns node health data.
|
796
|
+
result = api_instance.health
|
797
|
+
p result
|
798
|
+
rescue SkyApi::ApiError => e
|
799
|
+
puts "Exception when calling DefaultApi->health: #{e}"
|
800
|
+
end
|
801
|
+
```
|
802
|
+
|
803
|
+
### Parameters
|
804
|
+
|
805
|
+
This endpoint does not need any parameter.
|
806
|
+
|
807
|
+
### Return type
|
808
|
+
|
809
|
+
**Object**
|
810
|
+
|
811
|
+
### Authorization
|
812
|
+
|
813
|
+
No authorization required
|
814
|
+
|
815
|
+
### HTTP request headers
|
816
|
+
|
817
|
+
- **Content-Type**: Not defined
|
818
|
+
- **Accept**: application/json, application/xml,
|
819
|
+
|
820
|
+
|
821
|
+
## last_blocks
|
822
|
+
|
823
|
+
> Object last_blocks(num)
|
824
|
+
|
825
|
+
|
826
|
+
|
827
|
+
Returns the most recent N blocks on the blockchain
|
828
|
+
|
829
|
+
### Example
|
830
|
+
|
831
|
+
```ruby
|
832
|
+
# load the gem
|
833
|
+
require 'sky_api'
|
834
|
+
|
835
|
+
api_instance = SkyApi::DefaultApi.new
|
836
|
+
num = 56 # Integer | Num of blockss
|
837
|
+
|
838
|
+
begin
|
839
|
+
result = api_instance.last_blocks(num)
|
840
|
+
p result
|
841
|
+
rescue SkyApi::ApiError => e
|
842
|
+
puts "Exception when calling DefaultApi->last_blocks: #{e}"
|
843
|
+
end
|
844
|
+
```
|
845
|
+
|
846
|
+
### Parameters
|
847
|
+
|
848
|
+
|
849
|
+
Name | Type | Description | Notes
|
850
|
+
------------- | ------------- | ------------- | -------------
|
851
|
+
**num** | **Integer**| Num of blockss |
|
852
|
+
|
853
|
+
### Return type
|
854
|
+
|
855
|
+
**Object**
|
856
|
+
|
857
|
+
### Authorization
|
858
|
+
|
859
|
+
No authorization required
|
860
|
+
|
861
|
+
### HTTP request headers
|
862
|
+
|
863
|
+
- **Content-Type**: Not defined
|
864
|
+
- **Accept**: application/json, application/xml,
|
865
|
+
|
866
|
+
|
867
|
+
## network_connection
|
868
|
+
|
869
|
+
> NetworkConnectionSchema network_connection(addr)
|
870
|
+
|
871
|
+
This endpoint returns a specific connection.
|
872
|
+
|
873
|
+
### Example
|
874
|
+
|
875
|
+
```ruby
|
876
|
+
# load the gem
|
877
|
+
require 'sky_api'
|
878
|
+
|
879
|
+
api_instance = SkyApi::DefaultApi.new
|
880
|
+
addr = 'addr_example' # String | Address port
|
881
|
+
|
882
|
+
begin
|
883
|
+
#This endpoint returns a specific connection.
|
884
|
+
result = api_instance.network_connection(addr)
|
885
|
+
p result
|
886
|
+
rescue SkyApi::ApiError => e
|
887
|
+
puts "Exception when calling DefaultApi->network_connection: #{e}"
|
888
|
+
end
|
889
|
+
```
|
890
|
+
|
891
|
+
### Parameters
|
892
|
+
|
893
|
+
|
894
|
+
Name | Type | Description | Notes
|
895
|
+
------------- | ------------- | ------------- | -------------
|
896
|
+
**addr** | **String**| Address port |
|
897
|
+
|
898
|
+
### Return type
|
899
|
+
|
900
|
+
[**NetworkConnectionSchema**](NetworkConnectionSchema.md)
|
901
|
+
|
902
|
+
### Authorization
|
903
|
+
|
904
|
+
No authorization required
|
905
|
+
|
906
|
+
### HTTP request headers
|
907
|
+
|
908
|
+
- **Content-Type**: Not defined
|
909
|
+
- **Accept**: application/json, application/xml,
|
910
|
+
|
911
|
+
|
912
|
+
## network_connections
|
913
|
+
|
914
|
+
> InlineResponse2004 network_connections(opts)
|
915
|
+
|
916
|
+
This endpoint returns all outgoings connections.
|
917
|
+
|
918
|
+
### Example
|
919
|
+
|
920
|
+
```ruby
|
921
|
+
# load the gem
|
922
|
+
require 'sky_api'
|
923
|
+
# setup authorization
|
924
|
+
SkyApi.configure do |config|
|
925
|
+
# Configure API key authorization: csrfAuth
|
926
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
927
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
928
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
929
|
+
end
|
930
|
+
|
931
|
+
api_instance = SkyApi::DefaultApi.new
|
932
|
+
opts = {
|
933
|
+
states: 'states_example', # String | Connection status.
|
934
|
+
direction: 'direction_example' # String | Direction of the connection.
|
935
|
+
}
|
936
|
+
|
937
|
+
begin
|
938
|
+
#This endpoint returns all outgoings connections.
|
939
|
+
result = api_instance.network_connections(opts)
|
940
|
+
p result
|
941
|
+
rescue SkyApi::ApiError => e
|
942
|
+
puts "Exception when calling DefaultApi->network_connections: #{e}"
|
943
|
+
end
|
944
|
+
```
|
945
|
+
|
946
|
+
### Parameters
|
947
|
+
|
948
|
+
|
949
|
+
Name | Type | Description | Notes
|
950
|
+
------------- | ------------- | ------------- | -------------
|
951
|
+
**states** | **String**| Connection status. | [optional]
|
952
|
+
**direction** | **String**| Direction of the connection. | [optional]
|
953
|
+
|
954
|
+
### Return type
|
955
|
+
|
956
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
957
|
+
|
958
|
+
### Authorization
|
959
|
+
|
960
|
+
[csrfAuth](../README.md#csrfAuth)
|
961
|
+
|
962
|
+
### HTTP request headers
|
963
|
+
|
964
|
+
- **Content-Type**: Not defined
|
965
|
+
- **Accept**: application/json, application/xml,
|
966
|
+
|
967
|
+
|
968
|
+
## network_connections_disconnect
|
969
|
+
|
970
|
+
> network_connections_disconnect(id)
|
971
|
+
|
972
|
+
|
973
|
+
|
974
|
+
This endpoint disconnects a connection by ID or address
|
975
|
+
|
976
|
+
### Example
|
977
|
+
|
978
|
+
```ruby
|
979
|
+
# load the gem
|
980
|
+
require 'sky_api'
|
981
|
+
# setup authorization
|
982
|
+
SkyApi.configure do |config|
|
983
|
+
# Configure API key authorization: csrfAuth
|
984
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
985
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
986
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
987
|
+
end
|
988
|
+
|
989
|
+
api_instance = SkyApi::DefaultApi.new
|
990
|
+
id = 'id_example' # String | Address id.
|
991
|
+
|
992
|
+
begin
|
993
|
+
api_instance.network_connections_disconnect(id)
|
994
|
+
rescue SkyApi::ApiError => e
|
995
|
+
puts "Exception when calling DefaultApi->network_connections_disconnect: #{e}"
|
996
|
+
end
|
997
|
+
```
|
998
|
+
|
999
|
+
### Parameters
|
1000
|
+
|
1001
|
+
|
1002
|
+
Name | Type | Description | Notes
|
1003
|
+
------------- | ------------- | ------------- | -------------
|
1004
|
+
**id** | **String**| Address id. |
|
1005
|
+
|
1006
|
+
### Return type
|
1007
|
+
|
1008
|
+
nil (empty response body)
|
1009
|
+
|
1010
|
+
### Authorization
|
1011
|
+
|
1012
|
+
[csrfAuth](../README.md#csrfAuth)
|
1013
|
+
|
1014
|
+
### HTTP request headers
|
1015
|
+
|
1016
|
+
- **Content-Type**: Not defined
|
1017
|
+
- **Accept**: application/json, application/xml
|
1018
|
+
|
1019
|
+
|
1020
|
+
## network_connections_exchange
|
1021
|
+
|
1022
|
+
> Array<String> network_connections_exchange
|
1023
|
+
|
1024
|
+
|
1025
|
+
|
1026
|
+
This endpoint returns all connections found through peer exchange
|
1027
|
+
|
1028
|
+
### Example
|
1029
|
+
|
1030
|
+
```ruby
|
1031
|
+
# load the gem
|
1032
|
+
require 'sky_api'
|
1033
|
+
|
1034
|
+
api_instance = SkyApi::DefaultApi.new
|
1035
|
+
|
1036
|
+
begin
|
1037
|
+
result = api_instance.network_connections_exchange
|
1038
|
+
p result
|
1039
|
+
rescue SkyApi::ApiError => e
|
1040
|
+
puts "Exception when calling DefaultApi->network_connections_exchange: #{e}"
|
1041
|
+
end
|
1042
|
+
```
|
1043
|
+
|
1044
|
+
### Parameters
|
1045
|
+
|
1046
|
+
This endpoint does not need any parameter.
|
1047
|
+
|
1048
|
+
### Return type
|
1049
|
+
|
1050
|
+
**Array<String>**
|
1051
|
+
|
1052
|
+
### Authorization
|
1053
|
+
|
1054
|
+
No authorization required
|
1055
|
+
|
1056
|
+
### HTTP request headers
|
1057
|
+
|
1058
|
+
- **Content-Type**: Not defined
|
1059
|
+
- **Accept**: application/json, application/xml,
|
1060
|
+
|
1061
|
+
|
1062
|
+
## network_connections_trust
|
1063
|
+
|
1064
|
+
> Array<String> network_connections_trust
|
1065
|
+
|
1066
|
+
trustConnectionsHandler returns all trusted connections.\\n They are not necessarily connected to. In the default configuration, these will be a subset of the default hardcoded bootstrap addresses.
|
1067
|
+
|
1068
|
+
### Example
|
1069
|
+
|
1070
|
+
```ruby
|
1071
|
+
# load the gem
|
1072
|
+
require 'sky_api'
|
1073
|
+
|
1074
|
+
api_instance = SkyApi::DefaultApi.new
|
1075
|
+
|
1076
|
+
begin
|
1077
|
+
#trustConnectionsHandler returns all trusted connections.\\n They are not necessarily connected to. In the default configuration, these will be a subset of the default hardcoded bootstrap addresses.
|
1078
|
+
result = api_instance.network_connections_trust
|
1079
|
+
p result
|
1080
|
+
rescue SkyApi::ApiError => e
|
1081
|
+
puts "Exception when calling DefaultApi->network_connections_trust: #{e}"
|
1082
|
+
end
|
1083
|
+
```
|
1084
|
+
|
1085
|
+
### Parameters
|
1086
|
+
|
1087
|
+
This endpoint does not need any parameter.
|
1088
|
+
|
1089
|
+
### Return type
|
1090
|
+
|
1091
|
+
**Array<String>**
|
1092
|
+
|
1093
|
+
### Authorization
|
1094
|
+
|
1095
|
+
No authorization required
|
1096
|
+
|
1097
|
+
### HTTP request headers
|
1098
|
+
|
1099
|
+
- **Content-Type**: Not defined
|
1100
|
+
- **Accept**: application/json, application/xml,
|
1101
|
+
|
1102
|
+
|
1103
|
+
## outputs_get
|
1104
|
+
|
1105
|
+
> Object outputs_get(opts)
|
1106
|
+
|
1107
|
+
If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
1108
|
+
|
1109
|
+
### Example
|
1110
|
+
|
1111
|
+
```ruby
|
1112
|
+
# load the gem
|
1113
|
+
require 'sky_api'
|
1114
|
+
|
1115
|
+
api_instance = SkyApi::DefaultApi.new
|
1116
|
+
opts = {
|
1117
|
+
address: ['address_example'], # Array<String> |
|
1118
|
+
hash: ['hash_example'] # Array<String> |
|
1119
|
+
}
|
1120
|
+
|
1121
|
+
begin
|
1122
|
+
#If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
1123
|
+
result = api_instance.outputs_get(opts)
|
1124
|
+
p result
|
1125
|
+
rescue SkyApi::ApiError => e
|
1126
|
+
puts "Exception when calling DefaultApi->outputs_get: #{e}"
|
1127
|
+
end
|
1128
|
+
```
|
1129
|
+
|
1130
|
+
### Parameters
|
1131
|
+
|
1132
|
+
|
1133
|
+
Name | Type | Description | Notes
|
1134
|
+
------------- | ------------- | ------------- | -------------
|
1135
|
+
**address** | [**Array<String>**](String.md)| | [optional]
|
1136
|
+
**hash** | [**Array<String>**](String.md)| | [optional]
|
1137
|
+
|
1138
|
+
### Return type
|
1139
|
+
|
1140
|
+
**Object**
|
1141
|
+
|
1142
|
+
### Authorization
|
1143
|
+
|
1144
|
+
No authorization required
|
1145
|
+
|
1146
|
+
### HTTP request headers
|
1147
|
+
|
1148
|
+
- **Content-Type**: Not defined
|
1149
|
+
- **Accept**: application/json, application/xml,
|
1150
|
+
|
1151
|
+
|
1152
|
+
## outputs_post
|
1153
|
+
|
1154
|
+
> Object outputs_post(opts)
|
1155
|
+
|
1156
|
+
If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
1157
|
+
|
1158
|
+
### Example
|
1159
|
+
|
1160
|
+
```ruby
|
1161
|
+
# load the gem
|
1162
|
+
require 'sky_api'
|
1163
|
+
# setup authorization
|
1164
|
+
SkyApi.configure do |config|
|
1165
|
+
# Configure API key authorization: csrfAuth
|
1166
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1167
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1168
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1169
|
+
end
|
1170
|
+
|
1171
|
+
api_instance = SkyApi::DefaultApi.new
|
1172
|
+
opts = {
|
1173
|
+
address: 'address_example', # String |
|
1174
|
+
hash: 'hash_example' # String |
|
1175
|
+
}
|
1176
|
+
|
1177
|
+
begin
|
1178
|
+
#If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
|
1179
|
+
result = api_instance.outputs_post(opts)
|
1180
|
+
p result
|
1181
|
+
rescue SkyApi::ApiError => e
|
1182
|
+
puts "Exception when calling DefaultApi->outputs_post: #{e}"
|
1183
|
+
end
|
1184
|
+
```
|
1185
|
+
|
1186
|
+
### Parameters
|
1187
|
+
|
1188
|
+
|
1189
|
+
Name | Type | Description | Notes
|
1190
|
+
------------- | ------------- | ------------- | -------------
|
1191
|
+
**address** | **String**| | [optional]
|
1192
|
+
**hash** | **String**| | [optional]
|
1193
|
+
|
1194
|
+
### Return type
|
1195
|
+
|
1196
|
+
**Object**
|
1197
|
+
|
1198
|
+
### Authorization
|
1199
|
+
|
1200
|
+
[csrfAuth](../README.md#csrfAuth)
|
1201
|
+
|
1202
|
+
### HTTP request headers
|
1203
|
+
|
1204
|
+
- **Content-Type**: Not defined
|
1205
|
+
- **Accept**: application/json, application/xml,
|
1206
|
+
|
1207
|
+
|
1208
|
+
## pending_txs
|
1209
|
+
|
1210
|
+
> Array<InlineResponse20010> pending_txs
|
1211
|
+
|
1212
|
+
|
1213
|
+
|
1214
|
+
### Example
|
1215
|
+
|
1216
|
+
```ruby
|
1217
|
+
# load the gem
|
1218
|
+
require 'sky_api'
|
1219
|
+
|
1220
|
+
api_instance = SkyApi::DefaultApi.new
|
1221
|
+
|
1222
|
+
begin
|
1223
|
+
result = api_instance.pending_txs
|
1224
|
+
p result
|
1225
|
+
rescue SkyApi::ApiError => e
|
1226
|
+
puts "Exception when calling DefaultApi->pending_txs: #{e}"
|
1227
|
+
end
|
1228
|
+
```
|
1229
|
+
|
1230
|
+
### Parameters
|
1231
|
+
|
1232
|
+
This endpoint does not need any parameter.
|
1233
|
+
|
1234
|
+
### Return type
|
1235
|
+
|
1236
|
+
[**Array<InlineResponse20010>**](InlineResponse20010.md)
|
1237
|
+
|
1238
|
+
### Authorization
|
1239
|
+
|
1240
|
+
No authorization required
|
1241
|
+
|
1242
|
+
### HTTP request headers
|
1243
|
+
|
1244
|
+
- **Content-Type**: Not defined
|
1245
|
+
- **Accept**: application/json, application/xml,
|
1246
|
+
|
1247
|
+
|
1248
|
+
## resend_unconfirmed_txns
|
1249
|
+
|
1250
|
+
> Object resend_unconfirmed_txns
|
1251
|
+
|
1252
|
+
|
1253
|
+
|
1254
|
+
Broadcasts all unconfirmed transactions from the unconfirmed transaction pool
|
1255
|
+
|
1256
|
+
### Example
|
1257
|
+
|
1258
|
+
```ruby
|
1259
|
+
# load the gem
|
1260
|
+
require 'sky_api'
|
1261
|
+
# setup authorization
|
1262
|
+
SkyApi.configure do |config|
|
1263
|
+
# Configure API key authorization: csrfAuth
|
1264
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1265
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1266
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
api_instance = SkyApi::DefaultApi.new
|
1270
|
+
|
1271
|
+
begin
|
1272
|
+
result = api_instance.resend_unconfirmed_txns
|
1273
|
+
p result
|
1274
|
+
rescue SkyApi::ApiError => e
|
1275
|
+
puts "Exception when calling DefaultApi->resend_unconfirmed_txns: #{e}"
|
1276
|
+
end
|
1277
|
+
```
|
1278
|
+
|
1279
|
+
### Parameters
|
1280
|
+
|
1281
|
+
This endpoint does not need any parameter.
|
1282
|
+
|
1283
|
+
### Return type
|
1284
|
+
|
1285
|
+
**Object**
|
1286
|
+
|
1287
|
+
### Authorization
|
1288
|
+
|
1289
|
+
[csrfAuth](../README.md#csrfAuth)
|
1290
|
+
|
1291
|
+
### HTTP request headers
|
1292
|
+
|
1293
|
+
- **Content-Type**: Not defined
|
1294
|
+
- **Accept**: application-json, application/json, application/xml
|
1295
|
+
|
1296
|
+
|
1297
|
+
## richlist
|
1298
|
+
|
1299
|
+
> Object richlist(opts)
|
1300
|
+
|
1301
|
+
Returns the top skycoin holders.
|
1302
|
+
|
1303
|
+
### Example
|
1304
|
+
|
1305
|
+
```ruby
|
1306
|
+
# load the gem
|
1307
|
+
require 'sky_api'
|
1308
|
+
|
1309
|
+
api_instance = SkyApi::DefaultApi.new
|
1310
|
+
opts = {
|
1311
|
+
include_distribution: true, # Boolean | include distribution addresses or not, default value false
|
1312
|
+
n: 'n_example' # String | include distribution addresses or not, default value false
|
1313
|
+
}
|
1314
|
+
|
1315
|
+
begin
|
1316
|
+
#Returns the top skycoin holders.
|
1317
|
+
result = api_instance.richlist(opts)
|
1318
|
+
p result
|
1319
|
+
rescue SkyApi::ApiError => e
|
1320
|
+
puts "Exception when calling DefaultApi->richlist: #{e}"
|
1321
|
+
end
|
1322
|
+
```
|
1323
|
+
|
1324
|
+
### Parameters
|
1325
|
+
|
1326
|
+
|
1327
|
+
Name | Type | Description | Notes
|
1328
|
+
------------- | ------------- | ------------- | -------------
|
1329
|
+
**include_distribution** | **Boolean**| include distribution addresses or not, default value false | [optional]
|
1330
|
+
**n** | **String**| include distribution addresses or not, default value false | [optional]
|
1331
|
+
|
1332
|
+
### Return type
|
1333
|
+
|
1334
|
+
**Object**
|
1335
|
+
|
1336
|
+
### Authorization
|
1337
|
+
|
1338
|
+
No authorization required
|
1339
|
+
|
1340
|
+
### HTTP request headers
|
1341
|
+
|
1342
|
+
- **Content-Type**: Not defined
|
1343
|
+
- **Accept**: application/json, application/xml,
|
1344
|
+
|
1345
|
+
|
1346
|
+
## transaction
|
1347
|
+
|
1348
|
+
> Transaction transaction(txid)
|
1349
|
+
|
1350
|
+
|
1351
|
+
|
1352
|
+
Returns a transaction identified by its txid hash with just id
|
1353
|
+
|
1354
|
+
### Example
|
1355
|
+
|
1356
|
+
```ruby
|
1357
|
+
# load the gem
|
1358
|
+
require 'sky_api'
|
1359
|
+
|
1360
|
+
api_instance = SkyApi::DefaultApi.new
|
1361
|
+
txid = 'txid_example' # String | transaction Id
|
1362
|
+
|
1363
|
+
begin
|
1364
|
+
result = api_instance.transaction(txid)
|
1365
|
+
p result
|
1366
|
+
rescue SkyApi::ApiError => e
|
1367
|
+
puts "Exception when calling DefaultApi->transaction: #{e}"
|
1368
|
+
end
|
1369
|
+
```
|
1370
|
+
|
1371
|
+
### Parameters
|
1372
|
+
|
1373
|
+
|
1374
|
+
Name | Type | Description | Notes
|
1375
|
+
------------- | ------------- | ------------- | -------------
|
1376
|
+
**txid** | **String**| transaction Id |
|
1377
|
+
|
1378
|
+
### Return type
|
1379
|
+
|
1380
|
+
[**Transaction**](Transaction.md)
|
1381
|
+
|
1382
|
+
### Authorization
|
1383
|
+
|
1384
|
+
No authorization required
|
1385
|
+
|
1386
|
+
### HTTP request headers
|
1387
|
+
|
1388
|
+
- **Content-Type**: Not defined
|
1389
|
+
- **Accept**: application/json, application/xml,
|
1390
|
+
|
1391
|
+
|
1392
|
+
## transaction_inject
|
1393
|
+
|
1394
|
+
> String transaction_inject(rawtx)
|
1395
|
+
|
1396
|
+
Broadcast a hex-encoded, serialized transaction to the network.
|
1397
|
+
|
1398
|
+
### Example
|
1399
|
+
|
1400
|
+
```ruby
|
1401
|
+
# load the gem
|
1402
|
+
require 'sky_api'
|
1403
|
+
# setup authorization
|
1404
|
+
SkyApi.configure do |config|
|
1405
|
+
# Configure API key authorization: csrfAuth
|
1406
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1407
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1408
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1409
|
+
end
|
1410
|
+
|
1411
|
+
api_instance = SkyApi::DefaultApi.new
|
1412
|
+
rawtx = 'rawtx_example' # String | hex-encoded serialized transaction string.
|
1413
|
+
|
1414
|
+
begin
|
1415
|
+
#Broadcast a hex-encoded, serialized transaction to the network.
|
1416
|
+
result = api_instance.transaction_inject(rawtx)
|
1417
|
+
p result
|
1418
|
+
rescue SkyApi::ApiError => e
|
1419
|
+
puts "Exception when calling DefaultApi->transaction_inject: #{e}"
|
1420
|
+
end
|
1421
|
+
```
|
1422
|
+
|
1423
|
+
### Parameters
|
1424
|
+
|
1425
|
+
|
1426
|
+
Name | Type | Description | Notes
|
1427
|
+
------------- | ------------- | ------------- | -------------
|
1428
|
+
**rawtx** | **String**| hex-encoded serialized transaction string. |
|
1429
|
+
|
1430
|
+
### Return type
|
1431
|
+
|
1432
|
+
**String**
|
1433
|
+
|
1434
|
+
### Authorization
|
1435
|
+
|
1436
|
+
[csrfAuth](../README.md#csrfAuth)
|
1437
|
+
|
1438
|
+
### HTTP request headers
|
1439
|
+
|
1440
|
+
- **Content-Type**: Not defined
|
1441
|
+
- **Accept**: text/plain, application/json, application/xml
|
1442
|
+
|
1443
|
+
|
1444
|
+
## transaction_post
|
1445
|
+
|
1446
|
+
> InlineResponse2008 transaction_post(opts)
|
1447
|
+
|
1448
|
+
|
1449
|
+
|
1450
|
+
### Example
|
1451
|
+
|
1452
|
+
```ruby
|
1453
|
+
# load the gem
|
1454
|
+
require 'sky_api'
|
1455
|
+
# setup authorization
|
1456
|
+
SkyApi.configure do |config|
|
1457
|
+
# Configure API key authorization: csrfAuth
|
1458
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1459
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1460
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1461
|
+
end
|
1462
|
+
|
1463
|
+
api_instance = SkyApi::DefaultApi.new
|
1464
|
+
opts = {
|
1465
|
+
transaction_v2_params_address: SkyApi::TransactionV2ParamsAddress.new # TransactionV2ParamsAddress |
|
1466
|
+
}
|
1467
|
+
|
1468
|
+
begin
|
1469
|
+
result = api_instance.transaction_post(opts)
|
1470
|
+
p result
|
1471
|
+
rescue SkyApi::ApiError => e
|
1472
|
+
puts "Exception when calling DefaultApi->transaction_post: #{e}"
|
1473
|
+
end
|
1474
|
+
```
|
1475
|
+
|
1476
|
+
### Parameters
|
1477
|
+
|
1478
|
+
|
1479
|
+
Name | Type | Description | Notes
|
1480
|
+
------------- | ------------- | ------------- | -------------
|
1481
|
+
**transaction_v2_params_address** | [**TransactionV2ParamsAddress**](TransactionV2ParamsAddress.md)| | [optional]
|
1482
|
+
|
1483
|
+
### Return type
|
1484
|
+
|
1485
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
1486
|
+
|
1487
|
+
### Authorization
|
1488
|
+
|
1489
|
+
[csrfAuth](../README.md#csrfAuth)
|
1490
|
+
|
1491
|
+
### HTTP request headers
|
1492
|
+
|
1493
|
+
- **Content-Type**: application/json
|
1494
|
+
- **Accept**: application/json, application/xml,
|
1495
|
+
|
1496
|
+
|
1497
|
+
## transaction_post_unspent
|
1498
|
+
|
1499
|
+
> InlineResponse2008 transaction_post_unspent(transaction_v2_params_unspent)
|
1500
|
+
|
1501
|
+
|
1502
|
+
|
1503
|
+
### Example
|
1504
|
+
|
1505
|
+
```ruby
|
1506
|
+
# load the gem
|
1507
|
+
require 'sky_api'
|
1508
|
+
# setup authorization
|
1509
|
+
SkyApi.configure do |config|
|
1510
|
+
# Configure API key authorization: csrfAuth
|
1511
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1512
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1513
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1514
|
+
end
|
1515
|
+
|
1516
|
+
api_instance = SkyApi::DefaultApi.new
|
1517
|
+
transaction_v2_params_unspent = SkyApi::TransactionV2ParamsUnspent.new # TransactionV2ParamsUnspent | Unspent parameters
|
1518
|
+
|
1519
|
+
begin
|
1520
|
+
result = api_instance.transaction_post_unspent(transaction_v2_params_unspent)
|
1521
|
+
p result
|
1522
|
+
rescue SkyApi::ApiError => e
|
1523
|
+
puts "Exception when calling DefaultApi->transaction_post_unspent: #{e}"
|
1524
|
+
end
|
1525
|
+
```
|
1526
|
+
|
1527
|
+
### Parameters
|
1528
|
+
|
1529
|
+
|
1530
|
+
Name | Type | Description | Notes
|
1531
|
+
------------- | ------------- | ------------- | -------------
|
1532
|
+
**transaction_v2_params_unspent** | [**TransactionV2ParamsUnspent**](TransactionV2ParamsUnspent.md)| Unspent parameters |
|
1533
|
+
|
1534
|
+
### Return type
|
1535
|
+
|
1536
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
1537
|
+
|
1538
|
+
### Authorization
|
1539
|
+
|
1540
|
+
[csrfAuth](../README.md#csrfAuth)
|
1541
|
+
|
1542
|
+
### HTTP request headers
|
1543
|
+
|
1544
|
+
- **Content-Type**: application/json
|
1545
|
+
- **Accept**: application/json, application/xml,
|
1546
|
+
|
1547
|
+
|
1548
|
+
## transaction_raw
|
1549
|
+
|
1550
|
+
> Object transaction_raw(opts)
|
1551
|
+
|
1552
|
+
Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
|
1553
|
+
|
1554
|
+
### Example
|
1555
|
+
|
1556
|
+
```ruby
|
1557
|
+
# load the gem
|
1558
|
+
require 'sky_api'
|
1559
|
+
|
1560
|
+
api_instance = SkyApi::DefaultApi.new
|
1561
|
+
opts = {
|
1562
|
+
txid: 'txid_example' # String | Transaction id hash
|
1563
|
+
}
|
1564
|
+
|
1565
|
+
begin
|
1566
|
+
#Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
|
1567
|
+
result = api_instance.transaction_raw(opts)
|
1568
|
+
p result
|
1569
|
+
rescue SkyApi::ApiError => e
|
1570
|
+
puts "Exception when calling DefaultApi->transaction_raw: #{e}"
|
1571
|
+
end
|
1572
|
+
```
|
1573
|
+
|
1574
|
+
### Parameters
|
1575
|
+
|
1576
|
+
|
1577
|
+
Name | Type | Description | Notes
|
1578
|
+
------------- | ------------- | ------------- | -------------
|
1579
|
+
**txid** | **String**| Transaction id hash | [optional]
|
1580
|
+
|
1581
|
+
### Return type
|
1582
|
+
|
1583
|
+
**Object**
|
1584
|
+
|
1585
|
+
### Authorization
|
1586
|
+
|
1587
|
+
No authorization required
|
1588
|
+
|
1589
|
+
### HTTP request headers
|
1590
|
+
|
1591
|
+
- **Content-Type**: Not defined
|
1592
|
+
- **Accept**: application/json, application/xml,
|
1593
|
+
|
1594
|
+
|
1595
|
+
## transaction_verify
|
1596
|
+
|
1597
|
+
> Object transaction_verify(transaction_verify_request)
|
1598
|
+
|
1599
|
+
|
1600
|
+
|
1601
|
+
Decode and verify an encoded transaction
|
1602
|
+
|
1603
|
+
### Example
|
1604
|
+
|
1605
|
+
```ruby
|
1606
|
+
# load the gem
|
1607
|
+
require 'sky_api'
|
1608
|
+
# setup authorization
|
1609
|
+
SkyApi.configure do |config|
|
1610
|
+
# Configure API key authorization: csrfAuth
|
1611
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1612
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1613
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1614
|
+
end
|
1615
|
+
|
1616
|
+
api_instance = SkyApi::DefaultApi.new
|
1617
|
+
transaction_verify_request = SkyApi::TransactionVerifyRequest.new # TransactionVerifyRequest |
|
1618
|
+
|
1619
|
+
begin
|
1620
|
+
result = api_instance.transaction_verify(transaction_verify_request)
|
1621
|
+
p result
|
1622
|
+
rescue SkyApi::ApiError => e
|
1623
|
+
puts "Exception when calling DefaultApi->transaction_verify: #{e}"
|
1624
|
+
end
|
1625
|
+
```
|
1626
|
+
|
1627
|
+
### Parameters
|
1628
|
+
|
1629
|
+
|
1630
|
+
Name | Type | Description | Notes
|
1631
|
+
------------- | ------------- | ------------- | -------------
|
1632
|
+
**transaction_verify_request** | [**TransactionVerifyRequest**](TransactionVerifyRequest.md)| |
|
1633
|
+
|
1634
|
+
### Return type
|
1635
|
+
|
1636
|
+
**Object**
|
1637
|
+
|
1638
|
+
### Authorization
|
1639
|
+
|
1640
|
+
[csrfAuth](../README.md#csrfAuth)
|
1641
|
+
|
1642
|
+
### HTTP request headers
|
1643
|
+
|
1644
|
+
- **Content-Type**: application/json
|
1645
|
+
- **Accept**: application/json, application/xml,
|
1646
|
+
|
1647
|
+
|
1648
|
+
## transactions_get
|
1649
|
+
|
1650
|
+
> Object transactions_get(opts)
|
1651
|
+
|
1652
|
+
Returns transactions that match the filters.
|
1653
|
+
|
1654
|
+
### Example
|
1655
|
+
|
1656
|
+
```ruby
|
1657
|
+
# load the gem
|
1658
|
+
require 'sky_api'
|
1659
|
+
|
1660
|
+
api_instance = SkyApi::DefaultApi.new
|
1661
|
+
opts = {
|
1662
|
+
addrs: 'addrs_example', # String | command separated list of addresses
|
1663
|
+
confirmed: 'confirmed_example' # String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
|
1664
|
+
}
|
1665
|
+
|
1666
|
+
begin
|
1667
|
+
#Returns transactions that match the filters.
|
1668
|
+
result = api_instance.transactions_get(opts)
|
1669
|
+
p result
|
1670
|
+
rescue SkyApi::ApiError => e
|
1671
|
+
puts "Exception when calling DefaultApi->transactions_get: #{e}"
|
1672
|
+
end
|
1673
|
+
```
|
1674
|
+
|
1675
|
+
### Parameters
|
1676
|
+
|
1677
|
+
|
1678
|
+
Name | Type | Description | Notes
|
1679
|
+
------------- | ------------- | ------------- | -------------
|
1680
|
+
**addrs** | **String**| command separated list of addresses | [optional]
|
1681
|
+
**confirmed** | **String**| Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] | [optional]
|
1682
|
+
|
1683
|
+
### Return type
|
1684
|
+
|
1685
|
+
**Object**
|
1686
|
+
|
1687
|
+
### Authorization
|
1688
|
+
|
1689
|
+
No authorization required
|
1690
|
+
|
1691
|
+
### HTTP request headers
|
1692
|
+
|
1693
|
+
- **Content-Type**: Not defined
|
1694
|
+
- **Accept**: application/json, application/xml,
|
1695
|
+
|
1696
|
+
|
1697
|
+
## transactions_post
|
1698
|
+
|
1699
|
+
> Object transactions_post(opts)
|
1700
|
+
|
1701
|
+
Returns transactions that match the filters.
|
1702
|
+
|
1703
|
+
### Example
|
1704
|
+
|
1705
|
+
```ruby
|
1706
|
+
# load the gem
|
1707
|
+
require 'sky_api'
|
1708
|
+
# setup authorization
|
1709
|
+
SkyApi.configure do |config|
|
1710
|
+
# Configure API key authorization: csrfAuth
|
1711
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1712
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1713
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1714
|
+
end
|
1715
|
+
|
1716
|
+
api_instance = SkyApi::DefaultApi.new
|
1717
|
+
opts = {
|
1718
|
+
addrs: 'addrs_example', # String | command separated list of addresses
|
1719
|
+
confirmed: 'confirmed_example' # String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
|
1720
|
+
}
|
1721
|
+
|
1722
|
+
begin
|
1723
|
+
#Returns transactions that match the filters.
|
1724
|
+
result = api_instance.transactions_post(opts)
|
1725
|
+
p result
|
1726
|
+
rescue SkyApi::ApiError => e
|
1727
|
+
puts "Exception when calling DefaultApi->transactions_post: #{e}"
|
1728
|
+
end
|
1729
|
+
```
|
1730
|
+
|
1731
|
+
### Parameters
|
1732
|
+
|
1733
|
+
|
1734
|
+
Name | Type | Description | Notes
|
1735
|
+
------------- | ------------- | ------------- | -------------
|
1736
|
+
**addrs** | **String**| command separated list of addresses | [optional]
|
1737
|
+
**confirmed** | **String**| Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] | [optional]
|
1738
|
+
|
1739
|
+
### Return type
|
1740
|
+
|
1741
|
+
**Object**
|
1742
|
+
|
1743
|
+
### Authorization
|
1744
|
+
|
1745
|
+
[csrfAuth](../README.md#csrfAuth)
|
1746
|
+
|
1747
|
+
### HTTP request headers
|
1748
|
+
|
1749
|
+
- **Content-Type**: Not defined
|
1750
|
+
- **Accept**: application/json, application/xml,
|
1751
|
+
|
1752
|
+
|
1753
|
+
## uxout
|
1754
|
+
|
1755
|
+
> Object uxout(opts)
|
1756
|
+
|
1757
|
+
Returns an unspent output by ID.
|
1758
|
+
|
1759
|
+
### Example
|
1760
|
+
|
1761
|
+
```ruby
|
1762
|
+
# load the gem
|
1763
|
+
require 'sky_api'
|
1764
|
+
|
1765
|
+
api_instance = SkyApi::DefaultApi.new
|
1766
|
+
opts = {
|
1767
|
+
uxid: 'uxid_example' # String | uxid to filter by
|
1768
|
+
}
|
1769
|
+
|
1770
|
+
begin
|
1771
|
+
#Returns an unspent output by ID.
|
1772
|
+
result = api_instance.uxout(opts)
|
1773
|
+
p result
|
1774
|
+
rescue SkyApi::ApiError => e
|
1775
|
+
puts "Exception when calling DefaultApi->uxout: #{e}"
|
1776
|
+
end
|
1777
|
+
```
|
1778
|
+
|
1779
|
+
### Parameters
|
1780
|
+
|
1781
|
+
|
1782
|
+
Name | Type | Description | Notes
|
1783
|
+
------------- | ------------- | ------------- | -------------
|
1784
|
+
**uxid** | **String**| uxid to filter by | [optional]
|
1785
|
+
|
1786
|
+
### Return type
|
1787
|
+
|
1788
|
+
**Object**
|
1789
|
+
|
1790
|
+
### Authorization
|
1791
|
+
|
1792
|
+
No authorization required
|
1793
|
+
|
1794
|
+
### HTTP request headers
|
1795
|
+
|
1796
|
+
- **Content-Type**: Not defined
|
1797
|
+
- **Accept**: application/json, application/xml,
|
1798
|
+
|
1799
|
+
|
1800
|
+
## verify_address
|
1801
|
+
|
1802
|
+
> Object verify_address(address)
|
1803
|
+
|
1804
|
+
Verifies a Skycoin address.
|
1805
|
+
|
1806
|
+
### Example
|
1807
|
+
|
1808
|
+
```ruby
|
1809
|
+
# load the gem
|
1810
|
+
require 'sky_api'
|
1811
|
+
# setup authorization
|
1812
|
+
SkyApi.configure do |config|
|
1813
|
+
# Configure API key authorization: csrfAuth
|
1814
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
1815
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1816
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
1817
|
+
end
|
1818
|
+
|
1819
|
+
api_instance = SkyApi::DefaultApi.new
|
1820
|
+
address = nil # Object | Address id.
|
1821
|
+
|
1822
|
+
begin
|
1823
|
+
#Verifies a Skycoin address.
|
1824
|
+
result = api_instance.verify_address(address)
|
1825
|
+
p result
|
1826
|
+
rescue SkyApi::ApiError => e
|
1827
|
+
puts "Exception when calling DefaultApi->verify_address: #{e}"
|
1828
|
+
end
|
1829
|
+
```
|
1830
|
+
|
1831
|
+
### Parameters
|
1832
|
+
|
1833
|
+
|
1834
|
+
Name | Type | Description | Notes
|
1835
|
+
------------- | ------------- | ------------- | -------------
|
1836
|
+
**address** | [**Object**](.md)| Address id. |
|
1837
|
+
|
1838
|
+
### Return type
|
1839
|
+
|
1840
|
+
**Object**
|
1841
|
+
|
1842
|
+
### Authorization
|
1843
|
+
|
1844
|
+
[csrfAuth](../README.md#csrfAuth)
|
1845
|
+
|
1846
|
+
### HTTP request headers
|
1847
|
+
|
1848
|
+
- **Content-Type**: Not defined
|
1849
|
+
- **Accept**: application/json, application/xml,
|
1850
|
+
|
1851
|
+
|
1852
|
+
## version
|
1853
|
+
|
1854
|
+
> InlineResponse2005 version
|
1855
|
+
|
1856
|
+
|
1857
|
+
|
1858
|
+
versionHandler returns the application version info
|
1859
|
+
|
1860
|
+
### Example
|
1861
|
+
|
1862
|
+
```ruby
|
1863
|
+
# load the gem
|
1864
|
+
require 'sky_api'
|
1865
|
+
|
1866
|
+
api_instance = SkyApi::DefaultApi.new
|
1867
|
+
|
1868
|
+
begin
|
1869
|
+
result = api_instance.version
|
1870
|
+
p result
|
1871
|
+
rescue SkyApi::ApiError => e
|
1872
|
+
puts "Exception when calling DefaultApi->version: #{e}"
|
1873
|
+
end
|
1874
|
+
```
|
1875
|
+
|
1876
|
+
### Parameters
|
1877
|
+
|
1878
|
+
This endpoint does not need any parameter.
|
1879
|
+
|
1880
|
+
### Return type
|
1881
|
+
|
1882
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
1883
|
+
|
1884
|
+
### Authorization
|
1885
|
+
|
1886
|
+
No authorization required
|
1887
|
+
|
1888
|
+
### HTTP request headers
|
1889
|
+
|
1890
|
+
- **Content-Type**: Not defined
|
1891
|
+
- **Accept**: application/json, application/xml,
|
1892
|
+
|
1893
|
+
|
1894
|
+
## wallet
|
1895
|
+
|
1896
|
+
> Object wallet(id)
|
1897
|
+
|
1898
|
+
Returns a wallet by id.
|
1899
|
+
|
1900
|
+
### Example
|
1901
|
+
|
1902
|
+
```ruby
|
1903
|
+
# load the gem
|
1904
|
+
require 'sky_api'
|
1905
|
+
|
1906
|
+
api_instance = SkyApi::DefaultApi.new
|
1907
|
+
id = 'id_example' # String | tags to filter by
|
1908
|
+
|
1909
|
+
begin
|
1910
|
+
#Returns a wallet by id.
|
1911
|
+
result = api_instance.wallet(id)
|
1912
|
+
p result
|
1913
|
+
rescue SkyApi::ApiError => e
|
1914
|
+
puts "Exception when calling DefaultApi->wallet: #{e}"
|
1915
|
+
end
|
1916
|
+
```
|
1917
|
+
|
1918
|
+
### Parameters
|
1919
|
+
|
1920
|
+
|
1921
|
+
Name | Type | Description | Notes
|
1922
|
+
------------- | ------------- | ------------- | -------------
|
1923
|
+
**id** | **String**| tags to filter by |
|
1924
|
+
|
1925
|
+
### Return type
|
1926
|
+
|
1927
|
+
**Object**
|
1928
|
+
|
1929
|
+
### Authorization
|
1930
|
+
|
1931
|
+
No authorization required
|
1932
|
+
|
1933
|
+
### HTTP request headers
|
1934
|
+
|
1935
|
+
- **Content-Type**: Not defined
|
1936
|
+
- **Accept**: application/json, application/xml,
|
1937
|
+
|
1938
|
+
|
1939
|
+
## wallet_balance
|
1940
|
+
|
1941
|
+
> Object wallet_balance(id)
|
1942
|
+
|
1943
|
+
Returns the wallet's balance, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
1944
|
+
|
1945
|
+
### Example
|
1946
|
+
|
1947
|
+
```ruby
|
1948
|
+
# load the gem
|
1949
|
+
require 'sky_api'
|
1950
|
+
|
1951
|
+
api_instance = SkyApi::DefaultApi.new
|
1952
|
+
id = 'id_example' # String | tags to filter by
|
1953
|
+
|
1954
|
+
begin
|
1955
|
+
#Returns the wallet's balance, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
|
1956
|
+
result = api_instance.wallet_balance(id)
|
1957
|
+
p result
|
1958
|
+
rescue SkyApi::ApiError => e
|
1959
|
+
puts "Exception when calling DefaultApi->wallet_balance: #{e}"
|
1960
|
+
end
|
1961
|
+
```
|
1962
|
+
|
1963
|
+
### Parameters
|
1964
|
+
|
1965
|
+
|
1966
|
+
Name | Type | Description | Notes
|
1967
|
+
------------- | ------------- | ------------- | -------------
|
1968
|
+
**id** | **String**| tags to filter by |
|
1969
|
+
|
1970
|
+
### Return type
|
1971
|
+
|
1972
|
+
**Object**
|
1973
|
+
|
1974
|
+
### Authorization
|
1975
|
+
|
1976
|
+
No authorization required
|
1977
|
+
|
1978
|
+
### HTTP request headers
|
1979
|
+
|
1980
|
+
- **Content-Type**: Not defined
|
1981
|
+
- **Accept**: application/json, application/xml,
|
1982
|
+
|
1983
|
+
|
1984
|
+
## wallet_create
|
1985
|
+
|
1986
|
+
> Object wallet_create(seed, label, opts)
|
1987
|
+
|
1988
|
+
|
1989
|
+
|
1990
|
+
Loads wallet from seed, will scan ahead N address and load addresses till the last one that have coins.
|
1991
|
+
|
1992
|
+
### Example
|
1993
|
+
|
1994
|
+
```ruby
|
1995
|
+
# load the gem
|
1996
|
+
require 'sky_api'
|
1997
|
+
# setup authorization
|
1998
|
+
SkyApi.configure do |config|
|
1999
|
+
# Configure API key authorization: csrfAuth
|
2000
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2001
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2002
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2003
|
+
end
|
2004
|
+
|
2005
|
+
api_instance = SkyApi::DefaultApi.new
|
2006
|
+
seed = 'seed_example' # String | Wallet seed.
|
2007
|
+
label = 'label_example' # String | Wallet label.
|
2008
|
+
opts = {
|
2009
|
+
scan: 56, # Integer | The number of addresses to scan ahead for balances.
|
2010
|
+
encrypt: true, # Boolean | Encrypt wallet.
|
2011
|
+
password: 'password_example' # String | Wallet Password
|
2012
|
+
}
|
2013
|
+
|
2014
|
+
begin
|
2015
|
+
result = api_instance.wallet_create(seed, label, opts)
|
2016
|
+
p result
|
2017
|
+
rescue SkyApi::ApiError => e
|
2018
|
+
puts "Exception when calling DefaultApi->wallet_create: #{e}"
|
2019
|
+
end
|
2020
|
+
```
|
2021
|
+
|
2022
|
+
### Parameters
|
2023
|
+
|
2024
|
+
|
2025
|
+
Name | Type | Description | Notes
|
2026
|
+
------------- | ------------- | ------------- | -------------
|
2027
|
+
**seed** | **String**| Wallet seed. |
|
2028
|
+
**label** | **String**| Wallet label. |
|
2029
|
+
**scan** | **Integer**| The number of addresses to scan ahead for balances. | [optional]
|
2030
|
+
**encrypt** | **Boolean**| Encrypt wallet. | [optional]
|
2031
|
+
**password** | **String**| Wallet Password | [optional]
|
2032
|
+
|
2033
|
+
### Return type
|
2034
|
+
|
2035
|
+
**Object**
|
2036
|
+
|
2037
|
+
### Authorization
|
2038
|
+
|
2039
|
+
[csrfAuth](../README.md#csrfAuth)
|
2040
|
+
|
2041
|
+
### HTTP request headers
|
2042
|
+
|
2043
|
+
- **Content-Type**: Not defined
|
2044
|
+
- **Accept**: application/json, application/xml,
|
2045
|
+
|
2046
|
+
|
2047
|
+
## wallet_decrypt
|
2048
|
+
|
2049
|
+
> Object wallet_decrypt(id, password)
|
2050
|
+
|
2051
|
+
Decrypts wallet.
|
2052
|
+
|
2053
|
+
### Example
|
2054
|
+
|
2055
|
+
```ruby
|
2056
|
+
# load the gem
|
2057
|
+
require 'sky_api'
|
2058
|
+
# setup authorization
|
2059
|
+
SkyApi.configure do |config|
|
2060
|
+
# Configure API key authorization: csrfAuth
|
2061
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2062
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2063
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2064
|
+
end
|
2065
|
+
|
2066
|
+
api_instance = SkyApi::DefaultApi.new
|
2067
|
+
id = 'id_example' # String | Wallet id.
|
2068
|
+
password = 'password_example' # String | Wallet password.
|
2069
|
+
|
2070
|
+
begin
|
2071
|
+
#Decrypts wallet.
|
2072
|
+
result = api_instance.wallet_decrypt(id, password)
|
2073
|
+
p result
|
2074
|
+
rescue SkyApi::ApiError => e
|
2075
|
+
puts "Exception when calling DefaultApi->wallet_decrypt: #{e}"
|
2076
|
+
end
|
2077
|
+
```
|
2078
|
+
|
2079
|
+
### Parameters
|
2080
|
+
|
2081
|
+
|
2082
|
+
Name | Type | Description | Notes
|
2083
|
+
------------- | ------------- | ------------- | -------------
|
2084
|
+
**id** | **String**| Wallet id. |
|
2085
|
+
**password** | **String**| Wallet password. |
|
2086
|
+
|
2087
|
+
### Return type
|
2088
|
+
|
2089
|
+
**Object**
|
2090
|
+
|
2091
|
+
### Authorization
|
2092
|
+
|
2093
|
+
[csrfAuth](../README.md#csrfAuth)
|
2094
|
+
|
2095
|
+
### HTTP request headers
|
2096
|
+
|
2097
|
+
- **Content-Type**: Not defined
|
2098
|
+
- **Accept**: application/json, application/xml,
|
2099
|
+
|
2100
|
+
|
2101
|
+
## wallet_encrypt
|
2102
|
+
|
2103
|
+
> Object wallet_encrypt(id, password)
|
2104
|
+
|
2105
|
+
Encrypt wallet.
|
2106
|
+
|
2107
|
+
### Example
|
2108
|
+
|
2109
|
+
```ruby
|
2110
|
+
# load the gem
|
2111
|
+
require 'sky_api'
|
2112
|
+
# setup authorization
|
2113
|
+
SkyApi.configure do |config|
|
2114
|
+
# Configure API key authorization: csrfAuth
|
2115
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2116
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2117
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2118
|
+
end
|
2119
|
+
|
2120
|
+
api_instance = SkyApi::DefaultApi.new
|
2121
|
+
id = 'id_example' # String | Wallet id.
|
2122
|
+
password = 'password_example' # String | Wallet password.
|
2123
|
+
|
2124
|
+
begin
|
2125
|
+
#Encrypt wallet.
|
2126
|
+
result = api_instance.wallet_encrypt(id, password)
|
2127
|
+
p result
|
2128
|
+
rescue SkyApi::ApiError => e
|
2129
|
+
puts "Exception when calling DefaultApi->wallet_encrypt: #{e}"
|
2130
|
+
end
|
2131
|
+
```
|
2132
|
+
|
2133
|
+
### Parameters
|
2134
|
+
|
2135
|
+
|
2136
|
+
Name | Type | Description | Notes
|
2137
|
+
------------- | ------------- | ------------- | -------------
|
2138
|
+
**id** | **String**| Wallet id. |
|
2139
|
+
**password** | **String**| Wallet password. |
|
2140
|
+
|
2141
|
+
### Return type
|
2142
|
+
|
2143
|
+
**Object**
|
2144
|
+
|
2145
|
+
### Authorization
|
2146
|
+
|
2147
|
+
[csrfAuth](../README.md#csrfAuth)
|
2148
|
+
|
2149
|
+
### HTTP request headers
|
2150
|
+
|
2151
|
+
- **Content-Type**: Not defined
|
2152
|
+
- **Accept**: application/json, application/xml,
|
2153
|
+
|
2154
|
+
|
2155
|
+
## wallet_folder
|
2156
|
+
|
2157
|
+
> InlineResponse2007 wallet_folder(addr)
|
2158
|
+
|
2159
|
+
|
2160
|
+
|
2161
|
+
Returns the wallet directory path
|
2162
|
+
|
2163
|
+
### Example
|
2164
|
+
|
2165
|
+
```ruby
|
2166
|
+
# load the gem
|
2167
|
+
require 'sky_api'
|
2168
|
+
|
2169
|
+
api_instance = SkyApi::DefaultApi.new
|
2170
|
+
addr = 'addr_example' # String | Address port
|
2171
|
+
|
2172
|
+
begin
|
2173
|
+
result = api_instance.wallet_folder(addr)
|
2174
|
+
p result
|
2175
|
+
rescue SkyApi::ApiError => e
|
2176
|
+
puts "Exception when calling DefaultApi->wallet_folder: #{e}"
|
2177
|
+
end
|
2178
|
+
```
|
2179
|
+
|
2180
|
+
### Parameters
|
2181
|
+
|
2182
|
+
|
2183
|
+
Name | Type | Description | Notes
|
2184
|
+
------------- | ------------- | ------------- | -------------
|
2185
|
+
**addr** | **String**| Address port |
|
2186
|
+
|
2187
|
+
### Return type
|
2188
|
+
|
2189
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
2190
|
+
|
2191
|
+
### Authorization
|
2192
|
+
|
2193
|
+
No authorization required
|
2194
|
+
|
2195
|
+
### HTTP request headers
|
2196
|
+
|
2197
|
+
- **Content-Type**: Not defined
|
2198
|
+
- **Accept**: application/json, application/xml,
|
2199
|
+
|
2200
|
+
|
2201
|
+
## wallet_new_address
|
2202
|
+
|
2203
|
+
> Object wallet_new_address(id, opts)
|
2204
|
+
|
2205
|
+
|
2206
|
+
|
2207
|
+
Generates new addresses
|
2208
|
+
|
2209
|
+
### Example
|
2210
|
+
|
2211
|
+
```ruby
|
2212
|
+
# load the gem
|
2213
|
+
require 'sky_api'
|
2214
|
+
# setup authorization
|
2215
|
+
SkyApi.configure do |config|
|
2216
|
+
# Configure API key authorization: csrfAuth
|
2217
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2218
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2219
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2220
|
+
end
|
2221
|
+
|
2222
|
+
api_instance = SkyApi::DefaultApi.new
|
2223
|
+
id = 'id_example' # String | Wallet Id
|
2224
|
+
opts = {
|
2225
|
+
num: 'num_example', # String | The number you want to generate
|
2226
|
+
password: 'password_example' # String | Wallet Password
|
2227
|
+
}
|
2228
|
+
|
2229
|
+
begin
|
2230
|
+
result = api_instance.wallet_new_address(id, opts)
|
2231
|
+
p result
|
2232
|
+
rescue SkyApi::ApiError => e
|
2233
|
+
puts "Exception when calling DefaultApi->wallet_new_address: #{e}"
|
2234
|
+
end
|
2235
|
+
```
|
2236
|
+
|
2237
|
+
### Parameters
|
2238
|
+
|
2239
|
+
|
2240
|
+
Name | Type | Description | Notes
|
2241
|
+
------------- | ------------- | ------------- | -------------
|
2242
|
+
**id** | **String**| Wallet Id |
|
2243
|
+
**num** | **String**| The number you want to generate | [optional]
|
2244
|
+
**password** | **String**| Wallet Password | [optional]
|
2245
|
+
|
2246
|
+
### Return type
|
2247
|
+
|
2248
|
+
**Object**
|
2249
|
+
|
2250
|
+
### Authorization
|
2251
|
+
|
2252
|
+
[csrfAuth](../README.md#csrfAuth)
|
2253
|
+
|
2254
|
+
### HTTP request headers
|
2255
|
+
|
2256
|
+
- **Content-Type**: Not defined
|
2257
|
+
- **Accept**: application/json, application/xml,
|
2258
|
+
|
2259
|
+
|
2260
|
+
## wallet_new_seed
|
2261
|
+
|
2262
|
+
> Object wallet_new_seed(opts)
|
2263
|
+
|
2264
|
+
|
2265
|
+
|
2266
|
+
Returns the wallet directory path
|
2267
|
+
|
2268
|
+
### Example
|
2269
|
+
|
2270
|
+
```ruby
|
2271
|
+
# load the gem
|
2272
|
+
require 'sky_api'
|
2273
|
+
|
2274
|
+
api_instance = SkyApi::DefaultApi.new
|
2275
|
+
opts = {
|
2276
|
+
entropy: 'entropy_example' # String | Entropy bitSize.
|
2277
|
+
}
|
2278
|
+
|
2279
|
+
begin
|
2280
|
+
result = api_instance.wallet_new_seed(opts)
|
2281
|
+
p result
|
2282
|
+
rescue SkyApi::ApiError => e
|
2283
|
+
puts "Exception when calling DefaultApi->wallet_new_seed: #{e}"
|
2284
|
+
end
|
2285
|
+
```
|
2286
|
+
|
2287
|
+
### Parameters
|
2288
|
+
|
2289
|
+
|
2290
|
+
Name | Type | Description | Notes
|
2291
|
+
------------- | ------------- | ------------- | -------------
|
2292
|
+
**entropy** | **String**| Entropy bitSize. | [optional]
|
2293
|
+
|
2294
|
+
### Return type
|
2295
|
+
|
2296
|
+
**Object**
|
2297
|
+
|
2298
|
+
### Authorization
|
2299
|
+
|
2300
|
+
No authorization required
|
2301
|
+
|
2302
|
+
### HTTP request headers
|
2303
|
+
|
2304
|
+
- **Content-Type**: Not defined
|
2305
|
+
- **Accept**: application/json, application/xml,
|
2306
|
+
|
2307
|
+
|
2308
|
+
## wallet_recover
|
2309
|
+
|
2310
|
+
> Object wallet_recover(id, seed, opts)
|
2311
|
+
|
2312
|
+
Recovers an encrypted wallet by providing the seed. The first address will be generated from seed and compared to the first address of the specified wallet. If they match, the wallet will be regenerated with an optional password. If the wallet is not encrypted, an error is returned.
|
2313
|
+
|
2314
|
+
### Example
|
2315
|
+
|
2316
|
+
```ruby
|
2317
|
+
# load the gem
|
2318
|
+
require 'sky_api'
|
2319
|
+
# setup authorization
|
2320
|
+
SkyApi.configure do |config|
|
2321
|
+
# Configure API key authorization: csrfAuth
|
2322
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2323
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2324
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2325
|
+
end
|
2326
|
+
|
2327
|
+
api_instance = SkyApi::DefaultApi.new
|
2328
|
+
id = 'id_example' # String | Wallet id.
|
2329
|
+
seed = 'seed_example' # String | Wallet seed.
|
2330
|
+
opts = {
|
2331
|
+
password: 'password_example' # String | Wallet password.
|
2332
|
+
}
|
2333
|
+
|
2334
|
+
begin
|
2335
|
+
#Recovers an encrypted wallet by providing the seed. The first address will be generated from seed and compared to the first address of the specified wallet. If they match, the wallet will be regenerated with an optional password. If the wallet is not encrypted, an error is returned.
|
2336
|
+
result = api_instance.wallet_recover(id, seed, opts)
|
2337
|
+
p result
|
2338
|
+
rescue SkyApi::ApiError => e
|
2339
|
+
puts "Exception when calling DefaultApi->wallet_recover: #{e}"
|
2340
|
+
end
|
2341
|
+
```
|
2342
|
+
|
2343
|
+
### Parameters
|
2344
|
+
|
2345
|
+
|
2346
|
+
Name | Type | Description | Notes
|
2347
|
+
------------- | ------------- | ------------- | -------------
|
2348
|
+
**id** | **String**| Wallet id. |
|
2349
|
+
**seed** | **String**| Wallet seed. |
|
2350
|
+
**password** | **String**| Wallet password. | [optional]
|
2351
|
+
|
2352
|
+
### Return type
|
2353
|
+
|
2354
|
+
**Object**
|
2355
|
+
|
2356
|
+
### Authorization
|
2357
|
+
|
2358
|
+
[csrfAuth](../README.md#csrfAuth)
|
2359
|
+
|
2360
|
+
### HTTP request headers
|
2361
|
+
|
2362
|
+
- **Content-Type**: Not defined
|
2363
|
+
- **Accept**: application/json, application/xml,
|
2364
|
+
|
2365
|
+
|
2366
|
+
## wallet_seed
|
2367
|
+
|
2368
|
+
> Object wallet_seed(id, password)
|
2369
|
+
|
2370
|
+
This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
|
2371
|
+
|
2372
|
+
### Example
|
2373
|
+
|
2374
|
+
```ruby
|
2375
|
+
# load the gem
|
2376
|
+
require 'sky_api'
|
2377
|
+
# setup authorization
|
2378
|
+
SkyApi.configure do |config|
|
2379
|
+
# Configure API key authorization: csrfAuth
|
2380
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2381
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2382
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2383
|
+
end
|
2384
|
+
|
2385
|
+
api_instance = SkyApi::DefaultApi.new
|
2386
|
+
id = 'id_example' # String | Wallet Id.
|
2387
|
+
password = 'password_example' # String | Wallet password.
|
2388
|
+
|
2389
|
+
begin
|
2390
|
+
#This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
|
2391
|
+
result = api_instance.wallet_seed(id, password)
|
2392
|
+
p result
|
2393
|
+
rescue SkyApi::ApiError => e
|
2394
|
+
puts "Exception when calling DefaultApi->wallet_seed: #{e}"
|
2395
|
+
end
|
2396
|
+
```
|
2397
|
+
|
2398
|
+
### Parameters
|
2399
|
+
|
2400
|
+
|
2401
|
+
Name | Type | Description | Notes
|
2402
|
+
------------- | ------------- | ------------- | -------------
|
2403
|
+
**id** | **String**| Wallet Id. |
|
2404
|
+
**password** | **String**| Wallet password. |
|
2405
|
+
|
2406
|
+
### Return type
|
2407
|
+
|
2408
|
+
**Object**
|
2409
|
+
|
2410
|
+
### Authorization
|
2411
|
+
|
2412
|
+
[csrfAuth](../README.md#csrfAuth)
|
2413
|
+
|
2414
|
+
### HTTP request headers
|
2415
|
+
|
2416
|
+
- **Content-Type**: Not defined
|
2417
|
+
- **Accept**: application/json, application/xml,
|
2418
|
+
|
2419
|
+
|
2420
|
+
## wallet_seed_verify
|
2421
|
+
|
2422
|
+
> Object wallet_seed_verify(opts)
|
2423
|
+
|
2424
|
+
Verifies a wallet seed.
|
2425
|
+
|
2426
|
+
### Example
|
2427
|
+
|
2428
|
+
```ruby
|
2429
|
+
# load the gem
|
2430
|
+
require 'sky_api'
|
2431
|
+
# setup authorization
|
2432
|
+
SkyApi.configure do |config|
|
2433
|
+
# Configure API key authorization: csrfAuth
|
2434
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2435
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2436
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2437
|
+
end
|
2438
|
+
|
2439
|
+
api_instance = SkyApi::DefaultApi.new
|
2440
|
+
opts = {
|
2441
|
+
seed: 'seed_example' # String | Seed to be verified.
|
2442
|
+
}
|
2443
|
+
|
2444
|
+
begin
|
2445
|
+
#Verifies a wallet seed.
|
2446
|
+
result = api_instance.wallet_seed_verify(opts)
|
2447
|
+
p result
|
2448
|
+
rescue SkyApi::ApiError => e
|
2449
|
+
puts "Exception when calling DefaultApi->wallet_seed_verify: #{e}"
|
2450
|
+
end
|
2451
|
+
```
|
2452
|
+
|
2453
|
+
### Parameters
|
2454
|
+
|
2455
|
+
|
2456
|
+
Name | Type | Description | Notes
|
2457
|
+
------------- | ------------- | ------------- | -------------
|
2458
|
+
**seed** | **String**| Seed to be verified. | [optional]
|
2459
|
+
|
2460
|
+
### Return type
|
2461
|
+
|
2462
|
+
**Object**
|
2463
|
+
|
2464
|
+
### Authorization
|
2465
|
+
|
2466
|
+
[csrfAuth](../README.md#csrfAuth)
|
2467
|
+
|
2468
|
+
### HTTP request headers
|
2469
|
+
|
2470
|
+
- **Content-Type**: Not defined
|
2471
|
+
- **Accept**: application/json, application/xml,
|
2472
|
+
|
2473
|
+
|
2474
|
+
## wallet_transaction
|
2475
|
+
|
2476
|
+
> Object wallet_transaction(wallet_transaction_request)
|
2477
|
+
|
2478
|
+
Creates a signed transaction
|
2479
|
+
|
2480
|
+
### Example
|
2481
|
+
|
2482
|
+
```ruby
|
2483
|
+
# load the gem
|
2484
|
+
require 'sky_api'
|
2485
|
+
# setup authorization
|
2486
|
+
SkyApi.configure do |config|
|
2487
|
+
# Configure API key authorization: csrfAuth
|
2488
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2489
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2490
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2491
|
+
end
|
2492
|
+
|
2493
|
+
api_instance = SkyApi::DefaultApi.new
|
2494
|
+
wallet_transaction_request = SkyApi::WalletTransactionRequest.new # WalletTransactionRequest |
|
2495
|
+
|
2496
|
+
begin
|
2497
|
+
#Creates a signed transaction
|
2498
|
+
result = api_instance.wallet_transaction(wallet_transaction_request)
|
2499
|
+
p result
|
2500
|
+
rescue SkyApi::ApiError => e
|
2501
|
+
puts "Exception when calling DefaultApi->wallet_transaction: #{e}"
|
2502
|
+
end
|
2503
|
+
```
|
2504
|
+
|
2505
|
+
### Parameters
|
2506
|
+
|
2507
|
+
|
2508
|
+
Name | Type | Description | Notes
|
2509
|
+
------------- | ------------- | ------------- | -------------
|
2510
|
+
**wallet_transaction_request** | [**WalletTransactionRequest**](WalletTransactionRequest.md)| |
|
2511
|
+
|
2512
|
+
### Return type
|
2513
|
+
|
2514
|
+
**Object**
|
2515
|
+
|
2516
|
+
### Authorization
|
2517
|
+
|
2518
|
+
[csrfAuth](../README.md#csrfAuth)
|
2519
|
+
|
2520
|
+
### HTTP request headers
|
2521
|
+
|
2522
|
+
- **Content-Type**: application/json
|
2523
|
+
- **Accept**: application/json, application/xml,
|
2524
|
+
|
2525
|
+
|
2526
|
+
## wallet_transaction_sign
|
2527
|
+
|
2528
|
+
> InlineResponse2009 wallet_transaction_sign(wallet_transaction_sign_request)
|
2529
|
+
|
2530
|
+
Creates a signed transaction
|
2531
|
+
|
2532
|
+
### Example
|
2533
|
+
|
2534
|
+
```ruby
|
2535
|
+
# load the gem
|
2536
|
+
require 'sky_api'
|
2537
|
+
# setup authorization
|
2538
|
+
SkyApi.configure do |config|
|
2539
|
+
# Configure API key authorization: csrfAuth
|
2540
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2541
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2542
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2543
|
+
end
|
2544
|
+
|
2545
|
+
api_instance = SkyApi::DefaultApi.new
|
2546
|
+
wallet_transaction_sign_request = SkyApi::WalletTransactionSignRequest.new # WalletTransactionSignRequest |
|
2547
|
+
|
2548
|
+
begin
|
2549
|
+
#Creates a signed transaction
|
2550
|
+
result = api_instance.wallet_transaction_sign(wallet_transaction_sign_request)
|
2551
|
+
p result
|
2552
|
+
rescue SkyApi::ApiError => e
|
2553
|
+
puts "Exception when calling DefaultApi->wallet_transaction_sign: #{e}"
|
2554
|
+
end
|
2555
|
+
```
|
2556
|
+
|
2557
|
+
### Parameters
|
2558
|
+
|
2559
|
+
|
2560
|
+
Name | Type | Description | Notes
|
2561
|
+
------------- | ------------- | ------------- | -------------
|
2562
|
+
**wallet_transaction_sign_request** | [**WalletTransactionSignRequest**](WalletTransactionSignRequest.md)| |
|
2563
|
+
|
2564
|
+
### Return type
|
2565
|
+
|
2566
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
2567
|
+
|
2568
|
+
### Authorization
|
2569
|
+
|
2570
|
+
[csrfAuth](../README.md#csrfAuth)
|
2571
|
+
|
2572
|
+
### HTTP request headers
|
2573
|
+
|
2574
|
+
- **Content-Type**: application/json
|
2575
|
+
- **Accept**: application/json, application/xml,
|
2576
|
+
|
2577
|
+
|
2578
|
+
## wallet_transactions
|
2579
|
+
|
2580
|
+
> InlineResponse2006 wallet_transactions(id)
|
2581
|
+
|
2582
|
+
|
2583
|
+
|
2584
|
+
### Example
|
2585
|
+
|
2586
|
+
```ruby
|
2587
|
+
# load the gem
|
2588
|
+
require 'sky_api'
|
2589
|
+
|
2590
|
+
api_instance = SkyApi::DefaultApi.new
|
2591
|
+
id = 'id_example' # String | Wallet Id.
|
2592
|
+
|
2593
|
+
begin
|
2594
|
+
result = api_instance.wallet_transactions(id)
|
2595
|
+
p result
|
2596
|
+
rescue SkyApi::ApiError => e
|
2597
|
+
puts "Exception when calling DefaultApi->wallet_transactions: #{e}"
|
2598
|
+
end
|
2599
|
+
```
|
2600
|
+
|
2601
|
+
### Parameters
|
2602
|
+
|
2603
|
+
|
2604
|
+
Name | Type | Description | Notes
|
2605
|
+
------------- | ------------- | ------------- | -------------
|
2606
|
+
**id** | **String**| Wallet Id. |
|
2607
|
+
|
2608
|
+
### Return type
|
2609
|
+
|
2610
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
2611
|
+
|
2612
|
+
### Authorization
|
2613
|
+
|
2614
|
+
No authorization required
|
2615
|
+
|
2616
|
+
### HTTP request headers
|
2617
|
+
|
2618
|
+
- **Content-Type**: Not defined
|
2619
|
+
- **Accept**: application/json, application/xml,
|
2620
|
+
|
2621
|
+
|
2622
|
+
## wallet_unload
|
2623
|
+
|
2624
|
+
> wallet_unload(id)
|
2625
|
+
|
2626
|
+
Unloads wallet from the wallet service.
|
2627
|
+
|
2628
|
+
### Example
|
2629
|
+
|
2630
|
+
```ruby
|
2631
|
+
# load the gem
|
2632
|
+
require 'sky_api'
|
2633
|
+
# setup authorization
|
2634
|
+
SkyApi.configure do |config|
|
2635
|
+
# Configure API key authorization: csrfAuth
|
2636
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2637
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2638
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2639
|
+
end
|
2640
|
+
|
2641
|
+
api_instance = SkyApi::DefaultApi.new
|
2642
|
+
id = 'id_example' # String | Wallet Id.
|
2643
|
+
|
2644
|
+
begin
|
2645
|
+
#Unloads wallet from the wallet service.
|
2646
|
+
api_instance.wallet_unload(id)
|
2647
|
+
rescue SkyApi::ApiError => e
|
2648
|
+
puts "Exception when calling DefaultApi->wallet_unload: #{e}"
|
2649
|
+
end
|
2650
|
+
```
|
2651
|
+
|
2652
|
+
### Parameters
|
2653
|
+
|
2654
|
+
|
2655
|
+
Name | Type | Description | Notes
|
2656
|
+
------------- | ------------- | ------------- | -------------
|
2657
|
+
**id** | **String**| Wallet Id. |
|
2658
|
+
|
2659
|
+
### Return type
|
2660
|
+
|
2661
|
+
nil (empty response body)
|
2662
|
+
|
2663
|
+
### Authorization
|
2664
|
+
|
2665
|
+
[csrfAuth](../README.md#csrfAuth)
|
2666
|
+
|
2667
|
+
### HTTP request headers
|
2668
|
+
|
2669
|
+
- **Content-Type**: Not defined
|
2670
|
+
- **Accept**: application/json, application/xml
|
2671
|
+
|
2672
|
+
|
2673
|
+
## wallet_update
|
2674
|
+
|
2675
|
+
> String wallet_update(id, label)
|
2676
|
+
|
2677
|
+
Update the wallet.
|
2678
|
+
|
2679
|
+
### Example
|
2680
|
+
|
2681
|
+
```ruby
|
2682
|
+
# load the gem
|
2683
|
+
require 'sky_api'
|
2684
|
+
# setup authorization
|
2685
|
+
SkyApi.configure do |config|
|
2686
|
+
# Configure API key authorization: csrfAuth
|
2687
|
+
config.api_key['X-CSRF-TOKEN'] = 'YOUR API KEY'
|
2688
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2689
|
+
#config.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
|
2690
|
+
end
|
2691
|
+
|
2692
|
+
api_instance = SkyApi::DefaultApi.new
|
2693
|
+
id = 'id_example' # String | Wallet Id.
|
2694
|
+
label = 'label_example' # String | The label the wallet will be updated to.
|
2695
|
+
|
2696
|
+
begin
|
2697
|
+
#Update the wallet.
|
2698
|
+
result = api_instance.wallet_update(id, label)
|
2699
|
+
p result
|
2700
|
+
rescue SkyApi::ApiError => e
|
2701
|
+
puts "Exception when calling DefaultApi->wallet_update: #{e}"
|
2702
|
+
end
|
2703
|
+
```
|
2704
|
+
|
2705
|
+
### Parameters
|
2706
|
+
|
2707
|
+
|
2708
|
+
Name | Type | Description | Notes
|
2709
|
+
------------- | ------------- | ------------- | -------------
|
2710
|
+
**id** | **String**| Wallet Id. |
|
2711
|
+
**label** | **String**| The label the wallet will be updated to. |
|
2712
|
+
|
2713
|
+
### Return type
|
2714
|
+
|
2715
|
+
**String**
|
2716
|
+
|
2717
|
+
### Authorization
|
2718
|
+
|
2719
|
+
[csrfAuth](../README.md#csrfAuth)
|
2720
|
+
|
2721
|
+
### HTTP request headers
|
2722
|
+
|
2723
|
+
- **Content-Type**: Not defined
|
2724
|
+
- **Accept**: text/plain, application/json, application/xml
|
2725
|
+
|
2726
|
+
|
2727
|
+
## wallets
|
2728
|
+
|
2729
|
+
> Array<Object> wallets
|
2730
|
+
|
2731
|
+
|
2732
|
+
|
2733
|
+
Returns all loaded wallets
|
2734
|
+
|
2735
|
+
### Example
|
2736
|
+
|
2737
|
+
```ruby
|
2738
|
+
# load the gem
|
2739
|
+
require 'sky_api'
|
2740
|
+
|
2741
|
+
api_instance = SkyApi::DefaultApi.new
|
2742
|
+
|
2743
|
+
begin
|
2744
|
+
result = api_instance.wallets
|
2745
|
+
p result
|
2746
|
+
rescue SkyApi::ApiError => e
|
2747
|
+
puts "Exception when calling DefaultApi->wallets: #{e}"
|
2748
|
+
end
|
2749
|
+
```
|
2750
|
+
|
2751
|
+
### Parameters
|
2752
|
+
|
2753
|
+
This endpoint does not need any parameter.
|
2754
|
+
|
2755
|
+
### Return type
|
2756
|
+
|
2757
|
+
**Array<Object>**
|
2758
|
+
|
2759
|
+
### Authorization
|
2760
|
+
|
2761
|
+
No authorization required
|
2762
|
+
|
2763
|
+
### HTTP request headers
|
2764
|
+
|
2765
|
+
- **Content-Type**: Not defined
|
2766
|
+
- **Accept**: application/json, application/xml,
|
2767
|
+
|