cosmos-sdk/orm/encoding/ormkv/seq.go
Aaron Craelius 531bf50845
feat(orm): add ORM Table and Indexes (#10670)
## Description

Closes: #10729 

Includes:
* table, auto-increment table, and singleton `Table` implementations
* primary key, index and unique index `Index` implementations
* store wrappers based on tm-db but that could be retargeted to the new ADR 040 db which separate index and commitment stores, with a debug wrapper
* streaming JSON import and export
* full logical decoding (and encoding)



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
2022-01-20 16:22:06 +00:00

70 lines
1.5 KiB
Go

package ormkv
import (
"bytes"
"encoding/binary"
"github.com/cosmos/cosmos-sdk/orm/types/ormerrors"
"google.golang.org/protobuf/reflect/protoreflect"
)
// SeqCodec is the codec for auto-incrementing uint64 primary key sequences.
type SeqCodec struct {
messageType protoreflect.FullName
prefix []byte
}
// NewSeqCodec creates a new SeqCodec.
func NewSeqCodec(messageType protoreflect.MessageType, prefix []byte) *SeqCodec {
return &SeqCodec{messageType: messageType.Descriptor().FullName(), prefix: prefix}
}
var _ EntryCodec = &SeqCodec{}
func (s SeqCodec) DecodeEntry(k, v []byte) (Entry, error) {
if !bytes.Equal(k, s.prefix) {
return nil, ormerrors.UnexpectedDecodePrefix
}
x, err := s.DecodeValue(v)
if err != nil {
return nil, err
}
return &SeqEntry{
TableName: s.messageType,
Value: x,
}, nil
}
func (s SeqCodec) EncodeEntry(entry Entry) (k, v []byte, err error) {
seqEntry, ok := entry.(*SeqEntry)
if !ok {
return nil, nil, ormerrors.BadDecodeEntry
}
if seqEntry.TableName != s.messageType {
return nil, nil, ormerrors.BadDecodeEntry
}
return s.prefix, s.EncodeValue(seqEntry.Value), nil
}
func (s SeqCodec) Prefix() []byte {
return s.prefix
}
func (s SeqCodec) EncodeValue(seq uint64) (v []byte) {
bz := make([]byte, binary.MaxVarintLen64)
n := binary.PutUvarint(bz, seq)
return bz[:n]
}
func (s SeqCodec) DecodeValue(v []byte) (uint64, error) {
if len(v) == 0 {
return 0, nil
}
return binary.ReadUvarint(bytes.NewReader(v))
}