diff --git a/.travis.yml b/.travis.yml index 95f36ec25..724fef9fc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,42 +3,56 @@ services: - docker language: go go: - - "1.11.x" - matrix: include: - os: linux dist: xenial - os: osx osx_image: xcode8.3 - before_install: - - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test && sudo apt-get update -qq; fi + - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then + sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test && sudo apt-get update -qq; + fi - ./ci-scripts/install-travis-gcc.sh - eval "CC=gcc-6 && CXX=g++-6" - env: global: - BUILD_DIR: build - - BUILDLIB_DIR: $BUILD_DIR/libskycoin + - BUILDLIB_DIR: "$BUILD_DIR/libskycoin" - LIB_DIR: lib - CGO_ENABLED: 1 - VERSION_UPGRADE_TEST_WAIT_TIMEOUT: 60s - - PATH_DIR: $GOPATH/src/github.com/skycoin/libskycoin/ - - + - PATH_DIR: "$GOPATH/src/github.com/skycoin/libskycoin/" install: + # Install gox - go get github.com/gz-c/gox - go get -t ./... - make install-linters - - VERSION=1.10.2 ./ci-scripts/install-golangci-lint.sh - - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then DEPS_DIR="${TRAVIS_BUILD_DIR}/deps" && mkdir ${DEPS_DIR} && cd ${DEPS_DIR} && travis_retry wget --no-check-certificate https://cmake.org/files/v3.3/cmake-3.3.2-Linux-x86_64.tar.gz && echo "f3546812c11ce7f5d64dc132a566b749 *cmake-3.3.2-Linux-x86_64.tar.gz" > cmake_md5.txt && md5sum -c cmake_md5.txt && tar -xvf cmake-3.3.2-Linux-x86_64.tar.gz > /dev/null && mv cmake-3.3.2-Linux-x86_64 cmake-install && PATH=${DEPS_DIR}/cmake-install:${DEPS_DIR}/cmake-install/bin:$PATH && cd ${TRAVIS_BUILD_DIR}; fi + - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then + sudo apt-get install cmake ; + fi - make install-deps-libc - make install-lib-curl - script: - make check - +before_deploy: + - export VERSION="$(git describe --tags --exact-match HEAD 2> /dev/null)" + - export ARCH="$(uname -m)" + - export OS="$(uname -s)" + - make build + - tar -c -z -f libskycoin-${VERSION}-${OS}-${ARCH}.tar.gz -C build ./* +deploy: + - provider: releases + api_key: + secure: ZqagrrwPFXs4bgHV9lJkZaex6dxAEUJprSdhsqJLYTkF4uBN5VYNM4KCy+azBabV8pVLxiCCZ8G/ocRw+omQgzJ/1lymNtYez8C/SLAuKzOFxdTxkvyQ9pW5Xr+fjptTEpe/E/lRYvS6LFtQEEpbrtjW/km9HWc7EdMNxUaGhBCRun0YhK3a7JSpQE7JbsyR691Zco8hLb2b5PO8qYx5NoVWHKPMLMYUZhbSZbWs0Viu8s8t9VLVhrSIudAKnQiNs5viWp0YZy6U6mRMuBeZ7wazebx0d/BAj78f+atGOZIiJbHgOxupnhhgR10X7b5B89JggxVe3IFr5t96qz3VV4aTl1yuLZ3i8eYanMIvdirnpPU36bbfAVMJuG7L4hFmZ+pD22ZmiOI4COqHDxSd0gF8DUri+Cf9S+5RF5Kk3YBArQzdue6DjNPBtKyQja1xINfj3Go2LQnaKH+/ffzBJIlw9TICcqf241FS3bNtx0QvUDV/+ezqy0dcD7xKOoUQmLDhyWt5NltNKu/JjoCwj99B9P45GQHJCrSvMu71hwNYlTJxtTJuLIVRXqI5BUEGpnBK99MV+6nycl0ePla4zXTBbJ/uOFzwfj1njAdw2DT4ceTsvtkTAc9qEi3S1hrRL2z3mHQ4loZCTJ9Nn9Cx0WOgfs/bCDvExa7b+AJ3ScE= + file: + - libskycoin-${VERSION}-${OS}-${ARCH}.tar.gz + skip_cleanup: true + draft: true + overwrite: true + on: + repo: skycoin/hardware-wallet + tags: true notifications: email: false - webhooks: https://fathomless-fjord-24024.herokuapp.com/notify \ No newline at end of file + webhooks: https://fathomless-fjord-24024.herokuapp.com/notify diff --git a/CHANGELOG.md b/CHANGELOG.md index fb13bc427..5f6897545 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,8 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added -- C client for Skycoin Api at `lib/curl`. For next versions a form of automatically generating the C client will be included in the Makefile. -- In this version we only support the client at `lib/curl` +- `skyapi` C client for Skycoin node REST at `lib/curl`. +- Support for building `libskycoin` on ARM and 32 / 64 bits. ### Fixed @@ -17,447 +17,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Changed -- Switch `skycoin-cli` from `urfave/cli` to `spf13/cobra`. +- Adapt `libskycoin` after switching `skycoin-cli` from `urfave/cli` to `spf13/cobra`. ### Removed - - Delete function `SKY_base58_String2Hex` ## [0.25.0] - 2018-12-19 -### Upcoming deprecated method removal notice - -In the v0.26.0 these features and functions will be removed. If you have a need for any of these features, let us know. - -- JSON-RPC 2.0 interface (this is no longer used by the CLI tool, and the REST API supports everything the JSON-RPC 2.0 API does). See https://github.com/skycoin/skycoin/blob/develop/src/api/README.md#migrating-from-the-jsonrpc-api -- `/api/v1/wallet/spend` endpoint (use `POST /api/v1/wallet/transaction` followed by `POST /api/v1/injectTransaction` instead). See https://github.com/skycoin/skycoin/blob/develop/src/api/README.md#migrating-from--api-v1-spend -- The unversioned REST API (the `-enable-unversioned-api` option will be removed, prefix your API requests with `/api/v1`). See https://github.com/skycoin/skycoin/blob/develop/src/api/README.md#migrating-from-the-unversioned-api -- `/api/v1/explorer/address` endpoint (use `GET /api/v1/transactions?verbose=1` instead). See https://github.com/skycoin/skycoin/blob/develop/src/api/README.md#migrating-from--api-v1-explorer-address - -### Notice - -Nodes v0.23.0 and earlier will not be able to connect to v0.25.0 due to a change in the introduction packet message. - -Nodes v0.24.1 and earlier will not be able to connect to v0.26.0 due to a similar change. - -Make sure to upgrade to v0.25.0 so that your node will continue to connect once v0.26.0 is released. - ### Added -- Add `-csv` option to `cli send` and `cli createRawTransaction`, which will send coins to multiple addresses defined in a csv file -- Add `-disable-default-peers` option to disable the default hardcoded peers and mark all cached peers as untrusted -- Add `-custom-peers-file` to load peers from disk. This peers file is a newline separate list of `ip:port` strings -- Add `user_agent`, `coin`, `csrf_enabled`, `csp_enabled`, `wallet_api_enabled`, `unversioned_api_enabled`, `gui_enabled` and `json_rpc_enabled`, `coinhour_burn_factor` configuration settings and `started_at` timestamp to the `/api/v1/health` endpoint response -- Add `verbose` flag to `/api/v1/block`, `/api/v1/blocks`, `/api/v1/last_blocks`, `/api/v1/pendingTxs`, `/api/v1/transaction`, `/api/v1/transactions`, `/api/v1/wallet/transactions` to return verbose block data, which includes the address, coins, hours and calculcated_hours of the block's transaction's inputs -- Add `encoded` flag to `/api/v1/transaction` to return an encoded transaction -- Add `-http-prof-host` option to choose the HTTP profiler's bind hostname (defaults to `localhost:6060`) -- Add `-enable-api-sets`, `-disable-api-sets`, `-enable-all-api-sets` options to choose which sets of API endpoints to enable. Options are `READ`, `STATUS`, `TXN`, `WALLET`, `PROMETHEUS`, `INSECURE_WALLET_SEED`, `DEPRECATED_WALLET_SPEND`. Multiple values must be comma separated. -- `/api/v1/wallet/spend` is deprecated and requires `-enable-api-set=DEPRECATED_WALLET_SPEND` to enable it. Use `/api/v1/wallet/transaction` and `/api/v1/injectTransaction` instead. -- Add `-host-whitelist` option to specify alternate allowed hosts when communicating with the API bound to a localhost interface -- Add the head block header to the response of `GET /api/v1/outputs` -- Add `"ux_hash"` to block headers in API responses -- Database verification will only be performed once when upgrading to the next version. Verification will not be performed on subsequent upgrades unless necessary. To force verification, use `-verify-db=true`. Note that it is unsafe to downgrade the skycoin node without erasing the database first. -- Add `seqs` parameter to `/api/v1/blocks` to query multiple blocks by sequences -- Add `/api/v2/wallet/recover` to recover an encrypted wallet by providing the seed -- Add HTTP Basic Auth options `-web-interface-username` and `-web-interface-password`. Auth is only available when using `-web-interface-https` unless `-web-interface-plaintext-auth` is also used. -- Go application metrics exported at `/api/v2/metrics` (API set `PROMETHEUS`) in Prometheus format -- Add `/api/v2/wallet/recover` to recover an encrypted wallet by providing the seed -- Add `fiberAddressGen` CLI command to generate distribution addresses for fiber coins - Coinhour burn factor when creating transactions can be configured at runtime with `USER_BURN_FACTOR` envvar - Max transaction size when creating transactions can be configured at runtime with `USER_MAX_TXN_SIZE` envvar - Max decimals allowed when creating transactions can be configured at runtime with `USER_MAX_DECIMALS` envvar -- Daemon configured builds will be available on the [releases](https://github.com/skycoin/skycoin/releases) page. The builds available for previous versions are configured for desktop client use. -- `skycoin-cli` builds will be available on the [releases](https://github.com/skycoin/skycoin/releases) page. -- A user agent string is sent in the wire protocol's introduction packet -- `-max-connections` option to control total max connections -- `/api/v1/network/disconnect` to disconnect a peer - Complete support for `cipher` package in `libskycoin` C API. - Add `coin`, `wallet`, `util/droplet` and `util/fee` methods as part of `libskycoin` C API -- Add `make update-golden-files` to `Makefile` -- Add CLI `richlist` command - Add `util/droplet` and `util/fee` API's as part of `libskycoin` - Implement SWIG interfaces in order to generate client libraries for multiple programming languages -### Fixed - -- Fix hanging process caused when the p2p listener port is already in use -- Fix exit status of CLI tool when wallet file cannot be loaded -- Fix `calculated_hours` and `fee` in `/api/v1/explorer/address` responses -- Fix `calculated_hours` and `fee` in `/api/v2/transaction/verify` responses for confirmed transactions -- `/api/v1/blocks` and `/api/v1/last_blocks` return `500` instead of `400` on database errors -- `POST /api/v1/wallet` returns `500` instead of `400` for internal errors -- Fix unspent output hashes in the `cli decodeRawTransaction` result -- `POST /api/v1/wallet/newAddress` and `POST /api/v1/wallet/spend` will correctly fail if the wallet is not encrypted but a password is provided -- Return `503` error for `/api/v1/injectTransaction` for all message broadcast failures (note that it is still possible for broadcast to fail but no error to be returned, in certain conditions) -- Fixed autogenerated HTTPS certs. Certs are now self-signed ECDSA certs, valid for 10 years, valid for localhost and all public interfaces found on the machine. The default cert and key are renamed from cert.pem, key.pem to skycoind.cert, skycoind.key -- `/api/v1/resendUnconfirmedTxns` will return `503 Service Unavailable` is no connections are available for broadcast -- #1979, Fix header check to allow `localhost:6420` - -### Changed - -- Add blockchain pubkey in introduction message, it would close the connection if the pubkey is not matched, but would accept it if pubkey is not provided. -- CLI tool uses the REST API instead of the deprecated webrpc API to communicate with the node -- `cli status` return value is now the response from `GET /api/v1/health`, which changes some fields -- `/api/v1/network/` endpoints will return an empty array for array values instead of `null` -- `/api/v1/blocks` will return an empty array for `"blocks"` instead of `null` -- `/api/v1/blockchain/progress` will return an empty array for `"peers"` instead of `null` -- `go run cmd/skycoin/skycoin.go` will have exit status 1 on failure and exit status 2 on panic -- The deprecated JSON 2.0 RPC interface is disabled by default for all run modes, since it is no longer needed for the CLI tool -- Remove `"unknown"` from the `"status"` field in responses from `/api/v1/explorer/address`, `/api/v1/transaction`, `/api/v1/transactions` -- `cli decodeRawTransaction` output format changed, see the [CLI README](./src/cli/README.md) -- `/api/v1/wallet/spend` is deprecated, disabled by default and requires `-enable-api-sets=DEPRECATED_WALLET_SPEND` to enable it. Use `/api/v1/wallet/transaction` and `/api/v1/injectTransaction` instead. -- Invalid password in `/api/v1/wallet` requests now return `400` instead of `401` -- Replace `cmd/address_gen/` and `cmd/address_gen2` with `go run cmd/cli/cli.go addressGen` -- `cli addressGen` arguments have changed -- `cli generateWallet` renamed to `cli walletCreate` -- `cli generateAddresses` renamed to `cli walletAddAddresses` -- `/api/v1/explorer/address` is deprecated in favor of `/api/v1/transactions?verbose=1` -- `/api/v1/balance`, `/api/v1/transactions`, `/api/v1/outputs` and `/api/v1/blocks` accept the `POST` method so that large request bodies can be sent to the server, which would not fit in a `GET` query string -- Send new `DISC` disconnect packet to peer before disconnecting -- `/api/v1/health` `"open_connections"` value now includes incoming connections. Added `"outgoing_connections"` and `"incoming_connections"` fields to separate the two. -- `run.sh` is now `run-client.sh` and a new `run-daemon.sh` script is added for running in server daemon mode -- `/api/v1/network/connection*` connection object's field `"introduced"` replaced with field `"state"` which may have the values `"pending"`, `"connected"` or `"introduced"` -- `/api/v1/network/connection*` field `"is_trusted_peer"` added to connection object to indicate if the peer is in the hardcoded list of default peers -- `/api/v1/network/connection*` field `"connected_at"`, `"unconfirmed_burn_factor"` and `"unconfirmed_max_transaction_size"` added to connection object -- `/api/v1/network/connections` now includes incoming connections. Filters are added to query connections by state and direction -- `/api/v1/resendUnconfirmedTxns` is now a `POST` method, previously was a `GET` method -- Transactions that violation soft constraints will propagate through the network -- Node will send more peers before disconnecting due to a full peer list -- Refactor CSRF to use HMAC tokens. -- Add transaction verification parameters to the `GET /health` response - -### Removed - -- Remove `USE_CSRF` envvar from the CLI tool. It uses the REST API client now, which will automatically detect CSRF as needed, so no additional configuration is necessary. Operators may still wish to disable CSRF on their remote node to reduce request overhead. -- Remove `-enable-wallet-api` and `-enable-seed-api` in place of including `WALLET` and `INSECURE_WALLET_SEED` in `-enable-api-sets`. -- Copies of the source code removed from release builds due to build artifact size - -## [0.24.1] - 2018-07-30 - -### Added - -- Add Content-Security-Policy header to http responses - -### Fixed - -- Fix portable browser version opening to blank page - -### Changed - -- Increase visor db timeout to 5000 `ms` -- Change `InitTransaction` to accept parameters for distributing genesis coin to distribution wallets - -### Removed - -## [0.24.0] - 2018-07-06 - -### Added - -- Minimum go version is go1.10 -- Add environment variable `DATA_DIR` in CLI -- `USE_CSRF` environment variable for CLI, if the remote node has CSRF enabled (CSRF is enabled by default, use `-disable-csrf` to disable) -- `cli showConfig` command to echo the cli's configuration back to the user -- Option to generate 12/24 word seed when creating new wallet -- libskycoin 0.0.1 released with bindings for cipher/address, cipher/hash, cipher/crypto, cli/create_rawtx -- Add `-version` flag to show node version -- Add transaction verification step to "Send" page -- Add more details about transaction in transaction history -- Add advanced spend UI -- Add CLI `encryptWallet` command -- Add CLI `decryptWallet` command -- Add CLI `showSeed` command -- Add `password` argument to the CLI commands of `addPrivateKey`, `createRawTransaction`, `generateAddresses`, `generateWallet`, `send` -- Support for decoding map values in cipher binary encoder -- Expose known block height of peer in brand new `height` field added in responses of `GET /api/v1/network/connections` API endpoints -- `-verify-db` option (default true), will verify the database integrity during startup and exit if a problem is found -- `-reset-corrupt-db` option (default false) will verify the database integrity during startup and reset the db if a problem is found -- `GET /explorer/address`: add `fee` to transaction objects and `calculated_hours` to transaction inputs -- Test data generator and test suite for verification of alternative `cipher` implementations -- Begin `/api/v2` API endpoints. These endpoints are in beta and subject to change. -- Add `POST /api/v2/transaction/verify` API endpoint -- Add `POST /api/v2/address/verify` API endpoint -- Add `ignore_unconfirmed` option to `POST /api/v1/wallet/transaction` to allow transactions to be created or spent even if there are unspent outputs in the unconfirmed pool. -- Add `uxouts` to `POST /api/v1/wallet/transaction`, to allow specific unspent outputs to be used in a transaction. -- Add Dockerfile in docker/images/dev-cli to build a docker image suitable for development. -- Coin creator tool, `cmd/newcoin`, to quickly bootstrap a new fiber coin -- Add Dockerfile in `docker/images/dev-dind` to build a docker in docker image based on skycoindev-cli. - -### Fixed - -- Reduce connection disconnects, improves syncing -- Fix #1171, update CLI to support wallet encryption -- Use `bolt.Tx` correctly for read operations -- Docker images for `arm32v5` and `ar32v7` architectures by using busybox as base in docker/images/mainnet/Dockerfile and docker/images/mainnet/hooks/ - -### Changed - -- JSON 2.0 RPC interface (used by the CLI tool) is now served on the same host interface as the REST API, port `6420`. The additional listener has been removed. -- CLI's `RPC_ADDR` environment variable must now start with a scheme e.g. `http://127.0.0.1:6420`, previously it did not use a scheme. -- API response will be gzip compressed if client sends request with 'Accept-Encoding' contains 'gzip' in the header. -- `GET /api/v1/wallet/balance` and `GET /api/v1/balance` now return an address balance list as well. -- API endpoints are prefixed with `/api/v1/`. API endpoints without the `/api/v1/` prefix are deprecated but can be enabled with `-enable-unversioned-api`. Please migrate to use `/api/v1/` prefix in URLs. -- Enable message protocol upgrade -- `change_address` is no longer required in `POST /api/v1/wallet/transaction`. If not provided, `change_address` will default to one of the addresses being spent from. -- In `POST /api/v1/wallet/transaction`, for `auto` type `share` mode requests, if extra coinhours remain after applying the `share_factor` but change cannot be made due to insufficient coins, the `share_factor` will switch to `1.0`. -- Support automatic port allocation of the API interface by specifying port 0 -- The web interface / API port is randomly allocated for the precompiled standalone client and electron client released on the website. - If you are using the CLI tool or another API client to communicate with the standalone client, use `-web-interface-port=6420` to continue using port 6420. - If the program is run from source (e.g. `go run`, `run.sh`, `make run`) there is no change, the API will still be on port 6420. -- Change number of outgoing connections to 8 from 16 -- Transaction history shows transactions between own addresses -- Client will only maintain one connection to the default hardcoded peers, instead of all of them - -### Removed - -- Remove `-rpc-interface-addr`, `-rpc-interface-port` options. The RPC interface is now on default port `6420` with the REST API. -- Remove `-rpc-thread-num` option -- Remove `-connect-to` option -- Remove `-print-web-interface-address` option -- Remove support for go1.9 - -## [0.23.0] - 2018-04-22 - -### Added - -- Add wallet setup wizard -- Add wallet encryption, using chacha20+poly1305 for encryption and authentication and scrypt for key derivation. Encrypted data is stored in the wallet file in a `"secrets"` metadata field -- Add `GET /health` endpoint -- Add `POST /wallet/transaction` API endpoint, creates a transaction, allowing control of spending address and multiple destinations -- Add `POST /wallet/encrypt` API endpoint, encrypts wallet and returns encrypted wallet without sensitive data -- Add `POST /wallet/decrypt` API endpoint, decrypts wallet and returns decrypted wallet without sensitive data -- Add `POST /wallet/seed` API endpoint, returns the seed of an encrypted wallet. Unencrypted wallets will not expose their seeds over the API. Requires `-enable-seed-api` option -- `-enable-seed-api` option to enable `POST /wallet/seed` -- Add `"size"` to block API response data (affects `GET /block`, `GET /blocks` and `GET /last_blocks`) -- Write [specification for skycoin URIs](https://github.com/skycoin/skycoin#uri-specification) (based upon bip21) - -### Fixed - -- #1309, Float imprecision error in frontend malformed some spend amounts, preventing the spend -- Fix one aspect of sync stalling caused by a 5-second blocking channel write by switching it to a non-blocking write, decreasing timeouts and increasing buffer sizes - -### Changed - -- `GET /wallet` API endpoint, remove sensitive data from the response, and fix the data format to be the same as `POST /wallet/create` -- `GET /wallets` API endpoint, remove sensitive data from the response -- `POST /wallet/create` API endpoint, add `encrypt(bool)` and `password` argument -- `POST /wallet/newAddress` API endpoint, add `password` argument -- `POST /wallet/spend` API endpoint, add `password` argument -- Change `-disable-wallet-api` to `-enable-wallet-api`, and disable the wallet API by default -- `-launch-browser` is set to false by default -- A default wallet will not be created on startup if there is no wallet. Instead, the wallet setup wizard will run -- Replace [op/go-logging](https://github.com/op/go-logging) with [logrus](https://github.com/sirupsen/logrus) -- Disable JSON-RPC 2.0 interface when running the application with `run.sh` and electron -- Whitespace will be trimmed from the seed string by the frontend client before creating or loading a wallet -- Notify the user when their wallets have unconfirmed transactions -- Return an error when providing a transaction that spends to the null address in `POST /injectTransaction` -- Change accepted `-log-level` values to `debug`, `info`, `warn`, `error`, `fatal` and `panic` (previously were `debug`, `info`, `notice`, `warning`, `error` and `critical`) -- Default log level is `info` - -### Removed - -- Remove `"seed"`, `"lastSeed"` and `"secret_key"` in address entries from wallet API responses. A wallet's seed can be accessed through `POST /wallet/seed` only if the wallet is encrypted and the node is run with `-enable-seed-api` -- Remove unused `-logtogui` and `-logbufsize` options - -## [0.22.0] - 2018-03-20 - -### Added - -- go1.10 support -- Add Dockerfile -- Add libskycoin C API wrapper -- New wallet UI -- Notify the user when a new version is available -- CLI and GUI integration tests against a stable and live blockchain -- #877, Add `-disable-wallet-api` CLI option -- HTTP API client -- `/richlist` API method, returns top n address balances -- `/addresscount` API method, returns the number of addresses that have any amount of coins -- `/transactions` API method, returns transactions of addresses -- `/wallet/unload` API method, removes the wallet of given id from wallet services - -### Fixed - -- #1021, remove `SendOr404` and `SendOr500` as they do not work properly due to typed nils -- Add Read, Write and Idle timeouts to the HTTP listener, preventing file descriptor leaks -- Support absolute and relative paths for `-data-dir` option -- Prevent creating transactions whose size exceeds the maximum block size -- Check addition and multiplication uint64 overflow -- Keep trusted peers in the peerlist permanently, even if they are unreachable -- #885, Add `Host` header check to localhost HTTP interfaces to prevent DNS rebinding attacks -- #896, Add CSRF check to wallet API -- Fix base58 address parsing, which allowed leading invalid characters and treated unknown characters as a '1' -- Fix occasional error which causes blockchain progress not to be shown in front-end - -### Changed - -- #1080, `/wallet/transactions` now returns a proper json object with pending transactions under `transactions` key -- #951, cap cli createRawTransaction and send command coinhour distribution, coinhours are capped to a maximum of receiving coins for the address with a minimum of 1 coinhour -- Upgrade to Angular 5 -- Add `total_coinhour_supply` and `current_coinhour_supply` to `/coinSupply` endpoint -- #800, Add entropy parameter to `/wallet/newSeed` endpoint. Entropy can be 128 (default) or 256, corresponding to 12- and 24-word seeds respectively -- #866, Include coins and hours in `/explorer/address` inputs -- Rename cached `peers.txt` file to `peers.json` - -### Removed - -- Remove `/lastTxs` API endpoint -- Remove `/logs` and log buffering due to possible crash -- Remove `/wallets/reload` endpoint -- Remove deprecated `/api/getEffectiveOutputs`, use `/coinSupply`. - -## [0.21.1] - 2017-12-14 - -### Fixed - -- Fix blank page issue in windows gui wallet, which was caused by misusing the flag of -download-peers-list in electron. - -## [0.21.0] - 2017-12-10 - -### Added - -- Require transactions to have an input with non-zero coinhours -- Add `-peerlist-size` and `-max-outgoing-connections` CLI options -- Add `-download-peerlist` and `-peerlist-url` CLI options, to get peers from a URL -- For electron clients, download a list of peers from https://downloads.skycoin.net/blockchain/peers.txt by default - -### Fixed - -- Fix change hours calculation. Previous gave 1/8 to change and destination addresses; now gives 1/4 to each -- #653, the peerlist size was too small and could be easily filled up; default changed to 65535 from 1000 - -### Changed - -- CLI's `walletBalance` and `addressBalance` commands return aggregate balances for confirmed, spendable and expected balances. Coins are formatted as droplet strings. Hours added as strings. -- When splitting an odd number of hours in a spend, give the extra hour to the fee -- Add `block_seq` to `get_outputs` and `/outputs` API response -- Improve UxOut spend selection. Previously, they were spent oldest first. Now they are spent to ensure a non-zero coinhour input and otherwise minimize coinhours. -- `create_rawtx` will try to minimize the number of UxOuts used to create a transaction. -- `/wallet/spend` will try to maximize the number of UxOuts used to create a transaction. -- Update the default peerlist size to 65535 from 1000 -- When loading a wallet, 100 addresses will be scanned ahead to find one with a balance - -## [0.20.4] - 2017-11-22 - -### Added - -- Add `/logs` api to filter skycoin logs, so that we can add a debug panel to the GUI wallet to show logs - -## [0.20.3] - 2017-10-23 - -### Fixed - -- Fix block sync stall (mostly affected Windows users, but any OS was potentially affected) - -## [0.20.2] - 2017-10-12 - -### Fixed - -- Fixed Linux .AppImage missing "Category" field -- Clean up electron build script, switch to yarn and remove gulp - -## [0.20.1] - 2017-10-12 - -### Fixed - -- Fixed app icon padding - -## [0.20.0] - 2017-10-10 - -### Added - -- New wallet frontend in angular4. This is a complete rewrite and fixes many of the old wallet issues. -- New wallet has preliminary support for OTC functionality -- Create `webrpc.Client` for JSON-2.0 RPC calls. -- Add this CHANGELOG.md file. -- Add Installation.md file, with install instructions for go. -- Timelock distribution addresses. The first 25% of the distribution is spendable. After that 25% is spent, a timestamp will be added to the code to enable further distribution. -- Add `/coinSupply` endpoint. Correctly returns total, locked and unlocked coin amounts. -- `testutil` package for common test setup methods. -- `/version` endpoint, which will return the current node version number and the HEAD commit id when build the node -- `-no-ping-log` option to disable ping/pong log output -- Check for invalid block signatures during startup and recreate the database if they are corrupted. -- Add methods for converting fixed-point decimal strings to droplets and vice versa. -- Add `make run`, `make test`, `make lint`, `make check` to `Makefile` - -### Changed - -- Flag peers as incoming or outgoing. -- Refactor to decouple `wallet` and `visor` package. -- Refactor `cli` package for use as a library. -- `README` improvements. -- Set default wallet's label as "Your Wallet" -- Use BIP32 mnemomic seeds by default in `address_gen`. -- Add `-x` option to `address_gen`, to generate a random base64-encoded 128-bit seed instead of a BIP32 mnemomic seed. -- Add `-v` option to `address_gen` to print all address information (pubkey, seckey, address, seed) to stdout as JSON. -- All API and CLI methods with "coin"-related arguments must be a string and can use decimal notation to specify coin amounts. -- CLI's `walletHistory` command prints amounts as fixed-point decimal strings. Previously, it printed amounts as integers representing whole skycoin amounts, and did not support droplets / fractional skycoins. -- A user is prevented from broadcasting a new transaction with unspent outputs that they have already sent as an unconfirmed transaction. - -### Deprecated - -- `/api/getEffectiveOutputs` is deprecated in favor of `/coinSupply`. - -### Removed - -- Old wallet -- `/api/create-address` endpoint (use the `address_gen` tool) - -### Fixed - -- Wallet folder path loading. -- #371 Fix `/wallet/spend`, will return only when pending transaction is confirmed. -- #443 Fix predicted balance in `/wallet/spend` API call. -- #444 Fix bug in `/blockchain/progress` API call. -- Removed globals in `gui` package that caused race condition with wallet API calls. -- #494 Clean invalid unconfirmed transactions during startup. -- Various race conditions around the bolt.DB blockchain DB -- Missing `strand()` call in `daemon.Visor.AnnounceTxns`. - -### Security - -## [0.19.1] - 2017-08-26 - -### Fixed - -- #459 dist folder in repo out of date, wallet gui does not load - -## [0.19.0] - 2017-07-11 - -### Added - -- Add synchronize indicator when downloading blocks. -- #352 Store unspent pool in db for quick recovery when node restart -- Speed up the time the node start the browser -- Cache unspent pool in memory to speed up query action -- #411 Add button to hide seed -- #380 Move anything with heavy imports into util sub package - -### Fixed - -- #421 Sort wallet transaction history by time -- #398 Remove seeds from DOM -- #390 Make `go test ./src/...` work -- #383 Error during installation from skycoin source code -- #375 Node can't recovery from zero connections -- #376 Explorer api `/explorer/address` does not return spend transactions -- #373 Block publisher node will be closed if there're no transactions need to execute -- #360 Node will crash when do ctrl+c while downloading blocks -- #350 Wallet name always 'undefined' after loading wallet from seed - -[Unreleased]: https://github.com/skycoin/skycoin/compare/master...develop -[0.25.0]: https://github.com/skycoin/skycoin/compare/v0.24.1...v0.25.0 -[0.24.1]: https://github.com/skycoin/skycoin/compare/v0.24.0...v0.24.1 -[0.24.0]: https://github.com/skycoin/skycoin/compare/v0.23.0...v0.24.0 -[0.23.0]: https://github.com/skycoin/skycoin/compare/v0.22.0...v0.23.0 -[0.22.0]: https://github.com/skycoin/skycoin/compare/v0.21.1...v0.22.0 -[0.21.1]: https://github.com/skycoin/skycoin/compare/v0.21.0...v0.21.1 -[0.21.0]: https://github.com/skycoin/skycoin/compare/v0.20.4...v0.21.0 -[0.20.4]: https://github.com/skycoin/skycoin/compare/v0.20.3...v0.20.4 -[0.20.3]: https://github.com/skycoin/skycoin/compare/v0.20.2...v0.20.3 -[0.20.2]: https://github.com/skycoin/skycoin/compare/v0.20.1...v0.20.2 -[0.20.1]: https://github.com/skycoin/skycoin/compare/v0.20.0...v0.20.1 -[0.20.0]: https://github.com/skycoin/skycoin/compare/v0.19.1...v0.20.0 -[0.19.1]: https://github.com/skycoin/skycoin/compare/v0.19.0...v0.19.1 -[0.19.0]: https://github.com/skycoin/skycoin/commit/dd924e1f2de8fab945e05b3245dbeabf267f2910 diff --git a/Makefile b/Makefile index 38b59eb4f..ca9ec02e7 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ .DEFAULT_GOAL := help .PHONY: test-libc test-lint build-libc check -.PHONY: install-linters format clean-libc format-libc lint-libc +.PHONY: install-linters format clean-libc format-libc lint-libc docs COIN ?= skycoin @@ -28,7 +28,8 @@ BIN_DIR = bin DOC_DIR = docs INCLUDE_DIR = include LIBSRC_DIR = lib/cgo -LIBDOC_DIR = $(DOC_DIR)/libc +LIBSKYDOC_DIR = $(DOC_DIR)/libc +LIBCURLDOC_DIR = $(DOC_DIR)/curl SWAGGER_SPEC_DIR = lib/swagger SWAGGER_CLIENT_DIR = lib/curl @@ -92,14 +93,13 @@ $(BUILDLIB_DIR)/libskycoin.a: $(LIB_FILES) $(SRC_FILES) $(HEADER_FILES) go build -buildmode=c-archive -o $(BUILDLIB_DIR)/libskycoin.a $(LIB_FILES) mv $(BUILDLIB_DIR)/libskycoin.h $(INCLUDE_DIR)/ -## Build libskycoin C static library -build-libc-static: $(BUILDLIB_DIR)/libskycoin.a +build-libc-static: $(BUILDLIB_DIR)/libskycoin.a ## Build libskycoin C static library -## Build libskycoin C shared library -build-libc-shared: $(BUILDLIB_DIR)/libskycoin.so +build-libc-shared: $(BUILDLIB_DIR)/libskycoin.so ## Build libskycoin C shared library -## Build libskycoin C client libraries -build-libc: configure-build build-libc-static build-libc-shared +build-libc: configure-build build-libc-static build-libc-shared ## Build libskycoin C client libraries + +build: build-libc ## Build all C libraries ## Build libskycoin C client library and executable C test suites ## with debug symbols. Use this target to debug the source code @@ -120,11 +120,14 @@ test-hw-crypto: ## Run tests for hardware wallet crypto API $(CC) -o $(BIN_DIR)/test_hardwarewallet $(LIB_DIR)/cgo/tests/*.common.c $(LIB_DIR)/cgo/tests/testutils/libsky_string.c $(LIB_DIR)/cgo/tests/testutils/libsky_assert.c $(LIB_DIR)/cgo/tests/testutils/common.c $(LIB_DIR)/cgo/tests/test_main_hw.c -L$(HARDWARE_WALLET_ROOT_DIR)/skycoin-api -lskycoin-crypto-wrapper -lskycoin-crypto `pkg-config --cflags --libs check` -lpthread -Ilib/cgo -Iinclude -Ibuild/usr/include -I$(HARDWARE_WALLET_ROOT_DIR) $(BIN_DIR)/test_hardwarewallet -docs-libc: +docs-skyapi: ## Generate SkyApi (libcurl) documentation + openapi-generator generate -g html2 -i lib/swagger/skycoin.v0.25.1.openapi.v2.yml -o $(LIBCURLDOC_DIR) + +docs-libc: ## Generate libskycoin documentation doxygen ./.Doxyfile - moxygen -o $(LIBDOC_DIR)/API.md $(LIBDOC_DIR)/xml/ + moxygen -o $(LIBSKYDOC_DIR)/API.md $(LIBSKYDOC_DIR)/xml/ -docs: docs-libc +docs: docs-libc docs-skyapi ## Generate documentation for all libraries lint: ## Run linters. Use make install-linters first. vendorcheck ./... @@ -141,6 +144,7 @@ lint-libc: format-libc check: lint test-libc lint-libc ## Run tests and linters install-linters-Linux: ## Install linters on GNU/Linux + sudo apt-get update sudo apt-get install $(PKG_CLANG_FORMAT) sudo apt-get install $(PKG_CLANG_LINTER) @@ -156,7 +160,7 @@ install-deps-Linux: ## Install deps on GNU/Linux install-deps-Darwin: ## Install deps on Mac OSX brew install $(PKG_LIB_TEST) -install-libraries-deps: ## Install deps on GNU/Linux +install-libraries-deps: ## Install deps for lib\curl wrapper of Skycoin REST API if [[ "$(UNAME_S)" == "Linux" ]]; then (cd build && wget --no-check-certificate https://cmake.org/files/v3.3/cmake-3.3.2-Linux-x86_64.tar.gz && echo "f3546812c11ce7f5d64dc132a566b749 *cmake-3.3.2-Linux-x86_64.tar.gz" > cmake_md5.txt && md5sum -c cmake_md5.txt && tar -xvf cmake-3.3.2-Linux-x86_64.tar.gz > /dev/null && mv cmake-3.3.2-Linux-x86_64 cmake-install && PATH=$(pwd)/build/cmake-install:$(pwd)/build/cmake-install/bin:$PATH ) ; fi (cd build && wget http://curl.haxx.se/download/curl-7.58.0.tar.gz && tar -xvf curl-7.58.0.tar.gz && cd curl-7.58.0/ && bash ./configure && make && sudo make install) if [[ "$(UNAME_S)" == "Darwin" ]]; then brew install curl ; fi @@ -166,10 +170,7 @@ install-libraries-deps: ## Install deps on GNU/Linux install-linters: install-linters-$(UNAME_S) ## Install linters go get -u github.com/FiloSottile/vendorcheck - # For some reason this install method is not recommended, see https://github.com/golangci/golangci-lint#install - # However, they suggest `curl ... | bash` which we should not do - go get -u github.com/golangci/golangci-lint/cmd/golangci-lint - VERSION=1.10.2 ./ci-scripts/install-golangci-lint.sh + cat ./ci-scripts/install-golangci-lint.sh | sh -s -- -b $(GOPATH)/bin v1.10.2 install-deps-libc: install-deps-libc-$(OSNAME) install-libraries-deps diff --git a/README.md b/README.md index ed4c30a3c..e3f5c4bb4 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,59 @@ The Skycoin C library is made of the following components Consult respective `README` files for further details. + +- [Make rules](#make-rules) +- [Development setup](#development-setup) + - [Running tests](#running-tests) + - [Releases](#releases) + - [Update the version](#update-the-version) + - [Pre-release testing](#pre-release-testing) + - [Creating release builds](#creating-release-builds) + + +## Make Rules + +All these make rules require skycoin to be a git submodule of pyskycoin + +- `build-libc` + * Compiles skycoin C language library. +- `test-libc` + * Compiles skycoin C language library and executes the tests. +- `build-libc-static` + * Build libskycoin C static library +- `build-libc-shared` + * Build libskycoin C shared library + + +## Development setup + + ### Running tests + + ```sh + $ make test-libc + ``` + + ### Releases + + #### Update the version + + 0. If the `master` branch has commits that are not in `develop` (e.g. due to a hotfix applied to `master`), merge `master` into `develop` (and fix any build or test failures) + 0. Switch to a new release branch named `release-X.Y.Z` for preparing the release. + 0. Ensure that the submodule at `gopath/src/github.com/skycoin/skycoin` is in sync with respect to the corresponding tag in https://github.com/skycoin/skycoin repository. + 0. Update `CHANGELOG.md`: move the "unreleased" changes to the version and add the date. + 0. Follow the steps in [pre-release testing](#pre-release-testing) + 0. Make a PR merging the release branch into `master` + 0. Review the PR and merge it + 0. Tag the `master` branch with the version number. Version tags start with `v`, e.g. `v0.20.0`. Sign the tag. If you have your GPG key in github, creating a release on the Github website will automatically tag the release. It can be tagged from the command line with `git tag -as v0.20.0 $COMMIT_ID`, but Github will not recognize it as a "release". + 0. Release builds are created and uploaded by travis. To do it manually, checkout the master branch and follow the [create release builds instructions](#creating-release-builds). + + #### Pre-release testing + + Perform these actions before releasing: + + ```sh + make check + ``` ## Development We have two branches: `master` and `develop`. @@ -58,4 +111,60 @@ Stable development branches are created most of the time for the following reaso The following rules are enforced - Contributions must comply to the development guidelines documented in the [Skycoin wiki](https://github.com/skycoin/skycoin/wiki). -- C / C++ code must comply to the [Bitcoin C coding style](https://github.com/bitcoin/bitcoin/blob/master/doc/developer-notes.md#coding-style-c) (enforced by `clang-format`). \ No newline at end of file +- C / C++ code must comply to the [Bitcoin C coding style](https://github.com/bitcoin/bitcoin/blob/master/doc/developer-notes.md#coding-style-c) (enforced by `clang-format`). + +### SkyApi libcurl client for Skycoin REST API + +This wrapper is auto-generated by `openapi-generator` directly from [Skycoin REST API code](https://github.com/skycoin/skycoin/tree/master/src/api). + +For further instructions see [Autogenerated documentation](./lib/curl/README.md). + +### Doxygen comment syntax + +If you want to continue with `the doxygen way`(we recommend it) of coding and document functions, structs, and functions, you should follow the specifications found in the [Doxygen official site](http://www.doxygen.nl/manual/docblocks.html). + +An example of documentation using `doxygen` is the next: + +```c +/** + * Addresses of Bitcoin accounts + */ +typedef struct { + GoUint8_ Version; ///< Address version identifier. + ///< Used to differentiate testnet + ///< vs mainnet addresses, for instance. + cipher__Ripemd160 Key; ///< Address hash identifier. +} cipher__BitcoinAddress; +``` +This code example can be found at `include/cipher.bitcoin.go.h`. + +Inside `/* */` we found struct documentation, meanwhile `//<` symbol is used to describe fields of the struct. + +After that, run `make docs` for a new docs generation. You can found the api documentation at `docs/libc` folder. + +### Makefile targets: + +|Target |Help| +| :------------- | :----------: | +|build-libc-static |Build libskycoin C static library| +|build-libc-shared |Build libskycoin C shared library| +|build-libc |Build libskycoin C client libraries| +|build |Build all C libraries +|test-libc |Run tests for libskycoin C client library| +|docs |Generate documentation for all libraries| +|docs-libc |Generate libskycoin documentation| +|docs-skyapi |Generate SkyApi (libcurl) documentation| +|lint |Run linters. Use make install-linters first.| +|check |Run tests and linters| +|install-linters-Linux |Install linters on GNU/Linux| +|install-linters-Darwin |Install linters on Mac OSX| +|install-deps-Linux |Install deps on GNU/Linux| +|install-deps-Darwin |Install deps on Mac OSX| +|install-libraries-deps |Install deps for `lib\curl` wrapper of Skycoin REST API| +|install-linters |Install linters| +|install-deps-libc-linux |Install locally dependencies for testing libskycoin| +|install-lib-curl |Install Sky Api curl based rest wrapper| +|install-deps-libc-osx |Install locally dependencies for testing libskycoin| +|format |Formats the code. Must have goimports installed (use make install-linters).| +|clean-libc |Clean files generate by library| + diff --git a/ci-scripts/build.sh b/ci-scripts/build.sh new file mode 100644 index 000000000..2ad83cf0a --- /dev/null +++ b/ci-scripts/build.sh @@ -0,0 +1,2 @@ +echo "Init" +make -C $GOPATH/src/github.com/skycoin/libskycoin build-libc \ No newline at end of file diff --git a/ci-scripts/install-golangci-lint.sh b/ci-scripts/install-golangci-lint.sh index 6c796c7dc..fdec86064 100755 --- a/ci-scripts/install-golangci-lint.sh +++ b/ci-scripts/install-golangci-lint.sh @@ -1,17 +1,385 @@ -#!/usr/bin/env bash +#!/bin/sh +set -e +# Code generated by godownloader on 2019-05-02T19:05:24Z. DO NOT EDIT. +# -if [ -z "$VERSION" ]; then - echo "VERSION must be set" - exit 1 -fi +usage() { + this=$1 + cat </dev/null +} +echoerr() { + echo "$@" 1>&2 +} +log_prefix() { + echo "$0" +} +_logp=6 +log_set_priority() { + _logp="$1" +} +log_priority() { + if test -z "$1"; then + echo "$_logp" + return + fi + [ "$1" -le "$_logp" ] +} +log_tag() { + case $1 in + 0) echo "emerg" ;; + 1) echo "alert" ;; + 2) echo "crit" ;; + 3) echo "err" ;; + 4) echo "warning" ;; + 5) echo "notice" ;; + 6) echo "info" ;; + 7) echo "debug" ;; + *) echo "$1" ;; + esac +} +log_debug() { + log_priority 7 || return 0 + echoerr "$(log_prefix)" "$(log_tag 7)" "$@" +} +log_info() { + log_priority 6 || return 0 + echoerr "$(log_prefix)" "$(log_tag 6)" "$@" +} +log_err() { + log_priority 3 || return 0 + echoerr "$(log_prefix)" "$(log_tag 3)" "$@" +} +log_crit() { + log_priority 2 || return 0 + echoerr "$(log_prefix)" "$(log_tag 2)" "$@" +} +uname_os() { + os=$(uname -s | tr '[:upper:]' '[:lower:]') + case "$os" in + msys_nt) os="windows" ;; + esac + echo "$os" +} +uname_arch() { + arch=$(uname -m) + case $arch in + x86_64) arch="amd64" ;; + x86) arch="386" ;; + i686) arch="386" ;; + i386) arch="386" ;; + aarch64) arch="arm64" ;; + armv5*) arch="armv5" ;; + armv6*) arch="armv6" ;; + armv7*) arch="armv7" ;; + esac + echo ${arch} +} +uname_os_check() { + os=$(uname_os) + case "$os" in + darwin) return 0 ;; + dragonfly) return 0 ;; + freebsd) return 0 ;; + linux) return 0 ;; + android) return 0 ;; + nacl) return 0 ;; + netbsd) return 0 ;; + openbsd) return 0 ;; + plan9) return 0 ;; + solaris) return 0 ;; + windows) return 0 ;; + esac + log_crit "uname_os_check '$(uname -s)' got converted to '$os' which is not a GOOS value. Please file bug at https://github.com/client9/shlib" + return 1 +} +uname_arch_check() { + arch=$(uname_arch) + case "$arch" in + 386) return 0 ;; + amd64) return 0 ;; + arm64) return 0 ;; + armv5) return 0 ;; + armv6) return 0 ;; + armv7) return 0 ;; + ppc64) return 0 ;; + ppc64le) return 0 ;; + mips) return 0 ;; + mipsle) return 0 ;; + mips64) return 0 ;; + mips64le) return 0 ;; + s390x) return 0 ;; + amd64p32) return 0 ;; + esac + log_crit "uname_arch_check '$(uname -m)' got converted to '$arch' which is not a GOARCH value. Please file bug report at https://github.com/client9/shlib" + return 1 +} +untar() { + tarball=$1 + case "${tarball}" in + *.tar.gz | *.tgz) tar -xzf "${tarball}" ;; + *.tar) tar -xf "${tarball}" ;; + *.zip) unzip "${tarball}" ;; + *) + log_err "untar unknown archive format for ${tarball}" + return 1 + ;; + esac +} +http_download_curl() { + local_file=$1 + source_url=$2 + header=$3 + if [ -z "$header" ]; then + code=$(curl -w '%{http_code}' -sL -o "$local_file" "$source_url") + else + code=$(curl -w '%{http_code}' -sL -H "$header" -o "$local_file" "$source_url") + fi + if [ "$code" != "200" ]; then + log_debug "http_download_curl received HTTP status $code" + return 1 + fi + return 0 +} +http_download_wget() { + local_file=$1 + source_url=$2 + header=$3 + if [ -z "$header" ]; then + wget -q -O "$local_file" "$source_url" + else + wget -q --header "$header" -O "$local_file" "$source_url" + fi +} +http_download() { + log_debug "http_download $2" + if is_command curl; then + http_download_curl "$@" + return + elif is_command wget; then + http_download_wget "$@" + return + fi + log_crit "http_download unable to find wget or curl" + return 1 +} +http_copy() { + tmp=$(mktemp) + http_download "${tmp}" "$1" "$2" || return 1 + body=$(cat "$tmp") + rm -f "${tmp}" + echo "$body" +} +github_release() { + owner_repo=$1 + version=$2 + test -z "$version" && version="latest" + giturl="https://github.com/${owner_repo}/releases/${version}" + json=$(http_copy "$giturl" "Accept:application/json") + test -z "$json" && return 1 + version=$(echo "$json" | tr -s '\n' ' ' | sed 's/.*"tag_name":"//' | sed 's/".*//') + test -z "$version" && return 1 + echo "$version" +} +hash_sha256() { + TARGET=${1:-/dev/stdin} + if is_command gsha256sum; then + hash=$(gsha256sum "$TARGET") || return 1 + echo "$hash" | cut -d ' ' -f 1 + elif is_command sha256sum; then + hash=$(sha256sum "$TARGET") || return 1 + echo "$hash" | cut -d ' ' -f 1 + elif is_command shasum; then + hash=$(shasum -a 256 "$TARGET" 2>/dev/null) || return 1 + echo "$hash" | cut -d ' ' -f 1 + elif is_command openssl; then + hash=$(openssl -dst openssl dgst -sha256 "$TARGET") || return 1 + echo "$hash" | cut -d ' ' -f a + else + log_crit "hash_sha256 unable to find command to compute sha-256 hash" + return 1 + fi +} +hash_sha256_verify() { + TARGET=$1 + checksums=$2 + if [ -z "$checksums" ]; then + log_err "hash_sha256_verify checksum file not specified in arg2" + return 1 + fi + BASENAME=${TARGET##*/} + want=$(grep "${BASENAME}" "${checksums}" 2>/dev/null | tr '\t' ' ' | cut -d ' ' -f 1) + if [ -z "$want" ]; then + log_err "hash_sha256_verify unable to find checksum for '${TARGET}' in '${checksums}'" + return 1 + fi + got=$(hash_sha256 "$TARGET") + if [ "$want" != "$got" ]; then + log_err "hash_sha256_verify checksum for '$TARGET' did not verify ${want} vs $got" + return 1 + fi +} +cat /dev/null < + + + + Skycoin REST API. + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

Skycoin REST API.

+
+
+
+ +
+
+

Default

+
+
+
+

addressCount

+

Returns the total number of unique address that have coins.

+
+
+
+

+

+

+
+
/api/v1/addresscount
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/addresscount"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.addressCount();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addressCount");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.addressCount();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addressCount");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the total number of unique address that have coins.
+[apiInstance addressCountWithCompletionHandler: 
+              ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.addressCount(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class addressCountExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                // Returns the total number of unique address that have coins.
+                Object result = apiInstance.addressCount();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.addressCount: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->addressCount();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->addressCount: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->addressCount();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->addressCount: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    # Returns the total number of unique address that have coins.
+    api_response = api_instance.address_count()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->addressCount: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.addressCount(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

addressUxouts

+

+
+
+
+

+

Returns the historical, spent outputs associated with an address

+

+
+
/api/v1/address_uxouts
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/address_uxouts?address="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | address to filter by
+        try {
+            array[inline_response_200] result = apiInstance.addressUxouts(address);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addressUxouts");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | address to filter by
+        try {
+            array[inline_response_200] result = apiInstance.addressUxouts(address);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addressUxouts");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *address = address_example; // address to filter by (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance addressUxoutsWith:address
+              completionHandler: ^(array[inline_response_200] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var address = address_example; // {String} address to filter by
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.addressUxouts(address, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class addressUxoutsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var address = address_example;  // String | address to filter by (default to null)
+
+            try
+            {
+                array[inline_response_200] result = apiInstance.addressUxouts(address);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.addressUxouts: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$address = address_example; // String | address to filter by
+
+try {
+    $result = $api_instance->addressUxouts($address);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->addressUxouts: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $address = address_example; # String | address to filter by
+
+eval { 
+    my $result = $api_instance->addressUxouts(address => $address);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->addressUxouts: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+address = address_example # String | address to filter by (default to null)
+
+try: 
+    api_response = api_instance.address_uxouts(address)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->addressUxouts: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let address = address_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.addressUxouts(address, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
address* + + +
+
+
+ + String + + +
+address to filter by +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

balanceGet

+

Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.

+
+
+
+

+

+

+
+
/api/v1/balance
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/balance?addrs="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        try {
+            Object result = apiInstance.balanceGet(addrs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#balanceGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        try {
+            Object result = apiInstance.balanceGet(addrs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#balanceGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *addrs = addrs_example; // command separated list of addresses (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
+[apiInstance balanceGetWith:addrs
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var addrs = addrs_example; // {String} command separated list of addresses
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.balanceGet(addrs, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class balanceGetExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var addrs = addrs_example;  // String | command separated list of addresses (default to null)
+
+            try
+            {
+                // Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
+                Object result = apiInstance.balanceGet(addrs);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.balanceGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$addrs = addrs_example; // String | command separated list of addresses
+
+try {
+    $result = $api_instance->balanceGet($addrs);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->balanceGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $addrs = addrs_example; # String | command separated list of addresses
+
+eval { 
+    my $result = $api_instance->balanceGet(addrs => $addrs);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->balanceGet: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+addrs = addrs_example # String | command separated list of addresses (default to null)
+
+try: 
+    # Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
+    api_response = api_instance.balance_get(addrs)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->balanceGet: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let addrs = addrs_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.balanceGet(addrs, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
addrs* + + +
+
+
+ + String + + +
+command separated list of addresses +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

balancePost

+

Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.

+
+
+
+

+

+

+
+
/api/v1/balance
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/balance?addrs="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        try {
+            Object result = apiInstance.balancePost(addrs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#balancePost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        try {
+            Object result = apiInstance.balancePost(addrs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#balancePost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *addrs = addrs_example; // command separated list of addresses (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
+[apiInstance balancePostWith:addrs
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var addrs = addrs_example; // {String} command separated list of addresses
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.balancePost(addrs, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class balancePostExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var addrs = addrs_example;  // String | command separated list of addresses (default to null)
+
+            try
+            {
+                // Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
+                Object result = apiInstance.balancePost(addrs);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.balancePost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$addrs = addrs_example; // String | command separated list of addresses
+
+try {
+    $result = $api_instance->balancePost($addrs);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->balancePost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $addrs = addrs_example; # String | command separated list of addresses
+
+eval { 
+    my $result = $api_instance->balancePost(addrs => $addrs);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->balancePost: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+addrs = addrs_example # String | command separated list of addresses (default to null)
+
+try: 
+    # Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
+    api_response = api_instance.balance_post(addrs)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->balancePost: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let addrs = addrs_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.balancePost(addrs, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
addrs* + + +
+
+
+ + String + + +
+command separated list of addresses +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

block

+

+
+
+
+

+

Returns a block by hash or seq. Note: only one of hash or seq is allowed

+

+
+
/api/v1/block
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/block?hash=&seq="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String hash = hash_example; // String | 
+        Integer seq = 56; // Integer | 
+        try {
+            Object result = apiInstance.block(hash, seq);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#block");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String hash = hash_example; // String | 
+        Integer seq = 56; // Integer | 
+        try {
+            Object result = apiInstance.block(hash, seq);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#block");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *hash = hash_example; //  (optional) (default to null)
+Integer *seq = 56; //  (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance blockWith:hash
+    seq:seq
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'hash': hash_example, // {String} 
+  'seq': 56 // {Integer} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.block(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class blockExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var hash = hash_example;  // String |  (optional)  (default to null)
+            var seq = 56;  // Integer |  (optional)  (default to null)
+
+            try
+            {
+                Object result = apiInstance.block(hash, seq);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.block: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$hash = hash_example; // String | 
+$seq = 56; // Integer | 
+
+try {
+    $result = $api_instance->block($hash, $seq);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->block: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $hash = hash_example; # String | 
+my $seq = 56; # Integer | 
+
+eval { 
+    my $result = $api_instance->block(hash => $hash, seq => $seq);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->block: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+hash = hash_example # String |  (optional) (default to null)
+seq = 56 # Integer |  (optional) (default to null)
+
+try: 
+    api_response = api_instance.block(hash=hash, seq=seq)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->block: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let hash = hash_example; // String
+    let seq = 56; // Integer
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.block(hash, seq, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
hash + + +
+
+
+ + String + + +
+
+
+
seq + + +
+
+
+ + Integer + + +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

blockchainMetadata

+

Returns the blockchain metadata.

+
+
+
+

+

+

+
+
/api/v1/blockchain/metadata
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/blockchain/metadata"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.blockchainMetadata();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blockchainMetadata");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.blockchainMetadata();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blockchainMetadata");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the blockchain metadata.
+[apiInstance blockchainMetadataWithCompletionHandler: 
+              ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.blockchainMetadata(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class blockchainMetadataExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                // Returns the blockchain metadata.
+                Object result = apiInstance.blockchainMetadata();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.blockchainMetadata: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->blockchainMetadata();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->blockchainMetadata: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->blockchainMetadata();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->blockchainMetadata: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    # Returns the blockchain metadata.
+    api_response = api_instance.blockchain_metadata()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->blockchainMetadata: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.blockchainMetadata(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

blockchainProgress

+

Returns the blockchain sync progress.

+
+
+
+

+

+

+
+
/api/v1/blockchain/progress
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/blockchain/progress"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.blockchainProgress();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blockchainProgress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.blockchainProgress();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blockchainProgress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the blockchain sync progress.
+[apiInstance blockchainProgressWithCompletionHandler: 
+              ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.blockchainProgress(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class blockchainProgressExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                // Returns the blockchain sync progress.
+                Object result = apiInstance.blockchainProgress();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.blockchainProgress: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->blockchainProgress();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->blockchainProgress: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->blockchainProgress();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->blockchainProgress: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    # Returns the blockchain sync progress.
+    api_response = api_instance.blockchain_progress()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->blockchainProgress: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.blockchainProgress(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

blocksGet

+

blocksHandler returns blocks between a start and end point,

+
+
+
+

+

or an explicit list of sequences. +If using start and end, the block sequences include both the start and end point. +Explicit sequences cannot be combined with start and end. +Without verbose.

+

+
+
/api/v1/blocks
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/blocks?start=&end=&seqs="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        Integer start = 56; // Integer | 
+        Integer end = 56; // Integer | 
+        array[Integer] seqs = ; // array[Integer] | 
+        try {
+            Object result = apiInstance.blocksGet(start, end, seqs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blocksGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        Integer start = 56; // Integer | 
+        Integer end = 56; // Integer | 
+        array[Integer] seqs = ; // array[Integer] | 
+        try {
+            Object result = apiInstance.blocksGet(start, end, seqs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blocksGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Integer *start = 56; //  (optional) (default to null)
+Integer *end = 56; //  (optional) (default to null)
+array[Integer] *seqs = ; //  (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// blocksHandler returns blocks between a start and end point,
+[apiInstance blocksGetWith:start
+    end:end
+    seqs:seqs
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'start': 56, // {Integer} 
+  'end': 56, // {Integer} 
+  'seqs':  // {array[Integer]} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.blocksGet(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class blocksGetExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var start = 56;  // Integer |  (optional)  (default to null)
+            var end = 56;  // Integer |  (optional)  (default to null)
+            var seqs = new array[Integer](); // array[Integer] |  (optional)  (default to null)
+
+            try
+            {
+                // blocksHandler returns blocks between a start and end point,
+                Object result = apiInstance.blocksGet(start, end, seqs);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.blocksGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$start = 56; // Integer | 
+$end = 56; // Integer | 
+$seqs = ; // array[Integer] | 
+
+try {
+    $result = $api_instance->blocksGet($start, $end, $seqs);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->blocksGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $start = 56; # Integer | 
+my $end = 56; # Integer | 
+my $seqs = []; # array[Integer] | 
+
+eval { 
+    my $result = $api_instance->blocksGet(start => $start, end => $end, seqs => $seqs);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->blocksGet: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+start = 56 # Integer |  (optional) (default to null)
+end = 56 # Integer |  (optional) (default to null)
+seqs =  # array[Integer] |  (optional) (default to null)
+
+try: 
+    # blocksHandler returns blocks between a start and end point,
+    api_response = api_instance.blocks_get(start=start, end=end, seqs=seqs)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->blocksGet: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let start = 56; // Integer
+    let end = 56; // Integer
+    let seqs = ; // array[Integer]
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.blocksGet(start, end, seqs, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
start + + +
+
+
+ + Integer + + +
+
+
+
end + + +
+
+
+ + Integer + + +
+
+
+
seqs + + +
+
+
+ + array[Integer] + + +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

blocksPost

+

blocksHandler returns blocks between a start and end point,

+
+
+
+

+

or an explicit list of sequences. +If using start and end, the block sequences include both the start and end point. +Explicit sequences cannot be combined with start and end. +Without verbose

+

+
+
/api/v1/blocks
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/blocks?start=&end=&seqs="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        Integer start = 56; // Integer | 
+        Integer end = 56; // Integer | 
+        array[Integer] seqs = ; // array[Integer] | 
+        try {
+            Object result = apiInstance.blocksPost(start, end, seqs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blocksPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        Integer start = 56; // Integer | 
+        Integer end = 56; // Integer | 
+        array[Integer] seqs = ; // array[Integer] | 
+        try {
+            Object result = apiInstance.blocksPost(start, end, seqs);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#blocksPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+Integer *start = 56; //  (optional) (default to null)
+Integer *end = 56; //  (optional) (default to null)
+array[Integer] *seqs = ; //  (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// blocksHandler returns blocks between a start and end point,
+[apiInstance blocksPostWith:start
+    end:end
+    seqs:seqs
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'start': 56, // {Integer} 
+  'end': 56, // {Integer} 
+  'seqs':  // {array[Integer]} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.blocksPost(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class blocksPostExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var start = 56;  // Integer |  (optional)  (default to null)
+            var end = 56;  // Integer |  (optional)  (default to null)
+            var seqs = new array[Integer](); // array[Integer] |  (optional)  (default to null)
+
+            try
+            {
+                // blocksHandler returns blocks between a start and end point,
+                Object result = apiInstance.blocksPost(start, end, seqs);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.blocksPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$start = 56; // Integer | 
+$end = 56; // Integer | 
+$seqs = ; // array[Integer] | 
+
+try {
+    $result = $api_instance->blocksPost($start, $end, $seqs);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->blocksPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $start = 56; # Integer | 
+my $end = 56; # Integer | 
+my $seqs = []; # array[Integer] | 
+
+eval { 
+    my $result = $api_instance->blocksPost(start => $start, end => $end, seqs => $seqs);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->blocksPost: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+start = 56 # Integer |  (optional) (default to null)
+end = 56 # Integer |  (optional) (default to null)
+seqs =  # array[Integer] |  (optional) (default to null)
+
+try: 
+    # blocksHandler returns blocks between a start and end point,
+    api_response = api_instance.blocks_post(start=start, end=end, seqs=seqs)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->blocksPost: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let start = 56; // Integer
+    let end = 56; // Integer
+    let seqs = ; // array[Integer]
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.blocksPost(start, end, seqs, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
start + + +
+
+
+ + Integer + + +
+
+
+
end + + +
+
+
+ + Integer + + +
+
+
+
seqs + + +
+
+
+ + array[Integer] + + +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

coinSupply

+

+
+
+
+

+

coinSupplyHandler returns coin distribution supply stats

+

+
+
/api/v1/coinSupply
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/coinSupply"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.coinSupply();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#coinSupply");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.coinSupply();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#coinSupply");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance coinSupplyWithCompletionHandler: 
+              ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.coinSupply(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class coinSupplyExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                Object result = apiInstance.coinSupply();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.coinSupply: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->coinSupply();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->coinSupply: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->coinSupply();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->coinSupply: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    api_response = api_instance.coin_supply()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->coinSupply: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.coinSupply(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

csrf

+

Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.

+
+
+
+

+

+

+
+
/api/v1/csrf
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/csrf"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            inline_response_200_1 result = apiInstance.csrf();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#csrf");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            inline_response_200_1 result = apiInstance.csrf();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#csrf");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
+[apiInstance csrfWithCompletionHandler: 
+              ^(inline_response_200_1 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.csrf(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class csrfExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                // Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
+                inline_response_200_1 result = apiInstance.csrf();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.csrf: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->csrf();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->csrf: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->csrf();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->csrf: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    # Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
+    api_response = api_instance.csrf()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->csrf: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.csrf(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

defaultConnections

+

defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\n They are not necessarily connected to.

+
+
+
+

+

+

+
+
/api/v1/network/defaultConnections
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/network/defaultConnections"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array['String'] result = apiInstance.defaultConnections();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#defaultConnections");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array['String'] result = apiInstance.defaultConnections();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#defaultConnections");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\n They are not necessarily connected to.
+[apiInstance defaultConnectionsWithCompletionHandler: 
+              ^(array['String'] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.defaultConnections(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class defaultConnectionsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                // defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\n They are not necessarily connected to.
+                array['String'] result = apiInstance.defaultConnections();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.defaultConnections: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->defaultConnections();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->defaultConnections: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->defaultConnections();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->defaultConnections: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    # defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\n They are not necessarily connected to.
+    api_response = api_instance.default_connections()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->defaultConnections: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.defaultConnections(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

explorerAddress

+

+
+
+
+

+

Returns all transactions (confirmed and unconfirmed) for an address

+

+
+
/api/v1/explorer/address
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/explorer/address?address="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | tags to filter by
+        try {
+            array[inline_response_200_2] result = apiInstance.explorerAddress(address);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#explorerAddress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | tags to filter by
+        try {
+            array[inline_response_200_2] result = apiInstance.explorerAddress(address);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#explorerAddress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *address = address_example; // tags to filter by (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance explorerAddressWith:address
+              completionHandler: ^(array[inline_response_200_2] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'address': address_example // {String} tags to filter by
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.explorerAddress(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class explorerAddressExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var address = address_example;  // String | tags to filter by (optional)  (default to null)
+
+            try
+            {
+                array[inline_response_200_2] result = apiInstance.explorerAddress(address);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.explorerAddress: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$address = address_example; // String | tags to filter by
+
+try {
+    $result = $api_instance->explorerAddress($address);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->explorerAddress: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $address = address_example; # String | tags to filter by
+
+eval { 
+    my $result = $api_instance->explorerAddress(address => $address);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->explorerAddress: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+address = address_example # String | tags to filter by (optional) (default to null)
+
+try: 
+    api_response = api_instance.explorer_address(address=address)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->explorerAddress: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let address = address_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.explorerAddress(address, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
address + + +
+
+
+ + String + + +
+tags to filter by +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

health

+

Returns node health data.

+
+
+
+

+

+

+
+
/api/v1/health
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/health"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.health();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#health");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.health();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#health");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns node health data.
+[apiInstance healthWithCompletionHandler: 
+              ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.health(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class healthExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                // Returns node health data.
+                Object result = apiInstance.health();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.health: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->health();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->health: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->health();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->health: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    # Returns node health data.
+    api_response = api_instance.health()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->health: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.health(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

lastBlocks

+

+
+
+
+

+

Returns the most recent N blocks on the blockchain

+

+
+
/api/v1/last_blocks
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/last_blocks?num="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        Integer num = 56; // Integer | 
+        try {
+            Object result = apiInstance.lastBlocks(num);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#lastBlocks");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        Integer num = 56; // Integer | 
+        try {
+            Object result = apiInstance.lastBlocks(num);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#lastBlocks");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Integer *num = 56; //  (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance lastBlocksWith:num
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var num = 56; // {Integer} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.lastBlocks(num, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class lastBlocksExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var num = 56;  // Integer |  (default to null)
+
+            try
+            {
+                Object result = apiInstance.lastBlocks(num);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.lastBlocks: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$num = 56; // Integer | 
+
+try {
+    $result = $api_instance->lastBlocks($num);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->lastBlocks: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $num = 56; # Integer | 
+
+eval { 
+    my $result = $api_instance->lastBlocks(num => $num);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->lastBlocks: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+num = 56 # Integer |  (default to null)
+
+try: 
+    api_response = api_instance.last_blocks(num)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->lastBlocks: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let num = 56; // Integer
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.lastBlocks(num, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
num* + + +
+
+
+ + Integer + + +
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

networkConnection

+

This endpoint returns a specific connection.

+
+
+
+

+

+

+
+
/api/v1/network/connection
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/network/connection?addr="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String addr = addr_example; // String | Address port
+        try {
+            inline_response_200_3 result = apiInstance.networkConnection(addr);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnection");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String addr = addr_example; // String | Address port
+        try {
+            inline_response_200_3 result = apiInstance.networkConnection(addr);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnection");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *addr = addr_example; // Address port (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// This endpoint returns a specific connection.
+[apiInstance networkConnectionWith:addr
+              completionHandler: ^(inline_response_200_3 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var addr = addr_example; // {String} Address port
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.networkConnection(addr, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class networkConnectionExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var addr = addr_example;  // String | Address port (default to null)
+
+            try
+            {
+                // This endpoint returns a specific connection.
+                inline_response_200_3 result = apiInstance.networkConnection(addr);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.networkConnection: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$addr = addr_example; // String | Address port
+
+try {
+    $result = $api_instance->networkConnection($addr);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->networkConnection: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $addr = addr_example; # String | Address port
+
+eval { 
+    my $result = $api_instance->networkConnection(addr => $addr);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->networkConnection: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+addr = addr_example # String | Address port (default to null)
+
+try: 
+    # This endpoint returns a specific connection.
+    api_response = api_instance.network_connection(addr)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->networkConnection: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let addr = addr_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.networkConnection(addr, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
addr* + + +
+
+
+ + String + + +
+Address port +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

networkConnections

+

This endpoint returns all outgoings connections.

+
+
+
+

+

+

+
+
/api/v1/network/connections
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/network/connections?states=&direction="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String states = states_example; // String | Connection status.
+        String direction = direction_example; // String | Direction of the connection.
+        try {
+            array[inline_response_200_3] result = apiInstance.networkConnections(states, direction);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnections");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String states = states_example; // String | Connection status.
+        String direction = direction_example; // String | Direction of the connection.
+        try {
+            array[inline_response_200_3] result = apiInstance.networkConnections(states, direction);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnections");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *states = states_example; // Connection status. (optional) (default to null)
+String *direction = direction_example; // Direction of the connection. (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// This endpoint returns all outgoings connections.
+[apiInstance networkConnectionsWith:states
+    direction:direction
+              completionHandler: ^(array[inline_response_200_3] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'states': states_example, // {String} Connection status.
+  'direction': direction_example // {String} Direction of the connection.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.networkConnections(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class networkConnectionsExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var states = states_example;  // String | Connection status. (optional)  (default to null)
+            var direction = direction_example;  // String | Direction of the connection. (optional)  (default to null)
+
+            try
+            {
+                // This endpoint returns all outgoings connections.
+                array[inline_response_200_3] result = apiInstance.networkConnections(states, direction);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.networkConnections: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$states = states_example; // String | Connection status.
+$direction = direction_example; // String | Direction of the connection.
+
+try {
+    $result = $api_instance->networkConnections($states, $direction);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->networkConnections: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $states = states_example; # String | Connection status.
+my $direction = direction_example; # String | Direction of the connection.
+
+eval { 
+    my $result = $api_instance->networkConnections(states => $states, direction => $direction);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->networkConnections: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+states = states_example # String | Connection status. (optional) (default to null)
+direction = direction_example # String | Direction of the connection. (optional) (default to null)
+
+try: 
+    # This endpoint returns all outgoings connections.
+    api_response = api_instance.network_connections(states=states, direction=direction)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->networkConnections: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let states = states_example; // String
+    let direction = direction_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.networkConnections(states, direction, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
states + + +
+
+
+ + String + + +
+Connection status. +
+
+
+
+
direction + + +
+
+
+ + String + + +
+Direction of the connection. +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

networkConnectionsDisconnect

+

+
+
+
+

+

This endpoint disconnects a connection by ID or address

+

+
+
/api/v1/network/connection/disconnect
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/network/connection/disconnect?id="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Address id.
+        try {
+            apiInstance.networkConnectionsDisconnect(id);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnectionsDisconnect");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Address id.
+        try {
+            apiInstance.networkConnectionsDisconnect(id);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnectionsDisconnect");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Address id. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance networkConnectionsDisconnectWith:id
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Address id.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.networkConnectionsDisconnect(id, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class networkConnectionsDisconnectExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Address id. (default to null)
+
+            try
+            {
+                apiInstance.networkConnectionsDisconnect(id);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.networkConnectionsDisconnect: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Address id.
+
+try {
+    $api_instance->networkConnectionsDisconnect($id);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->networkConnectionsDisconnect: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Address id.
+
+eval { 
+    $api_instance->networkConnectionsDisconnect(id => $id);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->networkConnectionsDisconnect: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Address id. (default to null)
+
+try: 
+    api_instance.network_connections_disconnect(id)
+except ApiException as e:
+    print("Exception when calling DefaultApi->networkConnectionsDisconnect: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.networkConnectionsDisconnect(id, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Address id. +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

networkConnectionsExchange

+

+
+
+
+

+

This endpoint returns all connections found through peer exchange

+

+
+
/api/v1/network/connections/exchange
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/network/connections/exchange"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array['String'] result = apiInstance.networkConnectionsExchange();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnectionsExchange");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array['String'] result = apiInstance.networkConnectionsExchange();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnectionsExchange");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance networkConnectionsExchangeWithCompletionHandler: 
+              ^(array['String'] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.networkConnectionsExchange(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class networkConnectionsExchangeExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                array['String'] result = apiInstance.networkConnectionsExchange();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.networkConnectionsExchange: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->networkConnectionsExchange();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->networkConnectionsExchange: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->networkConnectionsExchange();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->networkConnectionsExchange: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    api_response = api_instance.network_connections_exchange()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->networkConnectionsExchange: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.networkConnectionsExchange(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

networkConnectionsTrust

+

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.

+
+
+
+

+

+

+
+
/api/v1/network/connections/trust
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/network/connections/trust"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array['String'] result = apiInstance.networkConnectionsTrust();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnectionsTrust");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array['String'] result = apiInstance.networkConnectionsTrust();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#networkConnectionsTrust");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// 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.
+[apiInstance networkConnectionsTrustWithCompletionHandler: 
+              ^(array['String'] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.networkConnectionsTrust(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class networkConnectionsTrustExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                // 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.
+                array['String'] result = apiInstance.networkConnectionsTrust();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.networkConnectionsTrust: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->networkConnectionsTrust();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->networkConnectionsTrust: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->networkConnectionsTrust();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->networkConnectionsTrust: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    # 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.
+    api_response = api_instance.network_connections_trust()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->networkConnectionsTrust: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.networkConnectionsTrust(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

outputsGet

+

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.

+
+
+
+

+

+

+
+
/api/v1/outputs
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/outputs?address=&hash="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        array[String] address = ; // array[String] | 
+        array[String] hash = ; // array[String] | 
+        try {
+            Object result = apiInstance.outputsGet(address, hash);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#outputsGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        array[String] address = ; // array[String] | 
+        array[String] hash = ; // array[String] | 
+        try {
+            Object result = apiInstance.outputsGet(address, hash);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#outputsGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
array[String] *address = ; //  (optional) (default to null)
+array[String] *hash = ; //  (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// 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.
+[apiInstance outputsGetWith:address
+    hash:hash
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'address': , // {array[String]} 
+  'hash':  // {array[String]} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.outputsGet(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class outputsGetExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var address = new array[String](); // array[String] |  (optional)  (default to null)
+            var hash = new array[String](); // array[String] |  (optional)  (default to null)
+
+            try
+            {
+                // 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.
+                Object result = apiInstance.outputsGet(address, hash);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.outputsGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$address = ; // array[String] | 
+$hash = ; // array[String] | 
+
+try {
+    $result = $api_instance->outputsGet($address, $hash);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->outputsGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $address = []; # array[String] | 
+my $hash = []; # array[String] | 
+
+eval { 
+    my $result = $api_instance->outputsGet(address => $address, hash => $hash);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->outputsGet: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+address =  # array[String] |  (optional) (default to null)
+hash =  # array[String] |  (optional) (default to null)
+
+try: 
+    # 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.
+    api_response = api_instance.outputs_get(address=address, hash=hash)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->outputsGet: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let address = ; // array[String]
+    let hash = ; // array[String]
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.outputsGet(address, hash, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
address + + +
+
+
+ + array[String] + + +
+
+
+
hash + + +
+
+
+ + array[String] + + +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

outputsPost

+

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.

+
+
+
+

+

+

+
+
/api/v1/outputs
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/outputs?address=&hash="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | 
+        String hash = hash_example; // String | 
+        try {
+            Object result = apiInstance.outputsPost(address, hash);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#outputsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | 
+        String hash = hash_example; // String | 
+        try {
+            Object result = apiInstance.outputsPost(address, hash);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#outputsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *address = address_example; //  (optional) (default to null)
+String *hash = hash_example; //  (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// 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.
+[apiInstance outputsPostWith:address
+    hash:hash
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'address': address_example, // {String} 
+  'hash': hash_example // {String} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.outputsPost(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class outputsPostExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var address = address_example;  // String |  (optional)  (default to null)
+            var hash = hash_example;  // String |  (optional)  (default to null)
+
+            try
+            {
+                // 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.
+                Object result = apiInstance.outputsPost(address, hash);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.outputsPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$address = address_example; // String | 
+$hash = hash_example; // String | 
+
+try {
+    $result = $api_instance->outputsPost($address, $hash);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->outputsPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $address = address_example; # String | 
+my $hash = hash_example; # String | 
+
+eval { 
+    my $result = $api_instance->outputsPost(address => $address, hash => $hash);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->outputsPost: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+address = address_example # String |  (optional) (default to null)
+hash = hash_example # String |  (optional) (default to null)
+
+try: 
+    # 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.
+    api_response = api_instance.outputs_post(address=address, hash=hash)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->outputsPost: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let address = address_example; // String
+    let hash = hash_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.outputsPost(address, hash, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
address + + +
+
+
+ + String + + +
+
+
+
hash + + +
+
+
+ + String + + +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

pendingTxs

+

+
+
+
+

+

Returns pending (unconfirmed) transactions without verbose

+

+
+
/api/v1/pendingTxs
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/pendingTxs"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array[inline_response_200_4] result = apiInstance.pendingTxs();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#pendingTxs");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array[inline_response_200_4] result = apiInstance.pendingTxs();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#pendingTxs");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance pendingTxsWithCompletionHandler: 
+              ^(array[inline_response_200_4] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.pendingTxs(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class pendingTxsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                array[inline_response_200_4] result = apiInstance.pendingTxs();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.pendingTxs: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->pendingTxs();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->pendingTxs: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->pendingTxs();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->pendingTxs: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    api_response = api_instance.pending_txs()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->pendingTxs: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.pendingTxs(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

resendUnconfirmedTxns

+

+
+
+
+

+

Broadcasts all unconfirmed transactions from the unconfirmed transaction pool

+

+
+
/api/v1/resendUnconfirmedTxns
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/resendUnconfirmedTxns"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            apiInstance.resendUnconfirmedTxns();
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#resendUnconfirmedTxns");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            apiInstance.resendUnconfirmedTxns();
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#resendUnconfirmedTxns");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance resendUnconfirmedTxnsWithCompletionHandler: 
+              ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.resendUnconfirmedTxns(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class resendUnconfirmedTxnsExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                apiInstance.resendUnconfirmedTxns();
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.resendUnconfirmedTxns: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $api_instance->resendUnconfirmedTxns();
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->resendUnconfirmedTxns: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    $api_instance->resendUnconfirmedTxns();
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->resendUnconfirmedTxns: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    api_instance.resend_unconfirmed_txns()
+except ApiException as e:
+    print("Exception when calling DefaultApi->resendUnconfirmedTxns: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.resendUnconfirmedTxns(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

richlist

+

Returns the top skycoin holders.

+
+
+
+

+

+

+
+
/api/v1/richlist
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/richlist?include-distribution=&n="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        Boolean includeDistribution = true; // Boolean | include distribution addresses or not, default value false
+        String n = n_example; // String | include distribution addresses or not, default value false
+        try {
+            Object result = apiInstance.richlist(includeDistribution, n);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#richlist");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        Boolean includeDistribution = true; // Boolean | include distribution addresses or not, default value false
+        String n = n_example; // String | include distribution addresses or not, default value false
+        try {
+            Object result = apiInstance.richlist(includeDistribution, n);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#richlist");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Boolean *includeDistribution = true; // include distribution addresses or not, default value false (optional) (default to null)
+String *n = n_example; // include distribution addresses or not, default value false (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the top skycoin holders.
+[apiInstance richlistWith:includeDistribution
+    n:n
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'includeDistribution': true, // {Boolean} include distribution addresses or not, default value false
+  'n': n_example // {String} include distribution addresses or not, default value false
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.richlist(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class richlistExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var includeDistribution = true;  // Boolean | include distribution addresses or not, default value false (optional)  (default to null)
+            var n = n_example;  // String | include distribution addresses or not, default value false (optional)  (default to null)
+
+            try
+            {
+                // Returns the top skycoin holders.
+                Object result = apiInstance.richlist(includeDistribution, n);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.richlist: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$includeDistribution = true; // Boolean | include distribution addresses or not, default value false
+$n = n_example; // String | include distribution addresses or not, default value false
+
+try {
+    $result = $api_instance->richlist($includeDistribution, $n);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->richlist: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $includeDistribution = true; # Boolean | include distribution addresses or not, default value false
+my $n = n_example; # String | include distribution addresses or not, default value false
+
+eval { 
+    my $result = $api_instance->richlist(includeDistribution => $includeDistribution, n => $n);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->richlist: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+includeDistribution = true # Boolean | include distribution addresses or not, default value false (optional) (default to null)
+n = n_example # String | include distribution addresses or not, default value false (optional) (default to null)
+
+try: 
+    # Returns the top skycoin holders.
+    api_response = api_instance.richlist(includeDistribution=includeDistribution, n=n)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->richlist: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let includeDistribution = true; // Boolean
+    let n = n_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.richlist(includeDistribution, n, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
include-distribution + + +
+
+
+ + Boolean + + +
+include distribution addresses or not, default value false +
+
+
+
+
n + + +
+
+
+ + String + + +
+include distribution addresses or not, default value false +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

transaction

+

+
+
+
+

+

Returns a transaction identi`fied by its txid hash with just id

+

+
+
/api/v1/transaction
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/transaction?txid=&encoded="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String txid = txid_example; // String | transaction hash
+        Boolean encoded = true; // Boolean | return as a raw encoded transaction.
+        try {
+            Object result = apiInstance.transaction(txid, encoded);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transaction");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String txid = txid_example; // String | transaction hash
+        Boolean encoded = true; // Boolean | return as a raw encoded transaction.
+        try {
+            Object result = apiInstance.transaction(txid, encoded);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transaction");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *txid = txid_example; // transaction hash (default to null)
+Boolean *encoded = true; // return as a raw encoded transaction. (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance transactionWith:txid
+    encoded:encoded
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var txid = txid_example; // {String} transaction hash
+var opts = {
+  'encoded': true // {Boolean} return as a raw encoded transaction.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.transaction(txid, opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class transactionExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var txid = txid_example;  // String | transaction hash (default to null)
+            var encoded = true;  // Boolean | return as a raw encoded transaction. (optional)  (default to null)
+
+            try
+            {
+                Object result = apiInstance.transaction(txid, encoded);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.transaction: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$txid = txid_example; // String | transaction hash
+$encoded = true; // Boolean | return as a raw encoded transaction.
+
+try {
+    $result = $api_instance->transaction($txid, $encoded);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->transaction: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $txid = txid_example; # String | transaction hash
+my $encoded = true; # Boolean | return as a raw encoded transaction.
+
+eval { 
+    my $result = $api_instance->transaction(txid => $txid, encoded => $encoded);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->transaction: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+txid = txid_example # String | transaction hash (default to null)
+encoded = true # Boolean | return as a raw encoded transaction. (optional) (default to null)
+
+try: 
+    api_response = api_instance.transaction(txid, encoded=encoded)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->transaction: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let txid = txid_example; // String
+    let encoded = true; // Boolean
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.transaction(txid, encoded, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
txid* + + +
+
+
+ + String + + +
+transaction hash +
+
+
+ Required +
+
+
+
encoded + + +
+
+
+ + Boolean + + +
+return as a raw encoded transaction. +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

transactionInject

+

Broadcast a hex-encoded, serialized transaction to the network.

+
+
+
+

+

+

+
+
/api/v2/transaction/inject
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v2/transaction/inject"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String rawtx = rawtx_example; // String | hex-encoded serialized transaction string.
+        try {
+            Object result = apiInstance.transactionInject(rawtx);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionInject");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String rawtx = rawtx_example; // String | hex-encoded serialized transaction string.
+        try {
+            Object result = apiInstance.transactionInject(rawtx);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionInject");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *rawtx = rawtx_example; // hex-encoded serialized transaction string. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Broadcast a hex-encoded, serialized transaction to the network.
+[apiInstance transactionInjectWith:rawtx
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var rawtx = rawtx_example; // {String} hex-encoded serialized transaction string.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.transactionInject(rawtx, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class transactionInjectExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var rawtx = rawtx_example;  // String | hex-encoded serialized transaction string. (default to null)
+
+            try
+            {
+                // Broadcast a hex-encoded, serialized transaction to the network.
+                Object result = apiInstance.transactionInject(rawtx);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.transactionInject: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$rawtx = rawtx_example; // String | hex-encoded serialized transaction string.
+
+try {
+    $result = $api_instance->transactionInject($rawtx);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->transactionInject: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $rawtx = rawtx_example; # String | hex-encoded serialized transaction string.
+
+eval { 
+    my $result = $api_instance->transactionInject(rawtx => $rawtx);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->transactionInject: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+rawtx = rawtx_example # String | hex-encoded serialized transaction string. (default to null)
+
+try: 
+    # Broadcast a hex-encoded, serialized transaction to the network.
+    api_response = api_instance.transaction_inject(rawtx)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->transactionInject: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let rawtx = rawtx_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.transactionInject(rawtx, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + +
NameDescription
rawtx* + + +
+
+
+ + String + + +
+hex-encoded serialized transaction string. +
+
+
+ Required +
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

transactionRaw

+

Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.

+
+
+
+

+

+

+
+
/api/v2/transaction/raw
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v2/transaction/raw?txid="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String txid = txid_example; // String | Transaction id hash
+        try {
+            Object result = apiInstance.transactionRaw(txid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionRaw");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String txid = txid_example; // String | Transaction id hash
+        try {
+            Object result = apiInstance.transactionRaw(txid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionRaw");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *txid = txid_example; // Transaction id hash (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
+[apiInstance transactionRawWith:txid
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'txid': txid_example // {String} Transaction id hash
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.transactionRaw(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class transactionRawExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var txid = txid_example;  // String | Transaction id hash (optional)  (default to null)
+
+            try
+            {
+                // Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
+                Object result = apiInstance.transactionRaw(txid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.transactionRaw: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$txid = txid_example; // String | Transaction id hash
+
+try {
+    $result = $api_instance->transactionRaw($txid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->transactionRaw: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $txid = txid_example; # String | Transaction id hash
+
+eval { 
+    my $result = $api_instance->transactionRaw(txid => $txid);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->transactionRaw: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+txid = txid_example # String | Transaction id hash (optional) (default to null)
+
+try: 
+    # Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
+    api_response = api_instance.transaction_raw(txid=txid)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->transactionRaw: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let txid = txid_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.transactionRaw(txid, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
txid + + +
+
+
+ + String + + +
+Transaction id hash +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

transactionVerify

+

+
+
+
+

+

Decode and verify an encoded transaction

+

+
+
/api/v2/transaction/verify
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v2/transaction/verify"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.transactionVerify();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionVerify");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.transactionVerify();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionVerify");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance transactionVerifyWithCompletionHandler: 
+              ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.transactionVerify(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class transactionVerifyExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                Object result = apiInstance.transactionVerify();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.transactionVerify: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->transactionVerify();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->transactionVerify: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->transactionVerify();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->transactionVerify: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    api_response = api_instance.transaction_verify()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->transactionVerify: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.transactionVerify(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

transactionsGet

+

Returns transactions that match the filters.

+
+
+
+

+

+

+
+
/api/v1/transactions
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/transactions?addrs=&confirmed="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        String confirmed = confirmed_example; // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+        try {
+            Object result = apiInstance.transactionsGet(addrs, confirmed);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionsGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        String confirmed = confirmed_example; // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+        try {
+            Object result = apiInstance.transactionsGet(addrs, confirmed);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionsGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *addrs = addrs_example; // command separated list of addresses (optional) (default to null)
+String *confirmed = confirmed_example; // Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns transactions that match the filters.
+[apiInstance transactionsGetWith:addrs
+    confirmed:confirmed
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'addrs': addrs_example, // {String} command separated list of addresses
+  'confirmed': confirmed_example // {String} Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.transactionsGet(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class transactionsGetExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var addrs = addrs_example;  // String | command separated list of addresses (optional)  (default to null)
+            var confirmed = confirmed_example;  // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] (optional)  (default to null)
+
+            try
+            {
+                // Returns transactions that match the filters.
+                Object result = apiInstance.transactionsGet(addrs, confirmed);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.transactionsGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$addrs = addrs_example; // String | command separated list of addresses
+$confirmed = confirmed_example; // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+
+try {
+    $result = $api_instance->transactionsGet($addrs, $confirmed);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->transactionsGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $addrs = addrs_example; # String | command separated list of addresses
+my $confirmed = confirmed_example; # String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+
+eval { 
+    my $result = $api_instance->transactionsGet(addrs => $addrs, confirmed => $confirmed);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->transactionsGet: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+addrs = addrs_example # String | command separated list of addresses (optional) (default to null)
+confirmed = confirmed_example # String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] (optional) (default to null)
+
+try: 
+    # Returns transactions that match the filters.
+    api_response = api_instance.transactions_get(addrs=addrs, confirmed=confirmed)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->transactionsGet: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let addrs = addrs_example; // String
+    let confirmed = confirmed_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.transactionsGet(addrs, confirmed, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
addrs + + +
+
+
+ + String + + +
+command separated list of addresses +
+
+
+
+
confirmed + + +
+
+
+ + String + + +
+Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

transactionsPost

+

Returns transactions that match the filters.

+
+
+
+

+

+

+
+
/api/v1/transactions
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/transactions?addrs=&confirmed="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        String confirmed = confirmed_example; // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+        try {
+            Object result = apiInstance.transactionsPost(addrs, confirmed);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String addrs = addrs_example; // String | command separated list of addresses
+        String confirmed = confirmed_example; // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+        try {
+            Object result = apiInstance.transactionsPost(addrs, confirmed);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#transactionsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *addrs = addrs_example; // command separated list of addresses (optional) (default to null)
+String *confirmed = confirmed_example; // Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns transactions that match the filters.
+[apiInstance transactionsPostWith:addrs
+    confirmed:confirmed
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'addrs': addrs_example, // {String} command separated list of addresses
+  'confirmed': confirmed_example // {String} Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.transactionsPost(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class transactionsPostExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var addrs = addrs_example;  // String | command separated list of addresses (optional)  (default to null)
+            var confirmed = confirmed_example;  // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] (optional)  (default to null)
+
+            try
+            {
+                // Returns transactions that match the filters.
+                Object result = apiInstance.transactionsPost(addrs, confirmed);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.transactionsPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$addrs = addrs_example; // String | command separated list of addresses
+$confirmed = confirmed_example; // String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+
+try {
+    $result = $api_instance->transactionsPost($addrs, $confirmed);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->transactionsPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $addrs = addrs_example; # String | command separated list of addresses
+my $confirmed = confirmed_example; # String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all]
+
+eval { 
+    my $result = $api_instance->transactionsPost(addrs => $addrs, confirmed => $confirmed);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->transactionsPost: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+addrs = addrs_example # String | command separated list of addresses (optional) (default to null)
+confirmed = confirmed_example # String | Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] (optional) (default to null)
+
+try: 
+    # Returns transactions that match the filters.
+    api_response = api_instance.transactions_post(addrs=addrs, confirmed=confirmed)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->transactionsPost: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let addrs = addrs_example; // String
+    let confirmed = confirmed_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.transactionsPost(addrs, confirmed, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
addrs + + +
+
+
+ + String + + +
+command separated list of addresses +
+
+
+
+
confirmed + + +
+
+
+ + String + + +
+Whether the transactions should be confirmed [optional, must be 0 or 1; if not provided, returns all] +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

uxout

+

Returns an unspent output by ID.

+
+
+
+

+

+

+
+
/api/v1/uxout
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/uxout?uxid="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String uxid = uxid_example; // String | uxid to filter by
+        try {
+            Object result = apiInstance.uxout(uxid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#uxout");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String uxid = uxid_example; // String | uxid to filter by
+        try {
+            Object result = apiInstance.uxout(uxid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#uxout");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *uxid = uxid_example; // uxid to filter by (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns an unspent output by ID.
+[apiInstance uxoutWith:uxid
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'uxid': uxid_example // {String} uxid to filter by
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.uxout(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class uxoutExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var uxid = uxid_example;  // String | uxid to filter by (optional)  (default to null)
+
+            try
+            {
+                // Returns an unspent output by ID.
+                Object result = apiInstance.uxout(uxid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.uxout: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$uxid = uxid_example; // String | uxid to filter by
+
+try {
+    $result = $api_instance->uxout($uxid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->uxout: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $uxid = uxid_example; # String | uxid to filter by
+
+eval { 
+    my $result = $api_instance->uxout(uxid => $uxid);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->uxout: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+uxid = uxid_example # String | uxid to filter by (optional) (default to null)
+
+try: 
+    # Returns an unspent output by ID.
+    api_response = api_instance.uxout(uxid=uxid)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->uxout: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let uxid = uxid_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.uxout(uxid, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
uxid + + +
+
+
+ + String + + +
+uxid to filter by +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

verifyAddress

+

Verifies a Skycoin address.

+
+
+
+

+

+

+
+
/api/v2/address/verify
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v2/address/verify?address="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | Address id.
+        try {
+            inline_response_200_7 result = apiInstance.verifyAddress(address);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#verifyAddress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String address = address_example; // String | Address id.
+        try {
+            inline_response_200_7 result = apiInstance.verifyAddress(address);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#verifyAddress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *address = address_example; // Address id. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Verifies a Skycoin address.
+[apiInstance verifyAddressWith:address
+              completionHandler: ^(inline_response_200_7 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var address = address_example; // {String} Address id.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.verifyAddress(address, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class verifyAddressExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var address = address_example;  // String | Address id. (default to null)
+
+            try
+            {
+                // Verifies a Skycoin address.
+                inline_response_200_7 result = apiInstance.verifyAddress(address);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.verifyAddress: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$address = address_example; // String | Address id.
+
+try {
+    $result = $api_instance->verifyAddress($address);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->verifyAddress: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $address = address_example; # String | Address id.
+
+eval { 
+    my $result = $api_instance->verifyAddress(address => $address);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->verifyAddress: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+address = address_example # String | Address id. (default to null)
+
+try: 
+    # Verifies a Skycoin address.
+    api_response = api_instance.verify_address(address)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->verifyAddress: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let address = address_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.verifyAddress(address, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
address* + + +
+
+
+ + String + + +
+Address id. +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

version

+

+
+
+
+

+

versionHandler returns the application version info

+

+
+
/api/v1/version
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/version"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.version();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#version");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            Object result = apiInstance.version();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#version");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance versionWithCompletionHandler: 
+              ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.version(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class versionExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                Object result = apiInstance.version();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.version: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->version();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->version: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->version();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->version: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    api_response = api_instance.version()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->version: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.version(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

wallet

+

Returns a wallet by id.

+
+
+
+

+

+

+
+
/api/v1/wallet
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/wallet?id="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | tags to filter by
+        try {
+            Object result = apiInstance.wallet(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#wallet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | tags to filter by
+        try {
+            Object result = apiInstance.wallet(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#wallet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *id = id_example; // tags to filter by (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns a wallet by id.
+[apiInstance walletWith:id
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} tags to filter by
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.wallet(id, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | tags to filter by (default to null)
+
+            try
+            {
+                // Returns a wallet by id.
+                Object result = apiInstance.wallet(id);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.wallet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | tags to filter by
+
+try {
+    $result = $api_instance->wallet($id);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->wallet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | tags to filter by
+
+eval { 
+    my $result = $api_instance->wallet(id => $id);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->wallet: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | tags to filter by (default to null)
+
+try: 
+    # Returns a wallet by id.
+    api_response = api_instance.wallet(id)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->wallet: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.wallet(id, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+tags to filter by +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletBalance

+

Returns the wallet's balance, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.

+
+
+
+

+

+

+
+
/api/v1/wallet/balance
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/wallet/balance?id="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | tags to filter by
+        try {
+            Object result = apiInstance.walletBalance(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletBalance");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | tags to filter by
+        try {
+            Object result = apiInstance.walletBalance(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletBalance");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *id = id_example; // tags to filter by (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Returns the wallet's balance, both confirmed and predicted.  The predicted balance is the confirmed balance minus the pending spends.
+[apiInstance walletBalanceWith:id
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} tags to filter by
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletBalance(id, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletBalanceExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | tags to filter by (default to null)
+
+            try
+            {
+                // Returns the wallet's balance, both confirmed and predicted.  The predicted balance is the confirmed balance minus the pending spends.
+                Object result = apiInstance.walletBalance(id);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletBalance: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | tags to filter by
+
+try {
+    $result = $api_instance->walletBalance($id);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletBalance: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | tags to filter by
+
+eval { 
+    my $result = $api_instance->walletBalance(id => $id);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletBalance: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | tags to filter by (default to null)
+
+try: 
+    # Returns the wallet's balance, both confirmed and predicted.  The predicted balance is the confirmed balance minus the pending spends.
+    api_response = api_instance.wallet_balance(id)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletBalance: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletBalance(id, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+tags to filter by +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletCreate

+

+
+
+
+

+

Loads wallet from seed, will scan ahead N address and +load addresses till the last one that have coins.

+

+
+
/api/v1/wallet/create
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/create"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String seed = seed_example; // String | Wallet seed.
+        String label = label_example; // String | Wallet label.
+        Integer scan = 56; // Integer | The number of addresses to scan ahead for balances.
+        Boolean encrypt = true; // Boolean | Encrypt wallet.
+        String password = password_example; // String | Wallet Password
+        try {
+            Object result = apiInstance.walletCreate(seed, label, scan, encrypt, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletCreate");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String seed = seed_example; // String | Wallet seed.
+        String label = label_example; // String | Wallet label.
+        Integer scan = 56; // Integer | The number of addresses to scan ahead for balances.
+        Boolean encrypt = true; // Boolean | Encrypt wallet.
+        String password = password_example; // String | Wallet Password
+        try {
+            Object result = apiInstance.walletCreate(seed, label, scan, encrypt, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletCreate");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *seed = seed_example; // Wallet seed. (default to null)
+String *label = label_example; // Wallet label. (default to null)
+Integer *scan = 56; // The number of addresses to scan ahead for balances. (optional) (default to null)
+Boolean *encrypt = true; // Encrypt wallet. (optional) (default to null)
+String *password = password_example; // Wallet Password (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletCreateWith:seed
+    label:label
+    scan:scan
+    encrypt:encrypt
+    password:password
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var seed = seed_example; // {String} Wallet seed.
+var label = label_example; // {String} Wallet label.
+var opts = {
+  'scan': 56, // {Integer} The number of addresses to scan ahead for balances.
+  'encrypt': true, // {Boolean} Encrypt wallet.
+  'password': password_example // {String} Wallet Password
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletCreate(seed, label, opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletCreateExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var seed = seed_example;  // String | Wallet seed. (default to null)
+            var label = label_example;  // String | Wallet label. (default to null)
+            var scan = 56;  // Integer | The number of addresses to scan ahead for balances. (optional)  (default to null)
+            var encrypt = true;  // Boolean | Encrypt wallet. (optional)  (default to null)
+            var password = password_example;  // String | Wallet Password (optional)  (default to null)
+
+            try
+            {
+                Object result = apiInstance.walletCreate(seed, label, scan, encrypt, password);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletCreate: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$seed = seed_example; // String | Wallet seed.
+$label = label_example; // String | Wallet label.
+$scan = 56; // Integer | The number of addresses to scan ahead for balances.
+$encrypt = true; // Boolean | Encrypt wallet.
+$password = password_example; // String | Wallet Password
+
+try {
+    $result = $api_instance->walletCreate($seed, $label, $scan, $encrypt, $password);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletCreate: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $seed = seed_example; # String | Wallet seed.
+my $label = label_example; # String | Wallet label.
+my $scan = 56; # Integer | The number of addresses to scan ahead for balances.
+my $encrypt = true; # Boolean | Encrypt wallet.
+my $password = password_example; # String | Wallet Password
+
+eval { 
+    my $result = $api_instance->walletCreate(seed => $seed, label => $label, scan => $scan, encrypt => $encrypt, password => $password);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletCreate: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+seed = seed_example # String | Wallet seed. (default to null)
+label = label_example # String | Wallet label. (default to null)
+scan = 56 # Integer | The number of addresses to scan ahead for balances. (optional) (default to null)
+encrypt = true # Boolean | Encrypt wallet. (optional) (default to null)
+password = password_example # String | Wallet Password (optional) (default to null)
+
+try: 
+    api_response = api_instance.wallet_create(seed, label, scan=scan, encrypt=encrypt, password=password)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletCreate: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let seed = seed_example; // String
+    let label = label_example; // String
+    let scan = 56; // Integer
+    let encrypt = true; // Boolean
+    let password = password_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletCreate(seed, label, scan, encrypt, password, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
seed* + + +
+
+
+ + String + + +
+Wallet seed. +
+
+
+ Required +
+
+
+
label* + + +
+
+
+ + String + + +
+Wallet label. +
+
+
+ Required +
+
+
+
scan + + +
+
+
+ + Integer + + +
+The number of addresses to scan ahead for balances. +
+
+
+
+
encrypt + + +
+
+
+ + Boolean + + +
+Encrypt wallet. +
+
+
+
+
password + + +
+
+
+ + String + + +
+Wallet Password +
+
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletDecrypt

+

Decrypts wallet.

+
+
+
+

+

+

+
+
/api/v1/wallet/decrypt
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/decrypt"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletDecrypt(id, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletDecrypt");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletDecrypt(id, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletDecrypt");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet id. (default to null)
+String *password = password_example; // Wallet password. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Decrypts wallet.
+[apiInstance walletDecryptWith:id
+    password:password
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet id.
+var password = password_example; // {String} Wallet password.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletDecrypt(id, password, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletDecryptExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet id. (default to null)
+            var password = password_example;  // String | Wallet password. (default to null)
+
+            try
+            {
+                // Decrypts wallet.
+                Object result = apiInstance.walletDecrypt(id, password);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletDecrypt: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet id.
+$password = password_example; // String | Wallet password.
+
+try {
+    $result = $api_instance->walletDecrypt($id, $password);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletDecrypt: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet id.
+my $password = password_example; # String | Wallet password.
+
+eval { 
+    my $result = $api_instance->walletDecrypt(id => $id, password => $password);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletDecrypt: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet id. (default to null)
+password = password_example # String | Wallet password. (default to null)
+
+try: 
+    # Decrypts wallet.
+    api_response = api_instance.wallet_decrypt(id, password)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletDecrypt: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+    let password = password_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletDecrypt(id, password, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet id. +
+
+
+ Required +
+
+
+
password* + + +
+
+
+ + String + + +
+Wallet password. +
+
+
+ Required +
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletEncrypt

+

Encrypt wallet.

+
+
+
+

+

+

+
+
/api/v1/wallet/encrypt
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/encrypt"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletEncrypt(id, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletEncrypt");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletEncrypt(id, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletEncrypt");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet id. (default to null)
+String *password = password_example; // Wallet password. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Encrypt wallet.
+[apiInstance walletEncryptWith:id
+    password:password
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet id.
+var password = password_example; // {String} Wallet password.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletEncrypt(id, password, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletEncryptExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet id. (default to null)
+            var password = password_example;  // String | Wallet password. (default to null)
+
+            try
+            {
+                // Encrypt wallet.
+                Object result = apiInstance.walletEncrypt(id, password);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletEncrypt: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet id.
+$password = password_example; // String | Wallet password.
+
+try {
+    $result = $api_instance->walletEncrypt($id, $password);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletEncrypt: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet id.
+my $password = password_example; # String | Wallet password.
+
+eval { 
+    my $result = $api_instance->walletEncrypt(id => $id, password => $password);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletEncrypt: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet id. (default to null)
+password = password_example # String | Wallet password. (default to null)
+
+try: 
+    # Encrypt wallet.
+    api_response = api_instance.wallet_encrypt(id, password)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletEncrypt: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+    let password = password_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletEncrypt(id, password, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet id. +
+
+
+ Required +
+
+
+
password* + + +
+
+
+ + String + + +
+Wallet password. +
+
+
+ Required +
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletFolder

+

+
+
+
+

+

Returns the wallet directory path

+

+
+
/api/v1/wallets/folderName
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/wallets/folderName?addr="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String addr = addr_example; // String | Address port
+        try {
+            inline_response_200_6 result = apiInstance.walletFolder(addr);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletFolder");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String addr = addr_example; // String | Address port
+        try {
+            inline_response_200_6 result = apiInstance.walletFolder(addr);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletFolder");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *addr = addr_example; // Address port (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletFolderWith:addr
+              completionHandler: ^(inline_response_200_6 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var addr = addr_example; // {String} Address port
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletFolder(addr, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletFolderExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var addr = addr_example;  // String | Address port (default to null)
+
+            try
+            {
+                inline_response_200_6 result = apiInstance.walletFolder(addr);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletFolder: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$addr = addr_example; // String | Address port
+
+try {
+    $result = $api_instance->walletFolder($addr);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletFolder: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $addr = addr_example; # String | Address port
+
+eval { 
+    my $result = $api_instance->walletFolder(addr => $addr);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletFolder: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+addr = addr_example # String | Address port (default to null)
+
+try: 
+    api_response = api_instance.wallet_folder(addr)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletFolder: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let addr = addr_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletFolder(addr, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
addr* + + +
+
+
+ + String + + +
+Address port +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletNewAddress

+

+
+
+
+

+

Generates new addresses

+

+
+
/api/v1/wallet/newAddress
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/newAddress?id=&num=&password="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id
+        String num = num_example; // String | The number you want to generate
+        String password = password_example; // String | Wallet Password
+        try {
+            Object result = apiInstance.walletNewAddress(id, num, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletNewAddress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id
+        String num = num_example; // String | The number you want to generate
+        String password = password_example; // String | Wallet Password
+        try {
+            Object result = apiInstance.walletNewAddress(id, num, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletNewAddress");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet Id (default to null)
+String *num = num_example; // The number you want to generate (optional) (default to null)
+String *password = password_example; // Wallet Password (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletNewAddressWith:id
+    num:num
+    password:password
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet Id
+var opts = {
+  'num': num_example, // {String} The number you want to generate
+  'password': password_example // {String} Wallet Password
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletNewAddress(id, opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletNewAddressExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet Id (default to null)
+            var num = num_example;  // String | The number you want to generate (optional)  (default to null)
+            var password = password_example;  // String | Wallet Password (optional)  (default to null)
+
+            try
+            {
+                Object result = apiInstance.walletNewAddress(id, num, password);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletNewAddress: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet Id
+$num = num_example; // String | The number you want to generate
+$password = password_example; // String | Wallet Password
+
+try {
+    $result = $api_instance->walletNewAddress($id, $num, $password);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletNewAddress: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet Id
+my $num = num_example; # String | The number you want to generate
+my $password = password_example; # String | Wallet Password
+
+eval { 
+    my $result = $api_instance->walletNewAddress(id => $id, num => $num, password => $password);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletNewAddress: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet Id (default to null)
+num = num_example # String | The number you want to generate (optional) (default to null)
+password = password_example # String | Wallet Password (optional) (default to null)
+
+try: 
+    api_response = api_instance.wallet_new_address(id, num=num, password=password)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletNewAddress: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+    let num = num_example; // String
+    let password = password_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletNewAddress(id, num, password, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet Id +
+
+
+ Required +
+
+
+
num + + +
+
+
+ + String + + +
+The number you want to generate +
+
+
+
+
password + + +
+
+
+ + String + + +
+Wallet Password +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletNewSeed

+

+
+
+
+

+

Returns the wallet directory path

+

+
+
/api/v1/wallet/newSeed
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/wallet/newSeed?entropy="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String entropy = entropy_example; // String | Entropy bitSize.
+        try {
+            Object result = apiInstance.walletNewSeed(entropy);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletNewSeed");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String entropy = entropy_example; // String | Entropy bitSize.
+        try {
+            Object result = apiInstance.walletNewSeed(entropy);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletNewSeed");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *entropy = entropy_example; // Entropy bitSize. (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletNewSeedWith:entropy
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'entropy': entropy_example // {String} Entropy bitSize.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletNewSeed(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletNewSeedExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var entropy = entropy_example;  // String | Entropy bitSize. (optional)  (default to null)
+
+            try
+            {
+                Object result = apiInstance.walletNewSeed(entropy);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletNewSeed: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$entropy = entropy_example; // String | Entropy bitSize.
+
+try {
+    $result = $api_instance->walletNewSeed($entropy);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletNewSeed: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $entropy = entropy_example; # String | Entropy bitSize.
+
+eval { 
+    my $result = $api_instance->walletNewSeed(entropy => $entropy);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletNewSeed: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+entropy = entropy_example # String | Entropy bitSize. (optional) (default to null)
+
+try: 
+    api_response = api_instance.wallet_new_seed(entropy=entropy)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletNewSeed: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let entropy = entropy_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletNewSeed(entropy, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
entropy + + +
+
+
+ + String + + +
+Entropy bitSize. +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletRecover

+

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.

+
+
+
+

+

+

+
+
/api/v2/wallet/recover
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v2/wallet/recover"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        String seed = seed_example; // String | Wallet seed.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletRecover(id, seed, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletRecover");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        String seed = seed_example; // String | Wallet seed.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletRecover(id, seed, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletRecover");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet id. (default to null)
+String *seed = seed_example; // Wallet seed. (default to null)
+String *password = password_example; // Wallet password. (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// 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.
+[apiInstance walletRecoverWith:id
+    seed:seed
+    password:password
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet id.
+var seed = seed_example; // {String} Wallet seed.
+var opts = {
+  'password': password_example // {String} Wallet password.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletRecover(id, seed, opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletRecoverExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet id. (default to null)
+            var seed = seed_example;  // String | Wallet seed. (default to null)
+            var password = password_example;  // String | Wallet password. (optional)  (default to null)
+
+            try
+            {
+                // 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.
+                Object result = apiInstance.walletRecover(id, seed, password);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletRecover: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet id.
+$seed = seed_example; // String | Wallet seed.
+$password = password_example; // String | Wallet password.
+
+try {
+    $result = $api_instance->walletRecover($id, $seed, $password);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletRecover: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet id.
+my $seed = seed_example; # String | Wallet seed.
+my $password = password_example; # String | Wallet password.
+
+eval { 
+    my $result = $api_instance->walletRecover(id => $id, seed => $seed, password => $password);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletRecover: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet id. (default to null)
+seed = seed_example # String | Wallet seed. (default to null)
+password = password_example # String | Wallet password. (optional) (default to null)
+
+try: 
+    # 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.
+    api_response = api_instance.wallet_recover(id, seed, password=password)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletRecover: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+    let seed = seed_example; // String
+    let password = password_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletRecover(id, seed, password, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet id. +
+
+
+ Required +
+
+
+
seed* + + +
+
+
+ + String + + +
+Wallet seed. +
+
+
+ Required +
+
+
+
password + + +
+
+
+ + String + + +
+Wallet password. +
+
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletSeed

+

This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.

+
+
+
+

+

+

+
+
/api/v1/wallet/seed
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/seed?id=&password="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletSeed(id, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletSeed");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletSeed(id, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletSeed");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet Id. (default to null)
+String *password = password_example; // Wallet password. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
+[apiInstance walletSeedWith:id
+    password:password
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet Id.
+var password = password_example; // {String} Wallet password.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletSeed(id, password, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletSeedExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet Id. (default to null)
+            var password = password_example;  // String | Wallet password. (default to null)
+
+            try
+            {
+                // This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
+                Object result = apiInstance.walletSeed(id, password);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletSeed: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet Id.
+$password = password_example; // String | Wallet password.
+
+try {
+    $result = $api_instance->walletSeed($id, $password);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletSeed: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet Id.
+my $password = password_example; # String | Wallet password.
+
+eval { 
+    my $result = $api_instance->walletSeed(id => $id, password => $password);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletSeed: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet Id. (default to null)
+password = password_example # String | Wallet password. (default to null)
+
+try: 
+    # This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
+    api_response = api_instance.wallet_seed(id, password)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletSeed: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+    let password = password_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletSeed(id, password, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet Id. +
+
+
+ Required +
+
+
+
password* + + +
+
+
+ + String + + +
+Wallet password. +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletSeedVerify

+

Verifies a wallet seed.

+
+
+
+

+

+

+
+
/api/v2/wallet/seed/verify
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v2/wallet/seed/verify"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String seed = seed_example; // String | Seed to be verified.
+        try {
+            Object result = apiInstance.walletSeedVerify(seed);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletSeedVerify");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String seed = seed_example; // String | Seed to be verified.
+        try {
+            Object result = apiInstance.walletSeedVerify(seed);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletSeedVerify");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *seed = seed_example; // Seed to be verified. (optional) (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Verifies a wallet seed.
+[apiInstance walletSeedVerifyWith:seed
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'seed': seed_example // {String} Seed to be verified.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletSeedVerify(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletSeedVerifyExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var seed = seed_example;  // String | Seed to be verified. (optional)  (default to null)
+
+            try
+            {
+                // Verifies a wallet seed.
+                Object result = apiInstance.walletSeedVerify(seed);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletSeedVerify: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$seed = seed_example; // String | Seed to be verified.
+
+try {
+    $result = $api_instance->walletSeedVerify($seed);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletSeedVerify: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $seed = seed_example; # String | Seed to be verified.
+
+eval { 
+    my $result = $api_instance->walletSeedVerify(seed => $seed);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletSeedVerify: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+seed = seed_example # String | Seed to be verified. (optional) (default to null)
+
+try: 
+    # Verifies a wallet seed.
+    api_response = api_instance.wallet_seed_verify(seed=seed)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletSeedVerify: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let seed = seed_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletSeedVerify(seed, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + +
NameDescription
seed + + +
+
+
+ + String + + +
+Seed to be verified. +
+
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletSpent

+

+
+
+
+

+

Creates and broadcasts a transaction sending money from one of our wallets +to destination address.

+

+
+
/api/v1/wallet/spend
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/spend"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id
+        String dst = dst_example; // String | Recipient address
+        String coins = coins_example; // String | Number of coins to spend, in droplets. 1 coin equals 1e6 droplets.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletSpent(id, dst, coins, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletSpent");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id
+        String dst = dst_example; // String | Recipient address
+        String coins = coins_example; // String | Number of coins to spend, in droplets. 1 coin equals 1e6 droplets.
+        String password = password_example; // String | Wallet password.
+        try {
+            Object result = apiInstance.walletSpent(id, dst, coins, password);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletSpent");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet id (default to null)
+String *dst = dst_example; // Recipient address (default to null)
+String *coins = coins_example; // Number of coins to spend, in droplets. 1 coin equals 1e6 droplets. (default to null)
+String *password = password_example; // Wallet password. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletSpentWith:id
+    dst:dst
+    coins:coins
+    password:password
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet id
+var dst = dst_example; // {String} Recipient address
+var coins = coins_example; // {String} Number of coins to spend, in droplets. 1 coin equals 1e6 droplets.
+var password = password_example; // {String} Wallet password.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletSpent(id, dst, coins, password, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletSpentExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet id (default to null)
+            var dst = dst_example;  // String | Recipient address (default to null)
+            var coins = coins_example;  // String | Number of coins to spend, in droplets. 1 coin equals 1e6 droplets. (default to null)
+            var password = password_example;  // String | Wallet password. (default to null)
+
+            try
+            {
+                Object result = apiInstance.walletSpent(id, dst, coins, password);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletSpent: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet id
+$dst = dst_example; // String | Recipient address
+$coins = coins_example; // String | Number of coins to spend, in droplets. 1 coin equals 1e6 droplets.
+$password = password_example; // String | Wallet password.
+
+try {
+    $result = $api_instance->walletSpent($id, $dst, $coins, $password);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletSpent: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet id
+my $dst = dst_example; # String | Recipient address
+my $coins = coins_example; # String | Number of coins to spend, in droplets. 1 coin equals 1e6 droplets.
+my $password = password_example; # String | Wallet password.
+
+eval { 
+    my $result = $api_instance->walletSpent(id => $id, dst => $dst, coins => $coins, password => $password);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletSpent: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet id (default to null)
+dst = dst_example # String | Recipient address (default to null)
+coins = coins_example # String | Number of coins to spend, in droplets. 1 coin equals 1e6 droplets. (default to null)
+password = password_example # String | Wallet password. (default to null)
+
+try: 
+    api_response = api_instance.wallet_spent(id, dst, coins, password)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletSpent: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+    let dst = dst_example; // String
+    let coins = coins_example; // String
+    let password = password_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletSpent(id, dst, coins, password, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet id +
+
+
+ Required +
+
+
+
dst* + + +
+
+
+ + String + + +
+Recipient address +
+
+
+ Required +
+
+
+
coins* + + +
+
+
+ + String + + +
+Number of coins to spend, in droplets. 1 coin equals 1e6 droplets. +
+
+
+ Required +
+
+
+
password* + + +
+
+
+ + String + + +
+Wallet password. +
+
+
+ Required +
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletTransaction

+

+
+
+
+

+

Creates a signed transaction

+

+
+
/api/v1/wallet/transaction
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/transaction"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        Inline_object inlineObject = ; // Inline_object | 
+        try {
+            Object result = apiInstance.walletTransaction(inlineObject);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletTransaction");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        Inline_object inlineObject = ; // Inline_object | 
+        try {
+            Object result = apiInstance.walletTransaction(inlineObject);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletTransaction");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+Inline_object *inlineObject = ; //  (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletTransactionWith:inlineObject
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var opts = {
+  'inlineObject':  // {Inline_object} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletTransaction(opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletTransactionExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var inlineObject = new Inline_object(); // Inline_object |  (optional) 
+
+            try
+            {
+                Object result = apiInstance.walletTransaction(inlineObject);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletTransaction: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$inlineObject = ; // Inline_object | 
+
+try {
+    $result = $api_instance->walletTransaction($inlineObject);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletTransaction: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $inlineObject = WWW::OPenAPIClient::Object::Inline_object->new(); # Inline_object | 
+
+eval { 
+    my $result = $api_instance->walletTransaction(inlineObject => $inlineObject);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletTransaction: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+inlineObject =  # Inline_object |  (optional)
+
+try: 
+    api_response = api_instance.wallet_transaction(inlineObject=inlineObject)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletTransaction: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let inlineObject = ; // Inline_object
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletTransaction(inlineObject, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + + +
NameDescription
inlineObject +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletTransactions

+

+
+
+
+

+

Returns returns all unconfirmed transactions for all addresses in a given wallet verbose

+

+
+
/api/v1/wallet/transactions
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/wallet/transactions?id="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        try {
+            Object result = apiInstance.walletTransactions(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletTransactions");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet id.
+        try {
+            Object result = apiInstance.walletTransactions(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletTransactions");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *id = id_example; // Wallet id. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletTransactionsWith:id
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet id.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.walletTransactions(id, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletTransactionsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet id. (default to null)
+
+            try
+            {
+                Object result = apiInstance.walletTransactions(id);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletTransactions: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet id.
+
+try {
+    $result = $api_instance->walletTransactions($id);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletTransactions: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet id.
+
+eval { 
+    my $result = $api_instance->walletTransactions(id => $id);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletTransactions: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet id. (default to null)
+
+try: 
+    api_response = api_instance.wallet_transactions(id)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletTransactions: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletTransactions(id, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet id. +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletUnload

+

Unloads wallet from the wallet service.

+
+
+
+

+

+

+
+
/api/v1/wallet/unload
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/unload?id="
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id.
+        try {
+            apiInstance.walletUnload(id);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletUnload");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id.
+        try {
+            apiInstance.walletUnload(id);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletUnload");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet Id. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Unloads wallet from the wallet service.
+[apiInstance walletUnloadWith:id
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet Id.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.walletUnload(id, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletUnloadExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet Id. (default to null)
+
+            try
+            {
+                // Unloads wallet from the wallet service.
+                apiInstance.walletUnload(id);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletUnload: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet Id.
+
+try {
+    $api_instance->walletUnload($id);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletUnload: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet Id.
+
+eval { 
+    $api_instance->walletUnload(id => $id);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletUnload: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet Id. (default to null)
+
+try: 
+    # Unloads wallet from the wallet service.
+    api_instance.wallet_unload(id)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletUnload: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletUnload(id, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet Id. +
+
+
+ Required +
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

walletUpdate

+

Update the wallet.

+
+
+
+

+

+

+
+
/api/v1/wallet/update
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST -H "X-CSRF-TOKEN: [[apiKey]]" "http://127.0.0.1:6420/api/v1/wallet/update"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure API key authorization: csrfAuth
+        ApiKeyAuth csrfAuth = (ApiKeyAuth) defaultClient.getAuthentication("csrfAuth");
+        csrfAuth.setApiKey("YOUR API KEY");
+        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+        //csrfAuth.setApiKeyPrefix("Token");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id.
+        String label = label_example; // String | The label the wallet will be updated to.
+        try {
+            apiInstance.walletUpdate(id, label);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletUpdate");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | Wallet Id.
+        String label = label_example; // String | The label the wallet will be updated to.
+        try {
+            apiInstance.walletUpdate(id, label);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#walletUpdate");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure API key authorization: (authentication scheme: csrfAuth)
+[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-CSRF-TOKEN"];
+
+String *id = id_example; // Wallet Id. (default to null)
+String *label = label_example; // The label the wallet will be updated to. (default to null)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Update the wallet.
+[apiInstance walletUpdateWith:id
+    label:label
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+var defaultClient = SkycoinRestApi.ApiClient.instance;
+
+// Configure API key authorization: csrfAuth
+var csrfAuth = defaultClient.authentications['csrfAuth'];
+csrfAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//csrfAuth.apiKeyPrefix['X-CSRF-TOKEN'] = "Token"
+
+var api = new SkycoinRestApi.DefaultApi()
+var id = id_example; // {String} Wallet Id.
+var label = label_example; // {String} The label the wallet will be updated to.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.walletUpdate(id, label, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletUpdateExample
+    {
+        public void main()
+        {
+            
+            // Configure API key authorization: csrfAuth
+            Configuration.Default.ApiKey.Add("X-CSRF-TOKEN", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // Configuration.Default.ApiKeyPrefix.Add("X-CSRF-TOKEN", "Bearer");
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | Wallet Id. (default to null)
+            var label = label_example;  // String | The label the wallet will be updated to. (default to null)
+
+            try
+            {
+                // Update the wallet.
+                apiInstance.walletUpdate(id, label);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.walletUpdate: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure API key authorization: csrfAuth
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-CSRF-TOKEN', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-CSRF-TOKEN', 'Bearer');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$id = id_example; // String | Wallet Id.
+$label = label_example; // String | The label the wallet will be updated to.
+
+try {
+    $api_instance->walletUpdate($id, $label);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->walletUpdate: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Configure API key authorization: csrfAuth
+$WWW::OPenAPIClient::Configuration::api_key->{'X-CSRF-TOKEN'} = 'YOUR_API_KEY';
+# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-CSRF-TOKEN'} = "Bearer";
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $id = id_example; # String | Wallet Id.
+my $label = label_example; # String | The label the wallet will be updated to.
+
+eval { 
+    $api_instance->walletUpdate(id => $id, label => $label);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->walletUpdate: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: csrfAuth
+openapi_client.configuration.api_key['X-CSRF-TOKEN'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# openapi_client.configuration.api_key_prefix['X-CSRF-TOKEN'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+id = id_example # String | Wallet Id. (default to null)
+label = label_example # String | The label the wallet will be updated to. (default to null)
+
+try: 
+    # Update the wallet.
+    api_instance.wallet_update(id, label)
+except ApiException as e:
+    print("Exception when calling DefaultApi->walletUpdate: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let id = id_example; // String
+    let label = label_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.walletUpdate(id, label, &context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + + + + + +
NameDescription
id* + + +
+
+
+ + String + + +
+Wallet Id. +
+
+
+ Required +
+
+
+
label* + + +
+
+
+ + String + + +
+The label the wallet will be updated to. +
+
+
+ Required +
+
+
+
+ + + + +

Responses

+

+

+ + + + + + +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

wallets

+

+
+
+
+

+

Returns all loaded wallets

+

+
+
/api/v1/wallets
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://127.0.0.1:6420/api/v1/wallets"
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array[inline_response_200_5] result = apiInstance.wallets();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#wallets");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        try {
+            array[inline_response_200_5] result = apiInstance.wallets();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#wallets");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+[apiInstance walletsWithCompletionHandler: 
+              ^(array[inline_response_200_5] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SkycoinRestApi = require('skycoin_rest_api');
+
+var api = new SkycoinRestApi.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.wallets(callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class walletsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new DefaultApi();
+
+            try
+            {
+                array[inline_response_200_5] result = apiInstance.wallets();
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.wallets: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->wallets();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->wallets: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval { 
+    my $result = $api_instance->wallets();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->wallets: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try: 
+    api_response = api_instance.wallets()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->wallets: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.wallets(&context).wait();
+    println!("{:?}", result);
+
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/libc/API.md b/docs/libc/API.md index 3bc522f08..48d993a2e 100644 --- a/docs/libc/API.md +++ b/docs/libc/API.md @@ -1,460 +1,438 @@ # Summary - Members | Descriptions ---------------------------------|--------------------------------------------- -`define `[`BUFFER_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1a6b20d41d6252e9871430c242cb1a56e7) | -`define `[`STRING_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1ad78224efe1d3fb39b67ca74ad9d9eec7) | -`define `[`JSON_FILE_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1aff447440daa595595664e192e1c01d81) | -`define `[`JSON_BIG_FILE_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1a10f4e0e5aa36596ea0886620e02feb49) | -`define `[`FILEPATH_SEPARATOR`](#cipher_8testsuite_8testsuite_8go_8h_1a6e456d1a7dded40d4dd4fd854c4e81ec) | -`define `[`TEST_DATA_DIR`](#cipher_8testsuite_8testsuite_8go_8h_1a45050bf269268f85a0a8b2d805b334fc) | -`define `[`MANY_ADDRESSES_FILENAME`](#cipher_8testsuite_8testsuite_8go_8h_1a6a45cb422542b704977e95e3b843cfba) | -`define `[`INPUT_HASHES_FILENAME`](#cipher_8testsuite_8testsuite_8go_8h_1a1bbb758f4454d01355b35a36fa3d7b61) | -`define `[`SEED_FILE_REGEX`](#cipher_8testsuite_8testsuite_8go_8h_1a7ae7c06af79cc79a9ad88e8719df1c9e) | -`define `[`json_char`](#json_8h_1ae3b21f339690a966e921fe2545939862) | -`define `[`json_int_t`](#json_8h_1ae8ad072e93f8e6584af231de2f592fc6) | -`define `[`json_enable_comments`](#json_8h_1a893db2e62d8fbf36b27bcea8654f1105) | -`define `[`json_error_max`](#json_8h_1a399c15929bed85a9a41bd4cba9703204) | -`define `[`GO_CGO_EXPORT_PROLOGUE_H`](#libskycoin_8h_1ac91211782906f9494d827fe6e0b2e190) | -`define `[`GO_CGO_PROLOGUE_H`](#libskycoin_8h_1ad45a58cf8a40d22e35017cb53dd6055a) | -`define `[`SKY_OK`](#skyerrors_8h_1a5cd9ddcf04c6f149c283c805c7d296da) | -`define `[`SKY_ERROR`](#skyerrors_8h_1a8405baf075a12e6232d75a8432d44f81) | -`enum `[`json_type`](#json_8h_1ac75c61993722a9b8aaa44704072ec06c) | -`public unsigned int `[`b64_int`](#base64_8h_1a0a6be6c96f28086f36d03676296a9372)`(unsigned int ch)` | -`public unsigned int `[`b64e_size`](#base64_8h_1ae530f943b1ac55252c7ffba9a56fe946)`(unsigned int in_size)` | -`public unsigned int `[`b64d_size`](#base64_8h_1ae6911453bae790c4ba1933674d51c4cb)`(unsigned int in_size)` | -`public unsigned int `[`b64_encode`](#base64_8h_1aeddff3b5b68b9080553c10ff2364cc4b)`(const unsigned char * in,unsigned int in_len,unsigned char * out)` | -`public unsigned int `[`b64_decode`](#base64_8h_1a181a008944edb84bcfd73efacadb41c5)`(const unsigned char * in,unsigned int in_len,unsigned char * out)` | -`public unsigned int `[`b64_encodef`](#base64_8h_1a2ea67610bb294c8d82deed5d9335d877)`(char * InFile,char * OutFile)` | -`public unsigned int `[`b64_decodef`](#base64_8h_1ac6582b011d3ebb0af9e47b5ee5d75a2c)`(char * InFile,char * OutFile)` | -`public `[`json_value`](#struct__json__value)` * `[`loadGoldenFile`](#cipher_8testsuite_8testsuite_8go_8h_1a97f400dcf2127780240374f791ad55cb)`(const char * file)` | -`public `[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * `[`jsonToInputTestData`](#cipher_8testsuite_8testsuite_8go_8h_1acc7925cd0a944333c5b0efef5926eee5)`(`[`json_value`](#struct__json__value)` * json,`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * input_data)` | -`public `[`InputTestData`](#struct_input_test_data)` * `[`registerInputTestDataCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a4940377b4eca6c3728e034a423d5964f)`(`[`InputTestData`](#struct_input_test_data)` * input_data)` | -`public `[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * `[`registerInputTestDataJSONCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a45e3d42f145d2065097b1715037973bf)`(`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * input_data)` | -`public void `[`InputTestDataToJSON`](#cipher_8testsuite_8testsuite_8go_8h_1a655f8018783ebb3ff95e7f6fcd392552)`(`[`InputTestData`](#struct_input_test_data)` * input_data,`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * json_data)` | -`public GoUint32 `[`InputTestDataFromJSON`](#cipher_8testsuite_8testsuite_8go_8h_1ab3c102e440e98e8cd90a970ce0ade222)`(`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * json_data,`[`InputTestData`](#struct_input_test_data)` * input_data)` | -`public `[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * `[`jsonToKeysTestData`](#cipher_8testsuite_8testsuite_8go_8h_1adc41ca999e05fb40c7ee8c2b6a59e1bc)`(`[`json_value`](#struct__json__value)` * json,`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * input_data)` | -`public `[`KeysTestData`](#struct_keys_test_data)` * `[`registerKeysTestDataCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a28dfd2ed9cfbf047a378e74ba026f053)`(`[`KeysTestData`](#struct_keys_test_data)` * input_data)` | -`public `[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * `[`registerKeysTestDataJSONCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a333892fc9f11cb43ce5b442d3b03f006)`(`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * input_data)` | -`public void `[`KeysTestDataToJson`](#cipher_8testsuite_8testsuite_8go_8h_1af9f0285478f247557b6334618d2aa145)`(`[`KeysTestData`](#struct_keys_test_data)` * input_data,`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * json_data)` | -`public GoUint32 `[`KeysTestDataFromJSON`](#cipher_8testsuite_8testsuite_8go_8h_1a92c62c143ec39d7186c19ab6e43dc92b)`(`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * json_data,`[`KeysTestData`](#struct_keys_test_data)` * input_data)` | -`public `[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * `[`jsonToSeedTestData`](#cipher_8testsuite_8testsuite_8go_8h_1af295a0cdc63ba27fd346852112f28b3c)`(`[`json_value`](#struct__json__value)` * json,`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * input_data)` | -`public `[`SeedTestData`](#struct_seed_test_data)` * `[`registerSeedTestDataCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a96bf06d5429ca3ec74e31e279f7f0cf0)`(`[`SeedTestData`](#struct_seed_test_data)` * input_data)` | -`public `[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * `[`registerSeedTestDataJSONCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1ae7d0af21cce697cc8bc097279c3ed398)`(`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * input_data)` | -`public void `[`SeedTestDataToJson`](#cipher_8testsuite_8testsuite_8go_8h_1abde3615ebe8efb1d0c126d4b71120bd7)`(`[`SeedTestData`](#struct_seed_test_data)` * input_data,`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * json_data)` | -`public GoUint32 `[`SeedTestDataFromJSON`](#cipher_8testsuite_8testsuite_8go_8h_1a7fb0e2dc54e3623caf580bab823255e5)`(`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * json_data,`[`SeedTestData`](#struct_seed_test_data)` * input_data)` | -`public void `[`ValidateSeedData`](#cipher_8testsuite_8testsuite_8go_8h_1a2af7891924708bd79f29b5ced351967a)`(`[`SeedTestData`](#struct_seed_test_data)` * seedData,`[`InputTestData`](#struct_input_test_data)` * inputData)` | -`public `[`json_value`](#struct__json__value)` * `[`json_parse`](#json_8h_1a4dd0cf45ec85a69a6021b6cfe0287b66)`(const json_char * json,size_t length)` | -`public `[`json_value`](#struct__json__value)` * `[`json_parse_ex`](#json_8h_1ae828aab0174a7e20eec19a40d835d3c1)`(`[`json_settings`](#structjson__settings)` * settings,const json_char * json,size_t length,char * error)` | -`public void `[`json_value_free`](#json_8h_1a3299652febea64fc59c5917ad47ede28)`(`[`json_value`](#struct__json__value)` *)` | -`public void `[`json_value_free_ex`](#json_8h_1a129467197843210b7ce2a2c59e92f781)`(`[`json_settings`](#structjson__settings)` * settings,`[`json_value`](#struct__json__value)` *)` | -`public int `[`DecodeBase58Address`](#libskycoin_8h_1af0bc416968a2873cf5952eecd12f1f92)`(`[`GoString`](#struct___go_string__)` p0,`[`Address`](#struct_address)` * p1)` | -`public int `[`cr_user_cipher__Address_eq`](#skycriterion_8h_1a00edb99a770d440315ad2c91107a314b)`(`[`cipher__Address`](#structcipher_____address)` * addr1,`[`cipher__Address`](#structcipher_____address)` * addr2)` | -`public char * `[`cr_user_cipher__Address_tostr`](#skycriterion_8h_1a7684fd986e502ffa967626174ecb121b)`(`[`cipher__Address`](#structcipher_____address)` * addr1)` | -`public int `[`cr_user_cipher__Address_noteq`](#skycriterion_8h_1aef473b3aaf9517e054136597befabb19)`(`[`cipher__Address`](#structcipher_____address)` * addr1,`[`cipher__Address`](#structcipher_____address)` * addr2)` | -`public int `[`cr_user_GoString_eq`](#skycriterion_8h_1afde184bfa3d42dadb560478bb384fd0e)`(`[`GoString`](#struct___go_string__)` * string1,`[`GoString`](#struct___go_string__)` * string2)` | -`public int `[`cr_user_GoString__eq`](#skycriterion_8h_1adc4957c85581c8021d1bc5e1fe68954e)`(`[`GoString_`](#struct_go_string__)` * string1,`[`GoString_`](#struct_go_string__)` * string2)` | -`public char * `[`cr_user_GoString_tostr`](#skycriterion_8h_1ac49e1ea1279ec23eb1b06fc4cff4346e)`(`[`GoString`](#struct___go_string__)` * string)` | -`public char * `[`cr_user_GoString__tostr`](#skycriterion_8h_1a8ba00c85c7eede2d955cfe016cb1023d)`(`[`GoString_`](#struct_go_string__)` * string)` | -`public int `[`cr_user_cipher__SecKey_eq`](#skycriterion_8h_1ac3d286c06a1659717bc392004b857ba0)`(cipher__SecKey * seckey1,cipher__SecKey * seckey2)` | -`public char * `[`cr_user_cipher__SecKey_tostr`](#skycriterion_8h_1ad6ebdf1335f21b53df8a9606e68889af)`(cipher__SecKey * seckey1)` | -`public int `[`cr_user_cipher__Ripemd160_noteq`](#skycriterion_8h_1a817a01cd72b552039a61d0add95a14f1)`(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)` | -`public int `[`cr_user_cipher__Ripemd160_eq`](#skycriterion_8h_1ac843b722e627d29c8450c766b866edd6)`(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)` | -`public char * `[`cr_user_cipher__Ripemd160_tostr`](#skycriterion_8h_1aeee5ce2262f3cfbdc942aa2ae6c16974)`(cipher__Ripemd160 * rp1)` | -`public int `[`cr_user_GoSlice_eq`](#skycriterion_8h_1a68e13a153f444839e3dbe06cc14e2348)`(`[`GoSlice`](#struct_go_slice)` * slice1,`[`GoSlice`](#struct_go_slice)` * slice2)` | -`public char * `[`cr_user_GoSlice_tostr`](#skycriterion_8h_1aa058100c8835ae72f2c609ad2ef1ba85)`(`[`GoSlice`](#struct_go_slice)` * slice1)` | -`public int `[`cr_user_GoSlice_noteq`](#skycriterion_8h_1a361dbb4ff75151c68df6d37368880b24)`(`[`GoSlice`](#struct_go_slice)` * slice1,`[`GoSlice`](#struct_go_slice)` * slice2)` | -`public int `[`cr_user_cipher__SHA256_noteq`](#skycriterion_8h_1af9de60cc1f5b338ff07b8a34a0af31d4)`(cipher__SHA256 * sh1,cipher__SHA256 * sh2)` | -`public int `[`cr_user_cipher__SHA256_eq`](#skycriterion_8h_1a239dd96034613f7c5d187f355d054843)`(cipher__SHA256 * sh1,cipher__SHA256 * sh2)` | -`public char * `[`cr_user_cipher__SHA256_tostr`](#skycriterion_8h_1a24e2acadd37b726ed2d9b07092e739d9)`(cipher__SHA256 * sh1)` | -`public void `[`randBytes`](#skystring_8h_1abc646fb4e2f83b9ec86bacd6f8006907)`(`[`GoSlice`](#struct_go_slice)` * bytes,size_t n)` | -`public void `[`strnhex`](#skystring_8h_1aef6e4f140a965b05589db78792dc3c09)`(unsigned char * buf,char * str,int n)` | -`public void `[`strhex`](#skystring_8h_1a589986670c6a1cd947da79512078ff05)`(unsigned char * buf,char * str)` | -`public void `[`fprintbuff`](#skytest_8h_1a1ee45e153c115a9a735b3ccbf992e495)`(FILE * f,void * buff,size_t n)` | -`public `[`json_value`](#struct__json__value)` * `[`loadJsonFile`](#skytest_8h_1ae9debe21347a5e30565195425a898448)`(const char * filename)` | -`public void * `[`registerMemCleanup`](#skytest_8h_1a3138ecc83c1c8906c84ef5e0d54cdfbb)`(void * p)` | -`public void `[`toGoString`](#skytest_8h_1a1bad90cc197623fa8328f71809dda1a3)`(`[`GoString_`](#struct_go_string__)` * s,`[`GoString`](#struct___go_string__)` * r)` | -`public `[`json_value`](#struct__json__value)` * `[`json_get_string`](#skytest_8h_1aaa0fcc92ec99e3682126c396c7990724)`(`[`json_value`](#struct__json__value)` * value,const char * key)` | -`public int `[`json_set_string`](#skytest_8h_1a532c9bff6c467be505835bcb9a2fcaa0)`(`[`json_value`](#struct__json__value)` * value,const char * new_string_value)` | -`public int `[`registerJsonFree`](#skytest_8h_1af298033f76a79ff6945d0a65a83842fe)`(void * p)` | -`public void `[`freeRegisteredJson`](#skytest_8h_1ae9eb5fd6a792b4db185089a1a14db57a)`(void * p)` | -`public int `[`compareJsonValues`](#skytest_8h_1abf7dd2e2fa866fc3fe6acedbf9842a3a)`(`[`json_value`](#struct__json__value)` * value1,`[`json_value`](#struct__json__value)` * value2)` | -`public `[`json_value`](#struct__json__value)` * `[`get_json_value`](#skytest_8h_1ad81ecc74786fda501485b271384b993e)`(`[`json_value`](#struct__json__value)` * node,const char * path,json_type type)` | -`public `[`json_value`](#struct__json__value)` * `[`get_json_value_not_strict`](#skytest_8h_1aabc1cef09feea6fdb43c33971366b1b5)`(`[`json_value`](#struct__json__value)` * node,const char * path,json_type type,int allow_null)` | -`public void `[`setup`](#skytest_8h_1a7dfd9b79bc5a37d7df40207afbc5431f)`(void)` | -`public void `[`teardown`](#skytest_8h_1a75dbff5b7c2c889050e2c49172679905)`(void)` | -`struct `[`_GoString_`](#struct___go_string__) | -`struct `[`_json_object_entry`](#struct__json__object__entry) | -`struct `[`_json_value`](#struct__json__value) | -`struct `[`Address`](#struct_address) | + Members | Descriptions +--------------------------------|--------------------------------------------- +`struct `[`_json_object_entry`](#struct__json__object__entry) | +`struct `[`_json_value`](#struct__json__value) | +`struct `[`api__NetworkConnectionsFilter`](#structapi_____network_connections_filter) | +`struct `[`api__RichlistParams`](#structapi_____richlist_params) | `struct `[`cipher__Address`](#structcipher_____address) | Addresses of SKY accounts `struct `[`cipher__BitcoinAddress`](#structcipher_____bitcoin_address) | Addresses of Bitcoin accounts +`struct `[`cipher_Addresses`](#structcipher___addresses) | +`struct `[`cipher_Checksum`](#structcipher___checksum) | +`struct `[`cipher_PubKey`](#structcipher___pub_key) | +`struct `[`cipher_PubKeys`](#structcipher___pub_keys) | +`struct `[`cipher_Ripemd160`](#structcipher___ripemd160) | +`struct `[`cipher_SecKey`](#structcipher___sec_key) | +`struct `[`cipher_SecKeys`](#structcipher___sec_keys) | +`struct `[`cipher_SHA256`](#structcipher___s_h_a256) | +`struct `[`cipher_SHA256s`](#structcipher___s_h_a256s) | +`struct `[`cipher_Sig`](#structcipher___sig) | `struct `[`cli__SendAmount`](#structcli_____send_amount) | Structure used to specify amounts transferred in a transaction. +`struct `[`coin__Block`](#structcoin_____block) | +`struct `[`coin__BlockBody`](#structcoin_____block_body) | +`struct `[`coin__BlockHeader`](#structcoin_____block_header) | +`struct `[`coin__SignedBlock`](#structcoin_____signed_block) | `struct `[`coin__Transaction`](#structcoin_____transaction) | Skycoin transaction. `struct `[`coin__TransactionOutput`](#structcoin_____transaction_output) | Skycoin transaction output. -`struct `[`coin__UxBody`](#structcoin_____ux_body) | -`struct `[`coin__UxHead`](#structcoin_____ux_head) | -`struct `[`coin__UxOut`](#structcoin_____ux_out) | -`struct `[`GoInterface`](#struct_go_interface) | +`struct `[`coin__UxBody`](#structcoin_____ux_body) | +`struct `[`coin__UxHead`](#structcoin_____ux_head) | +`struct `[`coin__UxOut`](#structcoin_____ux_out) | +`struct `[`coin_UxOutArray`](#structcoin___ux_out_array) | +`struct `[`cr_mem`](#structcr__mem) | +`struct `[`encrypt__ScryptChacha20poly1305`](#structencrypt_____scrypt_chacha20poly1305) | +`struct `[`Fee_Calculator`](#struct_fee___calculator) | +`struct `[`FeeCalculator`](#struct_fee_calculator) | +`struct `[`GoComplex128_`](#struct_go_complex128__) | Instances of Go `complex` type. +`struct `[`GoComplex64_`](#struct_go_complex64__) | Instances of Go `complex` type. `struct `[`GoInterface_`](#struct_go_interface__) | Instances of Go interface types. -`struct `[`GoSlice`](#struct_go_slice) | `struct `[`GoSlice_`](#struct_go_slice__) | Instances of Go slices `struct `[`GoString_`](#struct_go_string__) | Instances of Go `string` type. -`struct `[`InputTestData`](#struct_input_test_data) | -`struct `[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n) | -`struct `[`json_settings`](#structjson__settings) | -`struct `[`KeysTestData`](#struct_keys_test_data) | -`struct `[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n) | -`struct `[`SeedTestData`](#struct_seed_test_data) | -`struct `[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n) | -`struct `[`wallet__Entry`](#structwallet_____entry) | Wallet entry. +`struct `[`httphelper__Address`](#structhttphelper_____address) | +`struct `[`httphelper__SHA256`](#structhttphelper_____s_h_a256) | +`struct `[`InputTestData`](#struct_input_test_data) | +`struct `[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n) | +`struct `[`json_settings`](#structjson__settings) | +`struct `[`KeysTestData`](#struct_keys_test_data) | +`struct `[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n) | +`struct `[`Number`](#struct_number) | +`struct `[`secp256k1go__Field`](#structsecp256k1go_____field) | +`struct `[`secp256k1go__XY`](#structsecp256k1go_____x_y) | +`struct `[`secp256k1go__XYZ`](#structsecp256k1go_____x_y_z) | +`struct `[`SeedTestData`](#struct_seed_test_data) | +`struct `[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n) | +`struct `[`Signature`](#struct_signature) | +`struct `[`Wallet`](#struct_wallet) | Internal representation of a Skycoin wallet. +`struct `[`wallet__Balance`](#structwallet_____balance) | +`struct `[`wallet__BalancePair`](#structwallet_____balance_pair) | +`struct `[`wallet__Entry`](#structwallet_____entry) | [Wallet](#struct_wallet) entry. +`struct `[`wallet__Note`](#structwallet_____note) | +`struct `[`wallet__ReadableNote`](#structwallet_____readable_note) | `struct `[`wallet__UxBalance`](#structwallet_____ux_balance) | Intermediate representation of a UxOut for sorting and spend choosing. -`struct `[`wallet__Wallet`](#structwallet_____wallet) | Internal representation of a Skycoin wallet. -## Members +# struct `_json_object_entry` + +## Summary -#### `define `[`BUFFER_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1a6b20d41d6252e9871430c242cb1a56e7) + Members | Descriptions +--------------------------------|--------------------------------------------- +`public json_char * `[`name`](#struct__json__object__entry_1a3c3e575cdb04c92d1bd8e2ffbfd871cc) | +`public unsigned int `[`name_length`](#struct__json__object__entry_1a3f3f10ffae1e364e84a38517a174b01e) | +`public struct `[`_json_value`](#struct__json__value)` * `[`value`](#struct__json__object__entry_1ae4f19c247094dd7870bfbf798d79ac99) | -#### `define `[`STRING_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1ad78224efe1d3fb39b67ca74ad9d9eec7) +## Members -#### `define `[`JSON_FILE_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1aff447440daa595595664e192e1c01d81) +#### `public json_char * `[`name`](#struct__json__object__entry_1a3c3e575cdb04c92d1bd8e2ffbfd871cc) -#### `define `[`JSON_BIG_FILE_SIZE`](#cipher_8testsuite_8testsuite_8go_8h_1a10f4e0e5aa36596ea0886620e02feb49) +#### `public unsigned int `[`name_length`](#struct__json__object__entry_1a3f3f10ffae1e364e84a38517a174b01e) -#### `define `[`FILEPATH_SEPARATOR`](#cipher_8testsuite_8testsuite_8go_8h_1a6e456d1a7dded40d4dd4fd854c4e81ec) +#### `public struct `[`_json_value`](#struct__json__value)` * `[`value`](#struct__json__object__entry_1ae4f19c247094dd7870bfbf798d79ac99) -#### `define `[`TEST_DATA_DIR`](#cipher_8testsuite_8testsuite_8go_8h_1a45050bf269268f85a0a8b2d805b334fc) +# struct `_json_value` -#### `define `[`MANY_ADDRESSES_FILENAME`](#cipher_8testsuite_8testsuite_8go_8h_1a6a45cb422542b704977e95e3b843cfba) +## Summary -#### `define `[`INPUT_HASHES_FILENAME`](#cipher_8testsuite_8testsuite_8go_8h_1a1bbb758f4454d01355b35a36fa3d7b61) + Members | Descriptions +--------------------------------|--------------------------------------------- +`public struct `[`_json_value`](#struct__json__value)` * `[`parent`](#struct__json__value_1aa86e0e17a210b00b008a001e866050cd) | +`public json_type `[`type`](#struct__json__value_1a5b632686c28261d4d52390dfc8dc0dcd) | +`public int `[`boolean`](#struct__json__value_1afc58e0c0df35925913174accbf1114cb) | +`public json_int_t `[`integer`](#struct__json__value_1a45f8bcb9c0a1417f182d41049a2107e5) | +`public double `[`dbl`](#struct__json__value_1a57291299e530453fdec37a931c728239) | +`public unsigned int `[`length`](#struct__json__value_1ac8d42bcd4a44e078047ccd7291059238) | +`public json_char * `[`ptr`](#struct__json__value_1af340cb5b3b56fa2cc2b043529017fd3a) | +`public struct _json_value::@0::@2 `[`string`](#struct__json__value_1adbf96c673bfce83dd224c60f5a1eedc4) | +`public `[`json_object_entry`](#struct__json__object__entry)` * `[`values`](#struct__json__value_1a35eecbf6405a59adaf2c2001b9b224b0) | +`public struct _json_value::@0::@3 `[`object`](#struct__json__value_1a67174883be078cb852d4748b78aa60ce) | +`public struct `[`_json_value`](#struct__json__value)` ** `[`values`](#struct__json__value_1a6244a16657c988883bbb1fa7f1f0ba55) | +`public struct _json_value::@0::@4 `[`array`](#struct__json__value_1ac837a4233a38fcd3c3d51da2c3a56f0c) | +`public union _json_value::@0 `[`u`](#struct__json__value_1a2e5a72cccd43ae6e6b1dc476fc327d17) | +`public struct `[`_json_value`](#struct__json__value)` * `[`next_alloc`](#struct__json__value_1a6b6c655ef17b09a6ea18d94612a27304) | +`public void * `[`object_mem`](#struct__json__value_1aa166262c3b34bfb69a85f6e625970226) | +`public union _json_value::@1 `[`_reserved`](#struct__json__value_1ac7cdbd31aad7b4a672e38721c1122f35) | -#### `define `[`SEED_FILE_REGEX`](#cipher_8testsuite_8testsuite_8go_8h_1a7ae7c06af79cc79a9ad88e8719df1c9e) +## Members -#### `define `[`json_char`](#json_8h_1ae3b21f339690a966e921fe2545939862) +#### `public struct `[`_json_value`](#struct__json__value)` * `[`parent`](#struct__json__value_1aa86e0e17a210b00b008a001e866050cd) -#### `define `[`json_int_t`](#json_8h_1ae8ad072e93f8e6584af231de2f592fc6) +#### `public json_type `[`type`](#struct__json__value_1a5b632686c28261d4d52390dfc8dc0dcd) -#### `define `[`json_enable_comments`](#json_8h_1a893db2e62d8fbf36b27bcea8654f1105) +#### `public int `[`boolean`](#struct__json__value_1afc58e0c0df35925913174accbf1114cb) -#### `define `[`json_error_max`](#json_8h_1a399c15929bed85a9a41bd4cba9703204) +#### `public json_int_t `[`integer`](#struct__json__value_1a45f8bcb9c0a1417f182d41049a2107e5) -#### `define `[`GO_CGO_EXPORT_PROLOGUE_H`](#libskycoin_8h_1ac91211782906f9494d827fe6e0b2e190) +#### `public double `[`dbl`](#struct__json__value_1a57291299e530453fdec37a931c728239) -#### `define `[`GO_CGO_PROLOGUE_H`](#libskycoin_8h_1ad45a58cf8a40d22e35017cb53dd6055a) +#### `public unsigned int `[`length`](#struct__json__value_1ac8d42bcd4a44e078047ccd7291059238) -#### `define `[`SKY_OK`](#skyerrors_8h_1a5cd9ddcf04c6f149c283c805c7d296da) +#### `public json_char * `[`ptr`](#struct__json__value_1af340cb5b3b56fa2cc2b043529017fd3a) -#### `define `[`SKY_ERROR`](#skyerrors_8h_1a8405baf075a12e6232d75a8432d44f81) +#### `public struct _json_value::@0::@2 `[`string`](#struct__json__value_1adbf96c673bfce83dd224c60f5a1eedc4) -#### `enum `[`json_type`](#json_8h_1ac75c61993722a9b8aaa44704072ec06c) +#### `public `[`json_object_entry`](#struct__json__object__entry)` * `[`values`](#struct__json__value_1a35eecbf6405a59adaf2c2001b9b224b0) - Values | Descriptions ---------------------------------|--------------------------------------------- -json_none | -json_object | -json_array | -json_integer | -json_double | -json_string | -json_boolean | -json_null | +#### `public struct _json_value::@0::@3 `[`object`](#struct__json__value_1a67174883be078cb852d4748b78aa60ce) -#### `public unsigned int `[`b64_int`](#base64_8h_1a0a6be6c96f28086f36d03676296a9372)`(unsigned int ch)` +#### `public struct `[`_json_value`](#struct__json__value)` ** `[`values`](#struct__json__value_1a6244a16657c988883bbb1fa7f1f0ba55) -#### `public unsigned int `[`b64e_size`](#base64_8h_1ae530f943b1ac55252c7ffba9a56fe946)`(unsigned int in_size)` +#### `public struct _json_value::@0::@4 `[`array`](#struct__json__value_1ac837a4233a38fcd3c3d51da2c3a56f0c) -#### `public unsigned int `[`b64d_size`](#base64_8h_1ae6911453bae790c4ba1933674d51c4cb)`(unsigned int in_size)` +#### `public union _json_value::@0 `[`u`](#struct__json__value_1a2e5a72cccd43ae6e6b1dc476fc327d17) -#### `public unsigned int `[`b64_encode`](#base64_8h_1aeddff3b5b68b9080553c10ff2364cc4b)`(const unsigned char * in,unsigned int in_len,unsigned char * out)` +#### `public struct `[`_json_value`](#struct__json__value)` * `[`next_alloc`](#struct__json__value_1a6b6c655ef17b09a6ea18d94612a27304) -#### `public unsigned int `[`b64_decode`](#base64_8h_1a181a008944edb84bcfd73efacadb41c5)`(const unsigned char * in,unsigned int in_len,unsigned char * out)` +#### `public void * `[`object_mem`](#struct__json__value_1aa166262c3b34bfb69a85f6e625970226) -#### `public unsigned int `[`b64_encodef`](#base64_8h_1a2ea67610bb294c8d82deed5d9335d877)`(char * InFile,char * OutFile)` +#### `public union _json_value::@1 `[`_reserved`](#struct__json__value_1ac7cdbd31aad7b4a672e38721c1122f35) -#### `public unsigned int `[`b64_decodef`](#base64_8h_1ac6582b011d3ebb0af9e47b5ee5d75a2c)`(char * InFile,char * OutFile)` +# struct `api__NetworkConnectionsFilter` -#### `public `[`json_value`](#struct__json__value)` * `[`loadGoldenFile`](#cipher_8testsuite_8testsuite_8go_8h_1a97f400dcf2127780240374f791ad55cb)`(const char * file)` +## Summary -#### `public `[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * `[`jsonToInputTestData`](#cipher_8testsuite_8testsuite_8go_8h_1acc7925cd0a944333c5b0efef5926eee5)`(`[`json_value`](#struct__json__value)` * json,`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * input_data)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`GoString_`](#struct_go_string__)` `[`States`](#structapi_____network_connections_filter_1aadc5a43c4721265d5e7c507e5bbef628) | +`public `[`GoString_`](#struct_go_string__)` `[`Direction`](#structapi_____network_connections_filter_1aa7b6314710356d969facc923f8b1962e) | -#### `public `[`InputTestData`](#struct_input_test_data)` * `[`registerInputTestDataCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a4940377b4eca6c3728e034a423d5964f)`(`[`InputTestData`](#struct_input_test_data)` * input_data)` +## Members -#### `public `[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * `[`registerInputTestDataJSONCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a45e3d42f145d2065097b1715037973bf)`(`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * input_data)` +#### `public `[`GoString_`](#struct_go_string__)` `[`States`](#structapi_____network_connections_filter_1aadc5a43c4721265d5e7c507e5bbef628) -#### `public void `[`InputTestDataToJSON`](#cipher_8testsuite_8testsuite_8go_8h_1a655f8018783ebb3ff95e7f6fcd392552)`(`[`InputTestData`](#struct_input_test_data)` * input_data,`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * json_data)` +#### `public `[`GoString_`](#struct_go_string__)` `[`Direction`](#structapi_____network_connections_filter_1aa7b6314710356d969facc923f8b1962e) -#### `public GoUint32 `[`InputTestDataFromJSON`](#cipher_8testsuite_8testsuite_8go_8h_1ab3c102e440e98e8cd90a970ce0ade222)`(`[`InputTestDataJSON`](#struct_input_test_data_j_s_o_n)` * json_data,`[`InputTestData`](#struct_input_test_data)` * input_data)` +# struct `api__RichlistParams` -#### `public `[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * `[`jsonToKeysTestData`](#cipher_8testsuite_8testsuite_8go_8h_1adc41ca999e05fb40c7ee8c2b6a59e1bc)`(`[`json_value`](#struct__json__value)` * json,`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * input_data)` +## Summary -#### `public `[`KeysTestData`](#struct_keys_test_data)` * `[`registerKeysTestDataCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a28dfd2ed9cfbf047a378e74ba026f053)`(`[`KeysTestData`](#struct_keys_test_data)` * input_data)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoInt_ `[`N`](#structapi_____richlist_params_1a9341d3d326cce1ab3e82bf4223d61631) | +`public BOOL `[`IncludeDistribution`](#structapi_____richlist_params_1a77a606b3480624b44e5cf95ad5fe5fe5) | -#### `public `[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * `[`registerKeysTestDataJSONCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a333892fc9f11cb43ce5b442d3b03f006)`(`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * input_data)` +## Members -#### `public void `[`KeysTestDataToJson`](#cipher_8testsuite_8testsuite_8go_8h_1af9f0285478f247557b6334618d2aa145)`(`[`KeysTestData`](#struct_keys_test_data)` * input_data,`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * json_data)` +#### `public GoInt_ `[`N`](#structapi_____richlist_params_1a9341d3d326cce1ab3e82bf4223d61631) -#### `public GoUint32 `[`KeysTestDataFromJSON`](#cipher_8testsuite_8testsuite_8go_8h_1a92c62c143ec39d7186c19ab6e43dc92b)`(`[`KeysTestDataJSON`](#struct_keys_test_data_j_s_o_n)` * json_data,`[`KeysTestData`](#struct_keys_test_data)` * input_data)` +#### `public BOOL `[`IncludeDistribution`](#structapi_____richlist_params_1a77a606b3480624b44e5cf95ad5fe5fe5) -#### `public `[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * `[`jsonToSeedTestData`](#cipher_8testsuite_8testsuite_8go_8h_1af295a0cdc63ba27fd346852112f28b3c)`(`[`json_value`](#struct__json__value)` * json,`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * input_data)` +# struct `cipher__Address` -#### `public `[`SeedTestData`](#struct_seed_test_data)` * `[`registerSeedTestDataCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1a96bf06d5429ca3ec74e31e279f7f0cf0)`(`[`SeedTestData`](#struct_seed_test_data)` * input_data)` +Addresses of SKY accounts -#### `public `[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * `[`registerSeedTestDataJSONCleanup`](#cipher_8testsuite_8testsuite_8go_8h_1ae7d0af21cce697cc8bc097279c3ed398)`(`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * input_data)` +## Summary -#### `public void `[`SeedTestDataToJson`](#cipher_8testsuite_8testsuite_8go_8h_1abde3615ebe8efb1d0c126d4b71120bd7)`(`[`SeedTestData`](#struct_seed_test_data)` * input_data,`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * json_data)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint8_ `[`Version`](#structcipher_____address_1a606dc32a5b849202a1bd5ab70ec7c3f0) | Address version identifier. Used to differentiate testnet vs mainnet addresses, for ins +`public cipher__Ripemd160 `[`Key`](#structcipher_____address_1a16586cd3bfc67010c3c185d0da01317c) | Address hash identifier. -#### `public GoUint32 `[`SeedTestDataFromJSON`](#cipher_8testsuite_8testsuite_8go_8h_1a7fb0e2dc54e3623caf580bab823255e5)`(`[`SeedTestDataJSON`](#struct_seed_test_data_j_s_o_n)` * json_data,`[`SeedTestData`](#struct_seed_test_data)` * input_data)` +## Members -#### `public void `[`ValidateSeedData`](#cipher_8testsuite_8testsuite_8go_8h_1a2af7891924708bd79f29b5ced351967a)`(`[`SeedTestData`](#struct_seed_test_data)` * seedData,`[`InputTestData`](#struct_input_test_data)` * inputData)` +#### `public GoUint8_ `[`Version`](#structcipher_____address_1a606dc32a5b849202a1bd5ab70ec7c3f0) -#### `public `[`json_value`](#struct__json__value)` * `[`json_parse`](#json_8h_1a4dd0cf45ec85a69a6021b6cfe0287b66)`(const json_char * json,size_t length)` +Address version identifier. Used to differentiate testnet vs mainnet addresses, for ins -#### `public `[`json_value`](#struct__json__value)` * `[`json_parse_ex`](#json_8h_1ae828aab0174a7e20eec19a40d835d3c1)`(`[`json_settings`](#structjson__settings)` * settings,const json_char * json,size_t length,char * error)` +#### `public cipher__Ripemd160 `[`Key`](#structcipher_____address_1a16586cd3bfc67010c3c185d0da01317c) -#### `public void `[`json_value_free`](#json_8h_1a3299652febea64fc59c5917ad47ede28)`(`[`json_value`](#struct__json__value)` *)` +Address hash identifier. -#### `public void `[`json_value_free_ex`](#json_8h_1a129467197843210b7ce2a2c59e92f781)`(`[`json_settings`](#structjson__settings)` * settings,`[`json_value`](#struct__json__value)` *)` +# struct `cipher__BitcoinAddress` -#### `public int `[`DecodeBase58Address`](#libskycoin_8h_1af0bc416968a2873cf5952eecd12f1f92)`(`[`GoString`](#struct___go_string__)` p0,`[`Address`](#struct_address)` * p1)` +Addresses of Bitcoin accounts -#### `public int `[`cr_user_cipher__Address_eq`](#skycriterion_8h_1a00edb99a770d440315ad2c91107a314b)`(`[`cipher__Address`](#structcipher_____address)` * addr1,`[`cipher__Address`](#structcipher_____address)` * addr2)` +## Summary -#### `public char * `[`cr_user_cipher__Address_tostr`](#skycriterion_8h_1a7684fd986e502ffa967626174ecb121b)`(`[`cipher__Address`](#structcipher_____address)` * addr1)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint8_ `[`Version`](#structcipher_____bitcoin_address_1a606dc32a5b849202a1bd5ab70ec7c3f0) | Address version identifier. Used to differentiate testnet vs mainnet addresses, for instance. +`public cipher__Ripemd160 `[`Key`](#structcipher_____bitcoin_address_1a16586cd3bfc67010c3c185d0da01317c) | Address hash identifier. -#### `public int `[`cr_user_cipher__Address_noteq`](#skycriterion_8h_1aef473b3aaf9517e054136597befabb19)`(`[`cipher__Address`](#structcipher_____address)` * addr1,`[`cipher__Address`](#structcipher_____address)` * addr2)` +## Members -#### `public int `[`cr_user_GoString_eq`](#skycriterion_8h_1afde184bfa3d42dadb560478bb384fd0e)`(`[`GoString`](#struct___go_string__)` * string1,`[`GoString`](#struct___go_string__)` * string2)` +#### `public GoUint8_ `[`Version`](#structcipher_____bitcoin_address_1a606dc32a5b849202a1bd5ab70ec7c3f0) -#### `public int `[`cr_user_GoString__eq`](#skycriterion_8h_1adc4957c85581c8021d1bc5e1fe68954e)`(`[`GoString_`](#struct_go_string__)` * string1,`[`GoString_`](#struct_go_string__)` * string2)` +Address version identifier. Used to differentiate testnet vs mainnet addresses, for instance. -#### `public char * `[`cr_user_GoString_tostr`](#skycriterion_8h_1ac49e1ea1279ec23eb1b06fc4cff4346e)`(`[`GoString`](#struct___go_string__)` * string)` +#### `public cipher__Ripemd160 `[`Key`](#structcipher_____bitcoin_address_1a16586cd3bfc67010c3c185d0da01317c) -#### `public char * `[`cr_user_GoString__tostr`](#skycriterion_8h_1a8ba00c85c7eede2d955cfe016cb1023d)`(`[`GoString_`](#struct_go_string__)` * string)` +Address hash identifier. -#### `public int `[`cr_user_cipher__SecKey_eq`](#skycriterion_8h_1ac3d286c06a1659717bc392004b857ba0)`(cipher__SecKey * seckey1,cipher__SecKey * seckey2)` +# struct `cipher_Addresses` -#### `public char * `[`cr_user_cipher__SecKey_tostr`](#skycriterion_8h_1ad6ebdf1335f21b53df8a9606e68889af)`(cipher__SecKey * seckey1)` +## Summary -#### `public int `[`cr_user_cipher__Ripemd160_noteq`](#skycriterion_8h_1a817a01cd72b552039a61d0add95a14f1)`(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`cipher__Address`](#structcipher_____address)` * `[`data`](#structcipher___addresses_1a64c43e3b2bdb0384e70ff35c301f6d48) | +`public int `[`count`](#structcipher___addresses_1ad43c3812e6d13e0518d9f8b8f463ffcf) | -#### `public int `[`cr_user_cipher__Ripemd160_eq`](#skycriterion_8h_1ac843b722e627d29c8450c766b866edd6)`(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)` +## Members -#### `public char * `[`cr_user_cipher__Ripemd160_tostr`](#skycriterion_8h_1aeee5ce2262f3cfbdc942aa2ae6c16974)`(cipher__Ripemd160 * rp1)` +#### `public `[`cipher__Address`](#structcipher_____address)` * `[`data`](#structcipher___addresses_1a64c43e3b2bdb0384e70ff35c301f6d48) -#### `public int `[`cr_user_GoSlice_eq`](#skycriterion_8h_1a68e13a153f444839e3dbe06cc14e2348)`(`[`GoSlice`](#struct_go_slice)` * slice1,`[`GoSlice`](#struct_go_slice)` * slice2)` +#### `public int `[`count`](#structcipher___addresses_1ad43c3812e6d13e0518d9f8b8f463ffcf) -#### `public char * `[`cr_user_GoSlice_tostr`](#skycriterion_8h_1aa058100c8835ae72f2c609ad2ef1ba85)`(`[`GoSlice`](#struct_go_slice)` * slice1)` +# struct `cipher_Checksum` -#### `public int `[`cr_user_GoSlice_noteq`](#skycriterion_8h_1a361dbb4ff75151c68df6d37368880b24)`(`[`GoSlice`](#struct_go_slice)` * slice1,`[`GoSlice`](#struct_go_slice)` * slice2)` +## Summary -#### `public int `[`cr_user_cipher__SHA256_noteq`](#skycriterion_8h_1af9de60cc1f5b338ff07b8a34a0af31d4)`(cipher__SHA256 * sh1,cipher__SHA256 * sh2)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint8 `[`data`](#structcipher___checksum_1af2b5494d85bbe57bdc0e0284c687dbe7) | -#### `public int `[`cr_user_cipher__SHA256_eq`](#skycriterion_8h_1a239dd96034613f7c5d187f355d054843)`(cipher__SHA256 * sh1,cipher__SHA256 * sh2)` +## Members -#### `public char * `[`cr_user_cipher__SHA256_tostr`](#skycriterion_8h_1a24e2acadd37b726ed2d9b07092e739d9)`(cipher__SHA256 * sh1)` +#### `public GoUint8 `[`data`](#structcipher___checksum_1af2b5494d85bbe57bdc0e0284c687dbe7) -#### `public void `[`randBytes`](#skystring_8h_1abc646fb4e2f83b9ec86bacd6f8006907)`(`[`GoSlice`](#struct_go_slice)` * bytes,size_t n)` +# struct `cipher_PubKey` -#### `public void `[`strnhex`](#skystring_8h_1aef6e4f140a965b05589db78792dc3c09)`(unsigned char * buf,char * str,int n)` +## Summary -#### `public void `[`strhex`](#skystring_8h_1a589986670c6a1cd947da79512078ff05)`(unsigned char * buf,char * str)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint8 `[`data`](#structcipher___pub_key_1a3d3ea6251fa06829c27e1305d1273f83) | -#### `public void `[`fprintbuff`](#skytest_8h_1a1ee45e153c115a9a735b3ccbf992e495)`(FILE * f,void * buff,size_t n)` +## Members -#### `public `[`json_value`](#struct__json__value)` * `[`loadJsonFile`](#skytest_8h_1ae9debe21347a5e30565195425a898448)`(const char * filename)` +#### `public GoUint8 `[`data`](#structcipher___pub_key_1a3d3ea6251fa06829c27e1305d1273f83) -#### `public void * `[`registerMemCleanup`](#skytest_8h_1a3138ecc83c1c8906c84ef5e0d54cdfbb)`(void * p)` +# struct `cipher_PubKeys` -#### `public void `[`toGoString`](#skytest_8h_1a1bad90cc197623fa8328f71809dda1a3)`(`[`GoString_`](#struct_go_string__)` * s,`[`GoString`](#struct___go_string__)` * r)` +## Summary -#### `public `[`json_value`](#struct__json__value)` * `[`json_get_string`](#skytest_8h_1aaa0fcc92ec99e3682126c396c7990724)`(`[`json_value`](#struct__json__value)` * value,const char * key)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`cipher_PubKey`](#structcipher___pub_key)` * `[`data`](#structcipher___pub_keys_1ad1e8d7c9e96a254032b925957a69c5fc) | +`public int `[`count`](#structcipher___pub_keys_1ad43c3812e6d13e0518d9f8b8f463ffcf) | -#### `public int `[`json_set_string`](#skytest_8h_1a532c9bff6c467be505835bcb9a2fcaa0)`(`[`json_value`](#struct__json__value)` * value,const char * new_string_value)` +## Members -#### `public int `[`registerJsonFree`](#skytest_8h_1af298033f76a79ff6945d0a65a83842fe)`(void * p)` +#### `public `[`cipher_PubKey`](#structcipher___pub_key)` * `[`data`](#structcipher___pub_keys_1ad1e8d7c9e96a254032b925957a69c5fc) -#### `public void `[`freeRegisteredJson`](#skytest_8h_1ae9eb5fd6a792b4db185089a1a14db57a)`(void * p)` +#### `public int `[`count`](#structcipher___pub_keys_1ad43c3812e6d13e0518d9f8b8f463ffcf) -#### `public int `[`compareJsonValues`](#skytest_8h_1abf7dd2e2fa866fc3fe6acedbf9842a3a)`(`[`json_value`](#struct__json__value)` * value1,`[`json_value`](#struct__json__value)` * value2)` +# struct `cipher_Ripemd160` -#### `public `[`json_value`](#struct__json__value)` * `[`get_json_value`](#skytest_8h_1ad81ecc74786fda501485b271384b993e)`(`[`json_value`](#struct__json__value)` * node,const char * path,json_type type)` +## Summary -#### `public `[`json_value`](#struct__json__value)` * `[`get_json_value_not_strict`](#skytest_8h_1aabc1cef09feea6fdb43c33971366b1b5)`(`[`json_value`](#struct__json__value)` * node,const char * path,json_type type,int allow_null)` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint8 `[`data`](#structcipher___ripemd160_1ad270f78d3abe5fdbc9c63b9f2b66063e) | -#### `public void `[`setup`](#skytest_8h_1a7dfd9b79bc5a37d7df40207afbc5431f)`(void)` +## Members -#### `public void `[`teardown`](#skytest_8h_1a75dbff5b7c2c889050e2c49172679905)`(void)` +#### `public GoUint8 `[`data`](#structcipher___ripemd160_1ad270f78d3abe5fdbc9c63b9f2b66063e) -# struct `_GoString_` +# struct `cipher_SecKey` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public const char * `[`p`](#struct___go_string___1a6bc6b007533335efe02bafff799ec64c) | -`public ptrdiff_t `[`n`](#struct___go_string___1a52d899ae12c13f4df8ff5ee014f3a106) | +`public GoUint8 `[`data`](#structcipher___sec_key_1a0a1a4b21103f9c48a4ba08e82d8f0976) | ## Members -#### `public const char * `[`p`](#struct___go_string___1a6bc6b007533335efe02bafff799ec64c) - -#### `public ptrdiff_t `[`n`](#struct___go_string___1a52d899ae12c13f4df8ff5ee014f3a106) +#### `public GoUint8 `[`data`](#structcipher___sec_key_1a0a1a4b21103f9c48a4ba08e82d8f0976) -# struct `_json_object_entry` +# struct `cipher_SecKeys` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public json_char * `[`name`](#struct__json__object__entry_1a3c3e575cdb04c92d1bd8e2ffbfd871cc) | -`public unsigned int `[`name_length`](#struct__json__object__entry_1a3f3f10ffae1e364e84a38517a174b01e) | -`public struct `[`_json_value`](#struct__json__value)` * `[`value`](#struct__json__object__entry_1ae4f19c247094dd7870bfbf798d79ac99) | +`public `[`cipher_SecKey`](#structcipher___sec_key)` * `[`data`](#structcipher___sec_keys_1a6cc7dc96b18d848347e7d0a7f8c1604c) | +`public int `[`count`](#structcipher___sec_keys_1ad43c3812e6d13e0518d9f8b8f463ffcf) | ## Members -#### `public json_char * `[`name`](#struct__json__object__entry_1a3c3e575cdb04c92d1bd8e2ffbfd871cc) +#### `public `[`cipher_SecKey`](#structcipher___sec_key)` * `[`data`](#structcipher___sec_keys_1a6cc7dc96b18d848347e7d0a7f8c1604c) -#### `public unsigned int `[`name_length`](#struct__json__object__entry_1a3f3f10ffae1e364e84a38517a174b01e) +#### `public int `[`count`](#structcipher___sec_keys_1ad43c3812e6d13e0518d9f8b8f463ffcf) -#### `public struct `[`_json_value`](#struct__json__value)` * `[`value`](#struct__json__object__entry_1ae4f19c247094dd7870bfbf798d79ac99) - -# struct `_json_value` +# struct `cipher_SHA256` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public struct `[`_json_value`](#struct__json__value)` * `[`parent`](#struct__json__value_1aa86e0e17a210b00b008a001e866050cd) | -`public json_type `[`type`](#struct__json__value_1a5b632686c28261d4d52390dfc8dc0dcd) | -`public int `[`boolean`](#struct__json__value_1afc58e0c0df35925913174accbf1114cb) | -`public json_int_t `[`integer`](#struct__json__value_1a45f8bcb9c0a1417f182d41049a2107e5) | -`public double `[`dbl`](#struct__json__value_1a57291299e530453fdec37a931c728239) | -`public unsigned int `[`length`](#struct__json__value_1ac8d42bcd4a44e078047ccd7291059238) | -`public json_char * `[`ptr`](#struct__json__value_1af340cb5b3b56fa2cc2b043529017fd3a) | -`public struct _json_value::@0::@2 `[`string`](#struct__json__value_1adbf96c673bfce83dd224c60f5a1eedc4) | -`public `[`json_object_entry`](#struct__json__object__entry)` * `[`values`](#struct__json__value_1a35eecbf6405a59adaf2c2001b9b224b0) | -`public struct _json_value::@0::@3 `[`object`](#struct__json__value_1a67174883be078cb852d4748b78aa60ce) | -`public struct `[`_json_value`](#struct__json__value)` ** `[`values`](#struct__json__value_1a6244a16657c988883bbb1fa7f1f0ba55) | -`public struct _json_value::@0::@4 `[`array`](#struct__json__value_1ac837a4233a38fcd3c3d51da2c3a56f0c) | -`public union _json_value::@0 `[`u`](#struct__json__value_1a2e5a72cccd43ae6e6b1dc476fc327d17) | -`public struct `[`_json_value`](#struct__json__value)` * `[`next_alloc`](#struct__json__value_1a6b6c655ef17b09a6ea18d94612a27304) | -`public void * `[`object_mem`](#struct__json__value_1aa166262c3b34bfb69a85f6e625970226) | -`public union _json_value::@1 `[`_reserved`](#struct__json__value_1ac7cdbd31aad7b4a672e38721c1122f35) | +`public GoUint8 `[`data`](#structcipher___s_h_a256_1a0a1a4b21103f9c48a4ba08e82d8f0976) | ## Members -#### `public struct `[`_json_value`](#struct__json__value)` * `[`parent`](#struct__json__value_1aa86e0e17a210b00b008a001e866050cd) - -#### `public json_type `[`type`](#struct__json__value_1a5b632686c28261d4d52390dfc8dc0dcd) - -#### `public int `[`boolean`](#struct__json__value_1afc58e0c0df35925913174accbf1114cb) - -#### `public json_int_t `[`integer`](#struct__json__value_1a45f8bcb9c0a1417f182d41049a2107e5) +#### `public GoUint8 `[`data`](#structcipher___s_h_a256_1a0a1a4b21103f9c48a4ba08e82d8f0976) -#### `public double `[`dbl`](#struct__json__value_1a57291299e530453fdec37a931c728239) +# struct `cipher_SHA256s` -#### `public unsigned int `[`length`](#struct__json__value_1ac8d42bcd4a44e078047ccd7291059238) +## Summary -#### `public json_char * `[`ptr`](#struct__json__value_1af340cb5b3b56fa2cc2b043529017fd3a) + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`cipher_SHA256`](#structcipher___s_h_a256)` * `[`data`](#structcipher___s_h_a256s_1a731288d0297a94e8b6817872c8a36536) | +`public int `[`count`](#structcipher___s_h_a256s_1ad43c3812e6d13e0518d9f8b8f463ffcf) | -#### `public struct _json_value::@0::@2 `[`string`](#struct__json__value_1adbf96c673bfce83dd224c60f5a1eedc4) +## Members -#### `public `[`json_object_entry`](#struct__json__object__entry)` * `[`values`](#struct__json__value_1a35eecbf6405a59adaf2c2001b9b224b0) +#### `public `[`cipher_SHA256`](#structcipher___s_h_a256)` * `[`data`](#structcipher___s_h_a256s_1a731288d0297a94e8b6817872c8a36536) -#### `public struct _json_value::@0::@3 `[`object`](#struct__json__value_1a67174883be078cb852d4748b78aa60ce) +#### `public int `[`count`](#structcipher___s_h_a256s_1ad43c3812e6d13e0518d9f8b8f463ffcf) -#### `public struct `[`_json_value`](#struct__json__value)` ** `[`values`](#struct__json__value_1a6244a16657c988883bbb1fa7f1f0ba55) +# struct `cipher_Sig` -#### `public struct _json_value::@0::@4 `[`array`](#struct__json__value_1ac837a4233a38fcd3c3d51da2c3a56f0c) +## Summary -#### `public union _json_value::@0 `[`u`](#struct__json__value_1a2e5a72cccd43ae6e6b1dc476fc327d17) + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint8 `[`data`](#structcipher___sig_1acfabdfac9f5f366a659ba0288fcc4aba) | -#### `public struct `[`_json_value`](#struct__json__value)` * `[`next_alloc`](#struct__json__value_1a6b6c655ef17b09a6ea18d94612a27304) +## Members -#### `public void * `[`object_mem`](#struct__json__value_1aa166262c3b34bfb69a85f6e625970226) +#### `public GoUint8 `[`data`](#structcipher___sig_1acfabdfac9f5f366a659ba0288fcc4aba) -#### `public union _json_value::@1 `[`_reserved`](#struct__json__value_1ac7cdbd31aad7b4a672e38721c1122f35) +# struct `cli__SendAmount` -# struct `Address` +Structure used to specify amounts transferred in a transaction. ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public unsigned char `[`Version`](#struct_address_1a49fed92a3e4a3cc30678924a13acc19f) | -`public Ripemd160 `[`Key`](#struct_address_1aa7fd9da55c53a8f7a6abe4987a8ea093) | +`public `[`GoString_`](#struct_go_string__)` `[`Addr`](#structcli_____send_amount_1af646aec99cf83d30d17fd62e014d19f8) | Sender / receipient address. +`public GoInt64_ `[`Coins`](#structcli_____send_amount_1a7733f16af3115d3cfc712f2f687b73e4) | Amount transferred (e.g. measured in SKY) ## Members -#### `public unsigned char `[`Version`](#struct_address_1a49fed92a3e4a3cc30678924a13acc19f) +#### `public `[`GoString_`](#struct_go_string__)` `[`Addr`](#structcli_____send_amount_1af646aec99cf83d30d17fd62e014d19f8) -#### `public Ripemd160 `[`Key`](#struct_address_1aa7fd9da55c53a8f7a6abe4987a8ea093) +Sender / receipient address. -# struct `cipher__Address` +#### `public GoInt64_ `[`Coins`](#structcli_____send_amount_1a7733f16af3115d3cfc712f2f687b73e4) -Addresses of SKY accounts +Amount transferred (e.g. measured in SKY) + +# struct `coin__Block` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public unsigned char `[`Version`](#structcipher_____address_1a49fed92a3e4a3cc30678924a13acc19f) | [Address](#struct_address) version identifier. Used to differentiate testnet vs mainnet addresses, for instance. -`public cipher__Ripemd160 `[`Key`](#structcipher_____address_1a16586cd3bfc67010c3c185d0da01317c) | [Address](#struct_address) hash identifier. +`public `[`coin__BlockHeader`](#structcoin_____block_header)` `[`Head`](#structcoin_____block_1a64c1bf574366c3afc7adc2af819adafe) | +`public `[`coin__BlockBody`](#structcoin_____block_body)` `[`Body`](#structcoin_____block_1a59caa9af8b9909183c8b9831444b7633) | ## Members -#### `public unsigned char `[`Version`](#structcipher_____address_1a49fed92a3e4a3cc30678924a13acc19f) +#### `public `[`coin__BlockHeader`](#structcoin_____block_header)` `[`Head`](#structcoin_____block_1a64c1bf574366c3afc7adc2af819adafe) -[Address](#struct_address) version identifier. Used to differentiate testnet vs mainnet addresses, for instance. +#### `public `[`coin__BlockBody`](#structcoin_____block_body)` `[`Body`](#structcoin_____block_1a59caa9af8b9909183c8b9831444b7633) -#### `public cipher__Ripemd160 `[`Key`](#structcipher_____address_1a16586cd3bfc67010c3c185d0da01317c) +# struct `coin__BlockBody` -[Address](#struct_address) hash identifier. +## Summary -# struct `cipher__BitcoinAddress` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`coin__Transactions`](#struct_go_slice__)` `[`Transactions`](#structcoin_____block_body_1a95a9585b57fa4742b7be88c7f2a6d42c) | -Addresses of Bitcoin accounts +## Members + +#### `public `[`coin__Transactions`](#struct_go_slice__)` `[`Transactions`](#structcoin_____block_body_1a95a9585b57fa4742b7be88c7f2a6d42c) + +# struct `coin__BlockHeader` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public unsigned char `[`Version`](#structcipher_____bitcoin_address_1a49fed92a3e4a3cc30678924a13acc19f) | [Address](#struct_address) version identifier. Used to differentiate testnet vs mainnet addresses, for instance. -`public cipher__Ripemd160 `[`Key`](#structcipher_____bitcoin_address_1a16586cd3bfc67010c3c185d0da01317c) | [Address](#struct_address) hash identifier. +`public GoUint32_ `[`Version`](#structcoin_____block_header_1a3b774030b8018017c41c377d74512089) | +`public GoUint64_ `[`Time`](#structcoin_____block_header_1a1260435bd13330d2d5c2c61d044b1603) | +`public GoUint64_ `[`BkSeq`](#structcoin_____block_header_1a5f647c638c8d6a7e2b9ba8b409bf94f2) | +`public GoUint64_ `[`Fee`](#structcoin_____block_header_1af9cf0d58378a9d4cebbd504006db852d) | +`public cipher__SHA256 `[`PrevHash`](#structcoin_____block_header_1a4787d7554bca4e07b6c7538a1aa70d17) | +`public cipher__SHA256 `[`BodyHash`](#structcoin_____block_header_1a4101954b75ceebe672014e6313074225) | +`public cipher__SHA256 `[`UxHash`](#structcoin_____block_header_1ae2ed7673c2a3cd72f697835bebab9cd5) | ## Members -#### `public unsigned char `[`Version`](#structcipher_____bitcoin_address_1a49fed92a3e4a3cc30678924a13acc19f) +#### `public GoUint32_ `[`Version`](#structcoin_____block_header_1a3b774030b8018017c41c377d74512089) -[Address](#struct_address) version identifier. Used to differentiate testnet vs mainnet addresses, for instance. +#### `public GoUint64_ `[`Time`](#structcoin_____block_header_1a1260435bd13330d2d5c2c61d044b1603) -#### `public cipher__Ripemd160 `[`Key`](#structcipher_____bitcoin_address_1a16586cd3bfc67010c3c185d0da01317c) +#### `public GoUint64_ `[`BkSeq`](#structcoin_____block_header_1a5f647c638c8d6a7e2b9ba8b409bf94f2) -[Address](#struct_address) hash identifier. +#### `public GoUint64_ `[`Fee`](#structcoin_____block_header_1af9cf0d58378a9d4cebbd504006db852d) -# struct `cli__SendAmount` +#### `public cipher__SHA256 `[`PrevHash`](#structcoin_____block_header_1a4787d7554bca4e07b6c7538a1aa70d17) -Structure used to specify amounts transferred in a transaction. +#### `public cipher__SHA256 `[`BodyHash`](#structcoin_____block_header_1a4101954b75ceebe672014e6313074225) + +#### `public cipher__SHA256 `[`UxHash`](#structcoin_____block_header_1ae2ed7673c2a3cd72f697835bebab9cd5) + +# struct `coin__SignedBlock` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`GoString_`](#struct_go_string__)` `[`Addr`](#structcli_____send_amount_1af646aec99cf83d30d17fd62e014d19f8) | Sender / receipient address. -`public GoInt64_ `[`Coins`](#structcli_____send_amount_1a7733f16af3115d3cfc712f2f687b73e4) | Amount transferred (e.g. measured in SKY) +`public `[`coin__Block`](#structcoin_____block)` `[`_unnamed`](#structcoin_____signed_block_1a891758f1c7853767c037ca433f977565) | +`public cipher__Sig `[`Sig`](#structcoin_____signed_block_1a3dc2280cefb5cc2f3ddb00ab7adc66a4) | ## Members -#### `public `[`GoString_`](#struct_go_string__)` `[`Addr`](#structcli_____send_amount_1af646aec99cf83d30d17fd62e014d19f8) +#### `public `[`coin__Block`](#structcoin_____block)` `[`_unnamed`](#structcoin_____signed_block_1a891758f1c7853767c037ca433f977565) -Sender / receipient address. - -#### `public GoInt64_ `[`Coins`](#structcli_____send_amount_1a7733f16af3115d3cfc712f2f687b73e4) - -Amount transferred (e.g. measured in SKY) +#### `public cipher__Sig `[`Sig`](#structcoin_____signed_block_1a3dc2280cefb5cc2f3ddb00ab7adc66a4) -# struct `coin__Transaction` +# struct `coin__Transaction` Skycoin transaction. @@ -462,7 +440,7 @@ Instances of this struct are included in blocks. ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- `public GoInt32_ `[`Length`](#structcoin_____transaction_1a8a3c288e7b3f7245e0b7916ce322e5f9) | Current transaction's length expressed in bytes. `public GoInt8_ `[`Type`](#structcoin_____transaction_1a5bf4f40bde41c84f4ab5ff82bc74f744) | Transaction's version. When a node tries to process a transaction, it must verify whether it supports the transaction's type. This is intended to provide a way to update skycoin clients and servers without crashing the network. If the transaction is not compatible with the node, it should not process it. @@ -473,31 +451,31 @@ Instances of this struct are included in blocks. ## Members -#### `public GoInt32_ `[`Length`](#structcoin_____transaction_1a8a3c288e7b3f7245e0b7916ce322e5f9) +#### `public GoInt32_ `[`Length`](#structcoin_____transaction_1a8a3c288e7b3f7245e0b7916ce322e5f9) Current transaction's length expressed in bytes. -#### `public GoInt8_ `[`Type`](#structcoin_____transaction_1a5bf4f40bde41c84f4ab5ff82bc74f744) +#### `public GoInt8_ `[`Type`](#structcoin_____transaction_1a5bf4f40bde41c84f4ab5ff82bc74f744) Transaction's version. When a node tries to process a transaction, it must verify whether it supports the transaction's type. This is intended to provide a way to update skycoin clients and servers without crashing the network. If the transaction is not compatible with the node, it should not process it. -#### `public cipher__SHA256 `[`InnerHash`](#structcoin_____transaction_1af5187a82f283be2deca0f1781fa628ad) +#### `public cipher__SHA256 `[`InnerHash`](#structcoin_____transaction_1af5187a82f283be2deca0f1781fa628ad) It's a SHA256 hash of the inputs and outputs of the transaction. It is used to protect against transaction mutability. This means that the transaction cannot be altered after its creation. -#### `public `[`GoSlice_`](#struct_go_slice__)` `[`Sigs`](#structcoin_____transaction_1af0a2ba807a16f9ae66dd5682c243b943) +#### `public `[`GoSlice_`](#struct_go_slice__)` `[`Sigs`](#structcoin_____transaction_1af0a2ba807a16f9ae66dd5682c243b943) A list of digital signiatures generated by the skycoin client using the private key. It is used by Skycoin servers to verify the authenticy of the transaction. Each input requires a different signature. -#### `public `[`GoSlice_`](#struct_go_slice__)` `[`In`](#structcoin_____transaction_1a317b73fcfa2b93fd16dfeab7ba228c39) +#### `public `[`GoSlice_`](#struct_go_slice__)` `[`In`](#structcoin_____transaction_1a317b73fcfa2b93fd16dfeab7ba228c39) A list of references to unspent transaction outputs. Unlike other cryptocurrencies, such as Bitcoin, Skycoin unspent transaction outputs (UX) and Skycoin transactions (TX) are separated in the blockchain protocol, allowing for lighter transactions, thus reducing the broadcasting costs across the network. -#### `public `[`GoSlice_`](#struct_go_slice__)` `[`Out`](#structcoin_____transaction_1a181edcb164c89b192b3838de7792cc89) +#### `public `[`GoSlice_`](#struct_go_slice__)` `[`Out`](#structcoin_____transaction_1a181edcb164c89b192b3838de7792cc89) Outputs: A list of outputs created by the client, that will be recorded in the blockchain if transactions are confirmed. An output consists of a data structure representing an UTXT, which is composed by a Skycoin address to be sent to, the amount in Skycoin to be sent, and the amount of Coin Hours to be sent, and the SHA256 hash of the previous fields. -# struct `coin__TransactionOutput` +# struct `coin__TransactionOutput` Skycoin transaction output. @@ -505,384 +483,629 @@ Instances are integral part of transactions included in blocks. ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structcoin_____transaction_output_1a36182709852829827005f90eef8bf78c) | Receipient address. -`public GoInt64_ `[`Coins`](#structcoin_____transaction_output_1a7733f16af3115d3cfc712f2f687b73e4) | Amount sent to the receipient address. -`public GoInt64_ `[`Hours`](#structcoin_____transaction_output_1a7aef551ad5991173b5a6160fd8fe1594) | Amount of Coin Hours sent to the receipient address. +`public GoUint64_ `[`Coins`](#structcoin_____transaction_output_1aa8ecc8470e80feb9af67d2e39d01b1eb) | Amount sent to the receipient address. +`public GoUint64_ `[`Hours`](#structcoin_____transaction_output_1a527c44c111577ee7ae35d7a53ab11332) | Amount of Coin Hours sent to the receipient address. ## Members -#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structcoin_____transaction_output_1a36182709852829827005f90eef8bf78c) +#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structcoin_____transaction_output_1a36182709852829827005f90eef8bf78c) Receipient address. -#### `public GoInt64_ `[`Coins`](#structcoin_____transaction_output_1a7733f16af3115d3cfc712f2f687b73e4) +#### `public GoUint64_ `[`Coins`](#structcoin_____transaction_output_1aa8ecc8470e80feb9af67d2e39d01b1eb) Amount sent to the receipient address. -#### `public GoInt64_ `[`Hours`](#structcoin_____transaction_output_1a7aef551ad5991173b5a6160fd8fe1594) +#### `public GoUint64_ `[`Hours`](#structcoin_____transaction_output_1a527c44c111577ee7ae35d7a53ab11332) Amount of Coin Hours sent to the receipient address. -# struct `coin__UxBody` +# struct `coin__UxBody` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public cipher__SHA256 `[`SrcTransaction`](#structcoin_____ux_body_1a94a1b2134fcadb6f35f5a1573f771cde) | -`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structcoin_____ux_body_1a36182709852829827005f90eef8bf78c) | -`public GoUint64_ `[`Coins`](#structcoin_____ux_body_1aa8ecc8470e80feb9af67d2e39d01b1eb) | -`public GoUint64_ `[`Hours`](#structcoin_____ux_body_1a527c44c111577ee7ae35d7a53ab11332) | +`public cipher__SHA256 `[`SrcTransaction`](#structcoin_____ux_body_1a94a1b2134fcadb6f35f5a1573f771cde) | +`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structcoin_____ux_body_1a36182709852829827005f90eef8bf78c) | +`public GoUint64_ `[`Coins`](#structcoin_____ux_body_1aa8ecc8470e80feb9af67d2e39d01b1eb) | +`public GoUint64_ `[`Hours`](#structcoin_____ux_body_1a527c44c111577ee7ae35d7a53ab11332) | ## Members -#### `public cipher__SHA256 `[`SrcTransaction`](#structcoin_____ux_body_1a94a1b2134fcadb6f35f5a1573f771cde) +#### `public cipher__SHA256 `[`SrcTransaction`](#structcoin_____ux_body_1a94a1b2134fcadb6f35f5a1573f771cde) -#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structcoin_____ux_body_1a36182709852829827005f90eef8bf78c) +#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structcoin_____ux_body_1a36182709852829827005f90eef8bf78c) -#### `public GoUint64_ `[`Coins`](#structcoin_____ux_body_1aa8ecc8470e80feb9af67d2e39d01b1eb) +#### `public GoUint64_ `[`Coins`](#structcoin_____ux_body_1aa8ecc8470e80feb9af67d2e39d01b1eb) -#### `public GoUint64_ `[`Hours`](#structcoin_____ux_body_1a527c44c111577ee7ae35d7a53ab11332) +#### `public GoUint64_ `[`Hours`](#structcoin_____ux_body_1a527c44c111577ee7ae35d7a53ab11332) -# struct `coin__UxHead` +# struct `coin__UxHead` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public GoUint64_ `[`Time`](#structcoin_____ux_head_1a1260435bd13330d2d5c2c61d044b1603) | -`public GoUint64_ `[`BkSeq`](#structcoin_____ux_head_1a5f647c638c8d6a7e2b9ba8b409bf94f2) | +`public GoUint64_ `[`Time`](#structcoin_____ux_head_1a1260435bd13330d2d5c2c61d044b1603) | +`public GoUint64_ `[`BkSeq`](#structcoin_____ux_head_1a5f647c638c8d6a7e2b9ba8b409bf94f2) | ## Members -#### `public GoUint64_ `[`Time`](#structcoin_____ux_head_1a1260435bd13330d2d5c2c61d044b1603) +#### `public GoUint64_ `[`Time`](#structcoin_____ux_head_1a1260435bd13330d2d5c2c61d044b1603) -#### `public GoUint64_ `[`BkSeq`](#structcoin_____ux_head_1a5f647c638c8d6a7e2b9ba8b409bf94f2) +#### `public GoUint64_ `[`BkSeq`](#structcoin_____ux_head_1a5f647c638c8d6a7e2b9ba8b409bf94f2) -# struct `coin__UxOut` +# struct `coin__UxOut` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`coin__UxHead`](#structcoin_____ux_head)` `[`Head`](#structcoin_____ux_out_1ad77c0fb7d1545bcda1657269eab9721c) | -`public `[`coin__UxBody`](#structcoin_____ux_body)` `[`Body`](#structcoin_____ux_out_1a29e9173d148f64e9129d98a8d9bf5ed2) | +`public `[`coin__UxHead`](#structcoin_____ux_head)` `[`Head`](#structcoin_____ux_out_1ad77c0fb7d1545bcda1657269eab9721c) | +`public `[`coin__UxBody`](#structcoin_____ux_body)` `[`Body`](#structcoin_____ux_out_1a29e9173d148f64e9129d98a8d9bf5ed2) | ## Members -#### `public `[`coin__UxHead`](#structcoin_____ux_head)` `[`Head`](#structcoin_____ux_out_1ad77c0fb7d1545bcda1657269eab9721c) +#### `public `[`coin__UxHead`](#structcoin_____ux_head)` `[`Head`](#structcoin_____ux_out_1ad77c0fb7d1545bcda1657269eab9721c) -#### `public `[`coin__UxBody`](#structcoin_____ux_body)` `[`Body`](#structcoin_____ux_out_1a29e9173d148f64e9129d98a8d9bf5ed2) +#### `public `[`coin__UxBody`](#structcoin_____ux_body)` `[`Body`](#structcoin_____ux_out_1a29e9173d148f64e9129d98a8d9bf5ed2) -# struct `GoInterface` +# struct `coin_UxOutArray` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public void * `[`t`](#struct_go_interface_1a6445205ee90f5ff5131595cf7ddfcec0) | -`public void * `[`v`](#struct_go_interface_1a67806b49e20fb1170422969965db6ecb) | +`public `[`coin__UxOut`](#structcoin_____ux_out)` * `[`data`](#structcoin___ux_out_array_1a406bf2d3fbcb470171cda7891e79c62a) | +`public int `[`count`](#structcoin___ux_out_array_1ad43c3812e6d13e0518d9f8b8f463ffcf) | ## Members -#### `public void * `[`t`](#struct_go_interface_1a6445205ee90f5ff5131595cf7ddfcec0) +#### `public `[`coin__UxOut`](#structcoin_____ux_out)` * `[`data`](#structcoin___ux_out_array_1a406bf2d3fbcb470171cda7891e79c62a) -#### `public void * `[`v`](#struct_go_interface_1a67806b49e20fb1170422969965db6ecb) +#### `public int `[`count`](#structcoin___ux_out_array_1ad43c3812e6d13e0518d9f8b8f463ffcf) -# struct `GoInterface_` +# struct `cr_mem` -Instances of Go interface types. +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public const void * `[`data`](#structcr__mem_1a0d49d74db4c035719c3867723cf7e779) | +`public size_t `[`size`](#structcr__mem_1a854352f53b148adc24983a58a1866d66) | + +## Members + +#### `public const void * `[`data`](#structcr__mem_1a0d49d74db4c035719c3867723cf7e779) + +#### `public size_t `[`size`](#structcr__mem_1a854352f53b148adc24983a58a1866d66) + +# struct `encrypt__ScryptChacha20poly1305` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public void * `[`t`](#struct_go_interface___1a6445205ee90f5ff5131595cf7ddfcec0) | Pointer to the information of the concrete Go type bound to this interface reference. -`public void * `[`v`](#struct_go_interface___1a67806b49e20fb1170422969965db6ecb) | Pointer to the data corresponding to the value bound to this interface type. +`public GoInt_ `[`N`](#structencrypt_____scrypt_chacha20poly1305_1a9341d3d326cce1ab3e82bf4223d61631) | +`public GoInt_ `[`R`](#structencrypt_____scrypt_chacha20poly1305_1a345710bc5a459c491d371ab9882b9deb) | +`public GoInt_ `[`P`](#structencrypt_____scrypt_chacha20poly1305_1af70f5e03c75f91949266955080b31138) | +`public GoInt_ `[`KeyLen`](#structencrypt_____scrypt_chacha20poly1305_1a4da9e58cf088f5ea728571a8fa88c141) | ## Members -#### `public void * `[`t`](#struct_go_interface___1a6445205ee90f5ff5131595cf7ddfcec0) +#### `public GoInt_ `[`N`](#structencrypt_____scrypt_chacha20poly1305_1a9341d3d326cce1ab3e82bf4223d61631) -Pointer to the information of the concrete Go type bound to this interface reference. +#### `public GoInt_ `[`R`](#structencrypt_____scrypt_chacha20poly1305_1a345710bc5a459c491d371ab9882b9deb) -#### `public void * `[`v`](#struct_go_interface___1a67806b49e20fb1170422969965db6ecb) +#### `public GoInt_ `[`P`](#structencrypt_____scrypt_chacha20poly1305_1af70f5e03c75f91949266955080b31138) -Pointer to the data corresponding to the value bound to this interface type. +#### `public GoInt_ `[`KeyLen`](#structencrypt_____scrypt_chacha20poly1305_1a4da9e58cf088f5ea728571a8fa88c141) + +# struct `Fee_Calculator` + +## Summary -# struct `GoSlice` + Members | Descriptions +--------------------------------|--------------------------------------------- +`public FeeCalcFunc `[`callback`](#struct_fee___calculator_1ace64cc72910e5458a0b8098af37a57a1) | +`public void * `[`context`](#struct_fee___calculator_1ae376f130b17d169ee51be68077a89ed0) | + +## Members + +#### `public FeeCalcFunc `[`callback`](#struct_fee___calculator_1ace64cc72910e5458a0b8098af37a57a1) + +#### `public void * `[`context`](#struct_fee___calculator_1ae376f130b17d169ee51be68077a89ed0) + +# struct `FeeCalculator` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public void * `[`data`](#struct_go_slice_1a735984d41155bc1032e09bece8f8d66d) | -`public GoInt `[`len`](#struct_go_slice_1abefd7e3d615fc657a761fd36bcd7296c) | -`public GoInt `[`cap`](#struct_go_slice_1a726ab221ad9e219391b7f4c9a5c5ba33) | +`public FeeCalcFunc `[`callback`](#struct_fee_calculator_1ace64cc72910e5458a0b8098af37a57a1) | +`public void * `[`context`](#struct_fee_calculator_1ae376f130b17d169ee51be68077a89ed0) | + +## Members + +#### `public FeeCalcFunc `[`callback`](#struct_fee_calculator_1ace64cc72910e5458a0b8098af37a57a1) + +#### `public void * `[`context`](#struct_fee_calculator_1ae376f130b17d169ee51be68077a89ed0) + +# struct `GoComplex128_` + +Instances of Go `complex` type. + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public double `[`real`](#struct_go_complex128___1a51c821fcf95975271abfc49311e983d4) | +`public double `[`imaginary`](#struct_go_complex128___1a92dcee8df01cf892620da47f14b8e102) | + +## Members + +#### `public double `[`real`](#struct_go_complex128___1a51c821fcf95975271abfc49311e983d4) + +#### `public double `[`imaginary`](#struct_go_complex128___1a92dcee8df01cf892620da47f14b8e102) + +# struct `GoComplex64_` + +Instances of Go `complex` type. + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public float `[`real`](#struct_go_complex64___1a06ed4269b34924d748f2f77b17db7d21) | +`public float `[`imaginary`](#struct_go_complex64___1aa4331a3d00f2e714f1cb72efe5ca590e) | + +## Members + +#### `public float `[`real`](#struct_go_complex64___1a06ed4269b34924d748f2f77b17db7d21) + +#### `public float `[`imaginary`](#struct_go_complex64___1aa4331a3d00f2e714f1cb72efe5ca590e) + +# struct `GoInterface_` + +Instances of Go interface types. + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public void * `[`t`](#struct_go_interface___1a6445205ee90f5ff5131595cf7ddfcec0) | Pointer to the information of the concrete Go type bound to this interface reference. +`public void * `[`v`](#struct_go_interface___1a67806b49e20fb1170422969965db6ecb) | Pointer to the data corresponding to the value bound to this interface type. ## Members -#### `public void * `[`data`](#struct_go_slice_1a735984d41155bc1032e09bece8f8d66d) +#### `public void * `[`t`](#struct_go_interface___1a6445205ee90f5ff5131595cf7ddfcec0) -#### `public GoInt `[`len`](#struct_go_slice_1abefd7e3d615fc657a761fd36bcd7296c) +Pointer to the information of the concrete Go type bound to this interface reference. + +#### `public void * `[`v`](#struct_go_interface___1a67806b49e20fb1170422969965db6ecb) -#### `public GoInt `[`cap`](#struct_go_slice_1a726ab221ad9e219391b7f4c9a5c5ba33) +Pointer to the data corresponding to the value bound to this interface type. -# struct `GoSlice_` +# struct `GoSlice_` Instances of Go slices ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- `public void * `[`data`](#struct_go_slice___1a735984d41155bc1032e09bece8f8d66d) | Pointer to buffer containing slice data. -`public GoInt_ `[`len`](#struct_go_slice___1af7b822f9987d08af70f228eb6dd4b7c7) | Number of items stored in slice buffer. +`public GoInt_ `[`len`](#struct_go_slice___1af7b822f9987d08af70f228eb6dd4b7c7) | [Number](#struct_number) of items stored in slice buffer. `public GoInt_ `[`cap`](#struct_go_slice___1abb0492bac72ee60cd3cafd152291df94) | Maximum number of items that fits in this slice considering allocated memory and item type's size. ## Members -#### `public void * `[`data`](#struct_go_slice___1a735984d41155bc1032e09bece8f8d66d) +#### `public void * `[`data`](#struct_go_slice___1a735984d41155bc1032e09bece8f8d66d) Pointer to buffer containing slice data. -#### `public GoInt_ `[`len`](#struct_go_slice___1af7b822f9987d08af70f228eb6dd4b7c7) +#### `public GoInt_ `[`len`](#struct_go_slice___1af7b822f9987d08af70f228eb6dd4b7c7) -Number of items stored in slice buffer. +[Number](#struct_number) of items stored in slice buffer. -#### `public GoInt_ `[`cap`](#struct_go_slice___1abb0492bac72ee60cd3cafd152291df94) +#### `public GoInt_ `[`cap`](#struct_go_slice___1abb0492bac72ee60cd3cafd152291df94) Maximum number of items that fits in this slice considering allocated memory and item type's size. -# struct `GoString_` +# struct `GoString_` Instances of Go `string` type. ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- `public const char * `[`p`](#struct_go_string___1a6bc6b007533335efe02bafff799ec64c) | Pointer to string characters buffer. `public GoInt_ `[`n`](#struct_go_string___1aa78f60eaaf1d3eb1661886a694b82b23) | String size not counting trailing `\0` char if at all included. ## Members -#### `public const char * `[`p`](#struct_go_string___1a6bc6b007533335efe02bafff799ec64c) +#### `public const char * `[`p`](#struct_go_string___1a6bc6b007533335efe02bafff799ec64c) Pointer to string characters buffer. -#### `public GoInt_ `[`n`](#struct_go_string___1aa78f60eaaf1d3eb1661886a694b82b23) +#### `public GoInt_ `[`n`](#struct_go_string___1aa78f60eaaf1d3eb1661886a694b82b23) String size not counting trailing `\0` char if at all included. -# struct `InputTestData` +# struct `httphelper__Address` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`GoSlice`](#struct_go_slice)` `[`Hashes`](#struct_input_test_data_1ad0e54a71fc762f7f7c7765162e1a738a) | +`public `[`cipher__Address`](#structcipher_____address)` `[`_unnamed`](#structhttphelper_____address_1aad3e0caa43af2dc583e1a8cb47357088) | ## Members -#### `public `[`GoSlice`](#struct_go_slice)` `[`Hashes`](#struct_input_test_data_1ad0e54a71fc762f7f7c7765162e1a738a) +#### `public `[`cipher__Address`](#structcipher_____address)` `[`_unnamed`](#structhttphelper_____address_1aad3e0caa43af2dc583e1a8cb47357088) -# struct `InputTestDataJSON` +# struct `httphelper__SHA256` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`GoSlice`](#struct_go_slice)` `[`Hashes`](#struct_input_test_data_j_s_o_n_1ad0e54a71fc762f7f7c7765162e1a738a) | +`public cipher__SHA256 `[`_unnamed`](#structhttphelper_____s_h_a256_1a7799a54f739725769994b5bcfc44ecfb) | ## Members -#### `public `[`GoSlice`](#struct_go_slice)` `[`Hashes`](#struct_input_test_data_j_s_o_n_1ad0e54a71fc762f7f7c7765162e1a738a) +#### `public cipher__SHA256 `[`_unnamed`](#structhttphelper_____s_h_a256_1a7799a54f739725769994b5bcfc44ecfb) -# struct `json_settings` +# struct `InputTestData` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public unsigned long `[`max_memory`](#structjson__settings_1a0a75ed144583eabc50ba61e0e06abfea) | -`public int `[`settings`](#structjson__settings_1a4bc80b14d6c1a73e1f2ff9f0375dac8b) | -`public void *(* `[`mem_alloc`](#structjson__settings_1adf6905888aecb418419653d2c2ead6d8) | -`public void(* `[`mem_free`](#structjson__settings_1a0618e94c18df6d79aaa78fc57d797020) | -`public void * `[`user_data`](#structjson__settings_1a0f53d287ac7c064d1a49d4bd93ca1cb9) | -`public size_t `[`value_extra`](#structjson__settings_1af493db885ec44977143063289b5275db) | +`public GoSlice `[`Hashes`](#struct_input_test_data_1ad0e54a71fc762f7f7c7765162e1a738a) | ## Members -#### `public unsigned long `[`max_memory`](#structjson__settings_1a0a75ed144583eabc50ba61e0e06abfea) +#### `public GoSlice `[`Hashes`](#struct_input_test_data_1ad0e54a71fc762f7f7c7765162e1a738a) -#### `public int `[`settings`](#structjson__settings_1a4bc80b14d6c1a73e1f2ff9f0375dac8b) +# struct `InputTestDataJSON` -#### `public void *(* `[`mem_alloc`](#structjson__settings_1adf6905888aecb418419653d2c2ead6d8) +## Summary -#### `public void(* `[`mem_free`](#structjson__settings_1a0618e94c18df6d79aaa78fc57d797020) + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoSlice `[`Hashes`](#struct_input_test_data_j_s_o_n_1ad0e54a71fc762f7f7c7765162e1a738a) | -#### `public void * `[`user_data`](#structjson__settings_1a0f53d287ac7c064d1a49d4bd93ca1cb9) +## Members -#### `public size_t `[`value_extra`](#structjson__settings_1af493db885ec44977143063289b5275db) +#### `public GoSlice `[`Hashes`](#struct_input_test_data_j_s_o_n_1ad0e54a71fc762f7f7c7765162e1a738a) -# struct `KeysTestData` +# struct `json_settings` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#struct_keys_test_data_1a36182709852829827005f90eef8bf78c) | -`public cipher__SecKey `[`Secret`](#struct_keys_test_data_1ab7c6991603c7f6e2f9a7c5b7dd580dac) | -`public cipher__PubKey `[`Public`](#struct_keys_test_data_1a0bb45c3d09a24a1c34d376092a35dfdc) | -`public `[`GoSlice`](#struct_go_slice)` `[`Signatures`](#struct_keys_test_data_1ac97779b64174c30fa4cd2386f399d3b5) | +`public unsigned long `[`max_memory`](#structjson__settings_1a0a75ed144583eabc50ba61e0e06abfea) | +`public int `[`settings`](#structjson__settings_1a4bc80b14d6c1a73e1f2ff9f0375dac8b) | +`public void *(* `[`mem_alloc`](#structjson__settings_1a2e7e359c7ea91e8a2dc289973c1a175b) | +`public void(* `[`mem_free`](#structjson__settings_1a92bd9d811a0613553d77254839cd7bb2) | +`public void * `[`user_data`](#structjson__settings_1a0f53d287ac7c064d1a49d4bd93ca1cb9) | +`public size_t `[`value_extra`](#structjson__settings_1af493db885ec44977143063289b5275db) | ## Members -#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#struct_keys_test_data_1a36182709852829827005f90eef8bf78c) +#### `public unsigned long `[`max_memory`](#structjson__settings_1a0a75ed144583eabc50ba61e0e06abfea) + +#### `public int `[`settings`](#structjson__settings_1a4bc80b14d6c1a73e1f2ff9f0375dac8b) + +#### `public void *(* `[`mem_alloc`](#structjson__settings_1a2e7e359c7ea91e8a2dc289973c1a175b) -#### `public cipher__SecKey `[`Secret`](#struct_keys_test_data_1ab7c6991603c7f6e2f9a7c5b7dd580dac) +#### `public void(* `[`mem_free`](#structjson__settings_1a92bd9d811a0613553d77254839cd7bb2) -#### `public cipher__PubKey `[`Public`](#struct_keys_test_data_1a0bb45c3d09a24a1c34d376092a35dfdc) +#### `public void * `[`user_data`](#structjson__settings_1a0f53d287ac7c064d1a49d4bd93ca1cb9) -#### `public `[`GoSlice`](#struct_go_slice)` `[`Signatures`](#struct_keys_test_data_1ac97779b64174c30fa4cd2386f399d3b5) +#### `public size_t `[`value_extra`](#structjson__settings_1af493db885ec44977143063289b5275db) -# struct `KeysTestDataJSON` +# struct `KeysTestData` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`GoString`](#struct___go_string__)` `[`Address`](#struct_keys_test_data_j_s_o_n_1a9d21e8a82d5c1b3ad4f8ecf6f80e62ad) | -`public `[`GoString`](#struct___go_string__)` `[`Secret`](#struct_keys_test_data_j_s_o_n_1a801564a19fb6529beabfd99e1f4bb12e) | -`public `[`GoString`](#struct___go_string__)` `[`Public`](#struct_keys_test_data_j_s_o_n_1ac024a1d14cfeb43708ca2b526f176389) | -`public `[`GoSlice`](#struct_go_slice)` `[`Signatures`](#struct_keys_test_data_j_s_o_n_1ac97779b64174c30fa4cd2386f399d3b5) | +`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#struct_keys_test_data_1a36182709852829827005f90eef8bf78c) | +`public cipher__SecKey `[`Secret`](#struct_keys_test_data_1ab7c6991603c7f6e2f9a7c5b7dd580dac) | +`public cipher__PubKey `[`Public`](#struct_keys_test_data_1a0bb45c3d09a24a1c34d376092a35dfdc) | +`public GoSlice `[`Signatures`](#struct_keys_test_data_1ac97779b64174c30fa4cd2386f399d3b5) | ## Members -#### `public `[`GoString`](#struct___go_string__)` `[`Address`](#struct_keys_test_data_j_s_o_n_1a9d21e8a82d5c1b3ad4f8ecf6f80e62ad) +#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#struct_keys_test_data_1a36182709852829827005f90eef8bf78c) -#### `public `[`GoString`](#struct___go_string__)` `[`Secret`](#struct_keys_test_data_j_s_o_n_1a801564a19fb6529beabfd99e1f4bb12e) +#### `public cipher__SecKey `[`Secret`](#struct_keys_test_data_1ab7c6991603c7f6e2f9a7c5b7dd580dac) -#### `public `[`GoString`](#struct___go_string__)` `[`Public`](#struct_keys_test_data_j_s_o_n_1ac024a1d14cfeb43708ca2b526f176389) +#### `public cipher__PubKey `[`Public`](#struct_keys_test_data_1a0bb45c3d09a24a1c34d376092a35dfdc) -#### `public `[`GoSlice`](#struct_go_slice)` `[`Signatures`](#struct_keys_test_data_j_s_o_n_1ac97779b64174c30fa4cd2386f399d3b5) +#### `public GoSlice `[`Signatures`](#struct_keys_test_data_1ac97779b64174c30fa4cd2386f399d3b5) -# struct `SeedTestData` +# struct `KeysTestDataJSON` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`GoSlice`](#struct_go_slice)` `[`Seed`](#struct_seed_test_data_1ac243323ff380d4e4df1741f04f272ad7) | -`public `[`GoSlice`](#struct_go_slice)` `[`Keys`](#struct_seed_test_data_1af7b3b5dfe2d429d7484447fc5135c3b2) | +`public GoString `[`Address`](#struct_keys_test_data_j_s_o_n_1a9d21e8a82d5c1b3ad4f8ecf6f80e62ad) | +`public GoString `[`Secret`](#struct_keys_test_data_j_s_o_n_1a801564a19fb6529beabfd99e1f4bb12e) | +`public GoString `[`Public`](#struct_keys_test_data_j_s_o_n_1ac024a1d14cfeb43708ca2b526f176389) | +`public GoSlice `[`Signatures`](#struct_keys_test_data_j_s_o_n_1ac97779b64174c30fa4cd2386f399d3b5) | ## Members -#### `public `[`GoSlice`](#struct_go_slice)` `[`Seed`](#struct_seed_test_data_1ac243323ff380d4e4df1741f04f272ad7) +#### `public GoString `[`Address`](#struct_keys_test_data_j_s_o_n_1a9d21e8a82d5c1b3ad4f8ecf6f80e62ad) -#### `public `[`GoSlice`](#struct_go_slice)` `[`Keys`](#struct_seed_test_data_1af7b3b5dfe2d429d7484447fc5135c3b2) +#### `public GoString `[`Secret`](#struct_keys_test_data_j_s_o_n_1a801564a19fb6529beabfd99e1f4bb12e) -# struct `SeedTestDataJSON` +#### `public GoString `[`Public`](#struct_keys_test_data_j_s_o_n_1ac024a1d14cfeb43708ca2b526f176389) + +#### `public GoSlice `[`Signatures`](#struct_keys_test_data_j_s_o_n_1ac97779b64174c30fa4cd2386f399d3b5) + +# struct `Number` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`GoString`](#struct___go_string__)` `[`Seed`](#struct_seed_test_data_j_s_o_n_1a276b95b641aae441b01fe35bf9ffaba1) | -`public `[`GoSlice`](#struct_go_slice)` `[`Keys`](#struct_seed_test_data_j_s_o_n_1af7b3b5dfe2d429d7484447fc5135c3b2) | +`public BOOL `[`neg`](#struct_number_1a41cf4ffec7c96f46c8da4178883ff147) | +`public `[`GoSlice_`](#struct_go_slice__)` `[`nat`](#struct_number_1a5d41c00613550e6235c4cdf379c169b7) | ## Members -#### `public `[`GoString`](#struct___go_string__)` `[`Seed`](#struct_seed_test_data_j_s_o_n_1a276b95b641aae441b01fe35bf9ffaba1) +#### `public BOOL `[`neg`](#struct_number_1a41cf4ffec7c96f46c8da4178883ff147) + +#### `public `[`GoSlice_`](#struct_go_slice__)` `[`nat`](#struct_number_1a5d41c00613550e6235c4cdf379c169b7) + +# struct `secp256k1go__Field` + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint32_ `[`n`](#structsecp256k1go_____field_1ac59fea67392432d15cdaefebf95f0116) | -#### `public `[`GoSlice`](#struct_go_slice)` `[`Keys`](#struct_seed_test_data_j_s_o_n_1af7b3b5dfe2d429d7484447fc5135c3b2) +## Members -# struct `wallet__Entry` +#### `public GoUint32_ `[`n`](#structsecp256k1go_____field_1ac59fea67392432d15cdaefebf95f0116) -Wallet entry. +# struct `secp256k1go__XY` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____entry_1a36182709852829827005f90eef8bf78c) | Wallet address. -`public cipher__PubKey `[`Public`](#structwallet_____entry_1a0bb45c3d09a24a1c34d376092a35dfdc) | Public key used to generate address. -`public cipher__SecKey `[`Secret`](#structwallet_____entry_1ab7c6991603c7f6e2f9a7c5b7dd580dac) | Secret key used to generate address. +`public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`X`](#structsecp256k1go_____x_y_1a62f829bef767e88f83f3c7cae1113add) | +`public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`Y`](#structsecp256k1go_____x_y_1a0b1d10194685c0a24c7a69dfc28fc7c2) | +`public BOOL `[`Infinity`](#structsecp256k1go_____x_y_1a919e9d6912e340dac3cbeb528c1ae997) | ## Members -#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____entry_1a36182709852829827005f90eef8bf78c) +#### `public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`X`](#structsecp256k1go_____x_y_1a62f829bef767e88f83f3c7cae1113add) -Wallet address. +#### `public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`Y`](#structsecp256k1go_____x_y_1a0b1d10194685c0a24c7a69dfc28fc7c2) -#### `public cipher__PubKey `[`Public`](#structwallet_____entry_1a0bb45c3d09a24a1c34d376092a35dfdc) +#### `public BOOL `[`Infinity`](#structsecp256k1go_____x_y_1a919e9d6912e340dac3cbeb528c1ae997) -Public key used to generate address. +# struct `secp256k1go__XYZ` -#### `public cipher__SecKey `[`Secret`](#structwallet_____entry_1ab7c6991603c7f6e2f9a7c5b7dd580dac) +## Summary -Secret key used to generate address. + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`X`](#structsecp256k1go_____x_y_z_1a62f829bef767e88f83f3c7cae1113add) | +`public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`Y`](#structsecp256k1go_____x_y_z_1a0b1d10194685c0a24c7a69dfc28fc7c2) | +`public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`Z`](#structsecp256k1go_____x_y_z_1a72be6494ccdcd76d571dbddf55c5aae1) | +`public BOOL `[`Infinity`](#structsecp256k1go_____x_y_z_1a919e9d6912e340dac3cbeb528c1ae997) | + +## Members -# struct `wallet__UxBalance` +#### `public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`X`](#structsecp256k1go_____x_y_z_1a62f829bef767e88f83f3c7cae1113add) -Intermediate representation of a UxOut for sorting and spend choosing. +#### `public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`Y`](#structsecp256k1go_____x_y_z_1a0b1d10194685c0a24c7a69dfc28fc7c2) + +#### `public `[`secp256k1go__Field`](#structsecp256k1go_____field)` `[`Z`](#structsecp256k1go_____x_y_z_1a72be6494ccdcd76d571dbddf55c5aae1) + +#### `public BOOL `[`Infinity`](#structsecp256k1go_____x_y_z_1a919e9d6912e340dac3cbeb528c1ae997) + +# struct `SeedTestData` ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public cipher__SHA256 `[`Hash`](#structwallet_____ux_balance_1ac47f1b6e05da3c25722b2cc93728ee4d) | Hash of underlying UxOut. -`public GoInt64_ `[`BkSeq`](#structwallet_____ux_balance_1a1c1b05acfa8b1a65809ba4525f14a55b) | moment balance calculation is performed at. -`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____ux_balance_1a36182709852829827005f90eef8bf78c) | Account holder address. -`public GoInt64_ `[`Coins`](#structwallet_____ux_balance_1a7733f16af3115d3cfc712f2f687b73e4) | Coins amount (e.g. in SKY). -`public GoInt64_ `[`Hours`](#structwallet_____ux_balance_1a7aef551ad5991173b5a6160fd8fe1594) | Balance of Coin Hours generated by underlying UxOut, depending on UxOut's head time. +`public GoSlice `[`Seed`](#struct_seed_test_data_1ac243323ff380d4e4df1741f04f272ad7) | +`public GoSlice `[`Keys`](#struct_seed_test_data_1af7b3b5dfe2d429d7484447fc5135c3b2) | ## Members -#### `public cipher__SHA256 `[`Hash`](#structwallet_____ux_balance_1ac47f1b6e05da3c25722b2cc93728ee4d) +#### `public GoSlice `[`Seed`](#struct_seed_test_data_1ac243323ff380d4e4df1741f04f272ad7) -Hash of underlying UxOut. +#### `public GoSlice `[`Keys`](#struct_seed_test_data_1af7b3b5dfe2d429d7484447fc5135c3b2) -#### `public GoInt64_ `[`BkSeq`](#structwallet_____ux_balance_1a1c1b05acfa8b1a65809ba4525f14a55b) +# struct `SeedTestDataJSON` + +## Summary -moment balance calculation is performed at. + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoString `[`Seed`](#struct_seed_test_data_j_s_o_n_1a276b95b641aae441b01fe35bf9ffaba1) | +`public GoSlice `[`Keys`](#struct_seed_test_data_j_s_o_n_1af7b3b5dfe2d429d7484447fc5135c3b2) | -Block height corresponding to the +## Members -#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____ux_balance_1a36182709852829827005f90eef8bf78c) +#### `public GoString `[`Seed`](#struct_seed_test_data_j_s_o_n_1a276b95b641aae441b01fe35bf9ffaba1) -Account holder address. +#### `public GoSlice `[`Keys`](#struct_seed_test_data_j_s_o_n_1af7b3b5dfe2d429d7484447fc5135c3b2) -#### `public GoInt64_ `[`Coins`](#structwallet_____ux_balance_1a7733f16af3115d3cfc712f2f687b73e4) +# struct `Signature` -Coins amount (e.g. in SKY). +## Summary -#### `public GoInt64_ `[`Hours`](#structwallet_____ux_balance_1a7aef551ad5991173b5a6160fd8fe1594) + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`Number`](#struct_number)` `[`R`](#struct_signature_1a3796f971474f387d51b83ea0d37d1985) | +`public `[`Number`](#struct_number)` `[`S`](#struct_signature_1a30d286a33e62ae38e1e5ee8b2b8febff) | -Balance of Coin Hours generated by underlying UxOut, depending on UxOut's head time. +## Members -# struct `wallet__Wallet` +#### `public `[`Number`](#struct_number)` `[`R`](#struct_signature_1a3796f971474f387d51b83ea0d37d1985) + +#### `public `[`Number`](#struct_number)` `[`S`](#struct_signature_1a30d286a33e62ae38e1e5ee8b2b8febff) + +# struct `Wallet` Internal representation of a Skycoin wallet. ## Summary - Members | Descriptions + Members | Descriptions --------------------------------|--------------------------------------------- -`public GoMap_ `[`Meta`](#structwallet_____wallet_1acdf30a4af55c2c677ebf6fc57b27e740) | Records items that are not deterministic, like filename, lable, wallet type, secrets, etc. -`public `[`GoSlice_`](#struct_go_slice__)` `[`Entries`](#structwallet_____wallet_1a57b718d97f8db7e0bc9d9c755510951b) | Entries field stores the address entries that are deterministically generated from seed. +`public GoMap_ `[`Meta`](#struct_wallet_1acdf30a4af55c2c677ebf6fc57b27e740) | Records items that are not deterministic, like filename, lable, wallet type, secrets, etc. +`public `[`GoSlice_`](#struct_go_slice__)` `[`Entries`](#struct_wallet_1a57b718d97f8db7e0bc9d9c755510951b) | Entries field stores the address entries that are deterministically generated from seed. ## Members -#### `public GoMap_ `[`Meta`](#structwallet_____wallet_1acdf30a4af55c2c677ebf6fc57b27e740) +#### `public GoMap_ `[`Meta`](#struct_wallet_1acdf30a4af55c2c677ebf6fc57b27e740) Records items that are not deterministic, like filename, lable, wallet type, secrets, etc. -#### `public `[`GoSlice_`](#struct_go_slice__)` `[`Entries`](#structwallet_____wallet_1a57b718d97f8db7e0bc9d9c755510951b) +#### `public `[`GoSlice_`](#struct_go_slice__)` `[`Entries`](#struct_wallet_1a57b718d97f8db7e0bc9d9c755510951b) Entries field stores the address entries that are deterministically generated from seed. -Generated by [Moxygen](https://sourcey.com/moxygen) +# struct `wallet__Balance` + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public GoUint64_ `[`Coins`](#structwallet_____balance_1aa8ecc8470e80feb9af67d2e39d01b1eb) | +`public GoUint64_ `[`Hours`](#structwallet_____balance_1a527c44c111577ee7ae35d7a53ab11332) | + +## Members + +#### `public GoUint64_ `[`Coins`](#structwallet_____balance_1aa8ecc8470e80feb9af67d2e39d01b1eb) + +#### `public GoUint64_ `[`Hours`](#structwallet_____balance_1a527c44c111577ee7ae35d7a53ab11332) + +# struct `wallet__BalancePair` + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`wallet__Balance`](#structwallet_____balance)` `[`Confirmed`](#structwallet_____balance_pair_1a41316e517db7b9094b239c0506a365d4) | +`public `[`wallet__Balance`](#structwallet_____balance)` `[`Predicted`](#structwallet_____balance_pair_1adf1a2783f7f9cb7abddceee9da343676) | + +## Members + +#### `public `[`wallet__Balance`](#structwallet_____balance)` `[`Confirmed`](#structwallet_____balance_pair_1a41316e517db7b9094b239c0506a365d4) + +#### `public `[`wallet__Balance`](#structwallet_____balance)` `[`Predicted`](#structwallet_____balance_pair_1adf1a2783f7f9cb7abddceee9da343676) + +# struct `wallet__Entry` + +[Wallet](#struct_wallet) entry. + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____entry_1a36182709852829827005f90eef8bf78c) | [Wallet](#struct_wallet) address. +`public cipher__PubKey `[`Public`](#structwallet_____entry_1a0bb45c3d09a24a1c34d376092a35dfdc) | Public key used to generate address. +`public cipher__SecKey `[`Secret`](#structwallet_____entry_1ab7c6991603c7f6e2f9a7c5b7dd580dac) | Secret key used to generate address. + +## Members + +#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____entry_1a36182709852829827005f90eef8bf78c) + +[Wallet](#struct_wallet) address. + +#### `public cipher__PubKey `[`Public`](#structwallet_____entry_1a0bb45c3d09a24a1c34d376092a35dfdc) + +Public key used to generate address. + +#### `public cipher__SecKey `[`Secret`](#structwallet_____entry_1ab7c6991603c7f6e2f9a7c5b7dd580dac) + +Secret key used to generate address. + +# struct `wallet__Note` + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`GoString_`](#struct_go_string__)` `[`TxID`](#structwallet_____note_1a54c4432f84daa21ae7afcac518b95079) | +`public `[`GoString_`](#struct_go_string__)` `[`Value`](#structwallet_____note_1a51c1749adb41172cb32ea990f8c6b370) | + +## Members + +#### `public `[`GoString_`](#struct_go_string__)` `[`TxID`](#structwallet_____note_1a54c4432f84daa21ae7afcac518b95079) + +#### `public `[`GoString_`](#struct_go_string__)` `[`Value`](#structwallet_____note_1a51c1749adb41172cb32ea990f8c6b370) + +# struct `wallet__ReadableNote` + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public `[`GoString_`](#struct_go_string__)` `[`TransactionID`](#structwallet_____readable_note_1af10202cabcff3e418cb51d2c48d97791) | +`public `[`GoString_`](#struct_go_string__)` `[`ActualNote`](#structwallet_____readable_note_1ac0c686c42e8b829b2e553ff4d45460f3) | + +## Members + +#### `public `[`GoString_`](#struct_go_string__)` `[`TransactionID`](#structwallet_____readable_note_1af10202cabcff3e418cb51d2c48d97791) + +#### `public `[`GoString_`](#struct_go_string__)` `[`ActualNote`](#structwallet_____readable_note_1ac0c686c42e8b829b2e553ff4d45460f3) + +# struct `wallet__UxBalance` + +Intermediate representation of a UxOut for sorting and spend choosing. + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public cipher__SHA256 `[`Hash`](#structwallet_____ux_balance_1ac47f1b6e05da3c25722b2cc93728ee4d) | Hash of underlying UxOut. +`public GoInt64_ `[`BkSeq`](#structwallet_____ux_balance_1a1c1b05acfa8b1a65809ba4525f14a55b) | Block height corresponding to the moment balance calculation is performed at. +`public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____ux_balance_1a36182709852829827005f90eef8bf78c) | Account holder address. +`public GoInt64_ `[`Coins`](#structwallet_____ux_balance_1a7733f16af3115d3cfc712f2f687b73e4) | Coins amount (e.g. in SKY). +`public GoInt64_ `[`Hours`](#structwallet_____ux_balance_1a7aef551ad5991173b5a6160fd8fe1594) | Balance of Coin Hours generated by underlying UxOut, depending on UxOut's head time. + +## Members + +#### `public cipher__SHA256 `[`Hash`](#structwallet_____ux_balance_1ac47f1b6e05da3c25722b2cc93728ee4d) + +Hash of underlying UxOut. + +#### `public GoInt64_ `[`BkSeq`](#structwallet_____ux_balance_1a1c1b05acfa8b1a65809ba4525f14a55b) + +Block height corresponding to the moment balance calculation is performed at. + +#### `public `[`cipher__Address`](#structcipher_____address)` `[`Address`](#structwallet_____ux_balance_1a36182709852829827005f90eef8bf78c) + +Account holder address. + +#### `public GoInt64_ `[`Coins`](#structwallet_____ux_balance_1a7733f16af3115d3cfc712f2f687b73e4) + +Coins amount (e.g. in SKY). + +#### `public GoInt64_ `[`Hours`](#structwallet_____ux_balance_1a7aef551ad5991173b5a6160fd8fe1594) + +Balance of Coin Hours generated by underlying UxOut, depending on UxOut's head time. + +Generated by [Moxygen](https://sourcey.com/moxygen) \ No newline at end of file diff --git a/lib/cgo/README.md b/lib/cgo/README.md index 20208aa57..bfec00c5e 100644 --- a/lib/cgo/README.md +++ b/lib/cgo/README.md @@ -144,9 +144,9 @@ invoking `SKY_handle_close` API function. Follow these steps to generate API documentation. -- [Install `doxygen`](https://www.stack.nl/~dimitri/doxygen/manual/install.html) +- Install `doxygen` like so: `sudo apt-get install doxygen` - Install `moxygen` like so: `npm install moxygen -g` - At the project top-level folder invoke `make docs-libc` (libskycoin docs only) or `make docs` (all docs). -Both `doxygen` and `moxygen` are pre-installed in [`skycoin/skycoindev-cli:develop`](https://hub.docker.com/r/skycoin/skycoindev-cli) Docker image. +`doxygen` and `moxygen` generate documentation for cryptographic API. Both are are pre-installed in [`skycoin/skycoindev-cli:develop`](https://hub.docker.com/r/skycoin/skycoindev-cli) Docker image.