stacks

Documentation

Overview

Package stacks

This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).

Index

• Constants
• Variables
• type ClientInterface
  • func NewClient(configuration Configuration) ClientInterface
• type Configuration
  • func CreateConfiguration(options ...ConfigurationOptions) Configuration
  • func CreateConfigurationFromEnvironment(options ...ConfigurationOptions) Configuration
  • func DefaultConfiguration() Configuration
  • func (c *Configuration) Environment() Environment
  • func (c *Configuration) HttpConfiguration() HttpConfiguration
• type ConfigurationOptions
  • func WithBaseUri(uri string) ConfigurationOptions
  • func WithEnvironment(environment Environment) ConfigurationOptions
  • func WithHttpConfiguration(httpConfiguration HttpConfiguration) ConfigurationOptions
  • func WithLogger(loggerHandler *logger.Logger) ConfigurationOptions
  • func WithVerbose(v bool) ConfigurationOptions
• type Environment
• type HttpConfiguration
  • func CreateHttpConfiguration(options ...HttpConfigurationOptions) HttpConfiguration
  • func DefaultHttpConfiguration() HttpConfiguration
• type HttpConfigurationOptions
• type RetryConfiguration
  • func CreateRetryConfiguration(options ...RetryConfigurationOptions) RetryConfiguration
  • func DefaultRetryConfiguration() RetryConfiguration
• type RetryConfigurationOptions
• type Server

Constants

const (
	MAINNET_URI string = "https://api.mainnet.hiro.so/"
	TESTNET_URI string = "https://api.testnet.hiro.so/"
)

const UserAgent = "APIMATIC 3.0"

Variables

var NewHttpConfiguration = https.NewHttpConfiguration

NewHttpConfiguration creates a new HttpConfiguration.

var NewRetryConfiguration = https.NewRetryConfiguration

NewRetryConfiguration creates a new RetryConfiguration.

var WithBackoffFactor = https.WithBackoffFactor

WithBackoffFactor sets the BackoffFactor.

var WithHttpMethodsToRetry = https.WithHttpMethodsToRetry

WithHttpMethodsToRetry sets the HttpMethodsToRetry.

var WithHttpStatusCodesToRetry = https.WithHttpStatusCodesToRetry

WithHttpStatusCodesToRetry sets the HttpStatusCodesToRetry.

var WithMaxRetryAttempts = https.WithMaxRetryAttempts

WithMaxRetryAttempts sets the MaxRetryAttempts.

var WithMaximumRetryWaitTime = https.WithMaximumRetryWaitTime

WithMaximumRetryWaitTime sets the MaximumRetryWaitTime.

var WithRetryConfiguration = https.WithRetryConfiguration

WithRetryConfiguration sets the RetryConfiguration.

var WithRetryInterval = https.WithRetryInterval

WithRetryInterval sets the RetryInterval.

var WithRetryOnTimeout = https.WithRetryOnTimeout

WithRetryOnTimeout sets the RetryOnTimeout.

var WithTimeout = https.WithTimeout

WithTimeout sets the Timeout.

var WithTransport = https.WithTransport

WithTransport sets the Transport.

Types

type ClientInterface

type ClientInterface interface {
	Configuration() *Configuration
	AccountsController() *controllers.AccountsController
	BlocksController() *controllers.BlocksController
	BurnBlocksController() *controllers.BurnBlocksController
	FaucetsController() *controllers.FaucetsController
	FeesController() *controllers.FeesController
	InfoController() *controllers.InfoController
	MicroblocksController() *controllers.MicroblocksController
	NamesController() *controllers.NamesController
	NonFungibleTokensController() *controllers.NonFungibleTokensController
	RosettaController() *controllers.RosettaController
	SearchController() *controllers.SearchController
	SmartContractsController() *controllers.SmartContractsController
	StackingRewardsController() *controllers.StackingRewardsController
	TransactionsController() *controllers.TransactionsController
	MempoolController() *controllers.MempoolController
	StackingController() *controllers.StackingController
}

Client is an interface representing the main client for accessing configuration and controllers.

func NewClient

func NewClient(configuration Configuration) ClientInterface

NewClient is the constructor for creating a new client instance. It takes a Configuration object as a parameter and returns the Client interface.

type Configuration

type Configuration struct {
	// contains filtered or unexported fields
}

Configuration holds configuration settings.

func CreateConfiguration

func CreateConfiguration(options ...ConfigurationOptions) Configuration

CreateConfiguration creates a new Configuration with the provided options.

func CreateConfigurationFromEnvironment

func CreateConfigurationFromEnvironment(options ...ConfigurationOptions) Configuration

CreateConfigurationFromEnvironment creates a new Configuration with default settings. It also configures various Configuration options.

func DefaultConfiguration

func DefaultConfiguration() Configuration

DefaultConfiguration returns the default Configuration.

func (*Configuration) Environment

func (c *Configuration) Environment() Environment

Environment returns the Environment from the Configuration.

func (*Configuration) HttpConfiguration

func (c *Configuration) HttpConfiguration() HttpConfiguration

HttpConfiguration returns the HttpConfiguration from the Configuration.

type ConfigurationOptions

type ConfigurationOptions func(*Configuration)

ConfigurationOptions represents a function type that can be used to apply options to the Configuration struct.

func WithBaseUri

func WithBaseUri(uri string) ConfigurationOptions

WithBaseUri is an option that sets the Base URI in the Configuration.

func WithEnvironment

func WithEnvironment(environment Environment) ConfigurationOptions

WithEnvironment is an option that sets the Environment in the Configuration.

func WithHttpConfiguration

func WithHttpConfiguration(httpConfiguration HttpConfiguration) ConfigurationOptions

WithHttpConfiguration is an option that sets the HttpConfiguration in the Configuration.

func WithLogger

func WithLogger(loggerHandler *logger.Logger) ConfigurationOptions

WithLogger is an option that sets the Logger in the Configuration.

func WithVerbose

func WithVerbose(v bool) ConfigurationOptions

WithVerbose is an option that sets the log verbosity in the Configuration.

type Environment

type Environment string

Environment represents available environments.

const (
	PRODUCTION   Environment = "production"
	ENVIRONMENT2 Environment = "environment2"
	ENVIRONMENT3 Environment = "environment3"
)

type HttpConfiguration

type HttpConfiguration = https.HttpConfiguration

HttpConfiguration holds the configuration options for the client.

func CreateHttpConfiguration

func CreateHttpConfiguration(options ...HttpConfigurationOptions) HttpConfiguration

CreateHttpConfiguration creates a new HttpConfiguration with the provided options.

func DefaultHttpConfiguration

func DefaultHttpConfiguration() HttpConfiguration

DefaultHttpConfiguration returns the default HttpConfiguration for HTTP requests. It also configures various HttpConfiguration options.

type HttpConfigurationOptions

type HttpConfigurationOptions = https.HttpConfigurationOptions

HttpConfigurationOptions is a function type that modifies the HttpConfiguration.

type RetryConfiguration

type RetryConfiguration = https.RetryConfiguration

RetryConfiguration holds the configuration options for the client.

func CreateRetryConfiguration

func CreateRetryConfiguration(options ...RetryConfigurationOptions) RetryConfiguration

CreateRetryConfiguration creates a new RetryConfiguration with the provided options.

func DefaultRetryConfiguration

func DefaultRetryConfiguration() RetryConfiguration

DefaultRetryConfiguration returns the default RetryConfiguration for HTTP requests. It also configures various retry options.

type RetryConfigurationOptions

type RetryConfigurationOptions = https.RetryConfigurationOptions

RetryConfigurationOptions is a function type that modifies the RetryConfiguration.

type Server

type Server string

Server represents available servers.

const (
	ENUMDEFAULT Server = "default"
)