 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Overview ¶
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* NFD Management Service * * Service for querying and managing NFDs * * API version: 1.0 * Contact: feedback@txnlab.dev * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type BasicAuth
- type Configuration
- type ConsensusRecord
- type ContractLockRequestBody
- type Donation
- type GenericSwaggerError
- type GetQuoteResponseBody
- type InfoApiService
- type IsValidAsaResponseBody
- type IsValidNfdResponseBody
- type LinkAddressRequestBody
- type MintRequestBody
- type ModelError
- type Nfd
- type NfdActivity
- type NfdAnalyticEvent
- type NfdAnalyticRecord
- type NfdAnalyticRecords
- type NfdApiNfdActivityOpts
- type NfdApiNfdAnalyticsOpts
- type NfdApiNfdBadgesOpts
- type NfdApiNfdBrowseOpts
- type NfdApiNfdConsensusLeadersOpts
- type NfdApiNfdConsensusMetricsOpts
- type NfdApiNfdGetLookupOpts
- type NfdApiNfdGetNFDOpts
- type NfdApiNfdGetNFDsForAddressesV2Opts
- type NfdApiNfdSearchV2Opts
- type NfdApiNfdSegmentLeadersOpts
- type NfdApiNfdSuggestOpts
- type NfdApiNfdTotalsOpts
- type NfdApiNfdTwitterLeadersOpts
- type NfdApiNfdUpdateImageOpts
- type NfdApiService
- func (a *NfdApiService) NfdActivity(ctx context.Context, name []string, localVarOptionals *NfdApiNfdActivityOpts) ([]NfdActivity, *http.Response, error)
- func (a *NfdApiService) NfdAnalytics(ctx context.Context, localVarOptionals *NfdApiNfdAnalyticsOpts) (NfdAnalyticRecords, *http.Response, error)
- func (a *NfdApiService) NfdBadges(ctx context.Context, name string, localVarOptionals *NfdApiNfdBadgesOpts) (map[string][]map[string]string, *http.Response, error)
- func (a *NfdApiService) NfdBrowse(ctx context.Context, localVarOptionals *NfdApiNfdBrowseOpts) ([]NfdRecord, *http.Response, error)
- func (a *NfdApiService) NfdConsensusLeaders(ctx context.Context, localVarOptionals *NfdApiNfdConsensusLeadersOpts) ([]ConsensusRecord, *http.Response, error)
- func (a *NfdApiService) NfdConsensusMetrics(ctx context.Context, localVarOptionals *NfdApiNfdConsensusMetricsOpts) (map[string][]map[string]string, *http.Response, error)
- func (a *NfdApiService) NfdContractLock(ctx context.Context, body ContractLockRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdContractUpgrade(ctx context.Context, body RescindOfferRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdContractUpgradeV3(ctx context.Context, body RescindOfferRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdDonationLeadersV2(ctx context.Context, name string) ([]Donation, *http.Response, error)
- func (a *NfdApiService) NfdDonationListV2(ctx context.Context) ([]NfdRecordResponseFull, *http.Response, error)
- func (a *NfdApiService) NfdDonations(ctx context.Context, name string) ([]Donation, *http.Response, error)
- func (a *NfdApiService) NfdGetLookup(ctx context.Context, address []string, ...) (map[string]NfdRecordinaddress, *http.Response, error)
- func (a *NfdApiService) NfdGetNFD(ctx context.Context, nameOrID string, localVarOptionals *NfdApiNfdGetNFDOpts) (NfdRecord, *http.Response, error)
- func (a *NfdApiService) NfdGetNFDsForAddressesV2(ctx context.Context, address []string, ...) (map[string][]NfdRecordinaddress, *http.Response, error)
- func (a *NfdApiService) NfdGetNameSig(ctx context.Context, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdGetQuote(ctx context.Context, buyer string, name string) (GetQuoteResponseBody, *http.Response, error)
- func (a *NfdApiService) NfdGetRevAddressSig(ctx context.Context, address string) (string, *http.Response, error)
- func (a *NfdApiService) NfdIsValidASA(ctx context.Context, asaID int64) (IsValidAsaResponseBody, *http.Response, error)
- func (a *NfdApiService) NfdIsValidNFD(ctx context.Context, appID int64) (IsValidNfdResponseBody, *http.Response, error)
- func (a *NfdApiService) NfdLinkAddress(ctx context.Context, body LinkAddressRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdMint(ctx context.Context, body MintRequestBody) (string, *http.Response, error)
- func (a *NfdApiService) NfdOffer(ctx context.Context, body OfferRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdPostOfferToOwner(ctx context.Context, body PostOfferToOwnerRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdPurchase(ctx context.Context, body PurchaseRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdRenew(ctx context.Context, body RenewRequestBody) (string, *http.Response, error)
- func (a *NfdApiService) NfdRescindOffer(ctx context.Context, body RescindOfferRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdSearchV2(ctx context.Context, localVarOptionals *NfdApiNfdSearchV2Opts) (NfdV2SearchRecords, *http.Response, error)
- func (a *NfdApiService) NfdSegmentLeaders(ctx context.Context, localVarOptionals *NfdApiNfdSegmentLeadersOpts) ([]NfdRecord, *http.Response, error)
- func (a *NfdApiService) NfdSegmentLock(ctx context.Context, body SegmentLockRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdSendFromVault(ctx context.Context, body SendFromVaultRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdSendToVault(ctx context.Context, body SendToVaultRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdSetPrimaryAddress(ctx context.Context, body SetPrimaryAddressRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdSetPrimaryNFD(ctx context.Context, body SetPrimaryAddressRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdSuggest(ctx context.Context, buyer string, name string, ...) ([]NfdRecord, *http.Response, error)
- func (a *NfdApiService) NfdTotals(ctx context.Context, localVarOptionals *NfdApiNfdTotalsOpts) (TotalsOkResponseBody, *http.Response, error)
- func (a *NfdApiService) NfdTwitterLeaders(ctx context.Context, localVarOptionals *NfdApiNfdTwitterLeadersOpts) ([]TwitterRecord, *http.Response, error)
- func (a *NfdApiService) NfdUnlinkAddress(ctx context.Context, body LinkAddressRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdUpdateAll(ctx context.Context, body UpdatePartialRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdUpdateImage(ctx context.Context, name string, sender string, which string, ...) (string, *http.Response, error)
- func (a *NfdApiService) NfdUpdatePartial(ctx context.Context, body UpdatePartialRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdVaultOptInLock(ctx context.Context, body ContractLockRequestBody, name string) (string, *http.Response, error)
- func (a *NfdApiService) NfdVerifyConfirm(ctx context.Context, body VerifyConfirmRequestBody, id string) (VerifyConfirmResponseBody, *http.Response, error)
- func (a *NfdApiService) NfdVerifyRequest(ctx context.Context, body VerifyRequestRequestBody) (VerifyRequestResponseBody, *http.Response, error)
 
- type NfdProperties
- type NfdRecord
- type NfdRecordResponseFull
- type NfdRecordinaddress
- type NfdV2SearchRecords
- type OfferRequestBody
- type PostOfferToOwnerRequestBody
- type PurchaseRequestBody
- type RateLimited
- type RenewRequestBody
- type RescindOfferRequestBody
- type SegmentLockRequestBody
- type SendFromVaultRequestBody
- type SendToVaultRequestBody
- type SetPrimaryAddressRequestBody
- type TotalsOkResponseBody
- type TotalsOkResponseBodyContractTotals
- type TotalsOkResponseBodyMintedTotals
- type TwitterRecord
- type UpdatePartialRequestBody
- type VerifyConfirmRequestBody
- type VerifyConfirmResponseBody
- type VerifyRequestRequestBody
- type VerifyRequestResponseBody
- type VersionResponseBody
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes a oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct {
	InfoApi *InfoApiService
	NfdApi *NfdApiService
	// contains filtered or unexported fields
}
    APIClient manages communication with the NFD Management Service API v1.0 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
Change base path to allow switching to mocks
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}
    func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
type BasicAuth ¶
type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}
    BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type Configuration ¶
type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}
    func NewConfiguration ¶
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
type ConsensusRecord ¶
type ConsensusRecord struct {
	Account       string    `json:"account"`
	LastPropBlock int64     `json:"lastPropBlock,omitempty"`
	LastPropTime  time.Time `json:"lastPropTime,omitempty"`
	LastVoteBlock int64     `json:"lastVoteBlock,omitempty"`
	LastVoteTime  time.Time `json:"lastVoteTime,omitempty"`
	LinkType      string    `json:"linkType,omitempty"`
	OwnerAccount  string    `json:"ownerAccount"`
	PctOfOnline   float64   `json:"pctOfOnline"`
	Proposals     int64     `json:"proposals,omitempty"`
	Rank          int64     `json:"rank,omitempty"`
	Votes         int64     `json:"votes,omitempty"`
}
    ConsensusRecord contains information about an account that participated in consensus
type ContractLockRequestBody ¶
type Donation ¶
type Donation struct {
	// Sender or Receiver Algorand address depending on request
	Address string `json:"address"`
	// Total donation in microAlgos
	Total int64 `json:"total"`
}
    Donation contains basic information about donation totals to specific addresses from accounts related to an NFD
type GenericSwaggerError ¶
type GenericSwaggerError struct {
	// contains filtered or unexported fields
}
    GenericSwaggerError Provides access to the body, error and model on returned errors.
func (GenericSwaggerError) Body ¶
func (e GenericSwaggerError) Body() []byte
Body returns the raw bytes of the response
func (GenericSwaggerError) Error ¶
func (e GenericSwaggerError) Error() string
Error returns non-empty string if there was an error.
func (GenericSwaggerError) Model ¶
func (e GenericSwaggerError) Model() interface{}
Model returns the unpacked model of the error
type GetQuoteResponseBody ¶ added in v0.0.5
type GetQuoteResponseBody struct {
	// extra needed to cover MBR (if necessary) - price already includes this amount
	CarryCost int64 `json:"carryCost"`
	// whether the nfd exists. if so, cost is renewal, otherwise mint (including carry)
	Exists bool `json:"exists"`
	// if nfd is in auction pricing for given buyer
	InAuction bool `json:"inAuction"`
	// whether the (existing) nfd is expired
	IsExpired bool `json:"isExpired"`
	// price in microAlgo for 1 year w/ carry cost (if needs minted) added in. subtract carry cost for per-year cost
	Price int64 `json:"price"`
}
    type InfoApiService ¶
type InfoApiService service
func (*InfoApiService) InfoVersion ¶
func (a *InfoApiService) InfoVersion(ctx context.Context) (VersionResponseBody, *http.Response, error)
InfoApiService version info Returns version information for the service
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return VersionResponseBody
func (*InfoApiService) Infoinfoopenapi3Yaml ¶
InfoApiService Download ./pubfiles/openapi3.yaml YAML document containing the API swagger definition
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
type IsValidAsaResponseBody ¶
type IsValidAsaResponseBody struct {
	AppID   int64  `json:"appID"`
	IsValid bool   `json:"isValid"`
	Message string `json:"message"`
	Name    string `json:"name"`
}
    Whether NFD NFT ASA ID is for authentic NFD
type IsValidNfdResponseBody ¶
type IsValidNfdResponseBody struct {
	IsValid        bool   `json:"isValid"`
	Message        string `json:"message"`
	Name           string `json:"name"`
	SigNameAddress string `json:"sigNameAddress,omitempty"`
}
    Whether NFD App ID is for authentic NFD
type LinkAddressRequestBody ¶
type MintRequestBody ¶ added in v0.0.5
type MintRequestBody struct {
	// Offer price in ALGO. Expiration time set prorated based on amount paid vs fixed per-year cost when years argument is used
	AlgoOffer int64 `json:"algoOffer,omitempty"`
	// Address paying/signing for minting transaction
	Buyer string `json:"buyer"`
	Name  string `json:"name"`
	// Address NFD is being minted for if not buyer
	ReservedFor string `json:"reservedFor,omitempty"`
	// Number of years until expiration, 1 yr minimum, 20 max, extending renewal date - sets price in multiples of 1 year
	Years int64 `json:"years,omitempty"`
}
    type ModelError ¶
type ModelError struct {
	// Is the error a server-side fault?
	Fault bool `json:"fault"`
	// ID is a unique identifier for this particular occurrence of the problem.
	Id string `json:"id"`
	// Message is a human-readable explanation specific to this occurrence of the problem.
	Message string `json:"message"`
	// Name is the name of this class of errors.
	Name string `json:"name"`
	// Is the error temporary?
	Temporary bool `json:"temporary"`
	// Is the error a timeout?
	Timeout bool `json:"timeout"`
}
    type Nfd ¶
type Nfd struct {
	// NFD Application ID
	AppID int64 `json:"appID,omitempty"`
	// NFD ASA ID
	AsaID int64 `json:"asaID,omitempty"`
	// Whether the verified Avatar set in this NFD is newer (arc19) then is set into the NFD. This will only be present on direct NFD fetch and if true
	AvatarOutdated bool `json:"avatarOutdated,omitempty"`
	// Verified Algorand addresses for this NFD
	CaAlgo []string `json:"caAlgo,omitempty"`
	// Cache-Control header
	CacheControl string `json:"cache-control,omitempty"`
	Category     string `json:"category,omitempty"`
	// Round this data was last fetched from
	CurrentAsOfBlock int64 `json:"currentAsOfBlock,omitempty"`
	// account wallets should send funds to - precedence is: caAlgo[0], unverifiedCaAlgo[0], owner
	DepositAccount string `json:"depositAccount,omitempty"`
	// ETag
	Etag    string `json:"etag,omitempty"`
	Expired bool   `json:"expired,omitempty"`
	// Tags set by the system for tracking/analytics
	MetaTags   []string `json:"metaTags,omitempty"`
	Name       string   `json:"name"`
	NfdAccount string   `json:"nfdAccount,omitempty"`
	// Owner of NFD
	Owner string `json:"owner,omitempty"`
	// NFD Application ID of Parent if this is a segment
	ParentAppID int64          `json:"parentAppID,omitempty"`
	Properties  *NfdProperties `json:"properties,omitempty"`
	// Reserved owner of NFD
	ReservedFor string `json:"reservedFor,omitempty"`
	SaleType    string `json:"saleType,omitempty"`
	// amount NFD is being sold for (microAlgos)
	SellAmount int64 `json:"sellAmount,omitempty"`
	// RecipientUid of NFD sales
	Seller         string `json:"seller,omitempty"`
	SigNameAddress string `json:"sigNameAddress,omitempty"`
	State          string `json:"state,omitempty"`
	// Tags assigned to this NFD
	Tags          []string  `json:"tags,omitempty"`
	TimeChanged   time.Time `json:"timeChanged,omitempty"`
	TimeCreated   time.Time `json:"timeCreated,omitempty"`
	TimeExpires   time.Time `json:"timeExpires,omitempty"`
	TimePurchased time.Time `json:"timePurchased,omitempty"`
	// Unverified (non-algo) Crypto addresses for this NFD
	UnverifiedCa map[string][]string `json:"unverifiedCa,omitempty"`
	// Unverified Algorand addresses for this NFD
	UnverifiedCaAlgo []string `json:"unverifiedCaAlgo,omitempty"`
}
    NFD contains all known information about an NFD record
type NfdActivity ¶
type NfdActivity struct {
	// Algorand Block number of change
	Block        int64  `json:"block"`
	CacheControl string `json:"cache-control,omitempty"`
	// Changed properties
	Changes map[string]string `json:"changes,omitempty"`
	Etag    string            `json:"etag,omitempty"`
	// Not returned, used in tagging for response to indicate if-none-match etag matched
	MatchCheck string `json:"match-check,omitempty"`
	// NFD Name
	Name        string    `json:"name"`
	TimeChanged time.Time `json:"timeChanged"`
}
    NFDActivity contains the property changes made in a particular NFD contract update call
type NfdAnalyticEvent ¶
type NfdAnalyticEvent struct {
	Block int64  `json:"block,omitempty"`
	Buyer string `json:"buyer,omitempty"`
	// extra amount paid to cover minimum balance requirements - add to price to determine total amount paid
	CarryCost int64  `json:"carryCost,omitempty"`
	Category  string `json:"category,omitempty"`
	// NFD current owner - if set via includeOwner property
	CurrentOwner string   `json:"currentOwner,omitempty"`
	Event        string   `json:"event,omitempty"`
	GroupID      string   `json:"groupID,omitempty"`
	MetaTags     []string `json:"metaTags,omitempty"`
	// NFD Name
	Name string `json:"name,omitempty"`
	// new expiration time set from minting or renewing
	NewExpTime time.Time `json:"newExpTime,omitempty"`
	Note       string    `json:"note,omitempty"`
	// price for one year mint/renew
	OneYearRenewalPrice int64  `json:"oneYearRenewalPrice,omitempty"`
	SaleType            string `json:"saleType,omitempty"`
	Seller              string `json:"seller,omitempty"`
}
    NFDAnalyticEvent contains a price history record for a point in time of an NFD
type NfdAnalyticRecord ¶
type NfdAnalyticRecord struct {
	Data *NfdAnalyticEvent `json:"data,omitempty"`
	// price of event in microAlgos
	Price int64 `json:"price,omitempty"`
	// price of event in USD
	PriceUsd  float64   `json:"priceUsd,omitempty"`
	Timestamp time.Time `json:"timestamp,omitempty"`
}
    NFDAnalyticRecord is an NFD Analytics record in a time-series collection, with timestamp, price, and event data for that point in time.
type NfdAnalyticRecords ¶
type NfdAnalyticRecords struct {
	// Not returned, used in tagging for response to indicate if-none-match etag matched
	MatchCheck string              `json:"match-check,omitempty"`
	Results    []NfdAnalyticRecord `json:"results"`
	// total number of results, with data containing paged amount based on offset/limit
	Total int64 `json:"total"`
}
    type NfdApiNfdActivityOpts ¶
type NfdApiNfdAnalyticsOpts ¶
type NfdApiNfdAnalyticsOpts struct {
	Name               optional.String
	Buyer              optional.String
	Seller             optional.String
	Event              optional.Interface
	RequireBuyer       optional.Bool
	IncludeOwner       optional.Bool
	ExcludeNFDAsSeller optional.Bool
	Category           optional.Interface
	SaleType           optional.Interface
	Length             optional.Interface
	Traits             optional.Interface
	ParentAppID        optional.Int64
	MinPrice           optional.Int64
	MaxPrice           optional.Int64
	AfterTime          optional.Time
	Limit              optional.Int64
	Offset             optional.Int64
	Sort               optional.String
	IfNoneMatch        optional.String
}
    type NfdApiNfdBadgesOpts ¶
type NfdApiNfdBrowseOpts ¶
type NfdApiNfdBrowseOpts struct {
	Name         optional.String
	Category     optional.Interface
	SaleType     optional.Interface
	State        optional.Interface
	ParentAppID  optional.Int64
	Length       optional.Interface
	Traits       optional.Interface
	Owner        optional.String
	ReservedFor  optional.String
	Prefix       optional.String
	Substring    optional.String
	Vproperty    optional.String
	Vvalue       optional.String
	MinPrice     optional.Int64
	MaxPrice     optional.Int64
	ChangedAfter optional.Time
	Limit        optional.Int64
	Offset       optional.Int64
	Sort         optional.String
	View         optional.String
	IfNoneMatch  optional.String
}
    type NfdApiNfdGetLookupOpts ¶
type NfdApiNfdGetNFDOpts ¶
type NfdApiNfdSearchV2Opts ¶
type NfdApiNfdSearchV2Opts struct {
	Name                optional.String
	Category            optional.Interface
	SaleType            optional.Interface
	State               optional.Interface
	ParentAppID         optional.Int64
	Length              optional.Interface
	Traits              optional.Interface
	Owner               optional.String
	ReservedFor         optional.String
	ExcludeUserReserved optional.Bool
	Prefix              optional.String
	Substring           optional.String
	Vproperty           optional.String
	Vvalue              optional.String
	SegmentLocked       optional.Bool
	SegmentRoot         optional.Bool
	MinPrice            optional.Int64
	MaxPrice            optional.Int64
	MinPriceUsd         optional.Int64
	MaxPriceUsd         optional.Int64
	ChangedAfter        optional.Time
	Limit               optional.Int64
	Offset              optional.Int64
	Sort                optional.String
	View                optional.String
	IfNoneMatch         optional.String
}
    type NfdApiNfdSuggestOpts ¶
type NfdApiNfdTotalsOpts ¶
type NfdApiService ¶
type NfdApiService service
func (*NfdApiService) NfdActivity ¶
func (a *NfdApiService) NfdActivity(ctx context.Context, name []string, localVarOptionals *NfdApiNfdActivityOpts) ([]NfdActivity, *http.Response, error)
func (*NfdApiService) NfdAnalytics ¶
func (a *NfdApiService) NfdAnalytics(ctx context.Context, localVarOptionals *NfdApiNfdAnalyticsOpts) (NfdAnalyticRecords, *http.Response, error)
func (*NfdApiService) NfdBrowse ¶
func (a *NfdApiService) NfdBrowse(ctx context.Context, localVarOptionals *NfdApiNfdBrowseOpts) ([]NfdRecord, *http.Response, error)
func (*NfdApiService) NfdConsensusLeaders ¶
func (a *NfdApiService) NfdConsensusLeaders(ctx context.Context, localVarOptionals *NfdApiNfdConsensusLeadersOpts) ([]ConsensusRecord, *http.Response, error)
func (*NfdApiService) NfdConsensusMetrics ¶
func (a *NfdApiService) NfdConsensusMetrics(ctx context.Context, localVarOptionals *NfdApiNfdConsensusMetricsOpts) (map[string][]map[string]string, *http.Response, error)
func (*NfdApiService) NfdContractLock ¶
func (a *NfdApiService) NfdContractLock(ctx context.Context, body ContractLockRequestBody, name string) (string, *http.Response, error)
NfdApiService contractLock nfd Lock/Unlock an NFD contract - if locked, the contract can never being modified until unlocked again by the owner.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdContractUpgrade ¶
func (a *NfdApiService) NfdContractUpgrade(ctx context.Context, body RescindOfferRequestBody, name string) (string, *http.Response, error)
NfdApiService contractUpgrade nfd Request upgrade of a pre 2.11 NFD to 2.11 (going no further)
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdContractUpgradeV3 ¶ added in v0.0.5
func (a *NfdApiService) NfdContractUpgradeV3(ctx context.Context, body RescindOfferRequestBody, name string) (string, *http.Response, error)
NfdApiService ContractUpgradeV3 nfd Request upgrade of a 2.11 or 3.x NFD to 3.x+ (post renewals). First switch to 3.x will pay 1 year renewal fee
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdDonationLeadersV2 ¶
func (a *NfdApiService) NfdDonationLeadersV2(ctx context.Context, name string) ([]Donation, *http.Response, error)
NfdApiService donationLeadersV2 nfd Get top donors to a specific NFD Donation target
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name
@return []Donation
func (*NfdApiService) NfdDonationListV2 ¶
func (a *NfdApiService) NfdDonationListV2(ctx context.Context) ([]NfdRecordResponseFull, *http.Response, error)
NfdApiService donationListV2 nfd Fetch list of tracked Donation NFD 'targets'.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return []NfdRecordResponseFull
func (*NfdApiService) NfdDonations ¶
func (a *NfdApiService) NfdDonations(ctx context.Context, name string) ([]Donation, *http.Response, error)
NfdApiService donations nfd Fetch donation activity for an NFD, totalling amounts sent 'to' designated donation accounts
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name
@return []Donation
func (*NfdApiService) NfdGetLookup ¶
func (a *NfdApiService) NfdGetLookup(ctx context.Context, address []string, localVarOptionals *NfdApiNfdGetLookupOpts) (map[string]NfdRecordinaddress, *http.Response, error)
func (*NfdApiService) NfdGetNFD ¶
func (a *NfdApiService) NfdGetNFD(ctx context.Context, nameOrID string, localVarOptionals *NfdApiNfdGetNFDOpts) (NfdRecord, *http.Response, error)
func (*NfdApiService) NfdGetNFDsForAddressesV2 ¶
func (a *NfdApiService) NfdGetNFDsForAddressesV2(ctx context.Context, address []string, localVarOptionals *NfdApiNfdGetNFDsForAddressesV2Opts) (map[string][]NfdRecordinaddress, *http.Response, error)
func (*NfdApiService) NfdGetNameSig ¶
func (a *NfdApiService) NfdGetNameSig(ctx context.Context, name string) (string, *http.Response, error)
NfdApiService getNameSig nfd Returns NameSig address for an NFD name (usable for V1 only)
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name
@return string
func (*NfdApiService) NfdGetQuote ¶ added in v0.0.5
func (a *NfdApiService) NfdGetQuote(ctx context.Context, buyer string, name string) (GetQuoteResponseBody, *http.Response, error)
NfdApiService getQuote nfd get price / carry cost to mint or rewnew an NFD (if existing)
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param buyer Address requesting price. Optional, but important when getting quote on existing nfd that is expired. If expired, then owner can renew for base price, but if not existing (but expired) owner, then the price is reverse-auction format over 28 days.
- @param name
@return GetQuoteResponseBody
func (*NfdApiService) NfdGetRevAddressSig ¶
func (a *NfdApiService) NfdGetRevAddressSig(ctx context.Context, address string) (string, *http.Response, error)
NfdApiService getRevAddressSig nfd Returns RevAddress address for an NFD name (usable for V1 only)
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param address
@return string
func (*NfdApiService) NfdIsValidASA ¶
func (a *NfdApiService) NfdIsValidASA(ctx context.Context, asaID int64) (IsValidAsaResponseBody, *http.Response, error)
NfdApiService isValidASA nfd Determines if specified NFD NFT ASA ID is authentic NFD
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param asaID Asset ID of a presumed NFD ASA to verify. The API will verify the found asset references an NFD that in turn references that asset.
@return IsValidAsaResponseBody
func (*NfdApiService) NfdIsValidNFD ¶
func (a *NfdApiService) NfdIsValidNFD(ctx context.Context, appID int64) (IsValidNfdResponseBody, *http.Response, error)
NfdApiService isValidNFD nfd Determines if specified NFD Application ID is authentic
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param appID Application ID of a presumed NFD to verify. The API will perform a forward-name lookup of the name within the NFD to verify it points to the same ID
@return IsValidNfdResponseBody
func (*NfdApiService) NfdLinkAddress ¶
func (a *NfdApiService) NfdLinkAddress(ctx context.Context, body LinkAddressRequestBody, name string) (string, *http.Response, error)
NfdApiService linkAddress nfd Link one or more addresses to an NFD, adding to the reverse-address lookups as well as to this NFD. Sender must be owner, and each added address must be able to be signed for.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdMint ¶ added in v0.0.5
func (a *NfdApiService) NfdMint(ctx context.Context, body MintRequestBody) (string, *http.Response, error)
NfdApiService mint nfd Mint a new NFD, with user buying specified NFD and paying for a prorated amount of time based on its yearly price.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return string
func (*NfdApiService) NfdOffer ¶
func (a *NfdApiService) NfdOffer(ctx context.Context, body OfferRequestBody, name string) (string, *http.Response, error)
NfdApiService offer nfd Offer up an NFD for sale - specifying price and optionally an address it is reserved for.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdPostOfferToOwner ¶
func (a *NfdApiService) NfdPostOfferToOwner(ctx context.Context, body PostOfferToOwnerRequestBody, name string) (string, *http.Response, error)
NfdApiService postOfferToOwner nfd Post an offer to buy to the owner of an NFD, offering up a particular amount with optional note for them to consider
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdPurchase ¶
func (a *NfdApiService) NfdPurchase(ctx context.Context, body PurchaseRequestBody, name string) (string, *http.Response, error)
NfdApiService purchase nfd Purchase an NFD for sale - specifying buyer (to sign transaction) and price
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdRenew ¶ added in v0.0.5
func (a *NfdApiService) NfdRenew(ctx context.Context, body RenewRequestBody) (string, *http.Response, error)
NfdApiService renew nfd Renew or extend the expiration of an NFD. If current owner, renews at base price. If other owner, can take ownership but goes through reverse auction process for first 28 days where price drops to base price - with price being for 1 year
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return string
func (*NfdApiService) NfdRescindOffer ¶
func (a *NfdApiService) NfdRescindOffer(ctx context.Context, body RescindOfferRequestBody, name string) (string, *http.Response, error)
NfdApiService rescindOffer nfd Rescind offer of sale. Claiming NFD back for self, and removing it for sale.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdSearchV2 ¶
func (a *NfdApiService) NfdSearchV2(ctx context.Context, localVarOptionals *NfdApiNfdSearchV2Opts) (NfdV2SearchRecords, *http.Response, error)
func (*NfdApiService) NfdSegmentLeaders ¶
func (a *NfdApiService) NfdSegmentLeaders(ctx context.Context, localVarOptionals *NfdApiNfdSegmentLeadersOpts) ([]NfdRecord, *http.Response, error)
func (*NfdApiService) NfdSegmentLock ¶
func (a *NfdApiService) NfdSegmentLock(ctx context.Context, body SegmentLockRequestBody, name string) (string, *http.Response, error)
NfdApiService Lock/Unlock an NFD segment - specifying open price if unlocking Lock/Unlock an NFD segment - if locked, the segment only allows minted names created by the segment owner. If unlocked, anyone can mint off the segment for the price (in USD) the owner sets
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdSendFromVault ¶
func (a *NfdApiService) NfdSendFromVault(ctx context.Context, body SendFromVaultRequestBody, name string) (string, *http.Response, error)
NfdApiService sendFromVault nfd Send an amount of an asset [0 == ALGO] to another account FROM the NFD Vault. Only owner of NFD can send.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdSendToVault ¶
func (a *NfdApiService) NfdSendToVault(ctx context.Context, body SendToVaultRequestBody, name string) (string, *http.Response, error)
NfdApiService sendToVault nfd Provide transaction to send an asset owned by sender account to an NFD vault. Call to have opt-in to vault will be included if necessary. Callable by NFD owner, or if Opt-in is UNLOCKED (or asset already opted-in), anyone can call
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdSetPrimaryAddress ¶
func (a *NfdApiService) NfdSetPrimaryAddress(ctx context.Context, body SetPrimaryAddressRequestBody, name string) (string, *http.Response, error)
NfdApiService setPrimaryAddress nfd Set which of the currently verified addresses should be the first in the list (swapping positions as necessary)
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdSetPrimaryNFD ¶
func (a *NfdApiService) NfdSetPrimaryNFD(ctx context.Context, body SetPrimaryAddressRequestBody, name string) (string, *http.Response, error)
NfdApiService setPrimaryNFD nfd Set the specified NFD as the primary NFD to return for the specified address via its reverse lookup
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdSuggest ¶
func (a *NfdApiService) NfdSuggest(ctx context.Context, buyer string, name string, localVarOptionals *NfdApiNfdSuggestOpts) ([]NfdRecord, *http.Response, error)
func (*NfdApiService) NfdTotals ¶
func (a *NfdApiService) NfdTotals(ctx context.Context, localVarOptionals *NfdApiNfdTotalsOpts) (TotalsOkResponseBody, *http.Response, error)
func (*NfdApiService) NfdTwitterLeaders ¶
func (a *NfdApiService) NfdTwitterLeaders(ctx context.Context, localVarOptionals *NfdApiNfdTwitterLeadersOpts) ([]TwitterRecord, *http.Response, error)
func (*NfdApiService) NfdUnlinkAddress ¶
func (a *NfdApiService) NfdUnlinkAddress(ctx context.Context, body LinkAddressRequestBody, name string) (string, *http.Response, error)
NfdApiService unlinkAddress nfd UnLink one or more addresses to an NFD, adding to the reverse-address lookups as well as to this NFD. Sender must be owner, and each added address must be able to be signed for.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdUpdateAll ¶
func (a *NfdApiService) NfdUpdateAll(ctx context.Context, body UpdatePartialRequestBody, name string) (string, *http.Response, error)
NfdApiService updateAll nfd Replace all NFD user-settable attributes with those passed-in, removing, adding and replacing on behalf of a particular sender (who must be the owner). Returns transaction group of transactions to sign
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdUpdateImage ¶
func (*NfdApiService) NfdUpdatePartial ¶
func (a *NfdApiService) NfdUpdatePartial(ctx context.Context, body UpdatePartialRequestBody, name string) (string, *http.Response, error)
NfdApiService updatePartial nfd Set an attribute in an NFD on behalf of a particular sender (who must be the owner). Can set user-defined fields, or clear verified fields (except v.ca*)
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdVaultOptInLock ¶
func (a *NfdApiService) NfdVaultOptInLock(ctx context.Context, body ContractLockRequestBody, name string) (string, *http.Response, error)
NfdApiService vaultOptInLock nfd Lock/Unlock ability for the specified NFD Vault to auto opt-in to assets, allowing airdrops from other accounts
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param name
@return string
func (*NfdApiService) NfdVerifyConfirm ¶
func (a *NfdApiService) NfdVerifyConfirm(ctx context.Context, body VerifyConfirmRequestBody, id string) (VerifyConfirmResponseBody, *http.Response, error)
NfdApiService verifyConfirm nfd Verify a particular piece of data on, or off-chain. Each verification differs in its requirements
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param id ID of challenge, must be used in subsequent confirmation call
@return VerifyConfirmResponseBody
func (*NfdApiService) NfdVerifyRequest ¶
func (a *NfdApiService) NfdVerifyRequest(ctx context.Context, body VerifyRequestRequestBody) (VerifyRequestResponseBody, *http.Response, error)
NfdApiService verifyRequest nfd Request Verification for particular piece of data on, or off-chain. Each verification differs in its requirements. Returns data to be used in challenge
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return VerifyRequestResponseBody
type NfdProperties ¶
type NfdProperties struct {
	// Internal properties
	Internal map[string]string `json:"internal,omitempty"`
	// User properties
	UserDefined map[string]string `json:"userDefined,omitempty"`
	// Verified properties
	Verified map[string]string `json:"verified,omitempty"`
}
    NFDProperties contains the expanded metadata stored within an NFD contracts' global-state
type NfdRecord ¶
type NfdRecord struct {
	// NFD Application ID
	AppID int64 `json:"appID,omitempty"`
	// NFD ASA ID
	AsaID int64 `json:"asaID,omitempty"`
	// Whether the verified Avatar set in this NFD is newer (arc19) then is set into the NFD. This will only be present on direct NFD fetch and if true
	AvatarOutdated bool `json:"avatarOutdated,omitempty"`
	// Verified Algorand addresses for this NFD
	CaAlgo   []string `json:"caAlgo,omitempty"`
	Category string   `json:"category,omitempty"`
	// Round this data was last fetched from
	CurrentAsOfBlock int64 `json:"currentAsOfBlock,omitempty"`
	// account wallets should send funds to - precedence is: caAlgo[0], unverifiedCaAlgo[0], owner
	DepositAccount string `json:"depositAccount,omitempty"`
	Expired        bool   `json:"expired,omitempty"`
	// Not returned, used in tagging for response to indicate if-none-match etag matched
	MatchCheck string `json:"match-check,omitempty"`
	// Tags set by the system for tracking/analytics
	MetaTags   []string `json:"metaTags,omitempty"`
	Name       string   `json:"name"`
	NfdAccount string   `json:"nfdAccount,omitempty"`
	// Owner of NFD
	Owner string `json:"owner,omitempty"`
	// NFD Application ID of Parent if this is a segment
	ParentAppID int64          `json:"parentAppID,omitempty"`
	Properties  *NfdProperties `json:"properties,omitempty"`
	// Reserved owner of NFD
	ReservedFor string `json:"reservedFor,omitempty"`
	SaleType    string `json:"saleType,omitempty"`
	// amount NFD is being sold for (microAlgos)
	SellAmount int64 `json:"sellAmount,omitempty"`
	// RecipientUid of NFD sales
	Seller         string `json:"seller,omitempty"`
	SigNameAddress string `json:"sigNameAddress,omitempty"`
	State          string `json:"state,omitempty"`
	// Tags assigned to this NFD
	Tags          []string  `json:"tags,omitempty"`
	TimeChanged   time.Time `json:"timeChanged,omitempty"`
	TimeCreated   time.Time `json:"timeCreated,omitempty"`
	TimeExpires   time.Time `json:"timeExpires,omitempty"`
	TimePurchased time.Time `json:"timePurchased,omitempty"`
	// Unverified (non-algo) Crypto addresses for this NFD
	UnverifiedCa map[string][]string `json:"unverifiedCa,omitempty"`
	// Unverified Algorand addresses for this NFD
	UnverifiedCaAlgo []string `json:"unverifiedCaAlgo,omitempty"`
}
    type NfdRecordResponseFull ¶
type NfdRecordResponseFull struct {
	// NFD Application ID
	AppID int64 `json:"appID,omitempty"`
	// NFD ASA ID
	AsaID int64 `json:"asaID,omitempty"`
	// Whether the verified Avatar set in this NFD is newer (arc19) then is set into the NFD. This will only be present on direct NFD fetch and if true
	AvatarOutdated bool `json:"avatarOutdated,omitempty"`
	// Verified Algorand addresses for this NFD
	CaAlgo []string `json:"caAlgo,omitempty"`
	// Cache-Control header
	CacheControl string `json:"cache-control,omitempty"`
	Category     string `json:"category,omitempty"`
	// Round this data was last fetched from
	CurrentAsOfBlock int64 `json:"currentAsOfBlock,omitempty"`
	// account wallets should send funds to - precedence is: caAlgo[0], unverifiedCaAlgo[0], owner
	DepositAccount string `json:"depositAccount,omitempty"`
	// ETag
	Etag    string `json:"etag,omitempty"`
	Expired bool   `json:"expired,omitempty"`
	// Not returned, used in tagging for response to indicate if-none-match etag matched
	MatchCheck string `json:"match-check,omitempty"`
	// Tags set by the system for tracking/analytics
	MetaTags   []string `json:"metaTags,omitempty"`
	Name       string   `json:"name"`
	NfdAccount string   `json:"nfdAccount,omitempty"`
	// Owner of NFD
	Owner string `json:"owner,omitempty"`
	// NFD Application ID of Parent if this is a segment
	ParentAppID int64          `json:"parentAppID,omitempty"`
	Properties  *NfdProperties `json:"properties,omitempty"`
	// Reserved owner of NFD
	ReservedFor string `json:"reservedFor,omitempty"`
	SaleType    string `json:"saleType,omitempty"`
	// amount NFD is being sold for (microAlgos)
	SellAmount int64 `json:"sellAmount,omitempty"`
	// RecipientUid of NFD sales
	Seller         string `json:"seller,omitempty"`
	SigNameAddress string `json:"sigNameAddress,omitempty"`
	State          string `json:"state,omitempty"`
	// Tags assigned to this NFD
	Tags          []string  `json:"tags,omitempty"`
	TimeChanged   time.Time `json:"timeChanged,omitempty"`
	TimeCreated   time.Time `json:"timeCreated,omitempty"`
	TimeExpires   time.Time `json:"timeExpires,omitempty"`
	TimePurchased time.Time `json:"timePurchased,omitempty"`
	// Unverified (non-algo) Crypto addresses for this NFD
	UnverifiedCa map[string][]string `json:"unverifiedCa,omitempty"`
	// Unverified Algorand addresses for this NFD
	UnverifiedCaAlgo []string `json:"unverifiedCaAlgo,omitempty"`
}
    NFD contains all known information about an NFD record (full view)
type NfdRecordinaddress ¶
type NfdRecordinaddress struct {
	// NFD Application ID
	AppID int64 `json:"appID,omitempty"`
	// NFD ASA ID
	AsaID int64 `json:"asaID,omitempty"`
	// Whether the verified Avatar set in this NFD is newer (arc19) then is set into the NFD. This will only be present on direct NFD fetch and if true
	AvatarOutdated bool `json:"avatarOutdated,omitempty"`
	// Verified Algorand addresses for this NFD
	CaAlgo []string `json:"caAlgo,omitempty"`
	// Cache-Control header
	CacheControl string `json:"cache-control,omitempty"`
	Category     string `json:"category,omitempty"`
	// Round this data was last fetched from
	CurrentAsOfBlock int64 `json:"currentAsOfBlock,omitempty"`
	// account wallets should send funds to - precedence is: caAlgo[0], unverifiedCaAlgo[0], owner
	DepositAccount string `json:"depositAccount,omitempty"`
	// ETag
	Etag    string `json:"etag,omitempty"`
	Expired bool   `json:"expired,omitempty"`
	// Not returned, used in tagging for response to indicate if-none-match etag matched
	MatchCheck string `json:"match-check,omitempty"`
	// Tags set by the system for tracking/analytics
	MetaTags   []string `json:"metaTags,omitempty"`
	Name       string   `json:"name"`
	NfdAccount string   `json:"nfdAccount,omitempty"`
	// Owner of NFD
	Owner string `json:"owner,omitempty"`
	// NFD Application ID of Parent if this is a segment
	ParentAppID int64          `json:"parentAppID,omitempty"`
	Properties  *NfdProperties `json:"properties,omitempty"`
	// Reserved owner of NFD
	ReservedFor string `json:"reservedFor,omitempty"`
	SaleType    string `json:"saleType,omitempty"`
	// amount NFD is being sold for (microAlgos)
	SellAmount int64 `json:"sellAmount,omitempty"`
	// RecipientUid of NFD sales
	Seller         string `json:"seller,omitempty"`
	SigNameAddress string `json:"sigNameAddress,omitempty"`
	State          string `json:"state,omitempty"`
	// Tags assigned to this NFD
	Tags          []string  `json:"tags,omitempty"`
	TimeChanged   time.Time `json:"timeChanged,omitempty"`
	TimeCreated   time.Time `json:"timeCreated,omitempty"`
	TimeExpires   time.Time `json:"timeExpires,omitempty"`
	TimePurchased time.Time `json:"timePurchased,omitempty"`
	// Unverified (non-algo) Crypto addresses for this NFD
	UnverifiedCa map[string][]string `json:"unverifiedCa,omitempty"`
	// Unverified Algorand addresses for this NFD
	UnverifiedCaAlgo []string `json:"unverifiedCaAlgo,omitempty"`
}
    NFD contains all known information about an NFD record
type NfdV2SearchRecords ¶
type NfdV2SearchRecords struct {
	// Not returned, used in tagging for response to indicate if-none-match etag matched
	MatchCheck string       `json:"match-check,omitempty"`
	Nfds       *[]NfdRecord `json:"nfds"`
	// total number of results, with data containing paged amount based on offset/limit
	Total int64 `json:"total"`
}
    type OfferRequestBody ¶
type OfferRequestBody struct {
	// Amount in microAlgo to sell the NFD for.  1 ALGO is 1,000,000 microAlgo. 100 million maximum.
	Offer int64 `json:"offer"`
	// Whether to pay the offer amount + fees to the account the NFD is reserved for.  Equivalent to 'gifting' the NFD
	PayReceiver bool   `json:"payReceiver,omitempty"`
	ReservedFor string `json:"reservedFor,omitempty"`
	// Sender of transaction - needs to be owner of NFD
	Sender string `json:"sender"`
}
    type PurchaseRequestBody ¶
type RateLimited ¶
type RenewRequestBody ¶ added in v0.0.5
type RenewRequestBody struct {
	// Offer price in ALGO. Expiration time set prorated based on amount paid vs fixed per-year cost when years argument is used
	AlgoOffer int64 `json:"algoOffer,omitempty"`
	// Address paying/signing for minting transaction
	Buyer string `json:"buyer"`
	Name  string `json:"name"`
	// Number of years until expiration, 1 yr minimum, 20 max, extending renewal date - sets price in multiples of 1 year. If not current owner and expired, only 1 year is allowed
	Years int64 `json:"years,omitempty"`
}
    type RescindOfferRequestBody ¶
type RescindOfferRequestBody struct {
	// Sender of transaction - needs to be owner of NFD
	Sender string `json:"sender"`
}
    type SegmentLockRequestBody ¶
type SegmentLockRequestBody struct {
	// Whether to lock (true), or unlock (false)
	Lock bool `json:"lock"`
	// amount users minting off the segment have to pay to mint in USD (in cents - ie: 300 = $3.00). Set to 0 if locking
	SellAmount int64 `json:"sellAmount"`
	// Sender of transaction - needs to be owner of NFD
	Sender string `json:"sender"`
}
    type SendFromVaultRequestBody ¶
type SendFromVaultRequestBody struct {
	// Base amount (in base units of specified asset - so decimals must be considered) of asset to send.   If multiple assets are specified, amount is should be 0 as ALL of each are sent and closed out
	Amount int64 `json:"amount,omitempty"`
	// String version of Base amount (in base units of specified asset - so decimals must be considered) of asset to send.  This is used to work around JS deficiencies with bigint
	AmountStr string `json:"amountStr,omitempty"`
	// Algorand ASA IDs to transfer FROM vault - use asset 0 to send ALGO.  Specifying multiple assets means ALL of each are sent and amount is ignored. If receiver is a vault and needs to opt-in, then need MBR/opt-in pairs (5 pairs - 8  opt-ins each - 40 assets), then 6 send calls of 7 assets w/ 5 at end for total of 40.  If receiver is already opted-in, then 112 (7 per txn, 16 tnxs) is max.
	Assets []int64 `json:"assets"`
	// Optional note to include in asset send transaction
	Note string `json:"note,omitempty"`
	// Algorand account or NFD Name (if vault receiver) the asset(s) should be sent to
	Receiver string `json:"receiver"`
	// Specifies that the receiver account is something the caller can sign for. If specified, then opt-in transactions it signs may be included
	ReceiverCanSign bool `json:"receiverCanSign,omitempty"`
	// Type of receiver, 'account', or 'nfdVault'
	ReceiverType string `json:"receiverType,omitempty"`
	// Sender of transaction, must be NFD owner
	Sender string `json:"sender"`
}
    type SendToVaultRequestBody ¶
type SendToVaultRequestBody struct {
	// Base amount (in base units of specified asset - so decimals must be considered) of asset to send.   If multiple assets specified, amount is ignored and ALL of each are sent
	Amount int64 `json:"amount,omitempty"`
	// String version of Base amount (in base units of specified asset - so decimals must be considered) of asset to send.  This is used to work around JS deficiencies with bigint
	AmountStr string `json:"amountStr,omitempty"`
	// Algorand ASA IDs to transfer (and opt-in inside vault if necessary) - use asset 0 to send ALGO.  Specifying multiple assets means ALL of each are sent and amount is ignored. 13 is max assets that can be specified if they're being sent (2 for MBR payments, 2 for opt-in txns (8+4 asset opt-ins), 12 asset transfers).  If opt-in only then 64 is maximum (1 MBR per 8 assets, 8 assets per txn * 8 txns)
	Assets []int64 `json:"assets"`
	// Optional note to include in asset send transaction
	Note string `json:"note,omitempty"`
	// Whether to only opt-in to the asset, instead of including asset transfer txn
	OptInOnly bool   `json:"optInOnly"`
	Sender    string `json:"sender"`
}
    type TotalsOkResponseBody ¶
type TotalsOkResponseBody struct {
	ContractTotals *TotalsOkResponseBodyContractTotals `json:"contractTotals"`
	// NFDs that have expired
	ExpiredTotal int64 `json:"expiredTotal"`
	ForSale      int64 `json:"forSale"`
	// Not returned, used in tagging for response to indicate if-none-match etag matched
	MatchCheck    string                            `json:"match-check,omitempty"`
	MintedTotals  *TotalsOkResponseBodyMintedTotals `json:"mintedTotals"`
	SegmentTotals *TotalsOkResponseBodyMintedTotals `json:"segmentTotals"`
	SoldTotals    *TotalsOkResponseBodyMintedTotals `json:"soldTotals"`
	Total         int64                             `json:"total"`
	TotalSegments int64                             `json:"totalSegments"`
	UniqueOwners  int64                             `json:"uniqueOwners"`
}
    type TotalsOkResponseBodyContractTotals ¶ added in v0.0.5
type TwitterRecord ¶
type TwitterRecord struct {
	Followers     int64     `json:"followers"`
	Following     int64     `json:"following"`
	Nfd           *Nfd      `json:"nfd"`
	TimeChanged   time.Time `json:"timeChanged"`
	Tweets        int64     `json:"tweets"`
	TwitterHandle string    `json:"twitterHandle"`
}
    TwitterRecord contains information about an NFD w/ Verified Twitter account and basic info on its twitter metrics
type UpdatePartialRequestBody ¶
type UpdatePartialRequestBody struct {
	Properties *NfdProperties `json:"properties"`
	// Address that will be signing the returned transactions.  Should be owner of NFD
	Sender string `json:"sender"`
}
    type VerifyConfirmRequestBody ¶
type VerifyConfirmRequestBody struct {
	// Challenge value, optional depending on verification type
	Challenge string `json:"challenge,omitempty"`
}
    type VerifyConfirmResponseBody ¶
type VerifyConfirmResponseBody struct {
	Confirmed bool `json:"confirmed"`
}
    Whether verification was successful
type VerifyRequestResponseBody ¶
type VerifyRequestResponseBody struct {
	// Challenge to be used as part of verification process, with use specific to each field
	Challenge string `json:"challenge"`
	// ID of challenge, must be used in subsequent confirmation call but may be blank
	Id string `json:"id"`
	// If set, no confirmation is required, the verify call was sufficient
	Validated bool `json:"validated,omitempty"`
}
    Data to use as part of verification
type VersionResponseBody ¶
       Source Files
      ¶
      Source Files
      ¶
    
- api_info.go
- api_nfd.go
- client.go
- configuration.go
- model_consensus_record.go
- model_contract_lock_request_body.go
- model_donation.go
- model_error.go
- model_get_quote_response_body.go
- model_is_valid_asa_response_body.go
- model_is_valid_nfd_response_body.go
- model_link_address_request_body.go
- model_mint_request_body.go
- model_nfd.go
- model_nfd_activity.go
- model_nfd_analytic_event.go
- model_nfd_analytic_record.go
- model_nfd_analytic_records.go
- model_nfd_properties.go
- model_nfd_record.go
- model_nfd_record_response_full.go
- model_nfd_recordinaddress.go
- model_nfd_v2_search_records.go
- model_offer_request_body.go
- model_post_offer_to_owner_request_body.go
- model_purchase_request_body.go
- model_rate_limited.go
- model_renew_request_body.go
- model_rescind_offer_request_body.go
- model_segment_lock_request_body.go
- model_send_from_vault_request_body.go
- model_send_to_vault_request_body.go
- model_set_primary_address_request_body.go
- model_totals_ok_response_body.go
- model_totals_ok_response_body_contract_totals.go
- model_totals_ok_response_body_minted_totals.go
- model_twitter_record.go
- model_update_partial_request_body.go
- model_verify_confirm_request_body.go
- model_verify_confirm_response_body.go
- model_verify_request_request_body.go
- model_verify_request_response_body.go
- model_version_response_body.go
- response.go