pattern

Documentation

Index

• Constants
• Variables
• type Accumulator
• type BloomFilter
• type BucketInfo
• type ChallengeElement
• type ChallengeInfo
• type CompleteInfo
• type DigestInfo
• type EcdhPublicKey
• type ExpendersInfo
• type FileHash
• type FileMetadata
• type FragmentInfo
• type IdleFileMeta
• type IdleProveInfo
• type IdleSignInfo
• type Individual
• type MasterPublicKey
• type MinerInfo
• type MinerReward
• type MinerSnapShot
• type MinerSnapshot
• type NetSnapshot
• type OssInfo
• type OtherStakingExposure
• type PeerId
• type PoISKeyInfo
• type PoISKey_G
• type PoISKey_N
• type ProveInfo
• type QElement
• type Random
• type RestoralOrderInfo
• type RestoralTargetInfo
• type RewardOrder
• type RewardsType
• type SegmentDataInfo
• type SegmentInfo
• type SegmentList
• type ServiceProveInfo
• type SpaceChallengeParam
• type SpaceProofInfo
• type StakingEraRewardPoints
• type StakingExposure
• type StakingNominations
• type StakingValidatorPrefs
• type StorageOrder
• type SysProperties
• type SysSyncState
• type TagSigInfo
• type TeeInfo
• type TeeSig
• type TeeSignature
• type TeeWorkerInfo
• type UserBrief
• type UserInfo
• type UserSpaceInfo
• type UserSpaceSt
• type WorkerPublicKey

Constants

const (
	//
	AUDIT = "Audit"
	// OSS is a module about DeOSS
	OSS = "Oss"
	// FILEBANK is a module about data metadata, bucket info, etc.
	FILEBANK = "FileBank"
	// TEEWOEKER is a module about TEE
	TEEWORKER = "TeeWorker"
	// SMINER is a module about storage miners
	SMINER = "Sminer"
	// STAKING is a module about staking
	STAKING = "Staking"
	// SMINER is a module about storage miners
	STORAGEHANDLER = "StorageHandler"
	// BALANCES is a module about the balances
	BALANCES = "Balances"
	// SYSTEM is a module about the system
	SYSTEM = "System"
)

Pallets

const (
	//AUDIT
	UNVERIFYPROOF           = "UnverifyProof"
	CHALLENGEDURATION       = "ChallengeDuration"
	CHALLENGEVERIFYDURATION = "VerifyDuration"
	CHALLENGESNAPSHOT       = "ChallengeSnapShot"
	UNVERIFYIDLEPROOF       = "UnverifyIdleProof"
	UNVERIFYSERVICEPROOF    = "UnverifyServiceProof"

	// OSS
	// OSS
	AUTHORITYLIST = "AuthorityList"

	// SMINER
	ALLMINER           = "AllMiner"
	MINERITEMS         = "MinerItems"
	REWARDMAP          = "RewardMap"
	EXPENDERS          = "Expenders"
	RESTORALTARGETINFO = "RestoralTarget"
	STAKINGSTARTBLOCK  = "StakingStartBlock"

	// TEEWORKER
	TEEWorkers       = "Workers"
	TEEMasterPubkey  = "MasterPubkey"
	TEEEndpoints     = "Endpoints"
	TEEWorkerAddedAt = "WorkerAddedAt"

	// FILEBANK
	FILE           = "File"
	BUCKET         = "Bucket"
	BUCKETLIST     = "UserBucketList"
	DEALMAP        = "DealMap"
	FILLERMAP      = "FillerMap"
	PENDINGREPLACE = "PendingReplacements"
	RESTORALORDER  = "RestoralOrder"

	// STAKING
	COUNTERFORVALIDATORS = "CounterForValidators"
	CounterForNominators = "CounterForNominators"
	ErasTotalStake       = "ErasTotalStake"
	CurrentEra           = "CurrentEra"
	ErasStakers          = "ErasStakers"
	ErasRewardPoints     = "ErasRewardPoints"
	Nominators           = "Nominators"
	Bonded               = "Bonded"
	Validators           = "Validators"
	ErasValidatorReward  = "ErasValidatorReward"
	ValidatorCount       = "ValidatorCount"

	// STORAGE_HANDLER
	USERSPACEINFO     = "UserOwnedSpace"
	UNITPRICE         = "UnitPrice"
	TOTALIDLESPACE    = "TotalIdleSpace"
	TOTALSERVICESPACE = "TotalServiceSpace"
	PURCHASEDSPACE    = "PurchasedSpace"

	// BALANCES
	TOTALISSUANCE = "TotalIssuance"

	// SYSTEM
	ACCOUNT = "Account"
	EVENTS  = "Events"
)

Chain state

const (
	//AUDIT
	TX_AUDIT_SUBMITPROOF              = AUDIT + DOT + "submit_proof"
	TX_AUDIT_SUBMITIDLEPROOF          = AUDIT + DOT + "submit_idle_proof"
	TX_AUDIT_SUBMITSERVICEPROOF       = AUDIT + DOT + "submit_service_proof"
	TX_AUDIT_SUBMITIDLEPROOFRESULT    = AUDIT + DOT + "submit_verify_idle_result"
	TX_AUDIT_SUBMITSERVICEPROOFRESULT = AUDIT + DOT + "submit_verify_service_result"

	// OSS
	TX_OSS_REGISTER    = OSS + DOT + "register"
	TX_OSS_UPDATE      = OSS + DOT + "update"
	TX_OSS_DESTROY     = OSS + DOT + "destroy"
	TX_OSS_AUTHORIZE   = OSS + DOT + "authorize"
	TX_OSS_UNAUTHORIZE = OSS + DOT + "cancel_authorize"

	// SMINER
	TX_SMINER_REGISTER              = SMINER + DOT + "regnstk"
	TX_SMINER_REGISTERASSIGNSTAKING = SMINER + DOT + "regnstk_assign_staking"
	TX_SMINER_INCREASESTAKES        = SMINER + DOT + "increase_collateral"
	TX_SMINER_UPDATEPEERID          = SMINER + DOT + "update_peer_id"
	TX_SMINER_UPDATEINCOME          = SMINER + DOT + "update_beneficiary"
	TX_SMINER_CLAIMREWARD           = SMINER + DOT + "receive_reward"
	TX_SMINER_MINEREXITPREP         = SMINER + DOT + "miner_exit_prep"
	TX_SMINER_WITHDRAW              = SMINER + DOT + "miner_withdraw"
	TX_SMINER_REGISTERPOISKEY       = SMINER + DOT + "register_pois_key"
	TX_SMINER_INCREASEDECSPACE      = SMINER + DOT + "increase_declaration_space"

	// FILEBANK
	TX_FILEBANK_PUTBUCKET         = FILEBANK + DOT + "create_bucket"
	TX_FILEBANK_DELBUCKET         = FILEBANK + DOT + "delete_bucket"
	TX_FILEBANK_DELFILE           = FILEBANK + DOT + "delete_file"
	TX_FILEBANK_UPLOADDEC         = FILEBANK + DOT + "upload_declaration"
	TX_FILEBANK_FILEREPORT        = FILEBANK + DOT + "transfer_report"
	TX_FILEBANK_GENRESTOREORDER   = FILEBANK + DOT + "generate_restoral_order"
	TX_FILEBANK_CLAIMRESTOREORDER = FILEBANK + DOT + "claim_restoral_order"
	TX_FILEBANK_CLAIMNOEXISTORDER = FILEBANK + DOT + "claim_restoral_noexist_order"
	TX_FILEBANK_RESTORALCOMPLETE  = FILEBANK + DOT + "restoral_order_complete"
	TX_FILEBANK_CERTIDLESPACE     = FILEBANK + DOT + "cert_idle_space"
	TX_FILEBANK_REPLACEIDLESPACE  = FILEBANK + DOT + "replace_idle_space"
	TX_FILEBANK_CALCULATEREPORT   = FILEBANK + DOT + "calculate_report"

	// STORAGE_HANDLER
	TX_STORAGE_BUYSPACE       = STORAGEHANDLER + DOT + "buy_space"
	TX_STORAGE_EXPANSIONSPACE = STORAGEHANDLER + DOT + "expansion_space"
	TX_STORAGE_RENEWALSPACE   = STORAGEHANDLER + DOT + "renewal_space"

	// BALANCES
	TX_BALANCES_FORCETRANSFER = "Balances" + DOT + "transfer"
)

Extrinsics

const (
	// System
	RPC_SYS_Properties = "system_properties"
	RPC_SYS_SyncState  = "system_syncState"
	RPC_SYS_Version    = "system_version"
	RPC_SYS_Chain      = "system_chain"

	//Net
	RPC_NET_Listening = "net_listening"
)

RPC Call

const (
	Active = iota
	Calculate
	Missing
	Recovery
)

const (
	MINER_STATE_POSITIVE = "positive"
	MINER_STATE_FROZEN   = "frozen"
	MINER_STATE_EXIT     = "exit"
	MINER_STATE_LOCK     = "lock"
	MINER_STATE_OFFLINE  = "offline"
)

const (
	TeeType_Full     uint8 = 0
	TeeType_Verifier uint8 = 1
	TeeType_Marker   uint8 = 2
)

0:Full 1:Verifier 2:Marker

const (
	ERR_Failed  = "failed"
	ERR_Timeout = "timeout"
	ERR_Empty   = "empty"
)

const (
	MinBucketNameLength = 3
	MaxBucketNameLength = 63
	MaxDomainNameLength = 50
)

const (
	SIZE_1KiB = 1024
	SIZE_1MiB = 1024 * SIZE_1KiB
	SIZE_1GiB = 1024 * SIZE_1MiB
	SIZE_1TiB = 1024 * SIZE_1GiB
)

byte size

const (
	SegmentSize  = 32 * SIZE_1MiB
	FragmentSize = 8 * SIZE_1MiB
	DataShards   = 4
	ParShards    = 8
)

const (
	FileHashLen            = 64
	RandomLen              = 20
	PeerIdPublicKeyLen     = 38
	PoISKeyLen             = 256
	TeeSignatureLen        = 256
	AccumulatorLen         = 256
	SpaceChallengeParamLen = 8
	BloomFilterLen         = 256
	MaxSegmentNum          = 1000
	WorkerPublicKeyLen     = 32
	MasterPublicKeyLen     = 32
	EcdhPublicKeyLen       = 32
	TeeSigLen              = 64
)

const BlockInterval = time.Second * time.Duration(BlockIntervalSec)

BlockInterval is the time interval for generating blocks, in seconds

const BlockIntervalSec = 6

const DOT = "."

DOT is "." character

const MaxSubmitedIdleFileMeta = 30

const PublicDeoss = "http://deoss-pub-gateway.cess.cloud/"

const PublicDeossAccount = "cXhwBytXqrZLr1qM5NHJhCzEMckSTzNKw17ci2aHft6ETSQm9"

const StakingStakePerTiB = 4000

const TokenPrecision_CESS = "000000000000000000"

Unit precision of CESS token

Variables

var (
	ERR_RPC_CONNECTION     = errors.New("rpc err: connection failed")
	ERR_RPC_IP_FORMAT      = errors.New("unsupported ip format")
	ERR_RPC_TIMEOUT        = errors.New("timeout")
	ERR_RPC_EMPTY_VALUE    = errors.New("empty")
	ERR_RPC_PRIORITYTOOLOW = "Priority is too low"
)

Types

type Accumulator

type Accumulator [AccumulatorLen]types.U8

type BloomFilter

type BloomFilter [BloomFilterLen]types.U64

type BucketInfo

type BucketInfo struct {
	ObjectsList []FileHash
	Authority   []types.AccountID
}

type ChallengeElement

type ChallengeElement struct {
	Start        types.U32
	IdleSlip     types.U32
	ServiceSlip  types.U32
	VerifySlip   types.U32
	SpaceParam   SpaceChallengeParam
	ServiceParam QElement
}

type ChallengeInfo

type ChallengeInfo struct {
	MinerSnapshot    MinerSnapShot
	ChallengeElement ChallengeElement
	ProveInfo        ProveInfo
}

type CompleteInfo

type CompleteInfo struct {
	Index types.U8
	Miner types.AccountID
}

type DigestInfo

type DigestInfo struct {
	Fragment  FileHash
	TeePubkey WorkerPublicKey
}

type EcdhPublicKey

type EcdhPublicKey [EcdhPublicKeyLen]types.U8

type ExpendersInfo

type ExpendersInfo struct {
	K types.U64
	N types.U64
	D types.U64
}

type FileHash

type FileHash [FileHashLen]types.U8

type FileMetadata

type FileMetadata struct {
	SegmentList []SegmentInfo
	Owner       []UserBrief
	FileSize    types.U128
	Completion  types.U32
	State       types.U8
}

type FragmentInfo

type FragmentInfo struct {
	Hash  FileHash
	Avail types.Bool
	Tag   types.Option[types.U32]
	Miner types.AccountID
}

type IdleFileMeta

type IdleFileMeta struct {
	BlockNum uint32
	MinerAcc []byte
	Hash     string
}

--------------------customer-----------------

type IdleProveInfo

type IdleProveInfo struct {
	TeePubkey    WorkerPublicKey
	IdleProve    types.Bytes
	VerifyResult types.Option[bool]
}

type IdleSignInfo

type IdleSignInfo struct {
	Miner              types.AccountID
	Rear               types.U64
	Front              types.U64
	Accumulator        Accumulator
	LastOperationBlock types.U32
	PoisKey            PoISKeyInfo
}

type Individual

type Individual struct {
	Acc    types.AccountID
	Reward types.U32
}

type MasterPublicKey

type MasterPublicKey [MasterPublicKeyLen]types.U8

type MinerInfo

type MinerInfo struct {
	BeneficiaryAccount types.AccountID
	StakingAccount     types.AccountID
	PeerId             PeerId
	Collaterals        types.U128
	Debt               types.U128
	State              types.Bytes // positive, exit, frozen, lock
	DeclarationSpace   types.U128
	IdleSpace          types.U128
	ServiceSpace       types.U128
	LockSpace          types.U128
	SpaceProofInfo     types.Option[SpaceProofInfo]
	ServiceBloomFilter BloomFilter
	TeeSig             TeeSig
}

type MinerReward

type MinerReward struct {
	TotalReward  types.U128
	RewardIssued types.U128
	OrderList    []RewardOrder
}

type MinerSnapShot

type MinerSnapShot struct {
	IdleSpace          types.U128
	ServiceSpace       types.U128
	ServiceBloomFilter BloomFilter
	SpaceProofInfo     SpaceProofInfo
	TeeSig             TeeSig
}

type MinerSnapshot

type MinerSnapshot struct {
	Miner         string
	Idle_space    string
	Service_space string
}

type NetSnapshot

type NetSnapshot struct {
	Start               uint32
	Life                uint32
	Total_reward        string
	Total_idle_space    string
	Total_service_space string
	Random_index_list   []uint32
	Random              [][]byte
}

type OssInfo

type OssInfo struct {
	Peerid PeerId
	Domain types.Bytes
}

type OtherStakingExposure

type OtherStakingExposure struct {
	Who   types.AccountID
	Value types.U128
}

type PeerId

type PeerId [PeerIdPublicKeyLen]types.U8

type PoISKeyInfo

type PoISKeyInfo struct {
	G PoISKey_G
	N PoISKey_N
}

type PoISKey_G

type PoISKey_G [PoISKeyLen]types.U8

type PoISKey_N

type PoISKey_N [PoISKeyLen]types.U8

type ProveInfo

type ProveInfo struct {
	Assign       types.U8
	IdleProve    types.Option[IdleProveInfo]
	ServiceProve types.Option[ServiceProveInfo]
}

type QElement

type QElement struct {
	Index []types.U32
	Value []Random
}

type Random

type Random [RandomLen]types.U8

type RestoralOrderInfo

type RestoralOrderInfo struct {
	Count        types.U32
	Miner        types.AccountID
	OriginMiner  types.AccountID
	FragmentHash FileHash
	FileHash     FileHash
	GenBlock     types.U32
	Deadline     types.U32
}

type RestoralTargetInfo

type RestoralTargetInfo struct {
	Miner         types.AccountID
	ServiceSpace  types.U128
	RestoredSpace types.U128
	CoolingBlock  types.U32
}

type RewardOrder

type RewardOrder struct {
	ReceiveCount     types.U8
	MaxCount         types.U8
	Atonce           types.Bool
	OrderReward      types.U128
	EachAmount       types.U128
	LastReceiveBlock types.U32
}

type RewardsType

type RewardsType struct {
	Total   string
	Claimed string
}

type SegmentDataInfo

type SegmentDataInfo struct {
	SegmentHash  string
	FragmentHash []string
}

type SegmentInfo

type SegmentInfo struct {
	Hash         FileHash
	FragmentList []FragmentInfo
}

type SegmentList

type SegmentList struct {
	SegmentHash  FileHash
	FragmentHash []FileHash
}

type ServiceProveInfo

type ServiceProveInfo struct {
	TeePubkey    WorkerPublicKey
	ServiceProve types.Bytes
	VerifyResult types.Option[bool]
}

type SpaceChallengeParam

type SpaceChallengeParam [SpaceChallengeParamLen]types.U64

type SpaceProofInfo

type SpaceProofInfo struct {
	Miner       types.AccountID
	Front       types.U64
	Rear        types.U64
	PoisKey     PoISKeyInfo
	Accumulator Accumulator
}

type StakingEraRewardPoints

type StakingEraRewardPoints struct {
	Total      types.U32
	Individual []Individual
}

type StakingExposure

type StakingExposure struct {
	Total  types.U128
	Own    types.U128
	Others []OtherStakingExposure
}

type StakingNominations

type StakingNominations struct {
	Targets     []types.AccountID
	SubmittedIn types.U32
	Suppressed  types.Bool
}

type StakingValidatorPrefs

type StakingValidatorPrefs struct {
	Commission types.U32
	Blocked    types.Bool
}

type StorageOrder

type StorageOrder struct {
	FileSize     types.U128
	SegmentList  []SegmentList
	User         UserBrief
	CompleteList []CompleteInfo
}

type SysProperties

type SysProperties struct {
	Ss58Format    types.Bytes
	TokenDecimals types.U8
	TokenSymbol   types.Text
	SS58Prefix    types.U32
}

type SysSyncState

type SysSyncState struct {
	StartingBlock types.U32
	CurrentBlock  types.U32
	HighestBlock  types.U32
}

type TagSigInfo

type TagSigInfo struct {
	Miner    types.AccountID
	Digest   []DigestInfo
	Filehash FileHash
}

type TeeInfo

type TeeInfo struct {
	Pubkey              string
	EcdhPubkey          string
	Version             uint32
	LastUpdated         uint64
	StashAccount        string
	AttestationProvider uint8
	ConfidenceLevel     uint8
	Features            []uint32
	WorkerRole          uint8 // 0:Full 1:Verifier 2:Marker
}

type TeeSig

type TeeSig [TeeSigLen]types.U8

type TeeSignature

type TeeSignature [TeeSignatureLen]types.U8

type TeeWorkerInfo

type TeeWorkerInfo struct {
	Pubkey              WorkerPublicKey
	EcdhPubkey          EcdhPublicKey
	Version             types.U32
	LastUpdated         types.U64
	StashAccount        types.Option[types.AccountID]
	AttestationProvider types.Option[types.U8]
	ConfidenceLevel     types.U8
	Features            []types.U32
	Role                types.U8 // 0:Full 1:Verifier 2:Marker
}

type UserBrief

type UserBrief struct {
	User       types.AccountID
	FileName   types.Bytes
	BucketName types.Bytes
}

type UserInfo

type UserInfo struct {
	UserAccount string
	FileName    string
	BucketName  string
	FileSize    uint64
}

type UserSpaceInfo

type UserSpaceInfo struct {
	TotalSpace     types.U128
	UsedSpace      types.U128
	LockedSpace    types.U128
	RemainingSpace types.U128
	Start          types.U32
	Deadline       types.U32
	State          types.Bytes
}

type UserSpaceSt

type UserSpaceSt struct {
	TotalSpace     string
	UsedSpace      string
	LockedSpace    string
	RemainingSpace string
	State          string
	Start          uint32
	Deadline       uint32
}

type WorkerPublicKey

type WorkerPublicKey [WorkerPublicKeyLen]types.U8