/
types.go
98 lines (83 loc) · 2.74 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
// Copyright 2017 Annchain Information Technology Services Co.,Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package node
import (
"github.com/spf13/viper"
"go.uber.org/zap"
pbtypes "github.com/annchain/annchain/angine/protos/types"
agtypes "github.com/annchain/annchain/angine/types"
"github.com/annchain/annchain/module/lib/go-crypto"
"github.com/annchain/annchain/module/xlib/def"
)
type (
// Application embeds types.Application, defines application interface in ann
Application interface {
agtypes.Application
SetCore(Core)
GetAttributes() AppAttributes
}
// Core defines the interface at which an application sees its containing organization
Core interface {
IsValidator() bool
GetPublicKey() (crypto.PubKeyEd25519, bool)
GetPrivateKey() (crypto.PrivKeyEd25519, bool)
GetChainID() string
GetEngine() Engine
BroadcastTxSuperior([]byte) error
}
// Engine defines the consensus engine
Engine interface {
GetBlock(def.INT) (*agtypes.BlockCache, *pbtypes.BlockMeta, error)
GetBlockMeta(def.INT) (*pbtypes.BlockMeta, error)
GetValidators() (def.INT, *agtypes.ValidatorSet)
PrivValidator() *agtypes.PrivValidator
BroadcastTx([]byte) error
Query(byte, []byte) (interface{}, error)
}
// Superior defines the application on the upper level, e.g. Metropolis
Superior interface {
Broadcaster
}
// Broadcaster means we can deliver tx in application
Broadcaster interface {
BroadcastTx([]byte) error
}
// Serializable transforms to bytes
Serializable interface {
ToBytes() ([]byte, error)
}
// Unserializable transforms from bytes
Unserializable interface {
FromBytes(bs []byte)
}
// Hashable aliases Serializable
Hashable interface {
Serializable
}
// AppMaker is the signature for functions which take charge of create new instance of applications
AppMaker func(*zap.Logger, *viper.Viper, crypto.PrivKey) (Application, error)
)
// AppAttributes is just a type alias
type AppAttributes = map[string]string
type IMetropolisApp interface {
GetAttribute(string) (string, bool)
GetAttributes() AppAttributes
SetAttributes(AppAttributes)
PushAttribute(string, string)
AttributeExists(string) bool
}
type Payload struct {
Function string `json:"function"`
Params []interface{} `json:"params"`
}