@lethean/api-apollo v1.2.2
@lethean/api-apollo
@LetheanApiApollo - JavaScript client for @lethean/api-apollo Distributed Virtual Private Marketplace This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.2.2
- Package version: 1.2.2
- Build package: org.openapitools.codegen.languages.JavascriptApolloClientCodegen For more information, please visit https://lt.hn
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install @lethean/api-apollo --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your @lethean/api-apollo from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/lthn.io/projects/sdk/clients/javascript-apollo then install it via:
npm install lthn.io/projects/sdk/clients/javascript-apollo --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var @LetheanApiApollo = require('@lethean/api-apollo');
var api = new @LetheanApiApollo.ExplorerApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getActivity(callback);
Documentation for API Endpoints
All URIs are relative to https://dvpm.io
Class | Method | HTTP request | Description |
---|---|---|---|
@LetheanApiApollo.ExplorerApi | getActivity | GET /v1/explorer/activity | |
@LetheanApiApollo.ExplorerApi | getBlock | GET /v1/explorer/chain/block/{id} | |
@LetheanApiApollo.ExplorerApi | getEmission | GET /v1/explorer/chain/emission | |
@LetheanApiApollo.ExplorerApi | getMempool | GET /v1/explorer/chain/mempool | |
@LetheanApiApollo.ExplorerApi | getNetworkInfo | GET /v1/explorer/chain/stats | |
@LetheanApiApollo.ExplorerApi | getOutputsBlocks | GET /v1/explorer/chain/block/outputs | |
@LetheanApiApollo.ExplorerApi | getRawBlockData | GET /v1/explorer/chain/block/raw/{id} | |
@LetheanApiApollo.ExplorerApi | getRawTransactionData | GET /v1/explorer/chain/transaction/raw/{tx_hash} | |
@LetheanApiApollo.ExplorerApi | getTransaction | GET /v1/explorer/chain/transaction/{tx_hash} | |
@LetheanApiApollo.ExplorerApi | getTransactions | GET /v1/explorer/chain/transactions | |
@LetheanApiApollo.ExplorerApi | getVersion | GET /v1/explorer/chain/version | |
@LetheanApiApollo.ExplorerApi | proveTransfer | GET /v1/explorer/validate/transfer | |
@LetheanApiApollo.ExplorerApi | searchChain | GET /v1/explorer/chain/search/{id} | |
@LetheanApiApollo.VpnApi | listServices | GET /v1/services/public-nodes |
Documentation for Models
- @LetheanApiApollo.Activity
- @LetheanApiApollo.BlockDTO
- @LetheanApiApollo.BlockEntity
- @LetheanApiApollo.BlockOutputEntity
- @LetheanApiApollo.BlockOutputsDTO
- @LetheanApiApollo.BlockOutputsEntity
- @LetheanApiApollo.CertificatesEntity
- @LetheanApiApollo.Commit
- @LetheanApiApollo.CommitAuthor
- @LetheanApiApollo.CommitLink
- @LetheanApiApollo.CommitMediaThumbnail
- @LetheanApiApollo.CommitSummary
- @LetheanApiApollo.EcdhInfo
- @LetheanApiApollo.EmissionDTO
- @LetheanApiApollo.EmissionEntity
- @LetheanApiApollo.InputsEntity
- @LetheanApiApollo.MempoolDTO
- @LetheanApiApollo.MempoolEntity
- @LetheanApiApollo.MgsEntity
- @LetheanApiApollo.MixinEntity
- @LetheanApiApollo.NetworkStatsDTO
- @LetheanApiApollo.NetworkStatsEntity
- @LetheanApiApollo.OutputEntity
- @LetheanApiApollo.ProveTransferDTO
- @LetheanApiApollo.ProveTransferEntity
- @LetheanApiApollo.ProveTransferOutputsEntity
- @LetheanApiApollo.ProxySettingsEntity
- @LetheanApiApollo.RangeSigsEntity
- @LetheanApiApollo.RawBlockDTO
- @LetheanApiApollo.RawBlockEntity
- @LetheanApiApollo.RawBlockMinerTx
- @LetheanApiApollo.RawBlockMinerVin
- @LetheanApiApollo.RawBlockMinerVinGen
- @LetheanApiApollo.RawBlockMinerVout
- @LetheanApiApollo.RawTransactionDTO
- @LetheanApiApollo.RawTransactionEntity
- @LetheanApiApollo.RawTransactionEntityVin
- @LetheanApiApollo.RawTransactionEntityVinKey
- @LetheanApiApollo.RawTransactionEntityVout
- @LetheanApiApollo.RawTransactionEntityVoutTarget
- @LetheanApiApollo.RawTransactionRctSignature
- @LetheanApiApollo.RctSigEntity
- @LetheanApiApollo.RctSigPrunable
- @LetheanApiApollo.SearchDTO
- @LetheanApiApollo.SearchEntity
- @LetheanApiApollo.ServiceEntity
- @LetheanApiApollo.TimeRangeEntity
- @LetheanApiApollo.TransactionBlock
- @LetheanApiApollo.TransactionDTO
- @LetheanApiApollo.TransactionEntity
- @LetheanApiApollo.TransactionsDTO
- @LetheanApiApollo.TransactionsEntity
- @LetheanApiApollo.TxnEntity
- @LetheanApiApollo.VersionDTO
- @LetheanApiApollo.VersionEntity
- @LetheanApiApollo.VoutTarget
- @LetheanApiApollo.VpnSettingsEntity
Documentation for Authorization
All endpoints do not require authorization.