swap

Documentation

Index

• Constants
• Variables
• type BadRequestError
  • func NewBadRequestError(errors ...string) (err *BadRequestError)
  • func (e *BadRequestError) Error() (s string)
  • func (e *BadRequestError) Errors() (errs []string)
• type BlockTimeFetcher
• type Client
• type GethClient
  • func NewGethClient(baseURL *url.URL, o *GethClientOptions, logger logging.Logger) *GethClient
  • func (g *GethClient) AttestOverlayEthAddress(ctx context.Context, ethAddr string) (tx string, err error)
  • func (g *GethClient) FetchBlockTime(ctx context.Context, opts ...Option) (int64, error)
  • func (g *GethClient) SendBZZ(ctx context.Context, to string, amount float64) (tx string, err error)
  • func (g *GethClient) SendETH(ctx context.Context, to string, amount float64) (tx string, err error)
  • func (g *GethClient) SendGBZZ(ctx context.Context, to string, amount float64) (tx string, err error)
• type GethClientOptions
• type NotSet
  • func (n *NotSet) AttestOverlayEthAddress(ctx context.Context, ethAddr string) (tx string, err error)
  • func (n *NotSet) FetchBlockTime(ctx context.Context, opts ...Option) (blockTime int64, err error)
  • func (n *NotSet) SendBZZ(ctx context.Context, to string, amount float64) (tx string, err error)
  • func (n *NotSet) SendETH(ctx context.Context, to string, amount float64) (tx string, err error)
  • func (n *NotSet) SendGBZZ(ctx context.Context, to string, amount float64) (tx string, err error)
• type Option
  • func WithOffset(offset int64) Option
  • func WithRefresh() Option

Constants

const (
	BzzTokenAddress       = "0x6aab14fe9cccd64a502d23842d916eb5321c26e7"
	EthAccount            = "0x62cab2b3b55f341f10348720ca18063cdb779ad5"
	GasPrice        int64 = 10000000000
	BzzGasLimit           = 100000
	EthGasLimit           = 21000
)

Variables

var (
	ErrEmptyTimestamp   = errors.New("empty timestamp, offset too large")
	ErrInvalidTimestamp = errors.New("invalid timestamp")
	ErrEmptyResult      = errors.New("empty result")
	ErrInvalidResult    = errors.New("invalid result")
)

var (
	ErrUnauthorized        = errors.New("unauthorized")
	ErrForbidden           = errors.New("forbidden")
	ErrNotFound            = errors.New("not found")
	ErrMethodNotAllowed    = errors.New("method not allowed")
	ErrTooManyRequests     = errors.New("too many requests")
	ErrInternalServerError = errors.New("internal server error")
	ErrServiceUnavailable  = errors.New("service unavailable")
)

Errors that are returned by the API.

var ErrNotSet = errors.New("swap client not initialized because geth-url is missing")

ErrNotSet represents error when Swap client is not set

Types

type BadRequestError

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

BadRequestError holds list of errors from http response that represent invalid data submitted by the user.

func NewBadRequestError

func NewBadRequestError(errors ...string) (err *BadRequestError)

NewBadRequestError constructs a new BadRequestError with provided errors.

func (*BadRequestError) Error

func (e *BadRequestError) Error() (s string)

func (*BadRequestError) Errors

func (e *BadRequestError) Errors() (errs []string)

Errors returns a list of error messages.

type BlockTimeFetcher

type BlockTimeFetcher interface {
	FetchBlockTime(ctx context.Context, opts ...Option) (blockTime int64, err error)
}

type Client

type Client interface {
	SendETH(ctx context.Context, to string, amount float64) (tx string, err error)
	SendBZZ(ctx context.Context, to string, amount float64) (tx string, err error)
	SendGBZZ(ctx context.Context, to string, amount float64) (tx string, err error)
	AttestOverlayEthAddress(ctx context.Context, ethAddr string) (tx string, err error)
	BlockTimeFetcher
}

Client defines Client interface

type GethClient

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

GethClient manages communication with the Geth node

func NewGethClient

func NewGethClient(baseURL *url.URL, o *GethClientOptions, logger logging.Logger) *GethClient

NewClient constructs a new Client.

func (*GethClient) AttestOverlayEthAddress

func (g *GethClient) AttestOverlayEthAddress(ctx context.Context, ethAddr string) (tx string, err error)

func (*GethClient) FetchBlockTime

func (g *GethClient) FetchBlockTime(ctx context.Context, opts ...Option) (int64, error)

FetchBlockTime estimates the average block time by comparing timestamps of the latest block and an earlier block, adjusting the offset if needed. The block time is cached and reused until forced to refresh.

func (*GethClient) SendBZZ

func (g *GethClient) SendBZZ(ctx context.Context, to string, amount float64) (tx string, err error)

SendBZZ makes BZZ token deposit

func (*GethClient) SendETH

func (g *GethClient) SendETH(ctx context.Context, to string, amount float64) (tx string, err error)

SendETH makes ETH deposit

func (*GethClient) SendGBZZ

func (g *GethClient) SendGBZZ(ctx context.Context, to string, amount float64) (tx string, err error)

SendGBZZ makes gBZZ token deposit

type GethClientOptions

type GethClientOptions struct {
	BzzTokenAddress string
	EthAccount      string
	HTTPClient      *http.Client
}

GethClientOptions holds optional parameters for the GethClient

type NotSet

type NotSet struct{}

func (*NotSet) AttestOverlayEthAddress

func (n *NotSet) AttestOverlayEthAddress(ctx context.Context, ethAddr string) (tx string, err error)

func (*NotSet) FetchBlockTime

func (n *NotSet) FetchBlockTime(ctx context.Context, opts ...Option) (blockTime int64, err error)

FetchBlockTime(ctx context.Context) (blockTime int64, err error)

func (*NotSet) SendBZZ

func (n *NotSet) SendBZZ(ctx context.Context, to string, amount float64) (tx string, err error)

SendBZZ makes BZZ token deposit

func (*NotSet) SendETH

func (n *NotSet) SendETH(ctx context.Context, to string, amount float64) (tx string, err error)

SendETH makes ETH deposit

func (*NotSet) SendGBZZ

func (n *NotSet) SendGBZZ(ctx context.Context, to string, amount float64) (tx string, err error)

SendGBZZ makes gBZZ token deposit

type Option

type Option func(*options)

func WithOffset

func WithOffset(offset int64) Option

WithOffset sets the number of blocks to use for block time estimation.

func WithRefresh

func WithRefresh() Option

WithRefresh forces the block time to be recalculated.