package store import ( "context" "encoding/json" "fmt" "sync" "github.com/filecoin-project/go-lotus/chain/address" "github.com/filecoin-project/go-lotus/chain/state" "github.com/filecoin-project/go-lotus/chain/types" block "github.com/ipfs/go-block-format" "github.com/ipfs/go-cid" dstore "github.com/ipfs/go-datastore" hamt "github.com/ipfs/go-hamt-ipld" blockstore "github.com/ipfs/go-ipfs-blockstore" bstore "github.com/ipfs/go-ipfs-blockstore" logging "github.com/ipfs/go-log" "github.com/pkg/errors" pubsub "github.com/whyrusleeping/pubsub" sharray "github.com/whyrusleeping/sharray" ) var log = logging.Logger("chainstore") var chainHeadKey = dstore.NewKey("head") type ChainStore struct { bs bstore.Blockstore ds dstore.Datastore heaviestLk sync.Mutex heaviest *types.TipSet bestTips *pubsub.PubSub headChangeNotifs []func(rev, app []*types.TipSet) error } func NewChainStore(bs bstore.Blockstore, ds dstore.Batching) *ChainStore { cs := &ChainStore{ bs: bs, ds: ds, bestTips: pubsub.New(64), } hcnf := func(rev, app []*types.TipSet) error { for _, r := range rev { cs.bestTips.Pub(&HeadChange{ Type: HCRevert, Val: r, }, "headchange") } for _, r := range app { cs.bestTips.Pub(&HeadChange{ Type: HCApply, Val: r, }, "headchange") } return nil } cs.headChangeNotifs = append(cs.headChangeNotifs, hcnf) return cs } func (cs *ChainStore) Load() error { head, err := cs.ds.Get(chainHeadKey) if err == dstore.ErrNotFound { log.Warn("no previous chain state found") return nil } if err != nil { return errors.Wrap(err, "failed to load chain state from datastore") } var tscids []cid.Cid if err := json.Unmarshal(head, &tscids); err != nil { return errors.Wrap(err, "failed to unmarshal stored chain head") } ts, err := cs.LoadTipSet(tscids) if err != nil { return err } cs.heaviest = ts return nil } func (cs *ChainStore) writeHead(ts *types.TipSet) error { data, err := json.Marshal(ts.Cids()) if err != nil { return errors.Wrap(err, "failed to marshal tipset") } if err := cs.ds.Put(chainHeadKey, data); err != nil { return errors.Wrap(err, "failed to write chain head to datastore") } return nil } func (cs *ChainStore) SubNewTips() chan *types.TipSet { subch := cs.bestTips.Sub("best") out := make(chan *types.TipSet) go func() { defer close(out) for val := range subch { out <- val.(*types.TipSet) } }() return out } const ( HCRevert = "revert" HCApply = "apply" ) type HeadChange struct { Type string Val *types.TipSet } func (cs *ChainStore) SubHeadChanges(ctx context.Context) chan *HeadChange { subch := cs.bestTips.Sub("headchange") out := make(chan *HeadChange, 16) go func() { defer close(out) for { select { case val, ok := <-subch: if !ok { return } out <- val.(*HeadChange) case <-ctx.Done(): cs.bestTips.Unsub(subch) } } }() return out } func (cs *ChainStore) SubscribeHeadChanges(f func(rev, app []*types.TipSet) error) { cs.headChangeNotifs = append(cs.headChangeNotifs, f) } func (cs *ChainStore) SetGenesis(b *types.BlockHeader) error { fts := &FullTipSet{ Blocks: []*types.FullBlock{ {Header: b}, }, } if err := cs.PutTipSet(fts); err != nil { return err } return cs.ds.Put(dstore.NewKey("0"), b.Cid().Bytes()) } func (cs *ChainStore) PutTipSet(ts *FullTipSet) error { for _, b := range ts.Blocks { if err := cs.persistBlock(b); err != nil { return err } } if err := cs.MaybeTakeHeavierTipSet(ts.TipSet()); err != nil { return errors.Wrap(err, "MaybeTakeHeavierTipSet failed in PutTipSet") } return nil } func (cs *ChainStore) MaybeTakeHeavierTipSet(ts *types.TipSet) error { cs.heaviestLk.Lock() defer cs.heaviestLk.Unlock() if cs.heaviest == nil || cs.Weight(ts) > cs.Weight(cs.heaviest) { // TODO: don't do this for initial sync. Now that we don't have a // difference between 'bootstrap sync' and 'caught up' sync, we need // some other heuristic. if cs.heaviest != nil { revert, apply, err := cs.ReorgOps(cs.heaviest, ts) if err != nil { return errors.Wrap(err, "computing reorg ops failed") } for _, hcf := range cs.headChangeNotifs { if err := hcf(revert, apply); err != nil { return errors.Wrap(err, "head change func errored (BAD)") } } } log.Infof("New heaviest tipset! %s", ts.Cids()) cs.heaviest = ts if err := cs.writeHead(ts); err != nil { log.Errorf("failed to write chain head: %s", err) return nil } } return nil } func (cs *ChainStore) Contains(ts *types.TipSet) (bool, error) { for _, c := range ts.Cids() { has, err := cs.bs.Has(c) if err != nil { return false, err } if !has { return false, nil } } return true, nil } func (cs *ChainStore) GetBlock(c cid.Cid) (*types.BlockHeader, error) { sb, err := cs.bs.Get(c) if err != nil { return nil, err } return types.DecodeBlock(sb.RawData()) } func (cs *ChainStore) LoadTipSet(cids []cid.Cid) (*types.TipSet, error) { var blks []*types.BlockHeader for _, c := range cids { b, err := cs.GetBlock(c) if err != nil { return nil, err } blks = append(blks, b) } return types.NewTipSet(blks) } // returns true if 'a' is an ancestor of 'b' func (cs *ChainStore) IsAncestorOf(a, b *types.TipSet) (bool, error) { if b.Height() <= a.Height() { return false, nil } cur := b for !a.Equals(cur) && cur.Height() > a.Height() { next, err := cs.LoadTipSet(b.Parents()) if err != nil { return false, err } cur = next } return cur.Equals(a), nil } func (cs *ChainStore) NearestCommonAncestor(a, b *types.TipSet) (*types.TipSet, error) { l, _, err := cs.ReorgOps(a, b) if err != nil { return nil, err } return cs.LoadTipSet(l[len(l)-1].Parents()) } func (cs *ChainStore) ReorgOps(a, b *types.TipSet) ([]*types.TipSet, []*types.TipSet, error) { left := a right := b var leftChain, rightChain []*types.TipSet for !left.Equals(right) { if left.Height() > right.Height() { leftChain = append(leftChain, left) par, err := cs.LoadTipSet(left.Parents()) if err != nil { return nil, nil, err } left = par } else { rightChain = append(rightChain, right) par, err := cs.LoadTipSet(right.Parents()) if err != nil { log.Infof("failed to fetch right.Parents: %s", err) return nil, nil, err } right = par } } return leftChain, rightChain, nil } func (cs *ChainStore) Weight(ts *types.TipSet) uint64 { return ts.Blocks()[0].ParentWeight.Uint64() + uint64(len(ts.Cids())) } func (cs *ChainStore) GetHeaviestTipSet() *types.TipSet { cs.heaviestLk.Lock() defer cs.heaviestLk.Unlock() return cs.heaviest } func (cs *ChainStore) PersistBlockHeader(b *types.BlockHeader) error { sb, err := b.ToStorageBlock() if err != nil { return err } return cs.bs.Put(sb) } func (cs *ChainStore) persistBlock(b *types.FullBlock) error { if err := cs.PersistBlockHeader(b.Header); err != nil { return err } for _, m := range b.BlsMessages { if _, err := cs.PutMessage(m); err != nil { return err } } for _, m := range b.SecpkMessages { if _, err := cs.PutMessage(m); err != nil { return err } } return nil } type storable interface { ToStorageBlock() (block.Block, error) } func PutMessage(bs blockstore.Blockstore, m storable) (cid.Cid, error) { b, err := m.ToStorageBlock() if err != nil { return cid.Undef, err } if err := bs.Put(b); err != nil { return cid.Undef, err } return b.Cid(), nil } func (cs *ChainStore) PutMessage(m storable) (cid.Cid, error) { return PutMessage(cs.bs, m) } func (cs *ChainStore) AddBlock(b *types.BlockHeader) error { if err := cs.PersistBlockHeader(b); err != nil { return err } ts, _ := types.NewTipSet([]*types.BlockHeader{b}) if err := cs.MaybeTakeHeavierTipSet(ts); err != nil { return errors.Wrap(err, "MaybeTakeHeavierTipSet failed") } return nil } func (cs *ChainStore) GetGenesis() (*types.BlockHeader, error) { data, err := cs.ds.Get(dstore.NewKey("0")) if err != nil { return nil, err } c, err := cid.Cast(data) if err != nil { return nil, err } genb, err := cs.bs.Get(c) if err != nil { return nil, err } return types.DecodeBlock(genb.RawData()) } func (cs *ChainStore) TipSetState(cids []cid.Cid) (cid.Cid, error) { ts, err := cs.LoadTipSet(cids) if err != nil { log.Error("failed loading tipset: ", cids) return cid.Undef, err } if len(ts.Blocks()) == 1 { return ts.Blocks()[0].StateRoot, nil } panic("cant handle multiblock tipsets yet") } func (cs *ChainStore) GetMessage(c cid.Cid) (*types.Message, error) { sb, err := cs.bs.Get(c) if err != nil { log.Errorf("get message get failed: %s: %s", c, err) return nil, err } return types.DecodeMessage(sb.RawData()) } func (cs *ChainStore) GetSignedMessage(c cid.Cid) (*types.SignedMessage, error) { sb, err := cs.bs.Get(c) if err != nil { log.Errorf("get message get failed: %s: %s", c, err) return nil, err } return types.DecodeSignedMessage(sb.RawData()) } func (cs *ChainStore) readSharrayCids(root cid.Cid) ([]cid.Cid, error) { cst := hamt.CSTFromBstore(cs.bs) shar, err := sharray.Load(context.TODO(), root, 4, cst) if err != nil { return nil, errors.Wrap(err, "sharray load") } var cids []cid.Cid err = shar.ForEach(context.TODO(), func(i interface{}) error { c, ok := i.(cid.Cid) if !ok { return fmt.Errorf("value in message sharray was not a cid") } cids = append(cids, c) return nil }) if err != nil { return nil, err } return cids, nil } func (cs *ChainStore) MessagesForBlock(b *types.BlockHeader) ([]*types.Message, []*types.SignedMessage, error) { cst := hamt.CSTFromBstore(cs.bs) var msgmeta types.MsgMeta if err := cst.Get(context.TODO(), b.Messages, &msgmeta); err != nil { return nil, nil, err } blscids, err := cs.readSharrayCids(msgmeta.BlsMessages) if err != nil { return nil, nil, errors.Wrap(err, "loading bls message cids for block") } secpkcids, err := cs.readSharrayCids(msgmeta.SecpkMessages) if err != nil { return nil, nil, errors.Wrap(err, "loading secpk message cids for block") } blsmsgs, err := cs.LoadMessagesFromCids(blscids) if err != nil { return nil, nil, errors.Wrap(err, "loading bls messages for block") } secpkmsgs, err := cs.LoadSignedMessagesFromCids(secpkcids) if err != nil { return nil, nil, errors.Wrap(err, "loading secpk messages for block") } return blsmsgs, secpkmsgs, nil } func (cs *ChainStore) GetReceipt(b *types.BlockHeader, i int) (*types.MessageReceipt, error) { cst := hamt.CSTFromBstore(cs.bs) shar, err := sharray.Load(context.TODO(), b.MessageReceipts, 4, cst) if err != nil { return nil, errors.Wrap(err, "sharray load") } ival, err := shar.Get(context.TODO(), i) if err != nil { return nil, err } // @warpfork, @EricMyhre help me. save me. out, err := json.Marshal(ival) if err != nil { return nil, err } var r types.MessageReceipt if err := json.Unmarshal(out, &r); err != nil { return nil, err } return &r, nil } func (cs *ChainStore) LoadMessagesFromCids(cids []cid.Cid) ([]*types.Message, error) { msgs := make([]*types.Message, 0, len(cids)) for i, c := range cids { m, err := cs.GetMessage(c) if err != nil { return nil, errors.Wrapf(err, "failed to get message: (%s):%d", c, i) } msgs = append(msgs, m) } return msgs, nil } func (cs *ChainStore) LoadSignedMessagesFromCids(cids []cid.Cid) ([]*types.SignedMessage, error) { msgs := make([]*types.SignedMessage, 0, len(cids)) for i, c := range cids { m, err := cs.GetSignedMessage(c) if err != nil { return nil, errors.Wrapf(err, "failed to get message: (%s):%d", c, i) } msgs = append(msgs, m) } return msgs, nil } func (cs *ChainStore) GetBalance(addr address.Address) (types.BigInt, error) { act, err := cs.GetActor(addr) if err != nil { return types.BigInt{}, err } return act.Balance, nil } func (cs *ChainStore) GetActor(addr address.Address) (*types.Actor, error) { ts := cs.GetHeaviestTipSet() stcid, err := cs.TipSetState(ts.Cids()) if err != nil { return nil, err } cst := hamt.CSTFromBstore(cs.bs) state, err := state.LoadStateTree(cst, stcid) if err != nil { return nil, err } return state.GetActor(addr) } func (cs *ChainStore) WaitForMessage(ctx context.Context, mcid cid.Cid) (cid.Cid, *types.MessageReceipt, error) { tsub := cs.SubHeadChanges(ctx) head := cs.GetHeaviestTipSet() bc, r, err := cs.tipsetContainsMsg(head, mcid) if err != nil { return cid.Undef, nil, err } if r != nil { return bc, r, nil } for { select { case val := <-tsub: switch val.Type { case HCRevert: continue case HCApply: bc, r, err := cs.tipsetContainsMsg(val.Val, mcid) if err != nil { return cid.Undef, nil, err } if r != nil { return bc, r, nil } } case <-ctx.Done(): return cid.Undef, nil, ctx.Err() } } } func (cs *ChainStore) tipsetContainsMsg(ts *types.TipSet, msg cid.Cid) (cid.Cid, *types.MessageReceipt, error) { for _, b := range ts.Blocks() { r, err := cs.blockContainsMsg(b, msg) if err != nil { return cid.Undef, nil, err } if r != nil { return b.Cid(), r, nil } } return cid.Undef, nil, nil } func (cs *ChainStore) blockContainsMsg(blk *types.BlockHeader, msg cid.Cid) (*types.MessageReceipt, error) { cst := hamt.CSTFromBstore(cs.bs) var msgmeta types.MsgMeta if err := cst.Get(context.TODO(), blk.Messages, &msgmeta); err != nil { return nil, err } blscids, err := cs.readSharrayCids(msgmeta.BlsMessages) if err != nil { return nil, errors.Wrap(err, "loading bls message cids for block") } for i, c := range blscids { if c == msg { return cs.GetReceipt(blk, i) } } secpkcids, err := cs.readSharrayCids(msgmeta.SecpkMessages) if err != nil { return nil, errors.Wrap(err, "loading secpk message cids for block") } for i, c := range secpkcids { if c == msg { return cs.GetReceipt(blk, i+len(blscids)) } } return nil, nil } func (cs *ChainStore) Blockstore() blockstore.Blockstore { return cs.bs } func (cs *ChainStore) TryFillTipSet(ts *types.TipSet) (*FullTipSet, error) { var out []*types.FullBlock for _, b := range ts.Blocks() { bmsgs, smsgs, err := cs.MessagesForBlock(b) if err != nil { // TODO: check for 'not found' errors, and only return nil if this // is actually a 'not found' error return nil, nil } fb := &types.FullBlock{ Header: b, BlsMessages: bmsgs, SecpkMessages: smsgs, } out = append(out, fb) } return NewFullTipSet(out), nil }