Documentation
¶
Index ¶
- type API
- type NetworkAPI
- type PoolsAPI
- type TokensAPI
- type TransactionsAPI
- func (api *TransactionsAPI) ChangeSingleTransactionStatus(c echo.Context) error
- func (api *TransactionsAPI) CheckActiveTransactions(c echo.Context) error
- func (api *TransactionsAPI) CreateTransaction(c echo.Context) error
- func (api *TransactionsAPI) DeleteSingleTransaction(c echo.Context) error
- func (api *TransactionsAPI) GetAllTransactions(c echo.Context) error
- func (api *TransactionsAPI) GetSingleTransaction(c echo.Context) error
- func (api *TransactionsAPI) GetSingleTransactionStatus(c echo.Context) error
- func (api *TransactionsAPI) Middleware(next echo.HandlerFunc) echo.HandlerFunc
- func (api *TransactionsAPI) UpdateSingleTransaction(c echo.Context) error
- type UsersAPI
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct { UsersAPI *UsersAPI TransactionsAPI *TransactionsAPI TokensAPI *TokensAPI PoolsAPI *PoolsAPI NetworkAPI *NetworkAPI Config *models.Config }
type NetworkAPI ¶
type NetworkAPI struct { WalletClient walletPB.WalletClient // contains filtered or unexported fields }
func NewNetworkAPI ¶
func NewNetworkAPI(walletClient walletPB.WalletClient) *NetworkAPI
func (*NetworkAPI) GetNetworkInfo ¶
func (api *NetworkAPI) GetNetworkInfo(c echo.Context) error
################################################################################ GetNetworkInfo - function returns network info GetNetworkInfo godoc @Summary Get network info @Description Get network info @Tags Network @Produce json @Success 200 {object} models.NetworkInfoResponse @Router /api/v1/network/info [get]
func (*NetworkAPI) MiddlewareNetworkReady ¶
func (api *NetworkAPI) MiddlewareNetworkReady(next echo.HandlerFunc) echo.HandlerFunc
type PoolsAPI ¶
type PoolsAPI struct { WalletClient walletPB.WalletClient // contains filtered or unexported fields }
func NewPoolsAPI ¶
func NewPoolsAPI(config *models.Config, walletClient walletPB.WalletClient) *PoolsAPI
func (*PoolsAPI) DelegateToPool ¶
################################################################################ DelegateToPool - function to delegate to pool DelegateToPool godoc @Summary Delegate to pool. @Description Delegate to pool. @Tags pools @Accept json @Produce json @Param DelegateToPoolRequest body models.DelegateToPoolRequest true "DelegateToPoolRequest" @Success 200 {object} string @Router /api/v1/pools/delegate [POST]
func (*PoolsAPI) GetAllPools ¶
################################################################################ GetAllPools - function to get all pools GetAllPools godoc @Summary Get All Pools. @Description Get all pools. @Tags pools @Produce json @Success 200 {object} models.Pools @Router /api/v1/pools [GET]
type TokensAPI ¶
type TokensAPI struct { WalletClient walletPB.WalletClient // contains filtered or unexported fields }
func NewTokensAPI ¶
func NewTokensAPI(walletClient walletPB.WalletClient) *TokensAPI
func (*TokensAPI) GetAllTokens ¶
################################################################################ GetAllTokens - function to get all tokens GetAllTokens godoc @Summary Get All Tokens. @Description Get all tokens. @Tags tokens @Accept json @Produce json @Success 200 {object} []models.Token @Router /api/v1/tokens [GET]
func (*TokensAPI) GetSingleToken ¶
################################################################################ GetSingleToken - function to get single token GetSingleToken godoc @Summary Get Single Token. @Description Get single token. @Tags tokens @Accept json @Produce json @Success 200 {object} models.Token @Router /api/v1/tokens/{token_id} [GET]
func (*TokensAPI) GetSingleTokenPrice ¶
################################################################################ GetSingleTokenPrice - function to get single token price GetSingleTokenPrice godoc @Summary Get Single Token Price. @Description Get single token price. @Tags tokens @Accept json @Produce json @Success 200 {object} models.TokenPrice @Router /api/v1/tokens/{token_id}/price [GET]
type TransactionsAPI ¶
type TransactionsAPI struct { WalletClient walletPB.WalletClient // contains filtered or unexported fields }
func NewTransactionsAPI ¶
func NewTransactionsAPI(db *sql.DB, config *models.Config, sessions *models.Sessions, walletClient walletPB.WalletClient) *TransactionsAPI
func (*TransactionsAPI) ChangeSingleTransactionStatus ¶
func (api *TransactionsAPI) ChangeSingleTransactionStatus(c echo.Context) error
################################################################################ ChangeSingleTransactionStatus - function to change user`s single transaction status with data from JSON ChangeSingleTransactionStatus godoc @Summary Change Single Transaction Status. @Description Change user`s single transaction status with data from JSON. @Tags transactions @Accept json @Produce json @Param TransactionNewStatus body models.TransactionStatus true "Struct to store user`s new single transaction status" @Success 200 {object} models.ChangeSingleTransactionStatusResponse @Router /api/v1/transactions/:transaction_id/status [PUT]
func (*TransactionsAPI) CheckActiveTransactions ¶
func (api *TransactionsAPI) CheckActiveTransactions(c echo.Context) error
################################################################################ CheckActiveTransactions - function to check user`s active transactions CheckActiveTransactions godoc @Summary Check Active Transactions. @Description Check user`s active transactions. @Tags transactions @Produce json @Success 200 {object} models.ActiveTransactionsResponse @Router /api/v1/transactions/active [GET]
func (*TransactionsAPI) CreateTransaction ¶
func (api *TransactionsAPI) CreateTransaction(c echo.Context) error
################################################################################ CreateTransaction - function to save user`s transaction data from JSON CreateTransaction godoc @Summary Save Transaction. @Description Save user`s transaction data from JSON. @Tags transactions @Accept json @Produce json @Param Transaction body models.CreateTransactionRequest true "Struct to create user`s single transaction" @Success 200 {object} models.SaveTransactionDataResponse @Router /api/v1/transactions [POST]
func (*TransactionsAPI) DeleteSingleTransaction ¶
func (api *TransactionsAPI) DeleteSingleTransaction(c echo.Context) error
################################################################################ DeleteSingleTransaction - function to delete user`s single transaction DeleteSingleTransaction godoc @Summary Delete Single Transaction. @Description Delete user`s single transaction. @Tags transactions @Accept json @Produce json @Success 200 {object} models.DeleteSingleTransactionResponse @Router /api/v1/transactions/:transaction_id [DELETE]
func (*TransactionsAPI) GetAllTransactions ¶
func (api *TransactionsAPI) GetAllTransactions(c echo.Context) error
################################################################################ GetAllTransactions - function to get all user`s transactions GetAllTransactions godoc @Summary Get All Transactions. @Description Get all user`s transaction. @Tags transactions @Accept json @Produce json @Success 200 {object} models.AllTransactions @Router /api/v1/transactions [GET]
func (*TransactionsAPI) GetSingleTransaction ¶
func (api *TransactionsAPI) GetSingleTransaction(c echo.Context) error
################################################################################ GetSingleTransaction - function to get user`s single transaction GetSingleTransaction godoc @Summary Get Single Transaction. @Description Get user`s single transaction. @Tags transactions @Accept json @Produce json @Success 200 {object} models.SingleTransactionResponse @Router /api/v1/transactions/:transaction_id [GET]
func (*TransactionsAPI) GetSingleTransactionStatus ¶
func (api *TransactionsAPI) GetSingleTransactionStatus(c echo.Context) error
################################################################################ GetSingleTransactionStatus - function to get user`s single transaction status GetSingleTransactionStatus godoc @Summary Get Single Transaction Status. @Description Get user`s single transaction status. @Tags transactions @Accept json @Produce json @Success 200 {object} models.SingleTransactionStatusResponse @Router /api/v1/transactions/:transaction_id/status [GET]
func (*TransactionsAPI) Middleware ¶
func (api *TransactionsAPI) Middleware(next echo.HandlerFunc) echo.HandlerFunc
func (*TransactionsAPI) UpdateSingleTransaction ¶
func (api *TransactionsAPI) UpdateSingleTransaction(c echo.Context) error
################################################################################ UpdateSingleTransaction - function to update user`s single transaction data from JSON UpdateSingleTransaction godoc @Summary Update Transaction. @Description Update user`s single transaction data from JSON. @Tags transactions @Accept json @Produce json @Param Transaction body models.CreateTransactionRequest true "Struct to update user`s single transaction" @Success 200 {object} models.SaveTransactionDataResponse @Router /api/v1/transactions/:transaction_id [PUT]
type UsersAPI ¶
type UsersAPI struct {
// contains filtered or unexported fields
}
func NewUsersAPI ¶
func (*UsersAPI) LoginUser ¶
LoginUser godoc @Summary Login User. @Description Login user for 24 hours and create new user in database if needed. @Tags users @Accept json @Produce json @Param User body models.CardanoUser true "Struct for requested cardano user with hash of the wallet address" @Success 200 {object} models.UserSessionResponse @Router /api/v1/user/login [POST]
func (*UsersAPI) UsersSessionsEmptify ¶
func (api *UsersAPI) UsersSessionsEmptify()
UsersSessionsEmptify - function for wrapping internal session emptifying function