server

Documentation

Overview

Package server Cerberus

The Cerberus is an users' data keeper. The Cerberus encrypts data and pushes it into S3.

Schemes: https
BasePath: /v1
Version: 1.5.2

Produces:
- application/json
Consumes:
- application/json

SecurityDefinitions:
public_key:
     type: apiKey
     name: Public-Key
     in: header
     description: Blockchain account's public key
signature:
     type: apiKey
     name: Signature
     in: header
     description: |-
       Signature of request digest.<br>
       Digest is sha256 sum of request: `{body as is}`+`{request uri}`.<br>
       For example:<br>
       Private key in hex: ```cfe43c70347c7e39084612d9448f3ed86ed733a33a67de35c7e335b3c4edc37d```<br>
       Request url: ```http://localhost/v1/pdv```<br>
       Body: ```{"some":"file"}```<br>
       Digest will be made from ```{"some":"file"}/v1/pdv```<br>
       Digest in hex:<br>
       ```4a1084d05820d60aee9ce600227ca2290ef63e80e5227215b58b023ec6876799```<br>
       Signature in hex:<br>
       ```28eff4676d7839648dda925ba92d447dd7552e177a302f32681fc76278088f9f1fb98051666aa02dd80f7d9b7c01d42ea1abbb3e65de8f1fd04be7b747fb0692```<br>

swagger:meta

Index

• func SetupRouter(s service.Service, r chi.Router, timeout time.Duration, maxBodySize int64, ...)
• type PDVRewardDelta
• type PDVRewardsPool
• type Profile
• type SaveImageResponse
• type SavePDVResponse
• type ValidatePDVResponse

Functions

func SetupRouter

func SetupRouter(s service.Service, r chi.Router, timeout time.Duration, maxBodySize int64,
	spt throttler.Throttler, minPDVCount, maxPDVCount uint16, pdvRewardsPoolSize sdk.Dec)

SetupRouter setups handlers to chi router.

Types

type PDVRewardDelta

type PDVRewardDelta struct {
	Delta sdk.Dec         `json:"delta"`
	Pool  *PDVRewardsPool `json:"pool"`
}

PDVRewardDelta ... swagger:model PDVRewardDelta

type PDVRewardsPool

type PDVRewardsPool struct {
	Size                 sdk.Dec   `json:"size"`
	TotalDelta           sdk.Dec   `json:"total_delta"`
	NextDistributionDate time.Time `json:"next_distribution_date"`
}

PDVRewardsPool ... swagger:model PDVRewardsPool

type Profile

type Profile struct {
	Address   string   `json:"address"`
	FirstName string   `json:"firstName"`
	LastName  string   `json:"lastName"`
	Emails    []string `json:"emails,omitempty"`
	Bio       string   `json:"bio"`
	Gender    string   `json:"gender"`
	Avatar    string   `json:"avatar"`
	Banned    bool     `json:"banned"`
	Birthday  string   `json:"birthday,omitempty"`
	CreatedAt int64    `json:"createdAt"`
}

Profile ... swagger:model APIProfile

type SaveImageResponse

type SaveImageResponse struct {
	HD    string `json:"hd"`
	Thumb string `json:"thumb"`
}

SaveImageResponse ... swagger:model SaveImageResponse

type SavePDVResponse

type SavePDVResponse struct {
	ID uint64 `json:"id"`
}

SavePDVResponse ... swagger:model SavePDVResponse

type ValidatePDVResponse

type ValidatePDVResponse struct {
	Valid      bool  `json:"valid"`
	InvalidPDV []int `json:"invalidPDV,omitempty"`
}

ValidatePDVResponse ... swagger:model ValidatePDVResponse