hiro

package
v0.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 27, 2024 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const DefaultApiBase = "https://api.hiro.so"

Variables

This section is empty.

Functions

func ContractValidateSplit 

func ContractValidateSplit(c string) ([]string, error)

Types

type APIClient 

type APIClient struct {
	BaseURL string
	Client  *http.Client
}

func NewAPIClient 

func NewAPIClient(baseURL string) *APIClient

func (*APIClient) GetAccountBalance 

func (c *APIClient) GetAccountBalance(principal string) (BalanceResponse, error)

func (*APIClient) GetAllTokens 

func (c *APIClient) GetAllTokens() ([]TokenResult, error)

func (*APIClient) GetContractDetails 

func (c *APIClient) GetContractDetails(contractID string) (ContractDetailsResponse, error)

func (*APIClient) GetContractReadOnly 

func (c *APIClient) GetContractReadOnly(id string, function string, responseType string, arguments []string) (string, error)

func (*APIClient) GetContractSource 

func (c *APIClient) GetContractSource(id string) (string, error)

func (*APIClient) GetNFTHoldings 

func (c *APIClient) GetNFTHoldings(principal string) ([]NFTHoldingResponseResults, error)

func (*APIClient) GetTokenHolders 

func (c *APIClient) GetTokenHolders(contractID string, block int) (ContractHoldersResponse, error)

func (*APIClient) GetTransactions added in v0.0.11 

func (c *APIClient) GetTransactions(principal string) ([]Transaction, error)

type Balance 

type Balance struct {
	Balance       string `json:"balance"`
	TotalSent     string `json:"total_sent"`
	TotalReceived string `json:"total_received"`
}

type BalanceResponse 

type BalanceResponse struct {
	Stx               Balance           `json:"stx"`
	FungibleTokens    FungibleTokens    `json:"fungible_tokens"`
	NonFungibleTokens NonFungibleTokens `json:"non_fungible_tokens"`
}

type ContractDetailsResponse 

type ContractDetailsResponse struct {
	TxID           string `json:"tx_id"`
	Canonical      bool   `json:"canonical"`
	ContractID     string `json:"contract_id"`
	BlockHeight    int    `json:"block_height"`
	ClarityVersion int    `json:"clarity_version"`
	SourceCode     string `json:"source_code"`
	ABI            string `json:"abi"`
}

type ContractHoldersResponse 

type ContractHoldersResponse map[string]string

type ContractSourceResponse 

type ContractSourceResponse struct {
	Source        string `json:"source"`
	PublishHeight int    `json:"publish_height"`
	Proof         string `json:"proof"`
}

type Events added in v0.0.11 

type Events struct {
	Stx Stx `json:"stx,omitempty"`
	Ft  Ft  `json:"ft,omitempty"`
	Nft Nft `json:"nft,omitempty"`
}

type Ft added in v0.0.11 

type Ft struct {
	Transfer int `json:"transfer,omitempty"`
	Mint     int `json:"mint,omitempty"`
	Burn     int `json:"burn,omitempty"`
}

type FungibleTokens 

type FungibleTokens map[string]Balance

type NFTHoldingResponse 

type NFTHoldingResponse struct {
	Limit   int                         `json:"limit"`
	Offset  int                         `json:"offset"`
	Total   int                         `json:"total"`
	Results []NFTHoldingResponseResults `json:"results"`
}

type NFTHoldingResponseResults 

type NFTHoldingResponseResults struct {
	AssetIdentifier string                         `json:"asset_identifier"`
	Value           NFTHoldingResponseResultsValue `json:"value"`
	BlockHeight     int                            `json:"block_height"`
	TxID            string                         `json:"tx_id"`
}

type NFTHoldingResponseResultsValue 

type NFTHoldingResponseResultsValue struct {
	Hex  string `json:"hex"`
	Repr string `json:"repr"`
}

type Nft added in v0.0.11 

type Nft struct {
	Transfer int `json:"transfer,omitempty"`
	Mint     int `json:"mint,omitempty"`
	Burn     int `json:"burn,omitempty"`
}

type NonFungibleTokens 

type NonFungibleTokens map[string]struct {
	Count         string `json:"count"`
	TotalSent     string `json:"total_sent"`
	TotalReceived string `json:"total_received"`
}

type ReadOnlyPayload 

type ReadOnlyPayload struct {
	Sender    string   `json:"sender"`
	Arguments []string `json:"arguments"`
}

type ReadOnlyResponse 

type ReadOnlyResponse struct {
	Okay   bool   `json:"okay"`
	Result string `json:"result"`
}

type Response 

type Response struct {
	Limit   int           `json:"limit"`
	Offset  int           `json:"offset"`
	Total   int           `json:"total"`
	Results []TokenResult `json:"results"`
}

type Stx added in v0.0.11 

type Stx struct {
	Transfer int `json:"transfer,omitempty"`
	Mint     int `json:"mint,omitempty"`
	Burn     int `json:"burn,omitempty"`
}

type TokenResult 

type TokenResult struct {
	Name              string `json:"name"`
	Symbol            string `json:"symbol"`
	Decimals          int    `json:"decimals"`
	TotalSupply       string `json:"total_supply"`
	TokenURI          string `json:"token_uri"`
	Description       string `json:"description"`
	ImageURI          string `json:"image_uri"`
	ImageCanonicalURI string `json:"image_canonical_uri"`
	TxID              string `json:"tx_id"`
	SenderAddress     string `json:"sender_address"`
	ContractPrincipal string `json:"contract_principal"`
}

type TokenTransfer added in v0.0.11 

type TokenTransfer struct {
	RecipientAddress string `json:"recipient_address,omitempty"`
	Amount           string `json:"amount,omitempty"`
	Memo             string `json:"memo,omitempty"`
}

type Transaction added in v0.0.11 

type Transaction struct {
	Tx          Tx     `json:"tx,omitempty"`
	StxSent     string `json:"stx_sent,omitempty"`
	StxReceived string `json:"stx_received,omitempty"`
	Events      Events `json:"events,omitempty"`
}

type TransactionsResponse added in v0.0.11 

type TransactionsResponse struct {
	Limit   int           `json:"limit"`
	Offset  int           `json:"offset"`
	Total   int           `json:"total"`
	Results []Transaction `json:"results"`
}

type Tx added in v0.0.11 

type Tx struct {
	TxID                     string        `json:"tx_id,omitempty"`
	Nonce                    int           `json:"nonce,omitempty"`
	FeeRate                  string        `json:"fee_rate,omitempty"`
	SenderAddress            string        `json:"sender_address,omitempty"`
	Sponsored                bool          `json:"sponsored,omitempty"`
	PostConditionMode        string        `json:"post_condition_mode,omitempty"`
	PostConditions           []any         `json:"post_conditions,omitempty"`
	AnchorMode               string        `json:"anchor_mode,omitempty"`
	IsUnanchored             bool          `json:"is_unanchored,omitempty"`
	BlockHash                string        `json:"block_hash,omitempty"`
	ParentBlockHash          string        `json:"parent_block_hash,omitempty"`
	BlockHeight              int           `json:"block_height,omitempty"`
	BlockTime                int           `json:"block_time,omitempty"`
	BlockTimeIso             time.Time     `json:"block_time_iso,omitempty"`
	BurnBlockTime            int           `json:"burn_block_time,omitempty"`
	BurnBlockTimeIso         time.Time     `json:"burn_block_time_iso,omitempty"`
	ParentBurnBlockTime      int           `json:"parent_burn_block_time,omitempty"`
	ParentBurnBlockTimeIso   time.Time     `json:"parent_burn_block_time_iso,omitempty"`
	Canonical                bool          `json:"canonical,omitempty"`
	TxIndex                  int           `json:"tx_index,omitempty"`
	TxStatus                 string        `json:"tx_status,omitempty"`
	TxResult                 TxResult      `json:"tx_result,omitempty"`
	MicroblockHash           string        `json:"microblock_hash,omitempty"`
	MicroblockSequence       int64         `json:"microblock_sequence,omitempty"`
	MicroblockCanonical      bool          `json:"microblock_canonical,omitempty"`
	EventCount               int           `json:"event_count,omitempty"`
	Events                   []any         `json:"events,omitempty"`
	ExecutionCostReadCount   int           `json:"execution_cost_read_count,omitempty"`
	ExecutionCostReadLength  int           `json:"execution_cost_read_length,omitempty"`
	ExecutionCostRuntime     int           `json:"execution_cost_runtime,omitempty"`
	ExecutionCostWriteCount  int           `json:"execution_cost_write_count,omitempty"`
	ExecutionCostWriteLength int           `json:"execution_cost_write_length,omitempty"`
	TxType                   string        `json:"tx_type,omitempty"`
	TokenTransfer            TokenTransfer `json:"token_transfer,omitempty"`
}

type TxResult added in v0.0.11 

type TxResult struct {
	Hex  string `json:"hex,omitempty"`
	Repr string `json:"repr,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.