Skip to content

Commit bdaeac1

Browse files
bestbeforetodaybestbeforetoday
authored
Update Go error handling for v1.10 client API (#1362)
The Fabric Gateway client API v1.10.0 provides simplified access to Go error details. This change updates sample client application to use this latest version of the client API, and updates Go client applications to reflect the error handling changes. Signed-off-by: Mark S. Lewis <[email protected]>
1 parent f865a9e commit bdaeac1

File tree

33 files changed

+320
-371
lines changed

33 files changed

+320
-371
lines changed

‎asset-transfer-basic/application-gateway-go/assetTransfer.go‎

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import (
2020
"github.com/hyperledger/fabric-gateway/pkg/client"
2121
"github.com/hyperledger/fabric-gateway/pkg/hash"
2222
"github.com/hyperledger/fabric-gateway/pkg/identity"
23-
"github.com/hyperledger/fabric-protos-go-apiv2/gateway"
2423
"google.golang.org/grpc"
2524
"google.golang.org/grpc/credentials"
2625
"google.golang.org/grpc/status"
@@ -248,42 +247,22 @@ func exampleErrorHandling(contract *client.Contract) {
248247

249248
fmt.Println("*** Successfully caught the error:")
250249

251-
var endorseErr *client.EndorseError
252-
var submitErr *client.SubmitError
253250
var commitStatusErr *client.CommitStatusError
254-
var commitErr *client.CommitError
251+
var transactionErr *client.TransactionError
255252

256-
if errors.As(err, &endorseErr) {
257-
fmt.Printf("Endorse error for transaction %s with gRPC status %v: %s\n", endorseErr.TransactionID, status.Code(endorseErr), endorseErr)
258-
} else if errors.As(err, &submitErr) {
259-
fmt.Printf("Submit error for transaction %s with gRPC status %v: %s\n", submitErr.TransactionID, status.Code(submitErr), submitErr)
260-
} else if errors.As(err, &commitStatusErr) {
253+
if errors.As(err, &commitStatusErr) {
261254
if errors.Is(err, context.DeadlineExceeded) {
262-
fmt.Printf("Timeout waiting for transaction %s commit status: %s", commitStatusErr.TransactionID, commitStatusErr)
255+
fmt.Printf("Timeout waiting for transaction %s commit status: %s\n", commitStatusErr.TransactionID, commitStatusErr)
263256
} else {
264257
fmt.Printf("Error obtaining commit status for transaction %s with gRPC status %v: %s\n", commitStatusErr.TransactionID, status.Code(commitStatusErr), commitStatusErr)
265258
}
266-
} else if errors.As(err, &commitErr) {
267-
fmt.Printf("Transaction %s failed to commit with status %d: %s\n", commitErr.TransactionID, int32(commitErr.Code), err)
259+
} else if errors.As(err, &transactionErr) {
260+
// The error could be an EndorseError, SubmitError or CommitError.
261+
fmt.Println(err)
262+
fmt.Printf("TransactionID: %s\n", transactionErr.TransactionID)
268263
} else {
269264
panic(fmt.Errorf("unexpected error type %T: %w", err, err))
270265
}
271-
272-
// Any error that originates from a peer or orderer node external to the gateway will have its details
273-
// embedded within the gRPC status error. The following code shows how to extract that.
274-
statusErr := status.Convert(err)
275-
276-
details := statusErr.Details()
277-
if len(details) > 0 {
278-
fmt.Println("Error Details:")
279-
280-
for _, detail := range details {
281-
switch detail := detail.(type) {
282-
case *gateway.ErrorDetail:
283-
fmt.Printf("- address: %s; mspId: %s; message: %s\n", detail.Address, detail.MspId, detail.Message)
284-
}
285-
}
286-
}
287266
}
288267

289268
// Format JSON data

‎asset-transfer-basic/application-gateway-go/go.mod‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
module assetTransfer
22

3-
go 1.23.0
3+
go 1.24.0
44

55
require (
6-
github.com/hyperledger/fabric-gateway v1.8.0
7-
github.com/hyperledger/fabric-protos-go-apiv2 v0.3.7
8-
google.golang.org/grpc v1.73.0
6+
github.com/hyperledger/fabric-gateway v1.10.0
7+
google.golang.org/grpc v1.76.0
98
)
109

1110
require (
11+
github.com/hyperledger/fabric-protos-go-apiv2 v0.3.7 // indirect
1212
github.com/miekg/pkcs11 v1.1.1 // indirect
13-
golang.org/x/crypto v0.40.0 // indirect
14-
golang.org/x/net v0.41.0 // indirect
15-
golang.org/x/sys v0.34.0 // indirect
16-
golang.org/x/text v0.27.0 // indirect
17-
google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 // indirect
18-
google.golang.org/protobuf v1.36.6 // indirect
13+
golang.org/x/net v0.42.0 // indirect
14+
golang.org/x/sys v0.35.0 // indirect
15+
golang.org/x/text v0.28.0 // indirect
16+
google.golang.org/genproto/googleapis/rpc v0.0.0-20250804133106-a7a43d27e69b // indirect
17+
google.golang.org/protobuf v1.36.10 // indirect
1918
)

‎asset-transfer-basic/application-gateway-go/go.sum‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
22
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
3-
github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY=
4-
github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
3+
github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
4+
github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
55
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
66
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
77
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
@@ -10,8 +10,8 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
1010
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
1111
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
1212
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
13-
github.com/hyperledger/fabric-gateway v1.8.0 h1:OMqvfPCNvmWQ/Djcjate6qSslCkNP4evGSS569oUvBo=
14-
github.com/hyperledger/fabric-gateway v1.8.0/go.mod h1:0i66HQ6ytRd1UOBf58IEsxhAkaf8Alh0KIitrg5M6pA=
13+
github.com/hyperledger/fabric-gateway v1.10.0 h1:x5z/pofdVYIqgMo9QWejubfAZYCSt94WdUPj4Wipdeg=
14+
github.com/hyperledger/fabric-gateway v1.10.0/go.mod h1:fSFS1vQkPZq6inNvzsnI/7PCaKSU+UZOZ6uAuau0Yq0=
1515
github.com/hyperledger/fabric-protos-go-apiv2 v0.3.7 h1:sQ5qv8vQQfwewa1JlCiSCC8dLElmaU2/frLolpgibEY=
1616
github.com/hyperledger/fabric-protos-go-apiv2 v0.3.7/go.mod h1:bJnwzfv03oZQeCc863pdGTDgf5nmCy6Za3RAE7d2XsQ=
1717
github.com/miekg/pkcs11 v1.1.1 h1:Ugu9pdy6vAYku5DEpVWVFPYnzV+bxB+iRdbuFSu7TvU=
@@ -20,33 +20,33 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
2020
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
2121
github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
2222
github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
23-
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
24-
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
23+
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
24+
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
2525
go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=
2626
go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=
27-
go.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=
28-
go.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=
29-
go.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=
30-
go.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=
31-
go.opentelemetry.io/otel/sdk v1.35.0 h1:iPctf8iprVySXSKJffSS79eOjl9pvxV9ZqOWT0QejKY=
32-
go.opentelemetry.io/otel/sdk v1.35.0/go.mod h1:+ga1bZliga3DxJ3CQGg3updiaAJoNECOgJREo9KHGQg=
33-
go.opentelemetry.io/otel/sdk/metric v1.35.0 h1:1RriWBmCKgkeHEhM7a2uMjMUfP7MsOF5JpUCaEqEI9o=
34-
go.opentelemetry.io/otel/sdk/metric v1.35.0/go.mod h1:is6XYCUMpcKi+ZsOvfluY5YstFnhW0BidkR+gL+qN+w=
35-
go.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=
36-
go.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=
37-
golang.org/x/crypto v0.40.0 h1:r4x+VvoG5Fm+eJcxMaY8CQM7Lb0l1lsmjGBQ6s8BfKM=
38-
golang.org/x/crypto v0.40.0/go.mod h1:Qr1vMER5WyS2dfPHAlsOj01wgLbsyWtFn/aY+5+ZdxY=
39-
golang.org/x/net v0.41.0 h1:vBTly1HeNPEn3wtREYfy4GZ/NECgw2Cnl+nK6Nz3uvw=
40-
golang.org/x/net v0.41.0/go.mod h1:B/K4NNqkfmg07DQYrbwvSluqCJOOXwUjeb/5lOisjbA=
41-
golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
42-
golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
43-
golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4=
44-
golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU=
45-
google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 h1:e0AIkUUhxyBKh6ssZNrAMeqhA7RKUj42346d1y02i2g=
46-
google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
47-
google.golang.org/grpc v1.73.0 h1:VIWSmpI2MegBtTuFt5/JWy2oXxtjJ/e89Z70ImfD2ok=
48-
google.golang.org/grpc v1.73.0/go.mod h1:50sbHOUqWoCQGI8V2HQLJM0B+LMlIUjNSZmow7EVBQc=
49-
google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY=
50-
google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=
27+
go.opentelemetry.io/otel v1.37.0 h1:9zhNfelUvx0KBfu/gb+ZgeAfAgtWrfHJZcAqFC228wQ=
28+
go.opentelemetry.io/otel v1.37.0/go.mod h1:ehE/umFRLnuLa/vSccNq9oS1ErUlkkK71gMcN34UG8I=
29+
go.opentelemetry.io/otel/metric v1.37.0 h1:mvwbQS5m0tbmqML4NqK+e3aDiO02vsf/WgbsdpcPoZE=
30+
go.opentelemetry.io/otel/metric v1.37.0/go.mod h1:04wGrZurHYKOc+RKeye86GwKiTb9FKm1WHtO+4EVr2E=
31+
go.opentelemetry.io/otel/sdk v1.37.0 h1:ItB0QUqnjesGRvNcmAcU0LyvkVyGJ2xftD29bWdDvKI=
32+
go.opentelemetry.io/otel/sdk v1.37.0/go.mod h1:VredYzxUvuo2q3WRcDnKDjbdvmO0sCzOvVAiY+yUkAg=
33+
go.opentelemetry.io/otel/sdk/metric v1.37.0 h1:90lI228XrB9jCMuSdA0673aubgRobVZFhbjxHHspCPc=
34+
go.opentelemetry.io/otel/sdk/metric v1.37.0/go.mod h1:cNen4ZWfiD37l5NhS+Keb5RXVWZWpRE+9WyVCpbo5ps=
35+
go.opentelemetry.io/otel/trace v1.37.0 h1:HLdcFNbRQBE2imdSEgm/kwqmQj1Or1l/7bW6mxVK7z4=
36+
go.opentelemetry.io/otel/trace v1.37.0/go.mod h1:TlgrlQ+PtQO5XFerSPUYG0JSgGyryXewPGyayAWSBS0=
37+
golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs=
38+
golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8=
39+
golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI=
40+
golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
41+
golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
42+
golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
43+
gonum.org/v1/gonum v0.16.0 h1:5+ul4Swaf3ESvrOnidPp4GZbzf0mxVQpDCYUQE7OJfk=
44+
gonum.org/v1/gonum v0.16.0/go.mod h1:fef3am4MQ93R2HHpKnLk4/Tbh/s0+wqD5nfa6Pnwy4E=
45+
google.golang.org/genproto/googleapis/rpc v0.0.0-20250804133106-a7a43d27e69b h1:zPKJod4w6F1+nRGDI9ubnXYhU9NSWoFAijkHkUXeTK8=
46+
google.golang.org/genproto/googleapis/rpc v0.0.0-20250804133106-a7a43d27e69b/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
47+
google.golang.org/grpc v1.76.0 h1:UnVkv1+uMLYXoIz6o7chp59WfQUYA2ex/BXQ9rHZu7A=
48+
google.golang.org/grpc v1.76.0/go.mod h1:Ju12QI8M6iQJtbcsV+awF5a4hfJMLi4X0JLo94ULZ6c=
49+
google.golang.org/protobuf v1.36.10 h1:AYd7cD/uASjIL6Q9LiTjz8JLcrh/88q5UObnmY3aOOE=
50+
google.golang.org/protobuf v1.36.10/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
5151
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
5252
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

‎asset-transfer-basic/application-gateway-java/build.gradle‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ repositories {
1919
}
2020

2121
dependencies {
22-
implementation 'org.hyperledger.fabric:fabric-gateway:1.8.0'
23-
implementation platform('com.google.protobuf:protobuf-bom:4.28.2')
24-
implementation platform('io.grpc:grpc-bom:1.67.1')
22+
implementation 'org.hyperledger.fabric:fabric-gateway:1.10.0'
23+
implementation platform('com.google.protobuf:protobuf-bom:4.33.0')
24+
implementation platform('io.grpc:grpc-bom:1.76.0')
2525
compileOnly 'io.grpc:grpc-api'
2626
runtimeOnly 'io.grpc:grpc-netty-shaded'
27-
implementation 'com.google.code.gson:gson:2.11.0'
27+
implementation 'com.google.code.gson:gson:2.13.2'
2828
}
2929

3030
compileJava {

‎asset-transfer-basic/application-gateway-java/pom.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@
1818
<dependency>
1919
<groupId>com.google.protobuf</groupId>
2020
<artifactId>protobuf-bom</artifactId>
21-
<version>4.28.2</version>
21+
<version>4.33.0</version>
2222
<type>pom</type>
2323
<scope>import</scope>
2424
</dependency>
2525
<dependency>
2626
<groupId>io.grpc</groupId>
2727
<artifactId>grpc-bom</artifactId>
28-
<version>1.67.1</version>
28+
<version>1.76.0</version>
2929
<type>pom</type>
3030
<scope>import</scope>
3131
</dependency>
@@ -36,7 +36,7 @@
3636
<dependency>
3737
<groupId>org.hyperledger.fabric</groupId>
3838
<artifactId>fabric-gateway</artifactId>
39-
<version>1.8.0</version>
39+
<version>1.10.0</version>
4040
</dependency>
4141
<dependency>
4242
<groupId>io.grpc</groupId>

‎asset-transfer-basic/application-gateway-javascript/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
"author": "Hyperledger",
1515
"license": "Apache-2.0",
1616
"dependencies": {
17-
"@grpc/grpc-js": "^1.12.2",
18-
"@hyperledger/fabric-gateway": "^1.8.0"
17+
"@grpc/grpc-js": "^1.14.0",
18+
"@hyperledger/fabric-gateway": "^1.10.0"
1919
},
2020
"devDependencies": {
2121
"@eslint/js": "^9.5.0",

‎asset-transfer-basic/application-gateway-typescript/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
"author": "Hyperledger",
2020
"license": "Apache-2.0",
2121
"dependencies": {
22-
"@grpc/grpc-js": "^1.12.2",
23-
"@hyperledger/fabric-gateway": "^1.8.0"
22+
"@grpc/grpc-js": "^1.14.0",
23+
"@hyperledger/fabric-gateway": "^1.10.0"
2424
},
2525
"devDependencies": {
2626
"@eslint/js": "^9.3.0",

‎asset-transfer-basic/rest-api-go/go.mod‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
module rest-api-go
22

3-
go 1.23.0
3+
go 1.24.0
44

55
require (
6-
github.com/hyperledger/fabric-gateway v1.8.0
7-
google.golang.org/grpc v1.73.0
6+
github.com/hyperledger/fabric-gateway v1.10.0
7+
google.golang.org/grpc v1.76.0
88
)
99

1010
require (
1111
github.com/hyperledger/fabric-protos-go-apiv2 v0.3.7 // indirect
1212
github.com/miekg/pkcs11 v1.1.1 // indirect
13-
golang.org/x/crypto v0.40.0 // indirect
14-
golang.org/x/net v0.41.0 // indirect
15-
golang.org/x/sys v0.34.0 // indirect
16-
golang.org/x/text v0.27.0 // indirect
17-
google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 // indirect
18-
google.golang.org/protobuf v1.36.6 // indirect
13+
golang.org/x/net v0.42.0 // indirect
14+
golang.org/x/sys v0.35.0 // indirect
15+
golang.org/x/text v0.28.0 // indirect
16+
google.golang.org/genproto/googleapis/rpc v0.0.0-20250804133106-a7a43d27e69b // indirect
17+
google.golang.org/protobuf v1.36.10 // indirect
1918
)

0 commit comments

Comments
 (0)