onramp

Documentation

Index

• type CryptoOnRamp
• type Manager
  • func NewManager(providers []Provider) *Manager
  • func (c *Manager) GetProviders(ctx context.Context) ([]CryptoOnRamp, error)
  • func (c *Manager) GetURL(ctx context.Context, providerID string, parameters Parameters) (string, error)
• type MercuryoProvider
  • func NewMercuryoProvider(tokenManager token.ManagerInterface) *MercuryoProvider
  • func (p *MercuryoProvider) GetCryptoOnRamp(ctx context.Context) (CryptoOnRamp, error)
  • func (p *MercuryoProvider) GetURL(ctx context.Context, parameters Parameters) (string, error)
  • func (p *MercuryoProvider) ID() string
• type MoonPayProvider
  • func NewMoonPayProvider() *MoonPayProvider
  • func (p *MoonPayProvider) GetCryptoOnRamp(ctx context.Context) (CryptoOnRamp, error)
  • func (p *MoonPayProvider) GetURL(ctx context.Context, parameters Parameters) (string, error)
  • func (p *MoonPayProvider) ID() string
• type Parameters
• type Provider
• type RampProvider
  • func NewRampProvider() *RampProvider
  • func (p *RampProvider) GetCryptoOnRamp(ctx context.Context) (CryptoOnRamp, error)
  • func (p *RampProvider) GetURL(ctx context.Context, parameters Parameters) (string, error)
  • func (p *RampProvider) ID() string

Types

type CryptoOnRamp

type CryptoOnRamp struct {
	ID                        string         `json:"id"`
	Name                      string         `json:"name"`
	Description               string         `json:"description"`
	Fees                      string         `json:"fees"`
	LogoURL                   string         `json:"logoUrl"`
	Hostname                  string         `json:"hostname"`
	SupportsSinglePurchase    bool           `json:"supportsSinglePurchase"`
	SupportsRecurrentPurchase bool           `json:"supportsRecurrentPurchase"`
	SupportedChainIDs         []uint64       `json:"supportedChainIds"`
	SupportedTokens           []*token.Token `json:"supportedTokens"`    // Empty array means supported assets are not specified
	URLsNeedParameters        bool           `json:"urlsNeedParameters"` // True means Parameters are required for URL generation
	// Deprecated fields below, only used by mobile
	Params           map[string]string `json:"params"`
	SiteURL          string            `json:"siteUrl"`          // Replaced by call to GetURL
	RecurrentSiteURL string            `json:"recurrentSiteUrl"` // Replaced by call to GetURL
}

type Manager

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

func NewManager

func NewManager(providers []Provider) *Manager

func (*Manager) GetProviders

func (c *Manager) GetProviders(ctx context.Context) ([]CryptoOnRamp, error)

func (*Manager) GetURL

func (c *Manager) GetURL(ctx context.Context, providerID string, parameters Parameters) (string, error)

type MercuryoProvider

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

func NewMercuryoProvider

func NewMercuryoProvider(tokenManager token.ManagerInterface) *MercuryoProvider

func (*MercuryoProvider) GetCryptoOnRamp

func (p *MercuryoProvider) GetCryptoOnRamp(ctx context.Context) (CryptoOnRamp, error)

func (*MercuryoProvider) GetURL

func (p *MercuryoProvider) GetURL(ctx context.Context, parameters Parameters) (string, error)

func (*MercuryoProvider) ID

func (p *MercuryoProvider) ID() string

type MoonPayProvider

type MoonPayProvider struct{}

func NewMoonPayProvider

func NewMoonPayProvider() *MoonPayProvider

func (*MoonPayProvider) GetCryptoOnRamp

func (p *MoonPayProvider) GetCryptoOnRamp(ctx context.Context) (CryptoOnRamp, error)

func (*MoonPayProvider) GetURL

func (p *MoonPayProvider) GetURL(ctx context.Context, parameters Parameters) (string, error)

func (*MoonPayProvider) ID

func (p *MoonPayProvider) ID() string

type Parameters

type Parameters struct {
	IsRecurrent bool            `json:"isRecurrent"`
	DestAddress *common.Address `json:"destAddress,omitempty"`
	ChainID     *uint64         `json:"chainID,omitempty"`
	Symbol      *string         `json:"symbol,omitempty"`
}

type Provider

type Provider interface {
	ID() string
	GetCryptoOnRamp(ctx context.Context) (CryptoOnRamp, error)
	GetURL(ctx context.Context, parameters Parameters) (string, error)
}

type RampProvider

type RampProvider struct{}

func NewRampProvider

func NewRampProvider() *RampProvider

func (*RampProvider) GetCryptoOnRamp

func (p *RampProvider) GetCryptoOnRamp(ctx context.Context) (CryptoOnRamp, error)

func (*RampProvider) GetURL

func (p *RampProvider) GetURL(ctx context.Context, parameters Parameters) (string, error)

func (*RampProvider) ID

func (p *RampProvider) ID() string