api

Documentation

Index

• func GetRecoveryCodeHandler(identityBackend storage.IdentityBackend) gin.HandlerFunc
• func GetStatusHandler(controls *ServerControls, ledger model.Ledger) func(c *gin.Context)
• func InitAccountRoutes(rg *gin.RouterGroup, identityBackend storage.IdentityBackend)
• func InitDIDRoutes(rg *gin.RouterGroup, didStorage storage.DIDBackend)
• func InitLedgerRoutes(rg *gin.RouterGroup, ledger model.Ledger, offChainVault vaults.Vault)
• func InitRegisterRoute(r *gin.Engine, path string, cfg *koanf.Koanf, jwtMW *apibase.GinJWTMiddleware, ...)
• func NotificationChannelHandler(ns notification.Service) gin.HandlerFunc
• func RecoverAccountHandler(identityBackend storage.IdentityBackend) gin.HandlerFunc
• func RegisterHandler(registrationCodes []string, defaultVault string, secondLevelRecoveryKey []byte, ...) func(c *gin.Context)
• func ValidateRequestSignatureHandler(identityBackend storage.IdentityBackend) gin.HandlerFunc
• type AccountHandler
  • func NewAccountHandler(identityBackend storage.IdentityBackend) *AccountHandler
  • func (h *AccountHandler) DeleteAccessKeyHandler(c *gin.Context)
  • func (h *AccountHandler) DeleteAccountHandler(c *gin.Context)
  • func (h *AccountHandler) DeletePropertyHandler(c *gin.Context)
  • func (h *AccountHandler) GetAccessKeyHandler(c *gin.Context)
  • func (h *AccountHandler) GetAccessKeyListHandler(c *gin.Context)
  • func (h *AccountHandler) GetAccountHandler(c *gin.Context)
  • func (h *AccountHandler) GetIdentityHandler(c *gin.Context)
  • func (h *AccountHandler) GetIdentityListHandler(c *gin.Context)
  • func (h *AccountHandler) GetLockerHandler(c *gin.Context)
  • func (h *AccountHandler) GetLockerListHandler(c *gin.Context)
  • func (h *AccountHandler) GetOwnAccountHandler(c *gin.Context)
  • func (h *AccountHandler) GetPropertyHandler(c *gin.Context)
  • func (h *AccountHandler) GetPropertyListHandler(c *gin.Context)
  • func (h *AccountHandler) GetSubAccountListHandler(c *gin.Context)
  • func (h *AccountHandler) PatchAccountHandler(c *gin.Context)
  • func (h *AccountHandler) PostAccessKeyHandler(c *gin.Context)
  • func (h *AccountHandler) PostIdentityHandler(c *gin.Context)
  • func (h *AccountHandler) PostLockerHandler(c *gin.Context)
  • func (h *AccountHandler) PostPropertyHandler(c *gin.Context)
  • func (h *AccountHandler) PostSubAccountHandler(c *gin.Context)
  • func (h *AccountHandler) PutAccountHandler(c *gin.Context)
• type AccountPatch
• type AccountRecoveryResponse
• type DIDHandler
  • func (h *DIDHandler) GetDIDDocumentHandler(c *gin.Context)
  • func (h *DIDHandler) PostDIDDocumentHandler(c *gin.Context)
• type GetRecoveryCodeResponse
• type LedgerHandler
  • func (h *LedgerHandler) GetAssetHeadHandler(c *gin.Context)
  • func (h *LedgerHandler) GetDataAssetStateHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerBlockHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerBlockRecordsHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerChainHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerGenesisHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerOperationHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerRecordHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerRecordStateHandler(c *gin.Context)
  • func (h *LedgerHandler) GetLedgerTopHandler(c *gin.Context)
  • func (h *LedgerHandler) PostLedgerOperationHandler(c *gin.Context)
  • func (h *LedgerHandler) PostLedgerRecordHandler(c *gin.Context)
  • func (h *LedgerHandler) PostPurgeLedgerOperationHandler(c *gin.Context)
• type NewAccountForm
• type ServerControls

Functions

func GetRecoveryCodeHandler

func GetRecoveryCodeHandler(identityBackend storage.IdentityBackend) gin.HandlerFunc

func GetStatusHandler

func GetStatusHandler(controls *ServerControls, ledger model.Ledger) func(c *gin.Context)

func InitAccountRoutes

func InitAccountRoutes(rg *gin.RouterGroup, identityBackend storage.IdentityBackend)

func InitDIDRoutes

func InitDIDRoutes(rg *gin.RouterGroup, didStorage storage.DIDBackend)

func InitLedgerRoutes

func InitLedgerRoutes(rg *gin.RouterGroup, ledger model.Ledger, offChainVault vaults.Vault)

func InitRegisterRoute

func InitRegisterRoute(r *gin.Engine, path string, cfg *koanf.Koanf, jwtMW *apibase.GinJWTMiddleware, identityBackend storage.IdentityBackend, ledger model.Ledger)

func NotificationChannelHandler

func NotificationChannelHandler(ns notification.Service) gin.HandlerFunc

func RecoverAccountHandler

func RecoverAccountHandler(identityBackend storage.IdentityBackend) gin.HandlerFunc

func RegisterHandler

func RegisterHandler(registrationCodes []string, defaultVault string, secondLevelRecoveryKey []byte,
	entropyFunc account.EntropyFunction,
	hashFunction account.PasswordHashFunction,
	timeFunc func() time.Time, jwtMW *apibase.GinJWTMiddleware,
	identityBackend storage.IdentityBackend, ledger model.Ledger) func(c *gin.Context)

func ValidateRequestSignatureHandler

func ValidateRequestSignatureHandler(identityBackend storage.IdentityBackend) gin.HandlerFunc

Types

type AccountHandler

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

func NewAccountHandler

func NewAccountHandler(identityBackend storage.IdentityBackend) *AccountHandler

func (*AccountHandler) DeleteAccessKeyHandler

func (h *AccountHandler) DeleteAccessKeyHandler(c *gin.Context)

func (*AccountHandler) DeleteAccountHandler

func (h *AccountHandler) DeleteAccountHandler(c *gin.Context)

func (*AccountHandler) DeletePropertyHandler

func (h *AccountHandler) DeletePropertyHandler(c *gin.Context)

func (*AccountHandler) GetAccessKeyHandler

func (h *AccountHandler) GetAccessKeyHandler(c *gin.Context)

func (*AccountHandler) GetAccessKeyListHandler

func (h *AccountHandler) GetAccessKeyListHandler(c *gin.Context)

func (*AccountHandler) GetAccountHandler

func (h *AccountHandler) GetAccountHandler(c *gin.Context)

func (*AccountHandler) GetIdentityHandler

func (h *AccountHandler) GetIdentityHandler(c *gin.Context)

func (*AccountHandler) GetIdentityListHandler

func (h *AccountHandler) GetIdentityListHandler(c *gin.Context)

func (*AccountHandler) GetLockerHandler

func (h *AccountHandler) GetLockerHandler(c *gin.Context)

func (*AccountHandler) GetLockerListHandler

func (h *AccountHandler) GetLockerListHandler(c *gin.Context)

func (*AccountHandler) GetOwnAccountHandler

func (h *AccountHandler) GetOwnAccountHandler(c *gin.Context)

func (*AccountHandler) GetPropertyHandler

func (h *AccountHandler) GetPropertyHandler(c *gin.Context)

func (*AccountHandler) GetPropertyListHandler

func (h *AccountHandler) GetPropertyListHandler(c *gin.Context)

func (*AccountHandler) GetSubAccountListHandler

func (h *AccountHandler) GetSubAccountListHandler(c *gin.Context)

func (*AccountHandler) PatchAccountHandler

func (h *AccountHandler) PatchAccountHandler(c *gin.Context)

func (*AccountHandler) PostAccessKeyHandler

func (h *AccountHandler) PostAccessKeyHandler(c *gin.Context)

func (*AccountHandler) PostIdentityHandler

func (h *AccountHandler) PostIdentityHandler(c *gin.Context)

func (*AccountHandler) PostLockerHandler

func (h *AccountHandler) PostLockerHandler(c *gin.Context)

func (*AccountHandler) PostPropertyHandler

func (h *AccountHandler) PostPropertyHandler(c *gin.Context)

func (*AccountHandler) PostSubAccountHandler

func (h *AccountHandler) PostSubAccountHandler(c *gin.Context)

func (*AccountHandler) PutAccountHandler

func (h *AccountHandler) PutAccountHandler(c *gin.Context)

type AccountPatch

type AccountPatch struct {
	Email                string `json:"email,omitempty"`
	OldEncryptedPassword string `json:"oldEncryptedPassword,omitempty"`
	NewEncryptedPassword string `json:"newEncryptedPassword,omitempty"`
	Name                 string `json:"name,omitempty"`
	GivenName            string `json:"givenName,omitempty"`
	FamilyName           string `json:"familyName,omitempty"`
}

type AccountRecoveryResponse

type AccountRecoveryResponse struct {
	Account *account.Account `json:"account"`
}

type DIDHandler

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

func (*DIDHandler) GetDIDDocumentHandler

func (h *DIDHandler) GetDIDDocumentHandler(c *gin.Context)

func (*DIDHandler) PostDIDDocumentHandler

func (h *DIDHandler) PostDIDDocumentHandler(c *gin.Context)

type GetRecoveryCodeResponse

type GetRecoveryCodeResponse struct {
	Code string `json:"code"`
}

type LedgerHandler

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

func (*LedgerHandler) GetAssetHeadHandler

func (h *LedgerHandler) GetAssetHeadHandler(c *gin.Context)

func (*LedgerHandler) GetDataAssetStateHandler

func (h *LedgerHandler) GetDataAssetStateHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerBlockHandler

func (h *LedgerHandler) GetLedgerBlockHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerBlockRecordsHandler

func (h *LedgerHandler) GetLedgerBlockRecordsHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerChainHandler

func (h *LedgerHandler) GetLedgerChainHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerGenesisHandler

func (h *LedgerHandler) GetLedgerGenesisHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerOperationHandler

func (h *LedgerHandler) GetLedgerOperationHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerRecordHandler

func (h *LedgerHandler) GetLedgerRecordHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerRecordStateHandler

func (h *LedgerHandler) GetLedgerRecordStateHandler(c *gin.Context)

func (*LedgerHandler) GetLedgerTopHandler

func (h *LedgerHandler) GetLedgerTopHandler(c *gin.Context)

func (*LedgerHandler) PostLedgerOperationHandler

func (h *LedgerHandler) PostLedgerOperationHandler(c *gin.Context)

func (*LedgerHandler) PostLedgerRecordHandler

func (h *LedgerHandler) PostLedgerRecordHandler(c *gin.Context)

func (*LedgerHandler) PostPurgeLedgerOperationHandler

func (h *LedgerHandler) PostPurgeLedgerOperationHandler(c *gin.Context)

type NewAccountForm

type NewAccountForm struct {
	Account          *account.Account `json:"account"`
	RegistrationCode string           `json:"registrationCode"`
}

type ServerControls

type ServerControls struct {
	Status           string `json:"status"`
	MaintenanceMode  bool   `json:"maintenanceMode"`
	JWTPublicKey     string `json:"jwtPublicKey"`
	GenesisBlockHash string `json:"genesis"`
	TopBlock         int64  `json:"top"`
}