Add IsClientRequest function for actions.

Author: KarlTheProgrammer

dist/golang/actions/actions.go

@@ -15,6 +15,8 @@ type Action interface {
 	Code() string
 	TypeName() string
 
+	IsClientRequest() bool
+
 	Validate() error
 	Equal(proto.Message) bool
 }
@@ -269,6 +271,10 @@ func (a *ContractOffer) TypeName() string {
 	return "ContractOffer"
 }
 
+func (a *ContractOffer) IsClientRequest() bool {
+	return true
+}
+
 func (a *ContractFormation) Code() string {
 	return CodeContractFormation
 }
@@ -277,6 +283,10 @@ func (a *ContractFormation) TypeName() string {
 	return "ContractFormation"
 }
 
+func (a *ContractFormation) IsClientRequest() bool {
+	return false
+}
+
 func (a *ContractAmendment) Code() string {
 	return CodeContractAmendment
 }
@@ -285,6 +295,10 @@ func (a *ContractAmendment) TypeName() string {
 	return "ContractAmendment"
 }
 
+func (a *ContractAmendment) IsClientRequest() bool {
+	return true
+}
+
 func (a *StaticContractFormation) Code() string {
 	return CodeStaticContractFormation
 }
@@ -293,6 +307,10 @@ func (a *StaticContractFormation) TypeName() string {
 	return "StaticContractFormation"
 }
 
+func (a *StaticContractFormation) IsClientRequest() bool {
+	return false
+}
+
 func (a *ContractAddressChange) Code() string {
 	return CodeContractAddressChange
 }
@@ -301,6 +319,10 @@ func (a *ContractAddressChange) TypeName() string {
 	return "ContractAddressChange"
 }
 
+func (a *ContractAddressChange) IsClientRequest() bool {
+	return false
+}
+
 func (a *BodyOfAgreementOffer) Code() string {
 	return CodeBodyOfAgreementOffer
 }
@@ -309,6 +331,10 @@ func (a *BodyOfAgreementOffer) TypeName() string {
 	return "BodyOfAgreementOffer"
 }
 
+func (a *BodyOfAgreementOffer) IsClientRequest() bool {
+	return true
+}
+
 func (a *BodyOfAgreementFormation) Code() string {
 	return CodeBodyOfAgreementFormation
 }
@@ -317,6 +343,10 @@ func (a *BodyOfAgreementFormation) TypeName() string {
 	return "BodyOfAgreementFormation"
 }
 
+func (a *BodyOfAgreementFormation) IsClientRequest() bool {
+	return false
+}
+
 func (a *BodyOfAgreementAmendment) Code() string {
 	return CodeBodyOfAgreementAmendment
 }
@@ -325,6 +355,10 @@ func (a *BodyOfAgreementAmendment) TypeName() string {
 	return "BodyOfAgreementAmendment"
 }
 
+func (a *BodyOfAgreementAmendment) IsClientRequest() bool {
+	return true
+}
+
 func (a *InstrumentDefinition) Code() string {
 	return CodeInstrumentDefinition
 }
@@ -333,6 +367,10 @@ func (a *InstrumentDefinition) TypeName() string {
 	return "InstrumentDefinition"
 }
 
+func (a *InstrumentDefinition) IsClientRequest() bool {
+	return true
+}
+
 func (a *InstrumentCreation) Code() string {
 	return CodeInstrumentCreation
 }
@@ -341,6 +379,10 @@ func (a *InstrumentCreation) TypeName() string {
 	return "InstrumentCreation"
 }
 
+func (a *InstrumentCreation) IsClientRequest() bool {
+	return false
+}
+
 func (a *InstrumentModification) Code() string {
 	return CodeInstrumentModification
 }
@@ -349,6 +391,10 @@ func (a *InstrumentModification) TypeName() string {
 	return "InstrumentModification"
 }
 
+func (a *InstrumentModification) IsClientRequest() bool {
+	return true
+}
+
 func (a *Transfer) Code() string {
 	return CodeTransfer
 }
@@ -357,6 +403,10 @@ func (a *Transfer) TypeName() string {
 	return "Transfer"
 }
 
+func (a *Transfer) IsClientRequest() bool {
+	return true
+}
+
 func (a *Settlement) Code() string {
 	return CodeSettlement
 }
@@ -365,6 +415,10 @@ func (a *Settlement) TypeName() string {
 	return "Settlement"
 }
 
+func (a *Settlement) IsClientRequest() bool {
+	return false
+}
+
 func (a *RectificationSettlement) Code() string {
 	return CodeRectificationSettlement
 }
@@ -373,6 +427,10 @@ func (a *RectificationSettlement) TypeName() string {
 	return "RectificationSettlement"
 }
 
+func (a *RectificationSettlement) IsClientRequest() bool {
+	return false
+}
+
 func (a *Proposal) Code() string {
 	return CodeProposal
 }
@@ -381,6 +439,10 @@ func (a *Proposal) TypeName() string {
 	return "Proposal"
 }
 
+func (a *Proposal) IsClientRequest() bool {
+	return true
+}
+
 func (a *Vote) Code() string {
 	return CodeVote
 }
@@ -389,6 +451,10 @@ func (a *Vote) TypeName() string {
 	return "Vote"
 }
 
+func (a *Vote) IsClientRequest() bool {
+	return false
+}
+
 func (a *BallotCast) Code() string {
 	return CodeBallotCast
 }
@@ -397,6 +463,10 @@ func (a *BallotCast) TypeName() string {
 	return "BallotCast"
 }
 
+func (a *BallotCast) IsClientRequest() bool {
+	return true
+}
+
 func (a *BallotCounted) Code() string {
 	return CodeBallotCounted
 }
@@ -405,6 +475,10 @@ func (a *BallotCounted) TypeName() string {
 	return "BallotCounted"
 }
 
+func (a *BallotCounted) IsClientRequest() bool {
+	return false
+}
+
 func (a *Result) Code() string {
 	return CodeResult
 }
@@ -413,6 +487,10 @@ func (a *Result) TypeName() string {
 	return "Result"
 }
 
+func (a *Result) IsClientRequest() bool {
+	return false
+}
+
 func (a *Order) Code() string {
 	return CodeOrder
 }
@@ -421,6 +499,10 @@ func (a *Order) TypeName() string {
 	return "Order"
 }
 
+func (a *Order) IsClientRequest() bool {
+	return true
+}
+
 func (a *Freeze) Code() string {
 	return CodeFreeze
 }
@@ -429,6 +511,10 @@ func (a *Freeze) TypeName() string {
 	return "Freeze"
 }
 
+func (a *Freeze) IsClientRequest() bool {
+	return false
+}
+
 func (a *Thaw) Code() string {
 	return CodeThaw
 }
@@ -437,6 +523,10 @@ func (a *Thaw) TypeName() string {
 	return "Thaw"
 }
 
+func (a *Thaw) IsClientRequest() bool {
+	return false
+}
+
 func (a *Confiscation) Code() string {
 	return CodeConfiscation
 }
@@ -445,6 +535,10 @@ func (a *Confiscation) TypeName() string {
 	return "Confiscation"
 }
 
+func (a *Confiscation) IsClientRequest() bool {
+	return false
+}
+
 func (a *DeprecatedReconciliation) Code() string {
 	return CodeDeprecatedReconciliation
 }
@@ -453,6 +547,10 @@ func (a *DeprecatedReconciliation) TypeName() string {
 	return "DeprecatedReconciliation"
 }
 
+func (a *DeprecatedReconciliation) IsClientRequest() bool {
+	return false
+}
+
 func (a *Establishment) Code() string {
 	return CodeEstablishment
 }
@@ -461,6 +559,10 @@ func (a *Establishment) TypeName() string {
 	return "Establishment"
 }
 
+func (a *Establishment) IsClientRequest() bool {
+	return false
+}
+
 func (a *Addition) Code() string {
 	return CodeAddition
 }
@@ -469,6 +571,10 @@ func (a *Addition) TypeName() string {
 	return "Addition"
 }
 
+func (a *Addition) IsClientRequest() bool {
+	return false
+}
+
 func (a *Alteration) Code() string {
 	return CodeAlteration
 }
@@ -477,6 +583,10 @@ func (a *Alteration) TypeName() string {
 	return "Alteration"
 }
 
+func (a *Alteration) IsClientRequest() bool {
+	return false
+}
+
 func (a *Removal) Code() string {
 	return CodeRemoval
 }
@@ -485,6 +595,10 @@ func (a *Removal) TypeName() string {
 	return "Removal"
 }
 
+func (a *Removal) IsClientRequest() bool {
+	return false
+}
+
 func (a *Message) Code() string {
 	return CodeMessage
 }
@@ -493,6 +607,10 @@ func (a *Message) TypeName() string {
 	return "Message"
 }
 
+func (a *Message) IsClientRequest() bool {
+	return false
+}
+
 func (a *Rejection) Code() string {
 	return CodeRejection
 }
@@ -501,6 +619,10 @@ func (a *Rejection) TypeName() string {
 	return "Rejection"
 }
 
+func (a *Rejection) IsClientRequest() bool {
+	return false
+}
+
 // Formation creates a contract formation with all the values from the contract offer.
 func (a *ContractOffer) Formation() (*ContractFormation, error) {
 	return &ContractFormation{

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/spf13/cobra v0.0.5
 	github.com/tokenized/bitcoin_interpreter v0.1.1
 	github.com/tokenized/envelope v1.1.0
+	github.com/tokenized/logger v0.1.3
 	github.com/tokenized/pkg v0.7.1-0.20230728163803-9a855fa7d049
 	github.com/tokenized/txbuilder v1.1.1-0.20230816003850-4414c86d5db4
 	golang.org/x/crypto v0.8.0
@@ -27,7 +28,6 @@ require (
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.3 // indirect
 	github.com/tokenized/channels v0.1.1 // indirect
-	github.com/tokenized/logger v0.1.3 // indirect
 	github.com/tokenized/threads v0.1.2 // indirect
 	github.com/tyler-smith/go-bip32 v0.0.0-20170922074101-2c9cfd177564 // indirect
 )

internal/golang/templates/actions.tpl

@@ -15,6 +15,9 @@ type Action interface {
 	Code() string
 	TypeName() string
 
+	// IsClientRequest returns true when this action is a client request to a smart contract agent.
+	IsClientRequest() bool
+
 	Validate() error
 	Equal(proto.Message) bool
 }
@@ -128,6 +131,15 @@ func (a *{{.Name}}) Code() string {
 func (a *{{.Name}}) TypeName() string {
 	return "{{.Name}}"
 }
+
+// IsClientRequest returns true when this action is a client request to a smart contract agent.
+func (a *{{.Name}}) IsClientRequest() bool {
+	{{- if eq (len .MetaData.Validation) 0 }}
+	return false
+	{{- else }}
+	return true
+	{{- end }}
+}
 {{ end }}
 
 {{- range $i, $message := .Messages }}