api

Documentation

Overview

Package api provides the functionality of the aurora client-facing HTTP API.

Copyright 2021 The Swarm Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

Index

• Constants
• Variables
• func UnescapeUnicode(raw string) (string, error)
• type AllRequest
• type AllResponse
• type FileInfo
• type Options
• type Service
  • func New(storer storage.Storer, resolver resolver.Interface, addr boson.Address, ...) Service
• type TransactionResponse
• type UpgradedResponseWriter

Constants

const (
	AuroraPinHeader            = "Aurora-Pin"
	AuroraTagHeader            = "Aurora-Tag"
	AuroraEncryptHeader        = "Aurora-Encrypt"
	AuroraIndexDocumentHeader  = "Aurora-Index-Document"
	AuroraErrorDocumentHeader  = "Aurora-Error-Document"
	AuroraFeedIndexHeader      = "Aurora-Feed-Index"
	AuroraFeedIndexNextHeader  = "Aurora-Feed-Index-Next"
	AuroraCollectionHeader     = "Aurora-Collection"
	AuroraCollectionNameHeader = "Aurora-Collection-Name"
)

const (
	StringTrue = "true"
)

const (
	// TargetsRecoveryHeader defines the Header for Recovery targets in Global Pinning
	TargetsRecoveryHeader = "aurora-recovery-targets"
)

Variables

var (
	ErrNotFound    = errors.New("manifest: not found")
	ErrServerError = errors.New("manifest: ServerError")
)

var BufferSizeMul int

Functions

func UnescapeUnicode

func UnescapeUnicode(raw string) (string, error)

UnescapeUnicode convert the raw Unicode encoding to character

Types

type AllRequest

type AllRequest struct {
	Id      int           `json:"id"`
	JsonRpc string        `json:"jsonrpc"`
	Method  string        `json:"method"`
	Params  []interface{} `json:"params"`
}

type AllResponse

type AllResponse struct {
	Id      int         `json:"id"`
	JsonRpc string      `json:"jsonrpc"`
	Result  interface{} `json:"result"`
}

type FileInfo

type FileInfo struct {
	Path        string
	Name        string
	ContentType string
	Size        int64
	Reader      io.Reader
}

type Options

type Options struct {
	CORSAllowedOrigins []string
	GatewayMode        bool
	WsPingPeriod       time.Duration
	BufferSizeMul      int
	Restricted         bool
	DebugApiAddr       string
	RPCWSAddr          string
}

type Service

type Service interface {
	http.Handler
	m.Collector
	io.Closer
}

Service is the API service interface.

func New

func New(storer storage.Storer, resolver resolver.Interface, addr boson.Address, chunkInfo chunkinfo.Interface,
	traversalService traversal.Traverser, pinning pinning.Interface, auth authenticator, logger logging.Logger,
	tracer *tracing.Tracer, traffic traffic.ApiInterface, commonChain chain.Common, oracleChain chain.Resolver, netRelay netrelay.NetRelay,
	multicast multicast.GroupInterface, o Options) Service

New will create a and initialize a new API service.

type TransactionResponse

type TransactionResponse struct {
	Hash     common.Hash
	Address  boson.Address
	Register bool
}

type UpgradedResponseWriter

type UpgradedResponseWriter interface {
	http.ResponseWriter
	http.Pusher
	http.Hijacker
	http.Flusher
	// staticcheck SA1019 CloseNotifier interface is required by gorilla compress handler
	// nolint:staticcheck
	http.CloseNotifier // skipcq: SCC-SA1019
}

UpgradedResponseWriter adds more functionality on top of ResponseWriter