feat: expose sequence number correctly to users of the signer (celest…

…iaorg#2992)

It's probably misleading that `GetSequence` should not only return the
sequence number but increment it. The incrementing sequence should be
internal and the user should just be able to use `Sequence` if they wish
to query the sequence number of the signer

pkg/user/signer.go

@@ -267,14 +267,30 @@ func (s *Signer) PubKey() cryptotypes.PubKey {
 	return s.pk
 }
 
+// Sequence returns the last signed sequence number of the signer
+func (s *Signer) Sequence() uint64 {
+	s.mtx.RLock()
+	defer s.mtx.RUnlock()
+	return s.lastSignedSequence
+}
+
 // GetSequence gets the latest signed sequence and increments the local sequence number
+// Deprecated: Use Sequence if you want to get the latest signed sequence number
 func (s *Signer) GetSequence() uint64 {
 	s.mtx.Lock()
 	defer s.mtx.Unlock()
 	defer func() { s.lastSignedSequence++ }()
 	return s.lastSignedSequence
 }
 
+// getAndIncrementSequence gets the latest signed sequence and increments the local sequence number
+func (s *Signer) getAndIncrementSequence() uint64 {
+	s.mtx.Lock()
+	defer s.mtx.Unlock()
+	defer func() { s.lastSignedSequence++ }()
+	return s.lastSignedSequence
+}
+
 // ForceSetSequence manually overrides the current sequence number. Be careful when
 // invoking this as it may cause the transactions to reject the sequence if
 // it doesn't match the one in state
@@ -284,6 +300,11 @@ func (s *Signer) ForceSetSequence(seq uint64) {
 	s.lastSignedSequence = seq
 }
 
+// Keyring exposes the signers underlying keyring
+func (s *Signer) Keyring() keyring.Keyring {
+	return s.keys
+}
+
 func (s *Signer) signTransaction(builder client.TxBuilder) error {
 	signers := builder.GetTx().GetSigners()
 	if len(signers) != 1 {
@@ -294,7 +315,7 @@ func (s *Signer) signTransaction(builder client.TxBuilder) error {
 		return fmt.Errorf("expected signer %s, got %s", s.address.String(), signers[0].String())
 	}
 
-	sequence := s.GetSequence()
+	sequence := s.getAndIncrementSequence()
 
 	// To ensure we have the correct bytes to sign over we produce
 	// a dry run of the signing data