cli: add debug mode to upload-bin command

Signed-off-by: Ekaterina Pavlova <ekt@morphbits.io>

cli/util/convert.go

@@ -101,6 +101,10 @@ func NewCommands() []*cli.Command {
 				return nil
 			},
 		},
+		&cli.BoolFlag{
+			Name:  "debug",
+			Usage: "Enable debug mode with logging uploaded object ids",
+		},
 	}, options.RPC...)
 	uploadBinFlags = append(uploadBinFlags, options.Wallet...)
 	return []*cli.Command{
@@ -183,7 +187,7 @@ func NewCommands() []*cli.Command {
 				{
 					Name:      "upload-bin",
 					Usage:     "Fetch blocks from RPC node and upload them to the NeoFS container",
-					UsageText: "neo-go util upload-bin --fs-rpc-endpoint <address1>[,<address2>[...]] --container <cid> --block-attribute block --index-attribute index --rpc-endpoint <node> [--timeout <time>] --wallet <wallet> [--wallet-config <config>] [--address <address>] [--workers <num>] [--searchers <num>] [--index-file-size <size>] [--skip-blocks-uploading] [--retries <num>]",
+					UsageText: "neo-go util upload-bin --fs-rpc-endpoint <address1>[,<address2>[...]] --container <cid> --block-attribute block --index-attribute index --rpc-endpoint <node> [--timeout <time>] --wallet <wallet> [--wallet-config <config>] [--address <address>] [--workers <num>] [--searchers <num>] [--index-file-size <size>] [--skip-blocks-uploading] [--retries <num>] [--debug <bool>]",
 					Action:    uploadBin,
 					Flags:     uploadBinFlags,
 				},

cli/util/upload_bin.go

@@ -246,6 +246,7 @@ func uploadBlocks(ctx *cli.Context, p *pool.Pool, rpc *rpcclient.Client, signer
 		fmt.Fprintf(ctx.App.Writer, "No new blocks to upload. Need to upload starting from %d, current height %d\n", oldestMissingBlockIndex, currentBlockHeight)
 		return nil
 	}
+	debug := ctx.Bool("debug")
 	for batchStart := oldestMissingBlockIndex; batchStart <= int(currentBlockHeight); batchStart += searchBatchSize {
 		var (
 			batchEnd = min(batchStart+searchBatchSize, int(currentBlockHeight)+1)
@@ -295,7 +296,14 @@ func uploadBlocks(ctx *cli.Context, p *pool.Pool, rpc *rpcclient.Client, signer
 
 					objBytes := bw.Bytes()
 					errRetr := retry(func() error {
-						return uploadObj(ctx.Context, p, signer, acc.PrivateKey().GetScriptHash(), containerID, objBytes, attrs, homomorphicHashingDisabled)
+						resOid, errUpload := uploadObj(ctx.Context, p, signer, acc.PrivateKey().GetScriptHash(), containerID, objBytes, attrs, homomorphicHashingDisabled)
+						if errUpload != nil {
+							return errUpload
+						}
+						if debug {
+							fmt.Fprintf(ctx.App.Writer, "Uploaded block %d with object ID: %s\n", blockIndex, resOid.String())
+						}
+						return errUpload
 					}, maxRetries)
 					if errRetr != nil {
 						select {
@@ -460,7 +468,8 @@ func uploadIndexFiles(ctx *cli.Context, p *pool.Pool, containerID cid.ID, accoun
 				*object.NewAttribute("IndexSize", strconv.Itoa(int(indexFileSize))),
 			}
 			err := retry(func() error {
-				return uploadObj(ctx.Context, p, signer, account.PrivateKey().GetScriptHash(), containerID, buffer, attrs, homomorphicHashingDisabled)
+				_, errUpload := uploadObj(ctx.Context, p, signer, account.PrivateKey().GetScriptHash(), containerID, buffer, attrs, homomorphicHashingDisabled)
+				return errUpload
 			}, maxRetries)
 			if err != nil {
 				select {
@@ -541,14 +550,15 @@ func searchObjects(ctx context.Context, p *pool.Pool, containerID cid.ID, accoun
 }
 
 // uploadObj uploads object to the container using provided settings.
-func uploadObj(ctx context.Context, p *pool.Pool, signer user.Signer, owner util.Uint160, containerID cid.ID, objData []byte, attrs []object.Attribute, homomorphicHashingDisabled bool) error {
+func uploadObj(ctx context.Context, p *pool.Pool, signer user.Signer, owner util.Uint160, containerID cid.ID, objData []byte, attrs []object.Attribute, homomorphicHashingDisabled bool) (oid.ID, error) {
 	var (
 		ownerID          user.ID
 		hdr              object.Object
 		chSHA256         checksum.Checksum
 		chHomomorphic    checksum.Checksum
 		v                = new(version.Version)
 		prmObjectPutInit client.PrmObjectPutInit
+		resOID           = oid.ID{}
 	)
 
 	ownerID.SetScriptHash(owner)
@@ -569,31 +579,32 @@ func uploadObj(ctx context.Context, p *pool.Pool, signer user.Signer, owner util
 
 	err := hdr.SetIDWithSignature(signer)
 	if err != nil {
-		return err
+		return resOID, err
 	}
 	err = hdr.CheckHeaderVerificationFields()
 	if err != nil {
-		return err
+		return resOID, err
 	}
 
 	writer, err := p.ObjectPutInit(ctx, hdr, signer, prmObjectPutInit)
 	if err != nil {
-		return fmt.Errorf("failed to initiate object upload: %w", err)
+		return resOID, fmt.Errorf("failed to initiate object upload: %w", err)
 	}
 	_, err = writer.Write(objData)
 	if err != nil {
 		_ = writer.Close()
-		return fmt.Errorf("failed to write object data: %w", err)
+		return resOID, fmt.Errorf("failed to write object data: %w", err)
 	}
 	err = writer.Close()
 	if err != nil {
-		return fmt.Errorf("failed to close object writer: %w", err)
+		return resOID, fmt.Errorf("failed to close object writer: %w", err)
 	}
 	res := writer.GetResult()
-	if res.StoredObjectID().Equals(oid.ID{}) {
-		return fmt.Errorf("object ID is empty")
+	resOID = res.StoredObjectID()
+	if resOID.Equals(oid.ID{}) {
+		return resOID, fmt.Errorf("object ID is empty")
 	}
-	return nil
+	return resOID, nil
 }
 
 func getBlockIndex(header object.Object, attribute string) (int, error) {

docs/neofs-blockstorage.md

@@ -87,7 +87,7 @@ NAME:
 neo-go util upload-bin - Fetch blocks from RPC node and upload them to the NeoFS container
 
 USAGE:
-neo-go util upload-bin --fs-rpc-endpoint <address1>[,<address2>[...]] --container <cid> --block-attribute block --index-attribute index --rpc-endpoint <node> [--timeout <time>] --wallet <wallet> [--wallet-config <config>] [--address <address>] [--workers <num>] [--searchers <num>] [--index-file-size <size>] [--skip-blocks-uploading] [--retries <num>]
+neo-go util upload-bin --fs-rpc-endpoint <address1>[,<address2>[...]] --container <cid> --block-attribute block --index-attribute index --rpc-endpoint <node> [--timeout <time>] --wallet <wallet> [--wallet-config <config>] [--address <address>] [--workers <num>] [--searchers <num>] [--index-file-size <size>] [--skip-blocks-uploading] [--retries <num>] [--debug <bool>]
 
 OPTIONS:
 --fs-rpc-endpoint value, --fsr value [ --fs-rpc-endpoint value, --fsr value ]  List of NeoFS storage node RPC addresses (comma-separated or multiple --fs-rpc-endpoint flags)
@@ -100,6 +100,7 @@ OPTIONS:
 --searchers value                                                              Number of concurrent searches for blocks (default: 20)
 --skip-blocks-uploading                                                        Skip blocks uploading and upload only index files (default: false)
 --retries value                                                                Maximum number of Neo/NeoFS node request retries (default: 5)
+--debug                                                                        Enable debug mode with logging uploaded object ids (default: false)
 --rpc-endpoint value, -r value                                                 RPC node address
 --timeout value, -s value                                                      Timeout for the operation (default: 10s)
 --wallet value, -w value                                                       Wallet to use to get the key for transaction signing; conflicts with --wallet-config flag