channeltype

type ChannelDataDetail struct {
	ChannelIdentifier   string   `json:"channel_identifier"`
	OpenBlockNumber     int64    `json:"open_block_number"`
	PartnerAddress      string   `json:"partner_address"`
	Balance             *big.Int `json:"balance"`
	PartnerBalance      *big.Int `json:"partner_balance"`
	LockedAmount        *big.Int `json:"locked_amount"`
	PartnerLockedAmount *big.Int `json:"partner_locked_amount"`
	TokenAddress        string   `json:"token_address"`
	State               State    `json:"state"`
	StateString         string   `json:"state_string"`
	SettleTimeout       int      `json:"settle_timeout"`
	RevealTimeout       int      `json:"reveal_timeout"`

	/*
		extended
	*/
	ClosedBlock               int64                              `json:"closed_block"`
	SettledBlock              int64                              `json:"settled_block"`
	OurUnknownSecretLocks     map[common.Hash]PendingLock        `json:"our_unknown_secret_locks,omitempty"`
	OurKnownSecretLocks       map[common.Hash]UnlockPartialProof `json:"our_known_secret_locks,omitempty"`
	PartnerUnknownSecretLocks map[common.Hash]PendingLock        `json:"partner_unknown_secret_locks,omitempty"`
	PartnerKnownSecretLocks   map[common.Hash]UnlockPartialProof `json:"partner_known_secret_locks,omitempty"`
	OurLeaves                 []*mtree.Lock                      `json:"our_leaves,omitempty"`
	PartnerLeaves             []*mtree.Lock                      `json:"partner_leaves,omitempty"`
	OurBalanceProof           *transfer.BalanceProofState        `json:"our_balance_proof,omitempty"`
	PartnerBalanceProof       *transfer.BalanceProofState        `json:"partner_balance_proof,omitempty"`
	Signature                 []byte                             `json:"signature,omitempty"` //my signature of PartnerBalanceProof
}

type Db interface {
	/*
		is secret has withdrawed on channel?
	*/
	IsThisLockHasUnlocked(channel common.Hash, lockHash common.Hash) bool
	/*
	 I have withdrawed this secret on channel.
	*/
	UnlockThisLock(channel common.Hash, lockHash common.Hash)
	/*
		is a expired hashlock has been removed from channel status.
	*/
	IsThisLockRemoved(channel common.Hash, sender common.Address, lockHash common.Hash) bool
	/*
		remember this lock has been removed from channel status.
	*/
	RemoveLock(channel common.Hash, sender common.Address, lockHash common.Hash)
	/*
		get the latest channel status
	*/
	GetChannelByAddress(channelIdentifier common.Hash) (c *Serialization, err error)

	/*
	 要记录自己放在某个 channel 上放弃了某个锁,到时候一定不能unlock
	*/
	IsLockSecretHashChannelIdentifierDisposed(lockSecretHash common.Hash, ChannelIdentifier common.Hash) bool
}

type KnownSecret struct {
	Secret              common.Hash `json:"secret"`
	IsRegisteredOnChain bool        `json:"is_registered_on_chain"` //该密码是通过链上注册获知的还是通过普通的RevealSecret得知的. 如果是链上注册得知,那么一定是没有过期的.
}

type MockChannelDb struct {
	Keys map[common.Hash]bool
}

type PendingLock struct {
	Lock     *mtree.Lock `json:"lock"`
	LockHash common.Hash `json:"lock_hash"` //hash of this lock
}

type Serialization struct {
	ChannelIdentifier      *contracts.ChannelUniqueID
	Key                    []byte `storm:"id"`
	TokenAddressBytes      []byte `storm:"index"`
	PartnerAddressBytes    []byte `storm:"index"`
	OurAddress             common.Address
	RevealTimeout          int
	OurBalanceProof        *transfer.BalanceProofState
	PartnerBalanceProof    *transfer.BalanceProofState
	OurLeaves              []*mtree.Lock
	PartnerLeaves          []*mtree.Lock
	OurKnownSecrets        []*KnownSecret
	PartnerKnownSecrets    []*KnownSecret
	State                  State
	OurContractBalance     *big.Int
	PartnerContractBalance *big.Int
	ClosedBlock            int64
	SettledBlock           int64
	SettleTimeout          int
}

type State int

type UnlockPartialProof struct {
	Lock                *mtree.Lock `json:"lock"`
	LockHash            common.Hash `json:"lock_hash"`
	Secret              common.Hash `json:"secret"`
	IsRegisteredOnChain bool        `json:"is_registered_on_chain"` //该密码是通过链上注册获知的还是通过普通的RevealSecret得知的. 如果是链上注册得知,那么一定是没有过期的.
}

type UnlockProof struct {
	MerkleProof []common.Hash `json:"merkle_proof"`
	Lock        *mtree.Lock   `json:"lock"`
}