Merge pull request #2386 from c9s/dboy/xalign/enrich-notification-content

Author: dboyliao

pkg/strategy/xalign/slack.go

@@ -34,6 +34,8 @@ type InteractiveSubmitOrder struct {
 	delay       time.Duration
 	mentions    []string
 
+	helpMsg string // optional help message to show in slack
+
 	slackEvtID string
 	dueTime    time.Time
 	done       bool
@@ -62,6 +64,10 @@ func NewInteractiveSubmitOrder(order types.SubmitOrder, delay time.Duration, men
 	return itOrder
 }
 
+func (itOrder *InteractiveSubmitOrder) SetHelpMessage(msg string) {
+	itOrder.helpMsg = msg
+}
+
 func (itOrder *InteractiveSubmitOrder) SlackBlocks() []slack.Block {
 	// add the slack event id block
 	// IMPORTANT: do not remove this block as it's used as a filter on upcoming interactions
@@ -98,6 +104,10 @@ On %s after delay %s (due at %s)
 		),
 	))
 
+	if itOrder.helpMsg != "" {
+		blocks = append(blocks, buildTextBlock(itOrder.helpMsg))
+	}
+
 	// add mention block
 	if len(itOrder.mentions) > 0 {
 		blocks = append(blocks, buildTextBlock(strings.Join(itOrder.mentions, " ")))
@@ -253,6 +263,13 @@ func setupSlackInteractionCallback(slackEvtID string, dispatcher *interact.Inter
 		value, ok := interactOrderRegistry.Load(actionValue)
 		if !ok {
 			// it's already processed
+			actionName := "unknown"
+			switch actionID {
+			case cancelOrderActionID:
+				actionName = "cancel order"
+			case confirmOrderActionID:
+				actionName = "confirm order"
+			}
 			blocks := []interact.InteractionMessageUpdate{
 				{
 					Blocks:       removeBlockByID(oriMessage.Blocks.BlockSet, interactiveButtonsBlockID),
@@ -262,7 +279,8 @@ func setupSlackInteractionCallback(slackEvtID string, dispatcher *interact.Inter
 				{
 					Blocks: []slack.Block{buildTextBlock(
 						fmt.Sprintf(
-							"*Order has been processed, cannot do any further actions.* (requested by %s at %s)",
+							"*This order has already been processed. Your action (%s) has no effect.* (requested by %s at %s)",
+							actionName,
 							user.Name,
 							time.Now().Format(time.RFC3339),
 						))},
@@ -274,7 +292,7 @@ func setupSlackInteractionCallback(slackEvtID string, dispatcher *interact.Inter
 				order, ok := value.(*types.Order)
 				if ok && order != nil {
 					blocks = append(blocks, interact.InteractionMessageUpdate{
-						Blocks:       []slack.Block{buildTextBlock("*Created Order*")},
+						Blocks:       []slack.Block{buildTextBlock("*Details of the Submitted Order*")},
 						Attachments:  []slack.Attachment{order.SlackAttachment()},
 						PostInThread: true,
 					})

pkg/strategy/xalign/strategy.go

@@ -810,6 +810,7 @@ func (s *Strategy) align(ctx context.Context, sessions bbgo.ExchangeSessionMap)
 					mentions,
 					s.slackEvtID,
 				)
+				itOrder.SetHelpMessage(s.interactiveOrderHelpMessage(submitOrder))
 				itOrder.AsyncSubmit(ctx, selectedSession, s.onSubmittedOrderCallback)
 			} else {
 				createdOrder, err := selectedSession.Exchange.SubmitOrder(ctx, *submitOrder)
@@ -834,6 +835,27 @@ func (s *Strategy) onSubmittedOrderCallback(session *bbgo.ExchangeSession, submi
 	}
 }
 
+func (s *Strategy) interactiveOrderHelpMessage(submitOrder *types.SubmitOrder) string {
+	quoteCurrency := submitOrder.Market.QuoteCurrency
+	return fmt.Sprintf(`
+xalign Interactive Order Behavior Guide:
+- If the alignment amount is <= %.4f %s, it will be placed immediately.
+- If %.4f %s < alignment amount < %.4f %s, it will be placed when the deviation is larger than the configured tolerance (%s).
+- If the alignment amount >= %.4f %s, an interactive order notification will be sent to Slack for confirmation, and the order will be placed automatically after delay timeout (%s).
+`,
+		s.InstantAlignAmount.Float64(),
+		quoteCurrency,
+		s.InstantAlignAmount.Float64(),
+		quoteCurrency,
+		s.LargeAmountAlert.Amount.Float64(),
+		quoteCurrency,
+		s.BalanceToleranceRange.Percentage(),
+		s.InteractiveOrderConfig.MinAmount.Float64(),
+		quoteCurrency,
+		s.InteractiveOrderConfig.Delay.Duration().String(),
+	)
+}
+
 func (s *Strategy) calculateRefillQuantity(
 	totalBalances types.BalanceMap, currency string, expectedBalance fixedpoint.Value,
 ) fixedpoint.Value {