highlight

Documentation

Index

• Variables
• type ClaimStatus
• type ErrHighlightCollectionMintUnavailable
  • func (e ErrHighlightCollectionMintUnavailable) Error() string
• type ErrHighlightInternalError
  • func (e ErrHighlightInternalError) Error() string
  • func (e ErrHighlightInternalError) Unwrap() error
• type ErrHighlightTxnFailed
  • func (e ErrHighlightTxnFailed) Error() string
• type Provider
  • func NewProvider(c *http.Client) *Provider
  • func (api *Provider) ClaimMint(ctx context.Context, collectionID string, qty int, ...) (claimID string, status ClaimStatus, chainAddress persist.ChainAddress, ...)
  • func (api *Provider) GetClaimStatus(ctx context.Context, claimID string) (ClaimStatus, persist.DecimalTokenID, persist.TokenMetadata, error)

Variables

var ErrHighlightChainNotSupported = errors.New("chain is not supported by highlight")

var ErrHighlightMaxClaims = errors.New("user hit max claims")

Types

type ClaimStatus

type ClaimStatus string

ClaimStatus represents the progress of a Highlight mint

const (

	// Lifecycle of a highlight mint
	ClaimStatusTxPending       ClaimStatus = "TX_PENDING"
	ClaimStatusTxFailed        ClaimStatus = "TX_FAILED"
	ClaimStatusTxSucceeded     ClaimStatus = "TX_SUCCEEDED"
	ClaimStatusMediaProcessing ClaimStatus = "MEDIA_PROCESSING"
	ClaimStatusMediaProcessed  ClaimStatus = "MEDIA_PROCESSED"
	ClaimStatusMediaFailed     ClaimStatus = "MEDIA_FAILED"
	ClaimStatusFailedInternal  ClaimStatus = "FAILED_INTERNAL"
)

type ErrHighlightCollectionMintUnavailable

type ErrHighlightCollectionMintUnavailable struct{ CollectionID string }

func (ErrHighlightCollectionMintUnavailable) Error

func (e ErrHighlightCollectionMintUnavailable) Error() string

type ErrHighlightInternalError

type ErrHighlightInternalError struct{ Err error }

func (ErrHighlightInternalError) Error

func (e ErrHighlightInternalError) Error() string

func (ErrHighlightInternalError) Unwrap

func (e ErrHighlightInternalError) Unwrap() error

type ErrHighlightTxnFailed

type ErrHighlightTxnFailed struct{ Msg string }

func (ErrHighlightTxnFailed) Error

func (e ErrHighlightTxnFailed) Error() string

type Provider

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

func NewProvider

func NewProvider(c *http.Client) *Provider

func (*Provider) ClaimMint

func (api *Provider) ClaimMint(ctx context.Context, collectionID string, qty int, recipient persist.ChainAddress) (claimID string, status ClaimStatus, chainAddress persist.ChainAddress, err error)

func (*Provider) GetClaimStatus

func (api *Provider) GetClaimStatus(ctx context.Context, claimID string) (ClaimStatus, persist.DecimalTokenID, persist.TokenMetadata, error)