openlane

Documentation

Overview

Package openlane is a wrapper used to interact with the openlane API

Index

• Variables
• func NewDefaultClient() (*openlaneclient.OpenlaneClient, error)
• type Config
  • func NewDefaultConfig() (*Config, error)
  • func (c *Config) NewClient() (*openlaneclient.OpenlaneClient, error)

Variables

var (
	// ErrAPITokenMissing is returned when the openlane API token is missing
	ErrAPITokenMissing = fmt.Errorf("token is required but not provided")
)

Functions

func NewDefaultClient

func NewDefaultClient() (*openlaneclient.OpenlaneClient, error)

NewDefaultClient creates a new openlane client using the default configuration variables

Types

type Config

type Config struct {
	// Token is the token to use for the openlane client
	Token string `json:"token" koanf:"token" default:""`
}

Config is the configuration for the openlane api

func NewDefaultConfig

func NewDefaultConfig() (*Config, error)

NewDefaultConfig returns a new Config with default values

func (*Config) NewClient

func (c *Config) NewClient() (*openlaneclient.OpenlaneClient, error)

NewClient creates a new openlane client using the provided configuration variables