restaccounts

Documentation

Index

• Variables
• func RegisterGetAccountHandler(n *Namespace) error
• func RegisterGetAccountsByTagsHandler(n *Namespace) error
• func RegisterListAccountsHandler(n *Namespace) error
• type InputNetworkAddress
• type InputNetworkPaginated
• type InputNetworkTagsPaginated
• type Namespace
  • func NewNamespace(server *rest.Server, db db.Adapter, pool *clients.ClientPool, nats *nats.Conn, ...) *Namespace
  • func (s *Namespace) GetName() rest.ServiceName
  • func (s *Namespace) RegisterHandlers() error

Variables

var AccountsServiceName rest.ServiceName = "accounts"

AccountsServiceName defines the service name for the Accounts service.

Functions

func RegisterGetAccountHandler

func RegisterGetAccountHandler(n *Namespace) error

RegisterGetAccountHandler registers the endpoint to retrieve an account by address

func RegisterGetAccountsByTagsHandler

func RegisterGetAccountsByTagsHandler(n *Namespace) error

RegisterGetAccountsByTagsHandler registers the endpoint to retrieve accounts by tags

func RegisterListAccountsHandler

func RegisterListAccountsHandler(n *Namespace) error

RegisterListAccountsHandler registers the endpoint to retrieve accounts

Types

type InputNetworkAddress

type InputNetworkAddress struct {
	NetworkId utils.NetworkID `json:"networkId" path:"networkId" default:"1" example:"1" doc:"Network ID"` // Network ID specifies the blockchain network (e.g., 1 for Ethereum Mainnet)
	Address   common.Address  ``                                                                           // Address specifies the account address
	/* 134-byte string literal not displayed */
}

InputNetworkAddress represents the input parameters required to specify a network and address.

type InputNetworkPaginated

type InputNetworkPaginated struct {
	NetworkId utils.NetworkID `json:"networkId" path:"networkId" example:"1" doc:"Network ID"`                                        // Network ID specifies the blockchain network (e.g., 1 for Ethereum Mainnet)
	Limit     uint            `json:"limit" query:"limit" example:"10" default:"10" doc:"Limit for the number of accounts to return"` // Limit specifies the number of accounts to return
	Offset    uint            `json:"offset" query:"offset" example:"0" default:"0" doc:"Offset for pagination"`                      // Offset specifies the offset for pagination
}

InputNetworkPaginated represents the input parameters required to specify a network, limit and offset.

type InputNetworkTagsPaginated

type InputNetworkTagsPaginated struct {
	NetworkId utils.NetworkID `json:"networkId" path:"networkId" default:"1" example:"1" doc:"Network ID"`                            // Network ID specifies the blockchain network (e.g., 1 for Ethereum Mainnet)
	Tags      []string        `json:"tags" query:"tags" example:"[\"burn\"]" doc:"Tags to filter accounts"`                           // Tags specifies the tags to filter accounts
	Limit     uint            `json:"limit" query:"limit" default:"10" example:"10" doc:"Limit for the number of accounts to return"` // Limit specifies the number of accounts to return
	Offset    uint            `json:"offset" query:"offset" example:"0" default:"0" doc:"Offset for pagination"`                      // Offset specifies the offset for pagination
}

InputNetworkTagsPaginated represents the input parameters required to specify a network and tags with pagination.

type Namespace

type Namespace struct {
	*rest.Server
	// contains filtered or unexported fields
}

Namespace represents a service namespace containing configuration and dependencies for the Accounts service.

func NewNamespace

func NewNamespace(server *rest.Server, db db.Adapter, pool *clients.ClientPool, nats *nats.Conn, cache *cache.Redis) *Namespace

NewNamespace creates a new instance of Namespace with the provided server, database adapter, client pool, NATS connection, and Redis cache.

func (*Namespace) GetName

func (s *Namespace) GetName() rest.ServiceName

GetName returns the service name for the Accounts namespace.

func (*Namespace) RegisterHandlers

func (s *Namespace) RegisterHandlers() error

RegisterHandlers registers all the necessary handlers for the Accounts namespace.