rest

Documentation

Index

• type ActionRoutes
• type AuthRoutes
• type ContractRoutes
• type DevNetRoutes
• type ExtensionRoutes
• type GatewayRoutes
• type NetworkRoutes
• type ProjectRoutes
• type Rest
  • func NewRest(auth AuthRoutes, user UserRoutes, project ProjectRoutes, ...) *Rest
• type UserRoutes

Types

type ActionRoutes

type ActionRoutes interface {
	GetActionsForExtensions(accountSlugOrID string, projectSlugOrID string) (*payloads.GetActionsForExtensionsResponse, error)
	Validate(request generatedActions.ValidateRequest, projectSlug string) (*generatedActions.ValidateResponse, error)
	Publish(request generatedActions.PublishRequest, projectSlug string) (*generatedActions.PublishResponse, error)
}

type AuthRoutes

type AuthRoutes interface {
	Register(request payloads.RegisterRequest) (*payloads.TokenResponse, error)
	Login(request payloads.LoginRequest) (*payloads.TokenResponse, error)
	Logout(accountId string, tokenId string) error
}

type ContractRoutes

type ContractRoutes interface {
	GetContracts(projectSlug string) (*payloads.GetContractsResponse, error)
	UploadContracts(request payloads.UploadContractsRequest, projectSlug string) (*payloads.UploadContractsResponse, error)
	VerifyContracts(request payloads.UploadContractsRequest) (*payloads.UploadContractsResponse, error)
	RemoveContracts(request payloads.RemoveContractsRequest, projectSlug string) (*payloads.RemoveContractsResponse, error)
	RenameContract(request payloads.RenameContractRequest, projectSlug, networkID, address string) (*payloads.RenameContractResponse, error)
}

type DevNetRoutes

type DevNetRoutes interface {
	SpawnRPC(accountID string, projectID string, templateSlug string, accessKey string, token string) (string, error)
}

type ExtensionRoutes

type ExtensionRoutes interface {
	DeployExtension(accountSlugOrID string, projectSlugOrID string, actionID string, gatewayID string, extensionName string, extensionMethodName string) (*payloads.DeployExtensionResponse, error)
	GetExtensions(accountSlugOrID string, projectSlugOrID string, gatewayID string) (*payloads.GetExtensionsResponse, error)
}

type GatewayRoutes

type GatewayRoutes interface {
	GetGateways(accountID string, projectID string) (*payloads.GetGatewaysResponse, error)
}

type NetworkRoutes

type NetworkRoutes interface {
	GetPublicNetworks() (*payloads.NetworksResponse, error)
}

type ProjectRoutes

type ProjectRoutes interface {
	CreateProject(request payloads.ProjectRequest) (*payloads.ProjectResponse, error)
	GetProject(accountId, id string) (*model.Project, error)
	GetProjects(accountId string) (*payloads.GetProjectsResponse, error)
}

type Rest

type Rest struct {
	Auth       AuthRoutes
	User       UserRoutes
	Project    ProjectRoutes
	Contract   ContractRoutes
	Networks   NetworkRoutes
	Actions    ActionRoutes
	DevNet     DevNetRoutes
	Gateways   GatewayRoutes
	Extensions ExtensionRoutes
}

func NewRest

func NewRest(
	auth AuthRoutes,
	user UserRoutes,
	project ProjectRoutes,
	contract ContractRoutes,
	networks NetworkRoutes,
	actions ActionRoutes,
	devnet DevNetRoutes,
	gateways GatewayRoutes,
	extensions ExtensionRoutes,
) *Rest

type UserRoutes

type UserRoutes interface {
	Principal() (*model.Principal, error)
}