Method finalizeTxWait

core/transact.go:214–252

finalizeTxWait calls FinalizeTx and then waits for confirmation of the transaction. A nil error return means the transaction is confirmed on the blockchain. ErrRejected means a conflicting tx is on the blockchain. context.DeadlineExceeded means ctx is an expiring context that timed out.

(ctx context.Context, txTemplate *txbuilder.Template, waitUntil string)

// on the blockchain.  context.DeadlineExceeded means ctx is an
// expiring context that timed out.
func (a *API) finalizeTxWait(ctx context.Context, txTemplate *txbuilder.Template, waitUntil string) error {
	// Use the current generator height as the lower bound of the block height
	// that the transaction may appear in.
	generatorHeight, _ := fetch.GeneratorHeight()
	localHeight := a.chain.Height()
	if localHeight > generatorHeight {
		generatorHeight = localHeight
	}

	// Remember this height in case we retry this submit call.
	height, err := recordSubmittedTx(ctx, a.db, txTemplate.Transaction.ID, generatorHeight)
	if err != nil {
		return errors.Wrap(err, "saving tx submitted height")
	}

	err = txbuilder.FinalizeTx(ctx, a.chain, a.submitter, txTemplate.Transaction)
	if err != nil {
		return err
	}
	if waitUntil == "none" {
		return nil
	}

	height, err = a.waitForTxInBlock(ctx, txTemplate.Transaction, height)
	if err != nil {
		return err
	}
	if waitUntil == "confirmed" {
		return nil
	}

	select {
	case <-ctx.Done():
		return ctx.Err()
	case <-a.pinStore.AllWaiter(height):
	}

	return nil
}

func (a *API) waitForTxInBlock(ctx context.Context, tx *legacy.Tx, height uint64) (uint64, error) {
	for {