indexer

package
v1.9.0 Latest Latest
Warning

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

 Go to latest Published: Jun 17, 2021 License: MIT Imports: 6 Imported by: 38

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client common.Client

func MakeClient 

func MakeClient(address string, apiToken string) (c *Client, err error)

MakeClient is the factory for constructing a ClientV2 for a given endpoint.

func MakeClientWithHeaders added in v1.8.0 

func MakeClientWithHeaders(address string, apiToken string, headers []*common.Header) (c *Client, err error)

MakeClientWithHeaders is the factory for constructing a ClientV2 for a given endpoint with custom headers.

func (*Client) HealthCheck 

func (c *Client) HealthCheck() *HealthCheck

func (*Client) LookupAccountByID 

func (c *Client) LookupAccountByID(accountId string) *LookupAccountByID

func (*Client) LookupAccountTransactions 

func (c *Client) LookupAccountTransactions(accountId string) *LookupAccountTransactions

func (*Client) LookupApplicationByID added in v1.5.0 

func (c *Client) LookupApplicationByID(applicationId uint64) *LookupApplicationByID

func (*Client) LookupAssetBalances 

func (c *Client) LookupAssetBalances(assetId uint64) *LookupAssetBalances

func (*Client) LookupAssetByID 

func (c *Client) LookupAssetByID(assetId uint64) *LookupAssetByID

func (*Client) LookupAssetTransactions 

func (c *Client) LookupAssetTransactions(assetId uint64) *LookupAssetTransactions

func (*Client) LookupBlock 

func (c *Client) LookupBlock(roundNumber uint64) *LookupBlock

func (*Client) LookupTransaction added in v1.6.0 

func (c *Client) LookupTransaction(txid string) *LookupTransaction

func (*Client) SearchAccounts 

func (c *Client) SearchAccounts() *SearchAccounts

func (*Client) SearchForApplications added in v1.5.0 

func (c *Client) SearchForApplications() *SearchForApplications

func (*Client) SearchForAssets 

func (c *Client) SearchForAssets() *SearchForAssets

func (*Client) SearchForTransactions 

func (c *Client) SearchForTransactions() *SearchForTransactions

type HealthCheck 

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

HealthCheck returns 200 if healthy.

func (*HealthCheck) Do 

func (s *HealthCheck) Do(ctx context.Context, headers ...*common.Header) (response models.HealthCheckResponse, err error)

Do performs the HTTP request

type LookupAccountByID 

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

LookupAccountByID lookup account information.

func (*LookupAccountByID) Do 

func (s *LookupAccountByID) Do(ctx context.Context, headers ...*common.Header) (validRound uint64, result models.Account, err error)

Do performs the HTTP request

func (*LookupAccountByID) IncludeAll added in v1.6.0 

func (s *LookupAccountByID) IncludeAll(IncludeAll bool) *LookupAccountByID

IncludeAll include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

func (*LookupAccountByID) Round 

func (s *LookupAccountByID) Round(Round uint64) *LookupAccountByID

Round include results for the specified round.

type LookupAccountByIDParams added in v1.6.0 

type LookupAccountByIDParams struct {

	// IncludeAll include all items including closed accounts, deleted applications,
	// destroyed assets, opted-out asset holdings, and closed-out application
	// localstates.
	IncludeAll bool `url:"include-all,omitempty"`

	// Round include results for the specified round.
	Round uint64 `url:"round,omitempty"`
}

LookupAccountByIDParams contains all of the query parameters for url serialization.

type LookupAccountTransactions 

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

LookupAccountTransactions lookup account transactions.

func (*LookupAccountTransactions) AfterTime 

func (s *LookupAccountTransactions) AfterTime(AfterTime time.Time) *LookupAccountTransactions

AfterTime include results after the given time. Must be an RFC 3339 formatted string.

func (*LookupAccountTransactions) AfterTimeString 

func (s *LookupAccountTransactions) AfterTimeString(AfterTime string) *LookupAccountTransactions

AfterTimeString include results after the given time. Must be an RFC 3339 formatted string.

func (*LookupAccountTransactions) AssetID 

func (s *LookupAccountTransactions) AssetID(AssetID uint64) *LookupAccountTransactions

AssetID asset ID

func (*LookupAccountTransactions) BeforeTime 

func (s *LookupAccountTransactions) BeforeTime(BeforeTime time.Time) *LookupAccountTransactions

BeforeTime include results before the given time. Must be an RFC 3339 formatted string.

func (*LookupAccountTransactions) BeforeTimeString 

func (s *LookupAccountTransactions) BeforeTimeString(BeforeTime string) *LookupAccountTransactions

BeforeTimeString include results before the given time. Must be an RFC 3339 formatted string.

func (*LookupAccountTransactions) CurrencyGreaterThan 

func (s *LookupAccountTransactions) CurrencyGreaterThan(CurrencyGreaterThan uint64) *LookupAccountTransactions

CurrencyGreaterThan results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*LookupAccountTransactions) CurrencyLessThan 

func (s *LookupAccountTransactions) CurrencyLessThan(CurrencyLessThan uint64) *LookupAccountTransactions

CurrencyLessThan results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*LookupAccountTransactions) Do 

func (s *LookupAccountTransactions) Do(ctx context.Context, headers ...*common.Header) (response models.TransactionsResponse, err error)

Do performs the HTTP request

func (*LookupAccountTransactions) Limit 

func (s *LookupAccountTransactions) Limit(Limit uint64) *LookupAccountTransactions

Limit maximum number of results to return.

func (*LookupAccountTransactions) MaxRound 

func (s *LookupAccountTransactions) MaxRound(MaxRound uint64) *LookupAccountTransactions

MaxRound include results at or before the specified max-round.

func (*LookupAccountTransactions) MinRound 

func (s *LookupAccountTransactions) MinRound(MinRound uint64) *LookupAccountTransactions

MinRound include results at or after the specified min-round.

func (*LookupAccountTransactions) NextToken 

func (s *LookupAccountTransactions) NextToken(NextToken string) *LookupAccountTransactions

NextToken the next page of results. Use the next token provided by the previous results.

func (*LookupAccountTransactions) NotePrefix 

func (s *LookupAccountTransactions) NotePrefix(NotePrefix []byte) *LookupAccountTransactions

NotePrefix specifies a prefix which must be contained in the note field.

func (*LookupAccountTransactions) RekeyTo added in v1.5.0 

func (s *LookupAccountTransactions) RekeyTo(RekeyTo bool) *LookupAccountTransactions

RekeyTo include results which include the rekey-to field.

func (*LookupAccountTransactions) Round 

func (s *LookupAccountTransactions) Round(Round uint64) *LookupAccountTransactions

Round include results for the specified round.

func (*LookupAccountTransactions) SigType 

func (s *LookupAccountTransactions) SigType(SigType string) *LookupAccountTransactions

SigType sigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig

func (*LookupAccountTransactions) TXID 

func (s *LookupAccountTransactions) TXID(TXID string) *LookupAccountTransactions

TXID lookup the specific transaction by ID.

func (*LookupAccountTransactions) TxType 

func (s *LookupAccountTransactions) TxType(TxType string) *LookupAccountTransactions

TxType

type LookupAccountTransactionsParams added in v1.6.0 

type LookupAccountTransactionsParams struct {

	// AfterTime include results after the given time. Must be an RFC 3339 formatted
	// string.
	AfterTime string `url:"after-time,omitempty"`

	// AssetID asset ID
	AssetID uint64 `url:"asset-id,omitempty"`

	// BeforeTime include results before the given time. Must be an RFC 3339 formatted
	// string.
	BeforeTime string `url:"before-time,omitempty"`

	// CurrencyGreaterThan results should have an amount greater than this value.
	// MicroAlgos are the default currency unless an asset-id is provided, in which
	// case the asset will be used.
	CurrencyGreaterThan uint64 `url:"currency-greater-than,omitempty"`

	// CurrencyLessThan results should have an amount less than this value. MicroAlgos
	// are the default currency unless an asset-id is provided, in which case the asset
	// will be used.
	CurrencyLessThan uint64 `url:"currency-less-than,omitempty"`

	// Limit maximum number of results to return.
	Limit uint64 `url:"limit,omitempty"`

	// MaxRound include results at or before the specified max-round.
	MaxRound uint64 `url:"max-round,omitempty"`

	// MinRound include results at or after the specified min-round.
	MinRound uint64 `url:"min-round,omitempty"`

	// NextToken the next page of results. Use the next token provided by the previous
	// results.
	NextToken string `url:"next,omitempty"`

	// NotePrefix specifies a prefix which must be contained in the note field.
	NotePrefix string `url:"note-prefix,omitempty"`

	// RekeyTo include results which include the rekey-to field.
	RekeyTo bool `url:"rekey-to,omitempty"`

	// Round include results for the specified round.
	Round uint64 `url:"round,omitempty"`

	// SigType sigType filters just results using the specified type of signature:
	// * sig - Standard
	// * msig - MultiSig
	// * lsig - LogicSig
	SigType string `url:"sig-type,omitempty"`

	// TxType
	TxType string `url:"tx-type,omitempty"`

	// TXID lookup the specific transaction by ID.
	TXID string `url:"txid,omitempty"`
}

LookupAccountTransactionsParams contains all of the query parameters for url serialization.

type LookupApplicationByID added in v1.5.0 

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

LookupApplicationByID lookup application.

func (*LookupApplicationByID) Do added in v1.5.0 

func (s *LookupApplicationByID) Do(ctx context.Context, headers ...*common.Header) (response models.ApplicationResponse, err error)

Do performs the HTTP request

func (*LookupApplicationByID) IncludeAll added in v1.6.0 

func (s *LookupApplicationByID) IncludeAll(IncludeAll bool) *LookupApplicationByID

IncludeAll include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

type LookupApplicationByIDParams added in v1.6.0 

type LookupApplicationByIDParams struct {

	// IncludeAll include all items including closed accounts, deleted applications,
	// destroyed assets, opted-out asset holdings, and closed-out application
	// localstates.
	IncludeAll bool `url:"include-all,omitempty"`
}

LookupApplicationByIDParams contains all of the query parameters for url serialization.

type LookupAssetBalances 

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

LookupAssetBalances lookup the list of accounts who hold this asset

func (*LookupAssetBalances) CurrencyGreaterThan 

func (s *LookupAssetBalances) CurrencyGreaterThan(CurrencyGreaterThan uint64) *LookupAssetBalances

CurrencyGreaterThan results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*LookupAssetBalances) CurrencyLessThan 

func (s *LookupAssetBalances) CurrencyLessThan(CurrencyLessThan uint64) *LookupAssetBalances

CurrencyLessThan results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*LookupAssetBalances) Do 

func (s *LookupAssetBalances) Do(ctx context.Context, headers ...*common.Header) (response models.AssetBalancesResponse, err error)

Do performs the HTTP request

func (*LookupAssetBalances) IncludeAll added in v1.6.0 

func (s *LookupAssetBalances) IncludeAll(IncludeAll bool) *LookupAssetBalances

IncludeAll include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

func (*LookupAssetBalances) Limit 

func (s *LookupAssetBalances) Limit(Limit uint64) *LookupAssetBalances

Limit maximum number of results to return.

func (*LookupAssetBalances) NextToken 

func (s *LookupAssetBalances) NextToken(NextToken string) *LookupAssetBalances

NextToken the next page of results. Use the next token provided by the previous results.

func (*LookupAssetBalances) Round 

func (s *LookupAssetBalances) Round(Round uint64) *LookupAssetBalances

Round include results for the specified round.

type LookupAssetBalancesParams added in v1.6.0 

type LookupAssetBalancesParams struct {

	// CurrencyGreaterThan results should have an amount greater than this value.
	// MicroAlgos are the default currency unless an asset-id is provided, in which
	// case the asset will be used.
	CurrencyGreaterThan uint64 `url:"currency-greater-than,omitempty"`

	// CurrencyLessThan results should have an amount less than this value. MicroAlgos
	// are the default currency unless an asset-id is provided, in which case the asset
	// will be used.
	CurrencyLessThan uint64 `url:"currency-less-than,omitempty"`

	// IncludeAll include all items including closed accounts, deleted applications,
	// destroyed assets, opted-out asset holdings, and closed-out application
	// localstates.
	IncludeAll bool `url:"include-all,omitempty"`

	// Limit maximum number of results to return.
	Limit uint64 `url:"limit,omitempty"`

	// NextToken the next page of results. Use the next token provided by the previous
	// results.
	NextToken string `url:"next,omitempty"`

	// Round include results for the specified round.
	Round uint64 `url:"round,omitempty"`
}

LookupAssetBalancesParams contains all of the query parameters for url serialization.

type LookupAssetByID 

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

LookupAssetByID lookup asset information.

func (*LookupAssetByID) Do 

func (s *LookupAssetByID) Do(ctx context.Context, headers ...*common.Header) (validRound uint64, result models.Asset, err error)

Do performs the HTTP request

func (*LookupAssetByID) IncludeAll added in v1.6.0 

func (s *LookupAssetByID) IncludeAll(IncludeAll bool) *LookupAssetByID

IncludeAll include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

type LookupAssetByIDParams added in v1.6.0 

type LookupAssetByIDParams struct {

	// IncludeAll include all items including closed accounts, deleted applications,
	// destroyed assets, opted-out asset holdings, and closed-out application
	// localstates.
	IncludeAll bool `url:"include-all,omitempty"`
}

LookupAssetByIDParams contains all of the query parameters for url serialization.

type LookupAssetTransactions 

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

LookupAssetTransactions lookup transactions for an asset.

func (*LookupAssetTransactions) AddressRole 

func (s *LookupAssetTransactions) AddressRole(AddressRole string) *LookupAssetTransactions

AddressRole combine with the address parameter to define what type of address to search for.

func (*LookupAssetTransactions) AddressString 

func (s *LookupAssetTransactions) AddressString(AddressString string) *LookupAssetTransactions

AddressString only include transactions with this address in one of the transaction fields.

func (*LookupAssetTransactions) AfterTime 

func (s *LookupAssetTransactions) AfterTime(AfterTime time.Time) *LookupAssetTransactions

AfterTime include results after the given time. Must be an RFC 3339 formatted string.

func (*LookupAssetTransactions) AfterTimeString 

func (s *LookupAssetTransactions) AfterTimeString(AfterTime string) *LookupAssetTransactions

AfterTimeString include results after the given time. Must be an RFC 3339 formatted string.

func (*LookupAssetTransactions) BeforeTime 

func (s *LookupAssetTransactions) BeforeTime(BeforeTime time.Time) *LookupAssetTransactions

BeforeTime include results before the given time. Must be an RFC 3339 formatted string.

func (*LookupAssetTransactions) BeforeTimeString 

func (s *LookupAssetTransactions) BeforeTimeString(BeforeTime string) *LookupAssetTransactions

BeforeTimeString include results before the given time. Must be an RFC 3339 formatted string.

func (*LookupAssetTransactions) CurrencyGreaterThan 

func (s *LookupAssetTransactions) CurrencyGreaterThan(CurrencyGreaterThan uint64) *LookupAssetTransactions

CurrencyGreaterThan results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*LookupAssetTransactions) CurrencyLessThan 

func (s *LookupAssetTransactions) CurrencyLessThan(CurrencyLessThan uint64) *LookupAssetTransactions

CurrencyLessThan results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*LookupAssetTransactions) Do 

func (s *LookupAssetTransactions) Do(ctx context.Context, headers ...*common.Header) (response models.TransactionsResponse, err error)

Do performs the HTTP request

func (*LookupAssetTransactions) ExcludeCloseTo 

func (s *LookupAssetTransactions) ExcludeCloseTo(ExcludeCloseTo bool) *LookupAssetTransactions

ExcludeCloseTo combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true.

func (*LookupAssetTransactions) Limit 

func (s *LookupAssetTransactions) Limit(Limit uint64) *LookupAssetTransactions

Limit maximum number of results to return.

func (*LookupAssetTransactions) MaxRound 

func (s *LookupAssetTransactions) MaxRound(MaxRound uint64) *LookupAssetTransactions

MaxRound include results at or before the specified max-round.

func (*LookupAssetTransactions) MinRound 

func (s *LookupAssetTransactions) MinRound(MinRound uint64) *LookupAssetTransactions

MinRound include results at or after the specified min-round.

func (*LookupAssetTransactions) NextToken 

func (s *LookupAssetTransactions) NextToken(NextToken string) *LookupAssetTransactions

NextToken the next page of results. Use the next token provided by the previous results.

func (*LookupAssetTransactions) NotePrefix 

func (s *LookupAssetTransactions) NotePrefix(NotePrefix []byte) *LookupAssetTransactions

NotePrefix specifies a prefix which must be contained in the note field.

func (*LookupAssetTransactions) RekeyTo added in v1.5.0 

func (s *LookupAssetTransactions) RekeyTo(RekeyTo bool) *LookupAssetTransactions

RekeyTo include results which include the rekey-to field.

func (*LookupAssetTransactions) Round 

func (s *LookupAssetTransactions) Round(Round uint64) *LookupAssetTransactions

Round include results for the specified round.

func (*LookupAssetTransactions) SigType 

func (s *LookupAssetTransactions) SigType(SigType string) *LookupAssetTransactions

SigType sigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig

func (*LookupAssetTransactions) TXID 

func (s *LookupAssetTransactions) TXID(TXID string) *LookupAssetTransactions

TXID lookup the specific transaction by ID.

func (*LookupAssetTransactions) TxType 

func (s *LookupAssetTransactions) TxType(TxType string) *LookupAssetTransactions

TxType

type LookupAssetTransactionsParams added in v1.6.0 

type LookupAssetTransactionsParams struct {

	// AddressString only include transactions with this address in one of the
	// transaction fields.
	AddressString string `url:"address,omitempty"`

	// AddressRole combine with the address parameter to define what type of address to
	// search for.
	AddressRole string `url:"address-role,omitempty"`

	// AfterTime include results after the given time. Must be an RFC 3339 formatted
	// string.
	AfterTime string `url:"after-time,omitempty"`

	// BeforeTime include results before the given time. Must be an RFC 3339 formatted
	// string.
	BeforeTime string `url:"before-time,omitempty"`

	// CurrencyGreaterThan results should have an amount greater than this value.
	// MicroAlgos are the default currency unless an asset-id is provided, in which
	// case the asset will be used.
	CurrencyGreaterThan uint64 `url:"currency-greater-than,omitempty"`

	// CurrencyLessThan results should have an amount less than this value. MicroAlgos
	// are the default currency unless an asset-id is provided, in which case the asset
	// will be used.
	CurrencyLessThan uint64 `url:"currency-less-than,omitempty"`

	// ExcludeCloseTo combine with address and address-role parameters to define what
	// type of address to search for. The close to fields are normally treated as a
	// receiver, if you would like to exclude them set this parameter to true.
	ExcludeCloseTo bool `url:"exclude-close-to,omitempty"`

	// Limit maximum number of results to return.
	Limit uint64 `url:"limit,omitempty"`

	// MaxRound include results at or before the specified max-round.
	MaxRound uint64 `url:"max-round,omitempty"`

	// MinRound include results at or after the specified min-round.
	MinRound uint64 `url:"min-round,omitempty"`

	// NextToken the next page of results. Use the next token provided by the previous
	// results.
	NextToken string `url:"next,omitempty"`

	// NotePrefix specifies a prefix which must be contained in the note field.
	NotePrefix string `url:"note-prefix,omitempty"`

	// RekeyTo include results which include the rekey-to field.
	RekeyTo bool `url:"rekey-to,omitempty"`

	// Round include results for the specified round.
	Round uint64 `url:"round,omitempty"`

	// SigType sigType filters just results using the specified type of signature:
	// * sig - Standard
	// * msig - MultiSig
	// * lsig - LogicSig
	SigType string `url:"sig-type,omitempty"`

	// TxType
	TxType string `url:"tx-type,omitempty"`

	// TXID lookup the specific transaction by ID.
	TXID string `url:"txid,omitempty"`
}

LookupAssetTransactionsParams contains all of the query parameters for url serialization.

type LookupBlock 

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

LookupBlock lookup block.

func (*LookupBlock) Do 

func (s *LookupBlock) Do(ctx context.Context, headers ...*common.Header) (response models.Block, err error)

Do performs the HTTP request

type LookupTransaction added in v1.6.0 

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

LookupTransaction lookup a single transaction.

func (*LookupTransaction) Do added in v1.6.0 

func (s *LookupTransaction) Do(ctx context.Context, headers ...*common.Header) (response models.TransactionResponse, err error)

Do performs the HTTP request

type SearchAccounts 

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

SearchAccounts search for accounts.

func (*SearchAccounts) ApplicationId added in v1.5.0 

func (s *SearchAccounts) ApplicationId(ApplicationId uint64) *SearchAccounts

ApplicationId application ID

func (*SearchAccounts) AssetID 

func (s *SearchAccounts) AssetID(AssetID uint64) *SearchAccounts

AssetID asset ID

func (*SearchAccounts) AuthAddress added in v1.5.0 

func (s *SearchAccounts) AuthAddress(AuthAddress string) *SearchAccounts

AuthAddress include accounts configured to use this spending key.

func (*SearchAccounts) CurrencyGreaterThan 

func (s *SearchAccounts) CurrencyGreaterThan(CurrencyGreaterThan uint64) *SearchAccounts

CurrencyGreaterThan results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*SearchAccounts) CurrencyLessThan 

func (s *SearchAccounts) CurrencyLessThan(CurrencyLessThan uint64) *SearchAccounts

CurrencyLessThan results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*SearchAccounts) Do 

func (s *SearchAccounts) Do(ctx context.Context, headers ...*common.Header) (response models.AccountsResponse, err error)

Do performs the HTTP request

func (*SearchAccounts) IncludeAll added in v1.6.0 

func (s *SearchAccounts) IncludeAll(IncludeAll bool) *SearchAccounts

IncludeAll include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

func (*SearchAccounts) Limit 

func (s *SearchAccounts) Limit(Limit uint64) *SearchAccounts

Limit maximum number of results to return.

func (*SearchAccounts) NextToken 

func (s *SearchAccounts) NextToken(NextToken string) *SearchAccounts

NextToken the next page of results. Use the next token provided by the previous results.

func (*SearchAccounts) Round 

func (s *SearchAccounts) Round(Round uint64) *SearchAccounts

Round include results for the specified round. For performance reasons, this parameter may be disabled on some configurations.

type SearchAccountsParams added in v1.6.0 

type SearchAccountsParams struct {

	// ApplicationId application ID
	ApplicationId uint64 `url:"application-id,omitempty"`

	// AssetID asset ID
	AssetID uint64 `url:"asset-id,omitempty"`

	// AuthAddress include accounts configured to use this spending key.
	AuthAddress string `url:"auth-addr,omitempty"`

	// CurrencyGreaterThan results should have an amount greater than this value.
	// MicroAlgos are the default currency unless an asset-id is provided, in which
	// case the asset will be used.
	CurrencyGreaterThan uint64 `url:"currency-greater-than,omitempty"`

	// CurrencyLessThan results should have an amount less than this value. MicroAlgos
	// are the default currency unless an asset-id is provided, in which case the asset
	// will be used.
	CurrencyLessThan uint64 `url:"currency-less-than,omitempty"`

	// IncludeAll include all items including closed accounts, deleted applications,
	// destroyed assets, opted-out asset holdings, and closed-out application
	// localstates.
	IncludeAll bool `url:"include-all,omitempty"`

	// Limit maximum number of results to return.
	Limit uint64 `url:"limit,omitempty"`

	// NextToken the next page of results. Use the next token provided by the previous
	// results.
	NextToken string `url:"next,omitempty"`

	// Round include results for the specified round. For performance reasons, this
	// parameter may be disabled on some configurations.
	Round uint64 `url:"round,omitempty"`
}

SearchAccountsParams contains all of the query parameters for url serialization.

type SearchForApplications added in v1.5.0 

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

SearchForApplications search for applications

func (*SearchForApplications) ApplicationId added in v1.5.0 

func (s *SearchForApplications) ApplicationId(ApplicationId uint64) *SearchForApplications

ApplicationId application ID

func (*SearchForApplications) Do added in v1.5.0 

func (s *SearchForApplications) Do(ctx context.Context, headers ...*common.Header) (response models.ApplicationsResponse, err error)

Do performs the HTTP request

func (*SearchForApplications) IncludeAll added in v1.6.0 

func (s *SearchForApplications) IncludeAll(IncludeAll bool) *SearchForApplications

IncludeAll include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

func (*SearchForApplications) Limit added in v1.5.0 

func (s *SearchForApplications) Limit(Limit uint64) *SearchForApplications

Limit maximum number of results to return.

func (*SearchForApplications) Next added in v1.5.0 

func (s *SearchForApplications) Next(Next string) *SearchForApplications

Next the next page of results. Use the next token provided by the previous results.

type SearchForApplicationsParams added in v1.6.0 

type SearchForApplicationsParams struct {

	// ApplicationId application ID
	ApplicationId uint64 `url:"application-id,omitempty"`

	// IncludeAll include all items including closed accounts, deleted applications,
	// destroyed assets, opted-out asset holdings, and closed-out application
	// localstates.
	IncludeAll bool `url:"include-all,omitempty"`

	// Limit maximum number of results to return.
	Limit uint64 `url:"limit,omitempty"`

	// Next the next page of results. Use the next token provided by the previous
	// results.
	Next string `url:"next,omitempty"`
}

SearchForApplicationsParams contains all of the query parameters for url serialization.

type SearchForAssets 

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

SearchForAssets search for assets.

func (*SearchForAssets) AssetID 

func (s *SearchForAssets) AssetID(AssetID uint64) *SearchForAssets

AssetID asset ID

func (*SearchForAssets) Creator 

func (s *SearchForAssets) Creator(Creator string) *SearchForAssets

Creator filter just assets with the given creator address.

func (*SearchForAssets) Do 

func (s *SearchForAssets) Do(ctx context.Context, headers ...*common.Header) (response models.AssetsResponse, err error)

Do performs the HTTP request

func (*SearchForAssets) IncludeAll added in v1.6.0 

func (s *SearchForAssets) IncludeAll(IncludeAll bool) *SearchForAssets

IncludeAll include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

func (*SearchForAssets) Limit 

func (s *SearchForAssets) Limit(Limit uint64) *SearchForAssets

Limit maximum number of results to return.

func (*SearchForAssets) Name 

func (s *SearchForAssets) Name(Name string) *SearchForAssets

Name filter just assets with the given name.

func (*SearchForAssets) NextToken 

func (s *SearchForAssets) NextToken(NextToken string) *SearchForAssets

NextToken the next page of results. Use the next token provided by the previous results.

func (*SearchForAssets) Unit 

func (s *SearchForAssets) Unit(Unit string) *SearchForAssets

Unit filter just assets with the given unit.

type SearchForAssetsParams added in v1.6.0 

type SearchForAssetsParams struct {

	// AssetID asset ID
	AssetID uint64 `url:"asset-id,omitempty"`

	// Creator filter just assets with the given creator address.
	Creator string `url:"creator,omitempty"`

	// IncludeAll include all items including closed accounts, deleted applications,
	// destroyed assets, opted-out asset holdings, and closed-out application
	// localstates.
	IncludeAll bool `url:"include-all,omitempty"`

	// Limit maximum number of results to return.
	Limit uint64 `url:"limit,omitempty"`

	// Name filter just assets with the given name.
	Name string `url:"name,omitempty"`

	// NextToken the next page of results. Use the next token provided by the previous
	// results.
	NextToken string `url:"next,omitempty"`

	// Unit filter just assets with the given unit.
	Unit string `url:"unit,omitempty"`
}

SearchForAssetsParams contains all of the query parameters for url serialization.

type SearchForTransactions 

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

SearchForTransactions search for transactions.

func (*SearchForTransactions) AddressRole 

func (s *SearchForTransactions) AddressRole(AddressRole string) *SearchForTransactions

AddressRole combine with the address parameter to define what type of address to search for.

func (*SearchForTransactions) AddressString 

func (s *SearchForTransactions) AddressString(AddressString string) *SearchForTransactions

AddressString only include transactions with this address in one of the transaction fields.

func (*SearchForTransactions) AfterTime 

func (s *SearchForTransactions) AfterTime(AfterTime time.Time) *SearchForTransactions

AfterTime include results after the given time. Must be an RFC 3339 formatted string.

func (*SearchForTransactions) AfterTimeString 

func (s *SearchForTransactions) AfterTimeString(AfterTime string) *SearchForTransactions

AfterTimeString include results after the given time. Must be an RFC 3339 formatted string.

func (*SearchForTransactions) ApplicationId added in v1.5.0 

func (s *SearchForTransactions) ApplicationId(ApplicationId uint64) *SearchForTransactions

ApplicationId application ID

func (*SearchForTransactions) AssetID 

func (s *SearchForTransactions) AssetID(AssetID uint64) *SearchForTransactions

AssetID asset ID

func (*SearchForTransactions) BeforeTime 

func (s *SearchForTransactions) BeforeTime(BeforeTime time.Time) *SearchForTransactions

BeforeTime include results before the given time. Must be an RFC 3339 formatted string.

func (*SearchForTransactions) BeforeTimeString 

func (s *SearchForTransactions) BeforeTimeString(BeforeTime string) *SearchForTransactions

BeforeTimeString include results before the given time. Must be an RFC 3339 formatted string.

func (*SearchForTransactions) CurrencyGreaterThan 

func (s *SearchForTransactions) CurrencyGreaterThan(CurrencyGreaterThan uint64) *SearchForTransactions

CurrencyGreaterThan results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*SearchForTransactions) CurrencyLessThan 

func (s *SearchForTransactions) CurrencyLessThan(CurrencyLessThan uint64) *SearchForTransactions

CurrencyLessThan results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

func (*SearchForTransactions) Do 

func (s *SearchForTransactions) Do(ctx context.Context, headers ...*common.Header) (response models.TransactionsResponse, err error)

Do performs the HTTP request

func (*SearchForTransactions) ExcludeCloseTo 

func (s *SearchForTransactions) ExcludeCloseTo(ExcludeCloseTo bool) *SearchForTransactions

ExcludeCloseTo combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true.

func (*SearchForTransactions) Limit 

func (s *SearchForTransactions) Limit(Limit uint64) *SearchForTransactions

Limit maximum number of results to return.

func (*SearchForTransactions) MaxRound 

func (s *SearchForTransactions) MaxRound(MaxRound uint64) *SearchForTransactions

MaxRound include results at or before the specified max-round.

func (*SearchForTransactions) MinRound 

func (s *SearchForTransactions) MinRound(MinRound uint64) *SearchForTransactions

MinRound include results at or after the specified min-round.

func (*SearchForTransactions) NextToken 

func (s *SearchForTransactions) NextToken(NextToken string) *SearchForTransactions

NextToken the next page of results. Use the next token provided by the previous results.

func (*SearchForTransactions) NotePrefix 

func (s *SearchForTransactions) NotePrefix(NotePrefix []byte) *SearchForTransactions

NotePrefix specifies a prefix which must be contained in the note field.

func (*SearchForTransactions) RekeyTo added in v1.5.0 

func (s *SearchForTransactions) RekeyTo(RekeyTo bool) *SearchForTransactions

RekeyTo include results which include the rekey-to field.

func (*SearchForTransactions) Round 

func (s *SearchForTransactions) Round(Round uint64) *SearchForTransactions

Round include results for the specified round.

func (*SearchForTransactions) SigType 

func (s *SearchForTransactions) SigType(SigType string) *SearchForTransactions

SigType sigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig

func (*SearchForTransactions) TXID 

func (s *SearchForTransactions) TXID(TXID string) *SearchForTransactions

TXID lookup the specific transaction by ID.

func (*SearchForTransactions) TxType 

func (s *SearchForTransactions) TxType(TxType string) *SearchForTransactions

TxType

type SearchForTransactionsParams added in v1.6.0 

type SearchForTransactionsParams struct {

	// AddressString only include transactions with this address in one of the
	// transaction fields.
	AddressString string `url:"address,omitempty"`

	// AddressRole combine with the address parameter to define what type of address to
	// search for.
	AddressRole string `url:"address-role,omitempty"`

	// AfterTime include results after the given time. Must be an RFC 3339 formatted
	// string.
	AfterTime string `url:"after-time,omitempty"`

	// ApplicationId application ID
	ApplicationId uint64 `url:"application-id,omitempty"`

	// AssetID asset ID
	AssetID uint64 `url:"asset-id,omitempty"`

	// BeforeTime include results before the given time. Must be an RFC 3339 formatted
	// string.
	BeforeTime string `url:"before-time,omitempty"`

	// CurrencyGreaterThan results should have an amount greater than this value.
	// MicroAlgos are the default currency unless an asset-id is provided, in which
	// case the asset will be used.
	CurrencyGreaterThan uint64 `url:"currency-greater-than,omitempty"`

	// CurrencyLessThan results should have an amount less than this value. MicroAlgos
	// are the default currency unless an asset-id is provided, in which case the asset
	// will be used.
	CurrencyLessThan uint64 `url:"currency-less-than,omitempty"`

	// ExcludeCloseTo combine with address and address-role parameters to define what
	// type of address to search for. The close to fields are normally treated as a
	// receiver, if you would like to exclude them set this parameter to true.
	ExcludeCloseTo bool `url:"exclude-close-to,omitempty"`

	// Limit maximum number of results to return.
	Limit uint64 `url:"limit,omitempty"`

	// MaxRound include results at or before the specified max-round.
	MaxRound uint64 `url:"max-round,omitempty"`

	// MinRound include results at or after the specified min-round.
	MinRound uint64 `url:"min-round,omitempty"`

	// NextToken the next page of results. Use the next token provided by the previous
	// results.
	NextToken string `url:"next,omitempty"`

	// NotePrefix specifies a prefix which must be contained in the note field.
	NotePrefix string `url:"note-prefix,omitempty"`

	// RekeyTo include results which include the rekey-to field.
	RekeyTo bool `url:"rekey-to,omitempty"`

	// Round include results for the specified round.
	Round uint64 `url:"round,omitempty"`

	// SigType sigType filters just results using the specified type of signature:
	// * sig - Standard
	// * msig - MultiSig
	// * lsig - LogicSig
	SigType string `url:"sig-type,omitempty"`

	// TxType
	TxType string `url:"tx-type,omitempty"`

	// TXID lookup the specific transaction by ID.
	TXID string `url:"txid,omitempty"`
}

SearchForTransactionsParams contains all of the query parameters for url serialization.

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.