Merge pull request #613 from oasisprotocol/matevz/feature/rofl-show-offers-note

cmd/rofl/deploy: Also show a "note" metadata when listing offers

Author: matevz

build/rofl/provider/manifest.go

@@ -173,6 +173,10 @@ func (m *Manifest) Save() error {
 type Offer struct {
 	// ID is the unique offer identifier used by the scheduler.
 	ID string `yaml:"id" json:"id"`
+	// Note contains one-line notification such as a discount or a warning.
+	Note string `yaml:"note" json:"note"`
+	// Description contains longer offer-specific description such as intended applications.
+	Description string `yaml:"description" json:"description"`
 	// Resources are the offered resources.
 	Resources Resources `yaml:"resources" json:"resources"`
 	// Payment is the payment for this offer.
@@ -205,6 +209,12 @@ const schedulerMetadataPrefix = "net.oasis.scheduler."
 // SchedulerMetadataOfferKey is the metadata key used for the offer name.
 const SchedulerMetadataOfferKey = schedulerMetadataPrefix + "offer"
 
+// NoteMetadataKey is the metadata key for offer-specific one-line notification such as a discount or a warning.
+const NoteMetadataKey = "net.oasis.note"
+
+// DescriptionMetadataKey is the metadata key for longer offer-specific description such as intended applications.
+const DescriptionMetadataKey = "net.oasis.description"
+
 // GetMetadata derives metadata from the attributes defined in the offer and combines it with the
 // specified metadata.
 func (o *Offer) GetMetadata() map[string]string {
@@ -221,6 +231,13 @@ func (o *Offer) GetMetadata() map[string]string {
 		meta[schedulerMetadataPrefix+md.name] = md.value
 	}
 
+	if o.Description != "" {
+		meta[DescriptionMetadataKey] = o.Description
+	}
+	if o.Note != "" {
+		meta[NoteMetadataKey] = o.Note
+	}
+
 	maps.Copy(meta, o.Metadata)
 	return meta
 }
@@ -250,15 +267,11 @@ const (
 
 // Payment is payment configuration for an offer.
 type Payment struct {
-	Native *struct {
-		Denomination string            `yaml:"denomination" json:"denomination"`
-		Terms        map[string]string `yaml:"terms" json:"terms"`
-	} `yaml:"native,omitempty" json:"native,omitempty"`
-
-	EvmContract *struct {
-		Address string `json:"address"`
-		Data    string `json:"data"`
-	} `yaml:"evm,omitempty" json:"evm,omitempty"`
+	// Native contains native payment terms.
+	Native *NativePayment `yaml:"native,omitempty" json:"native,omitempty"`
+
+	// EvmContract contains payment terms defined in a smart contract.
+	EvmContract *EVMContractPayment `yaml:"evm,omitempty" json:"evm,omitempty"`
 }
 
 // Validate validates the payment configuration.
@@ -336,6 +349,24 @@ func (p *Payment) AsDescriptor(pt *config.ParaTime) (*roflmarket.Payment, error)
 	return &dsc, nil
 }
 
+// NativePayment is payment configuration for native tokens.
+type NativePayment struct {
+	// Denomination is the native token denomination.
+	Denomination string `yaml:"denomination,omitempty" json:"denomination,omitempty"`
+
+	// Terms are payment terms in form of Term => amount in decimal.
+	Terms map[string]string `yaml:"terms" json:"terms"`
+}
+
+// EVMContractPayment is payment configuration for EVM contract-based payments.
+type EVMContractPayment struct {
+	// Address is hex-encoded address without leading 0x.
+	Address string `json:"address"`
+
+	// Data is arbitrary Base-64 encoded payment information.
+	Data string `json:"data"`
+}
+
 // Resources are describe the offered resources.
 type Resources struct {
 	// TEE is the type of TEE hardware.

cmd/rofl/deploy.go

@@ -415,6 +415,12 @@ func showProviderOffer(ctx context.Context, offer *roflmarket.Offer) {
 		offer.Resources.CPUCount,
 		float64(offer.Resources.Storage)/1024.,
 	)
+	if _, ok := offer.Metadata[provider.NoteMetadataKey]; ok {
+		fmt.Printf("  Note: %s\n", offer.Metadata[provider.NoteMetadataKey])
+	}
+	if _, ok := offer.Metadata[provider.DescriptionMetadataKey]; ok {
+		fmt.Printf("  Description:\n    %s\n", strings.ReplaceAll(offer.Metadata[provider.DescriptionMetadataKey], "\n", "\n    "))
+	}
 	if offer.Payment.Native != nil {
 		if len(offer.Payment.Native.Terms) == 0 {
 			return

cmd/rofl/provider/mgmt.go

@@ -43,14 +43,31 @@ var (
 			}
 
 			fmt.Printf("Scheduler app: %s\n", schedulerApp)
-
-			// Create a default manifest.
 			manifest := provider.Manifest{
 				Network:        npa.NetworkName,
 				ParaTime:       npa.ParaTimeName,
 				Provider:       npa.AccountName,
 				SchedulerApp:   schedulerApp,
 				PaymentAddress: npa.AccountName,
+				Offers: []*provider.Offer{{
+					ID:          "example_offer",
+					Note:        "One-liner note for special discounts or warnings (optional)",
+					Description: "This is an example offer.\nFill in your description here.",
+					Resources: provider.Resources{
+						TEE:      "tdx",
+						Memory:   1024,
+						CPUCount: 1,
+						Storage:  3000,
+					},
+					Payment: provider.Payment{
+						Native: &provider.NativePayment{
+							Terms: map[string]string{
+								provider.TermKeyMonth: "100",
+							},
+						},
+					},
+					Capacity: 10,
+				}},
 			}
 			err := manifest.Validate()
 			cobra.CheckErr(err)