# Packages

test

No description provided by the author

Go API client for rpc_client

This is the documentation for the stacks-node RPC interface.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 1.0.0
Package version: 1.0.0
Generator version: 7.8.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import rpc_client "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value rpc_client.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), rpc_client.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value rpc_client.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), rpc_client.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using rpc_client.ContextOperationServerIndices and rpc_client.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), rpc_client.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), rpc_client.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost:20443

Class	Method	HTTP request	Description
AccountsAPI	GetAccountInfo	Get /v2/accounts/{principal}	Get account info
BlocksAPI	GetBlockV3	Get /v3/blocks/{block_id}	Fetch a Nakamoto block
BlocksAPI	GetTenureInfo	Get /v3/tenures/info	Fetch metadata about the ongoing Nakamoto tenure
BlocksAPI	GetTenures	Get /v3/tenures/{block_id}	Fetch a sequence of Nakamoto blocks in a tenure
FeesAPI	GetFeeTransfer	Get /v2/fees/transfer	Get estimated fee
FeesAPI	PostFeeTransaction	Post /v2/fees/transaction	Get approximate fees for the given transaction
InfoAPI	GetBurnOps	Get /v2/burn_ops/{burn_height}/{op_type}	Get burn operations
InfoAPI	GetCoreApiInfo	Get /v2/info	Get Core API info
InfoAPI	GetPoxInfo	Get /v2/pox	Get PoX details
MiningAPI	GetStackerSet	Get /v2/stacker_set/{cycle_number}	Fetch the stacker and signer set information for a given cycle.
MiningAPI	PostBlockProposal	Post /v2/block_proposal	Validate a proposed Stacks block
SmartContractsAPI	CallReadOnlyFunction	Post /v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}	Call read-only function
SmartContractsAPI	GetConstantVal	Post /v2/constant_val/{contract_address}/{contract_name}/{constant_name}	Get the value of a constant inside a contract
SmartContractsAPI	GetContractDataMapEntry	Post /v2/map_entry/{contract_address}/{contract_name}/{map_name}	Get specific data-map inside a contract
SmartContractsAPI	GetContractInterface	Get /v2/contracts/interface/{contract_address}/{contract_name}	Get contract interface
SmartContractsAPI	GetContractSource	Get /v2/contracts/source/{contract_address}/{contract_name}	Get contract source
SmartContractsAPI	GetIsTraitImplemented	Get /v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}	Get trait implementation details
TransactionsAPI	PostCoreNodeTransactions	Post /v2/transactions	Broadcast raw transaction

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime