/neblio-api-lib-objective-c

Primary LanguageObjective-C

NeblioAPI

APIs for Interacting with NTP1 Tokens & The Neblio Blockchain

This ObjC package is automatically generated by the OpenAPI Generator project:

  • API version: 1.3.0
  • Package version:
  • Build package: org.openapitools.codegen.languages.ObjcClientCodegen

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod 'NeblioAPI', :git => 'https://github.com/NeblioTeam/neblio-api-lib-objective-c.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/NeblioAPI) and then add the following to the Podfile:

pod 'NeblioAPI', :path => 'Vendor/NeblioAPI'

Usage

Import the following:

#import <NeblioAPI/NEBLApiClient.h>
#import <NeblioAPI/NEBLDefaultConfiguration.h>
// load models
#import <NeblioAPI/NEBLBroadcastTxRequest.h>
#import <NeblioAPI/NEBLBroadcastTxResponse.h>
#import <NeblioAPI/NEBLBurnTokenRequest.h>
#import <NeblioAPI/NEBLBurnTokenRequestBurn.h>
#import <NeblioAPI/NEBLBurnTokenResponse.h>
#import <NeblioAPI/NEBLError.h>
#import <NeblioAPI/NEBLGetAddressInfoResponse.h>
#import <NeblioAPI/NEBLGetAddressInfoResponseTokens.h>
#import <NeblioAPI/NEBLGetAddressInfoResponseUtxos.h>
#import <NeblioAPI/NEBLGetAddressResponse.h>
#import <NeblioAPI/NEBLGetBlockIndexResponse.h>
#import <NeblioAPI/NEBLGetBlockResponse.h>
#import <NeblioAPI/NEBLGetFaucetResponse.h>
#import <NeblioAPI/NEBLGetFaucetResponseData.h>
#import <NeblioAPI/NEBLGetRawTxResponse.h>
#import <NeblioAPI/NEBLGetSyncResponse.h>
#import <NeblioAPI/NEBLGetTokenHoldersResponse.h>
#import <NeblioAPI/NEBLGetTokenHoldersResponseHolders.h>
#import <NeblioAPI/NEBLGetTokenIdResponse.h>
#import <NeblioAPI/NEBLGetTokenMetadataResponse.h>
#import <NeblioAPI/NEBLGetTokenMetadataResponseMetadataOfIssuance.h>
#import <NeblioAPI/NEBLGetTokenMetadataResponseMetadataOfIssuanceData.h>
#import <NeblioAPI/NEBLGetTokenMetadataResponseMetadataOfIssuanceDataUserData.h>
#import <NeblioAPI/NEBLGetTokenMetadataResponseMetadataOfIssuanceDataUserDataMeta.h>
#import <NeblioAPI/NEBLGetTokenMetadataResponseMetadataOfUtxo.h>
#import <NeblioAPI/NEBLGetTokenMetadataResponseMetadataOfUtxoUserData.h>
#import <NeblioAPI/NEBLGetTransactionInfoResponse.h>
#import <NeblioAPI/NEBLGetTransactionInfoResponsePreviousOutput.h>
#import <NeblioAPI/NEBLGetTransactionInfoResponseScriptSig.h>
#import <NeblioAPI/NEBLGetTransactionInfoResponseTokens.h>
#import <NeblioAPI/NEBLGetTransactionInfoResponseVin.h>
#import <NeblioAPI/NEBLGetTransactionInfoResponseVout.h>
#import <NeblioAPI/NEBLGetTxResponse.h>
#import <NeblioAPI/NEBLGetTxResponseVin.h>
#import <NeblioAPI/NEBLGetTxResponseVout.h>
#import <NeblioAPI/NEBLGetTxsResponse.h>
#import <NeblioAPI/NEBLIssueTokenRequest.h>
#import <NeblioAPI/NEBLIssueTokenRequestFlags.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadata.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadataEncryptions.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadataRules.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadataRulesExpiration.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadataRulesFees.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadataRulesFeesItems.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadataRulesHolders.h>
#import <NeblioAPI/NEBLIssueTokenRequestMetadataUrls.h>
#import <NeblioAPI/NEBLIssueTokenRequestTransfer.h>
#import <NeblioAPI/NEBLIssueTokenResponse.h>
#import <NeblioAPI/NEBLRpcRequest.h>
#import <NeblioAPI/NEBLRpcResponse.h>
#import <NeblioAPI/NEBLSendTokenRequest.h>
#import <NeblioAPI/NEBLSendTokenRequestTo.h>
#import <NeblioAPI/NEBLSendTokenResponse.h>
#import <NeblioAPI/NEBLSendTxRequest.h>
// load API classes for accessing endpoints
#import <NeblioAPI/NEBLInsightApi.h>
#import <NeblioAPI/NEBLJSONRPCApi.h>
#import <NeblioAPI/NEBLNTP1Api.h>
#import <NeblioAPI/NEBLTestnetFaucetApi.h>
#import <NeblioAPI/NEBLTestnetInsightApi.h>
#import <NeblioAPI/NEBLTestnetNTP1Api.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issues.

Getting Started

Please follow the installation procedure and then run the following:

NSString* *address = @"address_example"; // Address

NEBLInsightApi *apiInstance = [[NEBLInsightApi alloc] init];

// Returns address object
[apiInstance getAddressWithAddress:address
              completionHandler: ^(NEBLGetAddressResponse* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to https://ntp1node.nebl.io

Class Method HTTP request Description
NEBLInsightApi getAddress GET /ins/addr/{address} Returns address object
NEBLInsightApi getAddressBalance GET /ins/addr/{address}/balance Returns address balance in sats
NEBLInsightApi getAddressTotalReceived GET /ins/addr/{address}/totalReceived Returns total received by address in sats
NEBLInsightApi getAddressTotalSent GET /ins/addr/{address}/totalSent Returns total sent by address in sats
NEBLInsightApi getAddressUnconfirmedBalance GET /ins/addr/{address}/unconfirmedBalance Returns address unconfirmed balance in sats
NEBLInsightApi getAddressUtxos GET /ins/addr/{address}/utxo Returns all UTXOs at a given address
NEBLInsightApi getBlock GET /ins/block/{blockhash} Returns information regarding a Neblio block
NEBLInsightApi getBlockIndex GET /ins/block-index/{blockindex} Returns block hash of block
NEBLInsightApi getRawTx GET /ins/rawtx/{txid} Returns raw transaction hex
NEBLInsightApi getStatus GET /ins/status Utility API for calling several blockchain node functions
NEBLInsightApi getSync GET /ins/sync Get node sync status
NEBLInsightApi getTx GET /ins/tx/{txid} Returns transaction object
NEBLInsightApi getTxs GET /ins/txs Get transactions by block or address
NEBLInsightApi sendTx POST /ins/tx/send Broadcasts a signed raw transaction to the network (not NTP1 specific)
NEBLJSONRPCApi jsonRpc POST / Send a JSON-RPC call to a localhost neblio-Qt or nebliod node
NEBLNTP1Api broadcastTx POST /ntp1/broadcast Broadcasts a signed raw transaction to the network
NEBLNTP1Api burnToken POST /ntp1/burntoken Builds a transaction that burns an NTP1 Token
NEBLNTP1Api getAddressInfo GET /ntp1/addressinfo/{address} Information On a Neblio Address
NEBLNTP1Api getTokenHolders GET /ntp1/stakeholders/{tokenid} Get Addresses Holding a Token
NEBLNTP1Api getTokenId GET /ntp1/tokenid/{tokensymbol} Returns the tokenId representing a token
NEBLNTP1Api getTokenMetadata GET /ntp1/tokenmetadata/{tokenid} Get Metadata of Token
NEBLNTP1Api getTokenMetadataOfUtxo GET /ntp1/tokenmetadata/{tokenid}/{utxo} Get UTXO Metadata of Token
NEBLNTP1Api getTransactionInfo GET /ntp1/transactioninfo/{txid} Information On an NTP1 Transaction
NEBLNTP1Api issueToken POST /ntp1/issue Builds a transaction that issues a new NTP1 Token
NEBLNTP1Api sendToken POST /ntp1/sendtoken Builds a transaction that sends an NTP1 Token
NEBLTestnetFaucetApi testnetGetFaucet GET /testnet/faucet Withdraws testnet NEBL to the specified address
NEBLTestnetInsightApi testnetGetAddress GET /testnet/ins/addr/{address} Returns address object
NEBLTestnetInsightApi testnetGetAddressBalance GET /testnet/ins/addr/{address}/balance Returns address balance in sats
NEBLTestnetInsightApi testnetGetAddressTotalReceived GET /testnet/ins/addr/{address}/totalReceived Returns total received by address in sats
NEBLTestnetInsightApi testnetGetAddressTotalSent GET /testnet/ins/addr/{address}/totalSent Returns total sent by address in sats
NEBLTestnetInsightApi testnetGetAddressUnconfirmedBalance GET /testnet/ins/addr/{address}/unconfirmedBalance Returns address unconfirmed balance in sats
NEBLTestnetInsightApi testnetGetAddressUtxos GET /testnet/ins/addr/{address}/utxo Returns all UTXOs at a given address
NEBLTestnetInsightApi testnetGetBlock GET /testnet/ins/block/{blockhash} Returns information regarding a Neblio block
NEBLTestnetInsightApi testnetGetBlockIndex GET /testnet/ins/block-index/{blockindex} Returns block hash of block
NEBLTestnetInsightApi testnetGetRawTx GET /testnet/ins/rawtx/{txid} Returns raw transaction hex
NEBLTestnetInsightApi testnetGetStatus GET /testnet/ins/status Utility API for calling several blockchain node functions
NEBLTestnetInsightApi testnetGetSync GET /testnet/ins/sync Get node sync status
NEBLTestnetInsightApi testnetGetTx GET /testnet/ins/tx/{txid} Returns transaction object
NEBLTestnetInsightApi testnetGetTxs GET /testnet/ins/txs Get transactions by block or address
NEBLTestnetInsightApi testnetSendTx POST /testnet/ins/tx/send Broadcasts a signed raw transaction to the network (not NTP1 specific)
NEBLTestnetNTP1Api testnetBroadcastTx POST /testnet/ntp1/broadcast Broadcasts a signed raw transaction to the network
NEBLTestnetNTP1Api testnetBurnToken POST /testnet/ntp1/burntoken Builds a transaction that burns an NTP1 Token
NEBLTestnetNTP1Api testnetGetAddressInfo GET /testnet/ntp1/addressinfo/{address} Information On a Neblio Address
NEBLTestnetNTP1Api testnetGetTokenHolders GET /testnet/ntp1/stakeholders/{tokenid} Get Addresses Holding a Token
NEBLTestnetNTP1Api testnetGetTokenId GET /testnet/ntp1/tokenid/{tokensymbol} Returns the tokenId representing a token
NEBLTestnetNTP1Api testnetGetTokenMetadata GET /testnet/ntp1/tokenmetadata/{tokenid} Get Metadata of Token
NEBLTestnetNTP1Api testnetGetTokenMetadataOfUtxo GET /testnet/ntp1/tokenmetadata/{tokenid}/{utxo} Get UTXO Metadata of Token
NEBLTestnetNTP1Api testnetGetTransactionInfo GET /testnet/ntp1/transactioninfo/{txid} Information On an NTP1 Transaction
NEBLTestnetNTP1Api testnetIssueToken POST /testnet/ntp1/issue Builds a transaction that issues a new NTP1 Token
NEBLTestnetNTP1Api testnetSendToken POST /testnet/ntp1/sendtoken Builds a transaction that sends an NTP1 Token

Documentation For Models

Documentation For Authorization

rpcAuth

  • Type: HTTP basic authentication

Author