Expose some helper functions (#420)

* Export SignatureFromJSONRawMsg * Expose Address and Signature read and write guards
iotaledger · Mar 20, 2023 · d533cb3 · d533cb3
1 parent 4f1f458
commit d533cb3
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 26 deletions.
diff --git a/address.go b/address.go
@@ -141,7 +141,7 @@ func jsonAddressToAddress(jAddr JSONSerializable) (Address, error) {
 }
 
 // checks whether the given Serializable is an Address and also supported AddressType.
-func addrWriteGuard(supportedAddr AddressTypeSet) serializer.SerializableWriteGuardFunc {
+func AddressWriteGuard(supportedAddr AddressTypeSet) serializer.SerializableWriteGuardFunc {
 	return func(seri serializer.Serializable) error {
 		if seri == nil {
 			return fmt.Errorf("%w: because nil", ErrTypeIsNotSupportedAddress)
@@ -159,7 +159,7 @@ func addrWriteGuard(supportedAddr AddressTypeSet) serializer.SerializableWriteGu
 	}
 }
 
-func addrReadGuard(supportedAddr AddressTypeSet) serializer.SerializableReadGuardFunc {
+func AddressReadGuard(supportedAddr AddressTypeSet) serializer.SerializableReadGuardFunc {
 	return func(ty uint32) (serializer.Serializable, error) {
 		if _, supported := supportedAddr[AddressType(ty)]; !supported {
 			return nil, fmt.Errorf("%w: because not in set %v (%d)", ErrTypeIsNotSupportedAddress, supportedAddr, ty)

diff --git a/feat_issuer.go b/feat_issuer.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	issuerFeatAddrGuard = serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(allAddressTypeSet),
-		WriteGuard: addrWriteGuard(allAddressTypeSet),
+		ReadGuard:  AddressReadGuard(allAddressTypeSet),
+		WriteGuard: AddressWriteGuard(allAddressTypeSet),
 	}
 )
 

diff --git a/feat_sender.go b/feat_sender.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	senderFeatAddrGuard = serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(allAddressTypeSet),
-		WriteGuard: addrWriteGuard(allAddressTypeSet),
+		ReadGuard:  AddressReadGuard(allAddressTypeSet),
+		WriteGuard: AddressWriteGuard(allAddressTypeSet),
 	}
 )
 

diff --git a/migrated_funds_entry.go b/migrated_funds_entry.go
@@ -9,8 +9,8 @@ import (
 
 var (
 	migratedFundEntryFeatBlockAddrGuard = serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(AddressTypeSet{AddressEd25519: struct{}{}}),
-		WriteGuard: addrWriteGuard(AddressTypeSet{AddressEd25519: struct{}{}}),
+		ReadGuard:  AddressReadGuard(AddressTypeSet{AddressEd25519: struct{}{}}),
+		WriteGuard: AddressWriteGuard(AddressTypeSet{AddressEd25519: struct{}{}}),
 	}
 )
 

diff --git a/milestone.go b/milestone.go
@@ -81,8 +81,8 @@ var (
 		Min: MinSignaturesInAMilestone,
 		Max: MaxSignaturesInAMilestone,
 		Guards: serializer.SerializableGuard{
-			ReadGuard:  sigReadGuard(milestoneSupportedSigTypes),
-			WriteGuard: sigWriteGuard(milestoneSupportedSigTypes),
+			ReadGuard:  SignatureReadGuard(milestoneSupportedSigTypes),
+			WriteGuard: SignatureWriteGuard(milestoneSupportedSigTypes),
 		},
 		UniquenessSliceFunc: func(next []byte) []byte { return next[:ed25519.PublicKeySize] },
 		ValidationMode:      serializer.ArrayValidationModeNoDuplicates | serializer.ArrayValidationModeLexicalOrdering,

diff --git a/signature.go b/signature.go
@@ -92,7 +92,7 @@ type Signature interface {
 type SignatureTypeSet map[SignatureType]struct{}
 
 // checks whether the given Serializable is a Signature and also supported SignatureType.
-func sigWriteGuard(supportedSigs SignatureTypeSet) serializer.SerializableWriteGuardFunc {
+func SignatureWriteGuard(supportedSigs SignatureTypeSet) serializer.SerializableWriteGuardFunc {
 	return func(seri serializer.Serializable) error {
 		if seri == nil {
 			return fmt.Errorf("%w: because nil", ErrTypeIsNotSupportedSignature)
@@ -111,7 +111,7 @@ func sigWriteGuard(supportedSigs SignatureTypeSet) serializer.SerializableWriteG
 	}
 }
 
-func sigReadGuard(supportedSigs SignatureTypeSet) serializer.SerializableReadGuardFunc {
+func SignatureReadGuard(supportedSigs SignatureTypeSet) serializer.SerializableReadGuardFunc {
 	return func(ty uint32) (serializer.Serializable, error) {
 		if _, supported := supportedSigs[SignatureType(ty)]; !supported {
 			return nil, fmt.Errorf("%w: because not in set %v (%d)", ErrTypeIsNotSupportedSignature, supportedSigs, ty)
@@ -132,7 +132,7 @@ func SignatureSelector(sigType uint32) (Signature, error) {
 	return seri, nil
 }
 
-func signatureFromJSONRawMsg(jRawMsg *json.RawMessage) (Signature, error) {
+func SignatureFromJSONRawMsg(jRawMsg *json.RawMessage) (Signature, error) {
 	jsonSignature, err := DeserializeObjectFromJSON(jRawMsg, jsonSignatureSelector)
 	if err != nil {
 		return nil, fmt.Errorf("can't decode signature type from JSON: %w", err)

diff --git a/unlock_cond_address.go b/unlock_cond_address.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	addrUnlockCondAddrGuard = &serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(allAddressTypeSet),
-		WriteGuard: addrWriteGuard(allAddressTypeSet),
+		ReadGuard:  AddressReadGuard(allAddressTypeSet),
+		WriteGuard: AddressWriteGuard(allAddressTypeSet),
 	}
 )
 

diff --git a/unlock_cond_expiration.go b/unlock_cond_expiration.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	expUnlockCondAddrGuard = &serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(allAddressTypeSet),
-		WriteGuard: addrWriteGuard(allAddressTypeSet),
+		ReadGuard:  AddressReadGuard(allAddressTypeSet),
+		WriteGuard: AddressWriteGuard(allAddressTypeSet),
 	}
 )
 

diff --git a/unlock_cond_governor.go b/unlock_cond_governor.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	govAddrUnlockCondAddrGuard = &serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(allAddressTypeSet),
-		WriteGuard: addrWriteGuard(allAddressTypeSet),
+		ReadGuard:  AddressReadGuard(allAddressTypeSet),
+		WriteGuard: AddressWriteGuard(allAddressTypeSet),
 	}
 )
 

diff --git a/unlock_cond_imm_alias.go b/unlock_cond_imm_alias.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	immAliasUnlockCondAddrGuard = &serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(AddressTypeSet{AddressAlias: struct{}{}}),
-		WriteGuard: addrWriteGuard(AddressTypeSet{AddressAlias: struct{}{}}),
+		ReadGuard:  AddressReadGuard(AddressTypeSet{AddressAlias: struct{}{}}),
+		WriteGuard: AddressWriteGuard(AddressTypeSet{AddressAlias: struct{}{}}),
 	}
 )
 

diff --git a/unlock_cond_state_ctrl.go b/unlock_cond_state_ctrl.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	stateCtrlUnlockCondAddrGuard = &serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(allAddressTypeSet),
-		WriteGuard: addrWriteGuard(allAddressTypeSet),
+		ReadGuard:  AddressReadGuard(allAddressTypeSet),
+		WriteGuard: AddressWriteGuard(allAddressTypeSet),
 	}
 )
 

diff --git a/unlock_cond_storage_return.go b/unlock_cond_storage_return.go
@@ -10,8 +10,8 @@ import (
 
 var (
 	storageDepReturnUnlockCondAddrGuard = &serializer.SerializableGuard{
-		ReadGuard:  addrReadGuard(allAddressTypeSet),
-		WriteGuard: addrWriteGuard(allAddressTypeSet),
+		ReadGuard:  AddressReadGuard(allAddressTypeSet),
+		WriteGuard: AddressWriteGuard(allAddressTypeSet),
 	}
 )
 

diff --git a/unlock_signature.go b/unlock_signature.go
@@ -93,7 +93,7 @@ type jsonSignatureUnlock struct {
 }
 
 func (j *jsonSignatureUnlock) ToSerializable() (serializer.Serializable, error) {
-	sig, err := signatureFromJSONRawMsg(j.Signature)
+	sig, err := SignatureFromJSONRawMsg(j.Signature)
 	if err != nil {
 		return nil, err
 	}