github.com/keybase/client/go@v0.0.0-20241007131713-f10651d043c8/stellar/batch_multi.go

package stellar

import (
	"errors"
	"fmt"
	"time"

	"github.com/keybase/client/go/libkb"
	"github.com/keybase/client/go/protocol/keybase1"
	"github.com/keybase/client/go/protocol/stellar1"
	"github.com/keybase/client/go/stellar/remote"
	"github.com/keybase/client/go/stellar/stellarcommon"
	"github.com/keybase/stellarnet"
	"golang.org/x/sync/errgroup"
)

var ErrRelayinMultiBatch = errors.New("relay recipient not allowed in a multi-op batch")

type multiOp struct {
	Recipient     stellar1.AccountID
	Amount        string
	CreateAccount bool
	Op            stellar1.PaymentOp
}

// BatchMulti sends a batch of payments from the user to multiple recipients in
// a single multi-operation transaction.
func BatchMulti(mctx libkb.MetaContext, walletState *WalletState, arg stellar1.BatchLocalArg) (res stellar1.BatchResultLocal, err error) {
	mctx = mctx.WithLogTag("BMULT=" + arg.BatchID)

	startTime := time.Now()
	res.StartTime = stellar1.ToTimeMs(startTime)
	defer func() {
		if res.EndTime == 0 {
			res.EndTime = stellar1.ToTimeMs(time.Now())
		}
	}()

	// look up sender account
	senderAccountID, senderSeed, err := LookupSenderSeed(mctx)
	if err != nil {
		return res, err
	}

	mctx.Debug("Batch sender account ID: %s", senderAccountID)
	mctx.Debug("Batch size: %d", len(arg.Payments))

	results := make([]stellar1.BatchPaymentResult, len(arg.Payments))
	var multiOps []multiOp
	for i, payment := range arg.Payments {
		results[i] = stellar1.BatchPaymentResult{
			Username: libkb.NewNormalizedUsername(payment.Recipient).String(),
		}
		recipient, err := LookupRecipient(mctx, stellarcommon.RecipientInput(payment.Recipient), false /* isCLI for identify purposes */)
		if err != nil {
			mctx.Debug("LookupRecipient error: %s", err)
			makeResultError(&results[i], err)
			continue
		}

		if recipient.AccountID == nil {
			// relays don't work well in multi-op payments, so return
			// an error.  the caller can use the non-multi version
			// for this batch.
			return res, ErrRelayinMultiBatch
		}

		mop, err := prepareDirectOp(mctx, walletState, payment, recipient)
		if err != nil {
			makeResultError(&results[i], err)
			continue
		}
		multiOps = append(multiOps, mop)
	}

	baseFee := walletState.BaseFee(mctx)
	sp, unlock := NewSeqnoProvider(mctx, walletState)
	defer unlock()
	tx := stellarnet.NewBaseTx(stellarnet.AddressStr(senderAccountID), sp, baseFee)
	var post stellar1.PaymentMultiPost

	// add all the prepared ops here
	for _, mop := range multiOps {
		if mop.CreateAccount {
			tx.AddCreateAccountOp(stellarnet.AddressStr(mop.Recipient), mop.Amount)
		} else {
			tx.AddPaymentOp(stellarnet.AddressStr(mop.Recipient), mop.Amount)
		}
		post.Operations = append(post.Operations, mop.Op)
	}

	// sign the tx
	sr, err := tx.Sign(senderSeed)
	if err != nil {
		return res, err
	}
	post.SignedTransaction = sr.Signed
	post.FromDeviceID = mctx.ActiveDevice().DeviceID()
	post.BatchID = arg.BatchID

	// submit it
	submitRes, err := walletState.SubmitMultiPayment(mctx.Ctx(), post)
	if err != nil {
		// make all the results have an error
		for i := 0; i < len(results); i++ {
			makeResultError(&results[i], err)
		}
	} else {
		// make all ther results have success
		now := stellar1.ToTimeMs(time.Now())

		for i := 0; i < len(results); i++ {
			if results[i].Status == stellar1.PaymentStatus_ERROR {
				// some of the results have already been marked as an
				// error, so skip those.
				continue
			}

			results[i].TxID = submitRes.TxID
			results[i].Status = stellar1.PaymentStatus_COMPLETED
			results[i].EndTime = now
		}

		// send chat messages
		// Note: the chat client does not like these messages currently...
		g, ctx := errgroup.WithContext(mctx.Ctx())
		recipients := make(chan string)
		g.Go(func() error {
			defer close(recipients)
			for _, result := range results {
				if result.Status != stellar1.PaymentStatus_COMPLETED {
					continue
				}
				select {
				case recipients <- result.Username:
				case <-ctx.Done():
					return ctx.Err()
				}
			}
			return nil
		})

		for i := 0; i < 10; i++ {
			g.Go(func() error {
				for recipient := range recipients {
					if err := chatSendPaymentMessage(mctx, recipient, submitRes.TxID, true); err != nil {
						mctx.Debug("chatSendPaymentMessage to %s (%s) error: %s", recipient, submitRes.TxID, err)
					} else {
						mctx.Debug("chatSendPaymentMessage to %s (%s) success", recipient, submitRes.TxID)
					}
				}

				return nil
			})
		}

		if err := g.Wait(); err != nil {
			mctx.Debug("error sending chat messages: %s", err)
		}
	}

	res.Payments = results

	return res, nil
}

func prepareDirectOp(mctx libkb.MetaContext, remoter remote.Remoter, payment stellar1.BatchPaymentArg, recipient stellarcommon.Recipient) (multiOp, error) {
	op := multiOp{
		Recipient: stellar1.AccountID(recipient.AccountID.String()),
		Amount:    payment.Amount,
	}

	funded, err := isAccountFunded(mctx.Ctx(), remoter, op.Recipient)
	if err != nil {
		return op, err
	}

	if !funded {
		if isAmountLessThanMin(payment.Amount, minAmountCreateAccountXLM) {
			return op, fmt.Errorf("you must send at least %s XLM to fund the account for %s", minAmountCreateAccountXLM, payment.Recipient)
		}
		op.CreateAccount = true
	}

	op.Op = stellar1.PaymentOp{
		To:     &recipient.User.UV,
		Direct: &stellar1.DirectOp{},
	}

	if len(payment.Message) > 0 {
		noteClear := stellar1.NoteContents{
			Note: payment.Message,
		}
		var recipientUv *keybase1.UserVersion
		if recipient.User != nil {
			recipientUv = &recipient.User.UV
		}
		op.Op.Direct.NoteB64, err = NoteEncryptB64(mctx, noteClear, recipientUv)
		if err != nil {
			return op, err
		}
	}

	return op, nil
}