arc

Documentation

Index

• Constants
• type FeeAmount
• type Policy
• type PolicyContent
• type Service
  • func NewARCService(logger zerolog.Logger, httpClient *resty.Client, arcCfg chainmodels.ARCConfig) *Service
  • func (s *Service) Broadcast(ctx context.Context, tx *sdk.Transaction) (*chainmodels.TXInfo, error)
  • func (s *Service) GetPolicy(ctx context.Context) (*Policy, error)
  • func (s *Service) QueryTransaction(ctx context.Context, txID string) (*chainmodels.TXInfo, error)

Constants

const (
	StatusNotExtendedFormat             = 460
	StatusFeeTooLow                     = 465
	StatusCumulativeFeeValidationFailed = 473
)

Custom ARC defined http status codes

Types

type FeeAmount

type FeeAmount struct {
	Bytes    int          `json:"bytes"`
	Satoshis bsv.Satoshis `json:"satoshis"`
}

FeeAmount indicating how many satoshis are paid for the given number of bytes in the transaction.

type Policy

type Policy struct {
	Content   PolicyContent `json:"policy"`
	Timestamp time.Time     `json:"timestamp"`
}

Policy is the policy model returned from ARC

type PolicyContent

type PolicyContent struct {
	MaxScriptSizePolicy     int       `json:"maxscriptsizepolicy"`
	MaxTXSigOPSCountsPolicy int64     `json:"maxtxsigopscountspolicy"`
	MaxTXSizePolicy         int       `json:"maxtxsizepolicy"`
	MiningFee               FeeAmount `json:"miningFee"`
}

PolicyContent is the actual policy values returned from ARC

type Service

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

Service for arc requests.

func NewARCService

func NewARCService(logger zerolog.Logger, httpClient *resty.Client, arcCfg chainmodels.ARCConfig) *Service

NewARCService creates a new arc service.

func (*Service) Broadcast

func (s *Service) Broadcast(ctx context.Context, tx *sdk.Transaction) (*chainmodels.TXInfo, error)

Broadcast submits a transaction to the ARC server and returns the transaction info.

func (*Service) GetPolicy

func (s *Service) GetPolicy(ctx context.Context) (*Policy, error)

GetPolicy returns the current policy from the ARC server.

func (*Service) QueryTransaction

func (s *Service) QueryTransaction(ctx context.Context, txID string) (*chainmodels.TXInfo, error)

QueryTransaction a transaction.