api

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 26, 2022 License: AGPL-3.0 Imports: 56 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// SUCCESS indicates the rpc calling is successful.
	SUCCESS = "success"
	// FAIL indicated the rpc calling is failed.
	FAIL = "fail"
)

Variables

View Source
var (
	ErrNullContract      = errors.New("contract is empty")
	ErrNullContractID    = errors.New("contract id is empty")
	ErrNullContractAlias = errors.New("contract alias is empty")
)

pre-define errors for supporting bytom errorFormatter

View Source
var (
	ErrBadActionType         = errors.New("bad action type")
	ErrBadAction             = errors.New("bad action object")
	ErrBadActionConstruction = errors.New("bad action construction")
)

action error

View Source
var (
	// ErrDefault is default Bystack API Error
	ErrDefault = errors.New("Bystack API Error")
)

Functions

func AuthHandler

func AuthHandler(handler http.Handler, accessTokens *accesstoken.CredentialStore, authDisable bool) http.Handler

AuthHandler access token auth Handler

func RedirectHandler

func RedirectHandler(next http.Handler) http.Handler

RedirectHandler redirect to dashboard handler

Types

type API

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

API is the scheduling center for server

func NewAPI

func NewAPI(sync NetSync, wallet *wallet.Wallet, blockProposer *blockproposer.BlockProposer, chain *protocol.Chain, traceService *contract.TraceService, config *cfg.Config, token *accesstoken.CredentialStore, dispatcher *event.Dispatcher, notificationMgr *websocket.WSNotificationManager) *API

NewAPI create and initialize the API

func (*API) GetChainStatus

func (a *API) GetChainStatus() (*ChainStatus, error)

GetChainStatus return chain status

func (*API) IsMining

func (a *API) IsMining() bool

IsMining return mining status

func (*API) ServeHTTP

func (a *API) ServeHTTP(rw http.ResponseWriter, req *http.Request)

func (*API) StartServer

func (a *API) StartServer(address string)

StartServer start the server

type AccountInfo

type AccountInfo struct {
	Info string `json:"account_info"`
}

AccountInfo is request struct for deleteAccount

type AccountPubkey

type AccountPubkey struct {
	RootXPub    chainkd.XPub `json:"root_xpub"`
	PubKeyInfos []PubKeyInfo `json:"pubkey_infos"`
}

AccountPubkey is detail of account pubkey info

type BlockReq

type BlockReq struct {
	BlockHeight uint64             `json:"block_height"`
	BlockHash   chainjson.HexBytes `json:"block_hash"`
}

BlockReq is used to handle getBlock req

type BlockTx

type BlockTx struct {
	ID        bc.Hash                  `json:"id"`
	Version   uint64                   `json:"version"`
	Size      uint64                   `json:"size"`
	TimeRange uint64                   `json:"time_range"`
	Inputs    []*query.AnnotatedInput  `json:"inputs"`
	Outputs   []*query.AnnotatedOutput `json:"outputs"`
	MuxID     bc.Hash                  `json:"mux_id"`
}

BlockTx is the tx struct for getBlock func

type BuildRequest

type BuildRequest struct {
	Tx        *types.TxData            `json:"base_transaction"`
	Actions   []map[string]interface{} `json:"actions"`
	TTL       json.Duration            `json:"ttl"`
	TimeRange uint64                   `json:"time_range"`
}

BuildRequest is main struct when building transactions

type ChainStatus

type ChainStatus struct {
	CurrentHeight   uint64 `json:"current_height"`
	CurrentHash     string `json:"current_hash"`
	FinalizedHeight uint64 `json:"finalized_height"`
	FinalizedHash   string `json:"finalized_hash"`
	JustifiedHeight uint64 `json:"justified_height"`
	JustifiedHash   string `json:"justified_hash"`
}

ChainStatus indicate chain status

type CheckPasswordResp

type CheckPasswordResp struct {
	CheckResult bool `json:"check_result"`
}

CheckPasswordResp is response for check key password

type ContractInstance

type ContractInstance struct {
	UTXOs       []*contract.UTXO     `json:"utxos"`
	TxHash      *bc.Hash             `json:"tx_hash"`
	Status      contract.Status      `json:"status"`
	Unconfirmed []*contract.TreeNode `json:"unconfirmed"`
}

type DecodeProgResp

type DecodeProgResp struct {
	Instructions string `json:"instructions"`
}

DecodeProgResp is response for decode program

type GetBlockHeaderResp

type GetBlockHeaderResp struct {
	BlockHeader *types.BlockHeader `json:"block_header"`
}

GetBlockHeaderResp is resp struct for getBlockHeader API

type GetBlockResp

type GetBlockResp struct {
	Hash                   *bc.Hash   `json:"hash"`
	Size                   uint64     `json:"size"`
	Version                uint64     `json:"version"`
	Height                 uint64     `json:"height"`
	Validator              string     `json:"validator"`
	PreviousBlockHash      *bc.Hash   `json:"previous_block_hash"`
	Timestamp              uint64     `json:"timestamp"`
	TransactionsMerkleRoot *bc.Hash   `json:"transaction_merkle_root"`
	Transactions           []*BlockTx `json:"transactions"`
}

GetBlockResp is the resp for getBlock api

type GetMerkleBlockResp

type GetMerkleBlockResp struct {
	BlockHeader  types.BlockHeader `json:"block_header"`
	TxHashes     []*bc.Hash        `json:"tx_hashes"`
	Flags        []uint32          `json:"flags"`
	MatchedTxIDs []*bc.Hash        `json:"matched_tx_ids"`
}

GetMerkleBlockResp is resp struct for GetTxOutProof API

type GetRawBlockResp

type GetRawBlockResp struct {
	RawBlock  *types.Block `json:"raw_block"`
	Validator string       `json:"validator"`
}

GetRawBlockResp is resp struct for getRawBlock API

type MerkleBlockReq

type MerkleBlockReq struct {
	TxIDs     []chainjson.HexBytes `json:"tx_ids"`
	BlockHash chainjson.HexBytes   `json:"block_hash"`
}

MerkleBlockReq is used to handle getTxOutProof req

type NetInfo

type NetInfo struct {
	Listening     bool         `json:"listening"`
	Syncing       bool         `json:"syncing"`
	Mining        bool         `json:"mining"`
	NodeXPub      string       `json:"node_xpub"`
	PeerCount     int          `json:"peer_count"`
	HighestHeight uint64       `json:"highest_height"`
	NetWorkID     string       `json:"network_id"`
	Version       *VersionInfo `json:"version_info"`
}

NetInfo indicate net information

type NetSync

type NetSync interface {
	IsListening() bool
	IsCaughtUp() bool
	PeerCount() int
	GetNetwork() string
	BestPeer() *peers.PeerInfo
	DialPeerWithAddress(addr *p2p.NetAddress) error
	GetPeerInfos() []*peers.PeerInfo
	StopPeer(peerID string) error
}

type PubKeyInfo

type PubKeyInfo struct {
	Pubkey string               `json:"pubkey"`
	Path   []chainjson.HexBytes `json:"derivation_path"`
}

PubKeyInfo is structure of pubkey info

type RawTx

type RawTx struct {
	ID        bc.Hash                  `json:"tx_id"`
	Version   uint64                   `json:"version"`
	Size      uint64                   `json:"size"`
	TimeRange uint64                   `json:"time_range"`
	Inputs    []*query.AnnotatedInput  `json:"inputs"`
	Outputs   []*query.AnnotatedOutput `json:"outputs"`
	Fee       uint64                   `json:"fee"`
}

RawTx is the tx struct for getRawTransaction

type ResetPasswordResp

type ResetPasswordResp struct {
	Changed bool `json:"changed"`
}

ResetPasswordResp is response for reset key password

type Response

type Response struct {
	Status      string      `json:"status,omitempty"`
	Code        string      `json:"code,omitempty"`
	Msg         string      `json:"msg,omitempty"`
	ErrorDetail string      `json:"error_detail,omitempty"`
	Data        interface{} `json:"data,omitempty"`
}

Response describes the response standard.

func FormatErrResp

func FormatErrResp(err error) (response Response)

FormatErrResp format error response

func NewErrorResponse

func NewErrorResponse(err error) Response

NewErrorResponse error response

func NewSuccessResponse

func NewSuccessResponse(data interface{}) Response

NewSuccessResponse success response

type SignMsgResp

type SignMsgResp struct {
	Signature   string       `json:"signature"`
	DerivedXPub chainkd.XPub `json:"derived_xpub"`
}

SignMsgResp is response for sign message

type SortByIndex

type SortByIndex []addressResp

SortByIndex implements sort.Interface for addressResp slices

func (SortByIndex) Len

func (a SortByIndex) Len() int

func (SortByIndex) Less

func (a SortByIndex) Less(i, j int) bool

func (SortByIndex) Swap

func (a SortByIndex) Swap(i, j int)

type VerifyMsgResp

type VerifyMsgResp struct {
	VerifyResult bool `json:"result"`
}

VerifyMsgResp is response for verify message

type VersionInfo

type VersionInfo struct {
	Version string `json:"version"`
	Update  uint16 `json:"update"` // 0: no update; 1: small update; 2: significant update
	NewVer  string `json:"new_version"`
}

type VoteInfo

type VoteInfo struct {
	Vote    string `json:"vote"`
	VoteNum uint64 `json:"vote_number"`
}

type WalletImage

type WalletImage struct {
	AccountImage *account.Image      `json:"account_image"`
	AssetImage   *asset.Image        `json:"asset_image"`
	KeyImages    *pseudohsm.KeyImage `json:"key_images"`
}

WalletImage hold the ziped wallet data

type WalletInfo

type WalletInfo struct {
	BestBlockHeight uint64 `json:"best_block_height"`
	WalletHeight    uint64 `json:"wallet_height"`
}

WalletInfo return wallet information

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL