client

package
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Mar 4, 2024 License: MIT Imports: 8 Imported by: 8

Documentation

Index

Constants

View Source 
const (
	BlockFilterModeExcludeNone  = api.BlockFilterModeExcludeNone
	BlockFilterModeExcludeEmpty = api.BlockFilterModeExcludeEmpty
	TxFetchModeExpand           = api.TxFetchModeExpand
	TxFetchModeIds              = api.TxFetchModeIds
	TxFetchModeCountOnly        = api.TxFetchModeCountOnly
	TxFetchModeOmit             = api.TxFetchModeOmit
)

Enums exported from internal/api/v2/query

View Source 
const (
	ErrCodeInternal           = api.ErrCodeInternal
	ErrCodeDispatch           = api.ErrCodeDispatch
	ErrCodeValidation         = api.ErrCodeValidation
	ErrCodeSubmission         = api.ErrCodeSubmission
	ErrCodeAccumulate         = api.ErrCodeAccumulate
	ErrCodeNotLiteAccount     = api.ErrCodeNotLiteAccount
	ErrCodeNotAcmeAccount     = api.ErrCodeNotAcmeAccount
	ErrCodeNotFound           = api.ErrCodeNotFound
	ErrCodeCanceled           = api.ErrCodeCanceled
	ErrCodeMetricsQuery       = api.ErrCodeMetricsQuery
	ErrCodeMetricsNotAVector  = api.ErrCodeMetricsNotAVector
	ErrCodeMetricsVectorEmpty = api.ErrCodeMetricsVectorEmpty
	ErrCodeProtocolBase       = api.ErrCodeProtocolBase
)

Error codes exported from internal/api/v2

Variables

View Source 
var (
	ErrInternal           = api.ErrInternal
	ErrCanceled           = api.ErrCanceled
	ErrMetricsNotAVector  = api.ErrMetricsNotAVector
	ErrMetricsVectorEmpty = api.ErrMetricsVectorEmpty
	ErrInvalidUrl         = api.ErrInvalidUrl
)

Errors exported from internal/api/v2

Functions

This section is empty.

Types

type BlockFilterMode 

type BlockFilterMode = api.BlockFilterMode

Types exported from internal/api/v2/query

func BlockFilterModeByName 

func BlockFilterModeByName(name string) (BlockFilterMode, bool)

type ChainEntry 

type ChainEntry = api.ChainEntry

Types exported from internal/api/v2

type ChainIdQuery 

type ChainIdQuery = api.ChainIdQuery

Types exported from internal/api/v2

type ChainQueryResponse 

type ChainQueryResponse = api.ChainQueryResponse

Types exported from internal/api/v2

type ChainState 

type ChainState = api.ChainState

Types exported from internal/api/v2/query

type Client 

type Client struct {
	jsonrpc2.Client
	// contains filtered or unexported fields
}

func New 

func New(server string) (*Client, error)

New creates new API client with default config

func (*Client) Describe 

func (c *Client) Describe(ctx context.Context) (*api.DescriptionResponse, error)

Describe queries the basic configuration of the node.

func (*Client) Execute 

func (c *Client) Execute(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

Execute submits a transaction.

func (*Client) ExecuteAddCredits 

func (c *Client) ExecuteAddCredits(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteAddCredits submits an AddCredits transaction.

func (*Client) ExecuteBurnTokens 

func (c *Client) ExecuteBurnTokens(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteBurnTokens submits a BurnTokens transaction.

func (*Client) ExecuteCreateAdi 

func (c *Client) ExecuteCreateAdi(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteCreateAdi submits a CreateIdentity transaction.

func (*Client) ExecuteCreateDataAccount 

func (c *Client) ExecuteCreateDataAccount(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteCreateDataAccount submits a CreateDataAccount transaction.

func (*Client) ExecuteCreateIdentity 

func (c *Client) ExecuteCreateIdentity(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteCreateIdentity submits a CreateIdentity transaction.

func (*Client) ExecuteCreateKeyBook 

func (c *Client) ExecuteCreateKeyBook(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteCreateKeyBook submits a CreateKeyBook transaction.

func (*Client) ExecuteCreateKeyPage 

func (c *Client) ExecuteCreateKeyPage(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteCreateKeyPage submits a CreateKeyPage transaction.

func (*Client) ExecuteCreateToken 

func (c *Client) ExecuteCreateToken(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteCreateToken submits a CreateToken transaction.

func (*Client) ExecuteCreateTokenAccount 

func (c *Client) ExecuteCreateTokenAccount(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteCreateTokenAccount submits a CreateTokenAccount transaction.

func (*Client) ExecuteDirect 

func (c *Client) ExecuteDirect(ctx context.Context, req *api.ExecuteRequest) (*api.TxResponse, error)

ExecuteDirect submits a transaction.

func (*Client) ExecuteIssueTokens 

func (c *Client) ExecuteIssueTokens(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteIssueTokens submits an IssueTokens transaction.

func (*Client) ExecuteLocal 

func (c *Client) ExecuteLocal(ctx context.Context, req *api.ExecuteRequest) (*api.TxResponse, error)

ExecuteLocal submits a transaction without routing it. INTENDED FOR INTERNAL USE ONLY.

func (*Client) ExecuteSendTokens 

func (c *Client) ExecuteSendTokens(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteSendTokens submits a SendTokens transaction.

func (*Client) ExecuteUpdateAccountAuth 

func (c *Client) ExecuteUpdateAccountAuth(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteUpdateAccountAuth submits an UpdateAccountAuth transaction.

func (*Client) ExecuteUpdateKey 

func (c *Client) ExecuteUpdateKey(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteUpdateKey submits an UpdateKey transaction.

func (*Client) ExecuteUpdateKeyPage 

func (c *Client) ExecuteUpdateKeyPage(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteUpdateKeyPage submits an UpdateKeyPage transaction.

func (*Client) ExecuteWriteData 

func (c *Client) ExecuteWriteData(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteWriteData submits a WriteData transaction.

func (*Client) ExecuteWriteDataTo 

func (c *Client) ExecuteWriteDataTo(ctx context.Context, req *api.TxRequest) (*api.TxResponse, error)

ExecuteWriteDataTo submits a WriteDataTo transaction.

func (*Client) Faucet 

func (c *Client) Faucet(ctx context.Context, req *protocol.AcmeFaucet) (*api.TxResponse, error)

Faucet requests tokens from the ACME faucet.

func (*Client) Metrics 

func (c *Client) Metrics(ctx context.Context, req *api.MetricsQuery) (*api.ChainQueryResponse, error)

Metrics queries network metrics, such as transactions per second.

func (*Client) Query 

func (c *Client) Query(ctx context.Context, req *api.GeneralQuery) (interface{}, error)

Query queries an account or account chain by URL.

func (*Client) QueryAccountAs 

func (c *Client) QueryAccountAs(ctx context.Context, req *api.GeneralQuery, target interface{}) (*api.ChainQueryResponse, error)

func (*Client) QueryData 

func (c *Client) QueryData(ctx context.Context, req *api.DataEntryQuery) (*api.ChainQueryResponse, error)

QueryData queries an entry on an account's data chain.

func (*Client) QueryDataSet 

func (c *Client) QueryDataSet(ctx context.Context, req *api.DataEntrySetQuery) (*api.MultiResponse, error)

QueryDataSet queries a range of entries on an account's data chain.

func (*Client) QueryDirectory 

func (c *Client) QueryDirectory(ctx context.Context, req *api.DirectoryQuery) (*api.MultiResponse, error)

QueryDirectory queries the directory entries of an account.

func (*Client) QueryKeyPageIndex 

func (c *Client) QueryKeyPageIndex(ctx context.Context, req *api.KeyPageIndexQuery) (*api.ChainQueryResponse, error)

QueryKeyPageIndex queries the location of a key within an account's key book(s).

func (*Client) QueryMajorBlocks 

func (c *Client) QueryMajorBlocks(ctx context.Context, req *api.MajorBlocksQuery) (*api.MultiResponse, error)

QueryMajorBlocks queries an account's major blocks.

WARNING: EXPERIMENTAL!

func (*Client) QueryMinorBlocks 

func (c *Client) QueryMinorBlocks(ctx context.Context, req *api.MinorBlocksQuery) (*api.MultiResponse, error)

QueryMinorBlocks queries an account's minor blocks.

WARNING: EXPERIMENTAL!

func (*Client) QuerySynth 

func (c *Client) QuerySynth(ctx context.Context, req *api.SyntheticTransactionRequest) (*api.TransactionQueryResponse, error)

WARNING: EXPERIMENTAL!

func (*Client) QueryTx 

func (c *Client) QueryTx(ctx context.Context, req *api.TxnQuery) (*api.TransactionQueryResponse, error)

QueryTx queries a transaction by ID.

func (*Client) QueryTxHistory 

func (c *Client) QueryTxHistory(ctx context.Context, req *api.TxHistoryQuery) (*api.MultiResponse, error)

QueryTxHistory queries an account's transaction history.

func (*Client) QueryTxLocal 

func (c *Client) QueryTxLocal(ctx context.Context, req *api.TxnQuery) (*api.TransactionQueryResponse, error)

QueryTxLocal queries a transaction by ID.

func (*Client) RequestAPIv2 

func (c *Client) RequestAPIv2(ctx context.Context, method string, params, result interface{}) error

RequestAPIv2 makes a JSON RPC request to the Accumulate API v2.

func (*Client) Status 

func (c *Client) Status(ctx context.Context) (*api.StatusResponse, error)

Status queries the status of the node.

func (*Client) Version 

func (c *Client) Version(ctx context.Context) (*api.ChainQueryResponse, error)

Version queries the software version of the node.

type DataEntryQuery 

type DataEntryQuery = api.DataEntryQuery

Types exported from internal/api/v2

type DataEntrySetQuery 

type DataEntrySetQuery = api.DataEntrySetQuery

Types exported from internal/api/v2

type DescriptionResponse 

type DescriptionResponse = api.DescriptionResponse

Types exported from internal/api/v2

type DirectoryQuery 

type DirectoryQuery = api.DirectoryQuery

Types exported from internal/api/v2

type ExecuteRequest 

type ExecuteRequest = api.ExecuteRequest

Types exported from internal/api/v2

type GeneralQuery 

type GeneralQuery = api.GeneralQuery

Types exported from internal/api/v2

type GeneralReceipt 

type GeneralReceipt = api.GeneralReceipt

Types exported from internal/api/v2/query

type KeyPage 

type KeyPage = api.KeyPage

Types exported from internal/api/v2

type KeyPageIndexQuery 

type KeyPageIndexQuery = api.KeyPageIndexQuery

Types exported from internal/api/v2

type MajorBlocksQuery 

type MajorBlocksQuery = api.MajorBlocksQuery

Types exported from internal/api/v2

type MajorQueryResponse 

type MajorQueryResponse = api.MajorQueryResponse

Types exported from internal/api/v2

type MerkleState 

type MerkleState = api.MerkleState

Types exported from internal/api/v2

type MetricsQuery 

type MetricsQuery = api.MetricsQuery

Types exported from internal/api/v2

type MetricsResponse 

type MetricsResponse = api.MetricsResponse

Types exported from internal/api/v2

type MinorBlock 

type MinorBlock = api.MinorBlock

Types exported from internal/api/v2

type MinorBlocksQuery 

type MinorBlocksQuery = api.MinorBlocksQuery

Types exported from internal/api/v2

type MinorQueryResponse 

type MinorQueryResponse = api.MinorQueryResponse

Types exported from internal/api/v2

type MultiResponse 

type MultiResponse = api.MultiResponse

Types exported from internal/api/v2

type QueryOptions 

type QueryOptions = api.QueryOptions

Types exported from internal/api/v2

type QueryPagination 

type QueryPagination = api.QueryPagination

Types exported from internal/api/v2

type ResponseDataEntry 

type ResponseDataEntry = api.ResponseDataEntry

Types exported from internal/api/v2/query

type ResponseDataEntrySet 

type ResponseDataEntrySet = api.ResponseDataEntrySet

Types exported from internal/api/v2/query

type ResponseKeyPageIndex 

type ResponseKeyPageIndex = api.ResponseKeyPageIndex

Types exported from internal/api/v2/query

type SignatureBook 

type SignatureBook = api.SignatureBook

Types exported from internal/api/v2

type SignaturePage 

type SignaturePage = api.SignaturePage

Types exported from internal/api/v2

type Signer 

type Signer = api.Signer

Types exported from internal/api/v2

type SignerMetadata 

type SignerMetadata = api.SignerMetadata

Types exported from internal/api/v2

type StatusResponse 

type StatusResponse = api.StatusResponse

Types exported from internal/api/v2

type SyntheticTransactionRequest 

type SyntheticTransactionRequest = api.SyntheticTransactionRequest

Types exported from internal/api/v2

type TokenDeposit 

type TokenDeposit = api.TokenDeposit

Types exported from internal/api/v2

type TokenSend 

type TokenSend = api.TokenSend

Types exported from internal/api/v2

type TransactionQueryResponse 

type TransactionQueryResponse = api.TransactionQueryResponse

Types exported from internal/api/v2

type TxFetchMode 

type TxFetchMode = api.TxFetchMode

Types exported from internal/api/v2/query

func TxFetchModeByName 

func TxFetchModeByName(name string) (TxFetchMode, bool)

type TxHistoryQuery 

type TxHistoryQuery = api.TxHistoryQuery

Types exported from internal/api/v2

type TxReceipt 

type TxReceipt = api.TxReceipt

Types exported from internal/api/v2/query

type TxRequest 

type TxRequest = api.TxRequest

Types exported from internal/api/v2

type TxResponse 

type TxResponse = api.TxResponse

Types exported from internal/api/v2

type TxnQuery 

type TxnQuery = api.TxnQuery

Types exported from internal/api/v2

type UrlQuery 

type UrlQuery = api.UrlQuery

Types exported from internal/api/v2

type VersionResponse 

type VersionResponse = api.VersionResponse

Types exported from internal/api/v2

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.