peer lifecycle chaincode

The peer lifecycle chaincode subcommand allows administrators to use the Fabric chaincode lifecycle to package a chaincode, install it on your peers, approve a chaincode definition for your organization, and then commit the definition to a channel. The chaincode is ready to be used after the definition has been successfully committed to the channel. For more information, visit Fabric chaincode lifecycle.

Note: These instructions use the Fabric chaincode lifecycle introduced in the v2.0 release. If you would like to use the old lifecycle to install and instantiate a chaincode, visit the peer chaincode command reference.

Syntax

The peer lifecycle chaincode command has the following subcommands:

  • package

  • install

  • queryinstalled

  • getinstalledpackage

  • calculatepackageid

  • approveformyorg

  • queryapproved

  • checkcommitreadiness

  • commit

  • querycommitted

Each peer lifecycle chaincode subcommand is described together with its options in its own section in this topic.

peer lifecycle

  1. Perform _lifecycle operations
  3. Usage:
  4.   peer lifecycle [command]
  6. Available Commands:
  7.   chaincode   Perform chaincode operations: package|install|queryinstalled|getinstalledpackage|calculatepackageid|approveformyorg|queryapproved|checkcommitreadiness|commit|querycommitted
  9. Flags:
  10.   -h, --help   help for lifecycle
  12. Use "peer lifecycle [command] --help" for more information about a command.

peer lifecycle chaincode

  1. Perform chaincode operations: package|install|queryinstalled|getinstalledpackage|calculatepackageid|approveformyorg|queryapproved|checkcommitreadiness|commit|querycommitted
  3. Usage:
  4.   peer lifecycle chaincode [command]
  6. Available Commands:
  7.   approveformyorg      Approve the chaincode definition for my org.
  8.   calculatepackageid   Calculate the package ID for a chaincode.
  9.   checkcommitreadiness Check whether a chaincode definition is ready to be committed on a channel.
  10.   commit               Commit the chaincode definition on the channel.
  11.   getinstalledpackage  Get an installed chaincode package from a peer.
  12.   install              Install a chaincode.
  13.   package              Package a chaincode
  14.   queryapproved        Query an org's approved chaincode definition from its peer.
  15.   querycommitted       Query the committed chaincode definitions by channel on a peer.
  16.   queryinstalled       Query the installed chaincodes on a peer.
  18. Flags:
  19.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  20.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  21.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  22.       --connTimeout duration                Timeout for client to connect (default 3s)
  23.   -h, --help                                help for chaincode
  24.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  25.   -o, --orderer string                      Ordering service endpoint
  26.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  27.       --tls                                 Use TLS when communicating with the orderer endpoint
  28.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint
  30. Use "peer lifecycle chaincode [command] --help" for more information about a command.

peer lifecycle chaincode package

  1. Package a chaincode and write the package to a file.
  3. Usage:
  4.   peer lifecycle chaincode package [outputfile] [flags]
  6. Flags:
  7.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  8.   -h, --help                           help for package
  9.       --label string                   The package label contains a human-readable description of the package
  10.   -l, --lang string                    Language the chaincode is written in (default "golang")
  11.   -p, --path string                    Path to the chaincode
  12.       --peerAddresses stringArray      The addresses of the peers to connect to
  13.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  15. Global Flags:
  16.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  17.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  18.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  19.       --connTimeout duration                Timeout for client to connect (default 3s)
  20.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  21.   -o, --orderer string                      Ordering service endpoint
  22.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  23.       --tls                                 Use TLS when communicating with the orderer endpoint
  24.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode install

  1. Install a chaincode on a peer.
  3. Usage:
  4.   peer lifecycle chaincode install [flags]
  6. Flags:
  7.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  8.   -h, --help                           help for install
  9.       --peerAddresses stringArray      The addresses of the peers to connect to
  10.       --targetPeer string              When using a connection profile, the name of the peer to target for this action
  11.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  13. Global Flags:
  14.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  15.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  16.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  17.       --connTimeout duration                Timeout for client to connect (default 3s)
  18.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  19.   -o, --orderer string                      Ordering service endpoint
  20.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  21.       --tls                                 Use TLS when communicating with the orderer endpoint
  22.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode queryinstalled

  1. Query the installed chaincodes on a peer.
  3. Usage:
  4.   peer lifecycle chaincode queryinstalled [flags]
  6. Flags:
  7.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  8.   -h, --help                           help for queryinstalled
  9.   -O, --output string                  The output format for query results. Default is human-readable plain-text. json is currently the only supported format.
  10.       --peerAddresses stringArray      The addresses of the peers to connect to
  11.       --targetPeer string              When using a connection profile, the name of the peer to target for this action
  12.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  14. Global Flags:
  15.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  16.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  17.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  18.       --connTimeout duration                Timeout for client to connect (default 3s)
  19.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  20.   -o, --orderer string                      Ordering service endpoint
  21.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  22.       --tls                                 Use TLS when communicating with the orderer endpoint
  23.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode getinstalledpackage

  1. Get an installed chaincode package from a peer.
  3. Usage:
  4.   peer lifecycle chaincode getinstalledpackage [outputfile] [flags]
  6. Flags:
  7.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  8.   -h, --help                           help for getinstalledpackage
  9.       --output-directory string        The output directory to use when writing a chaincode install package to disk. Default is the current working directory.
  10.       --package-id string              The identifier of the chaincode install package
  11.       --peerAddresses stringArray      The addresses of the peers to connect to
  12.       --targetPeer string              When using a connection profile, the name of the peer to target for this action
  13.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  15. Global Flags:
  16.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  17.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  18.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  19.       --connTimeout duration                Timeout for client to connect (default 3s)
  20.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  21.   -o, --orderer string                      Ordering service endpoint
  22.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  23.       --tls                                 Use TLS when communicating with the orderer endpoint
  24.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode calculatepackageid

  1. Calculate the package ID for a packaged chaincode.
  3. Usage:
  4.   peer lifecycle chaincode calculatepackageid packageFile [flags]
  6. Flags:
  7.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  8.   -h, --help                           help for calculatepackageid
  9.   -O, --output string                  The output format for query results. Default is human-readable plain-text. json is currently the only supported format.
  10.       --peerAddresses stringArray      The addresses of the peers to connect to
  11.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  13. Global Flags:
  14.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  15.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  16.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  17.       --connTimeout duration                Timeout for client to connect (default 3s)
  18.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  19.   -o, --orderer string                      Ordering service endpoint
  20.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  21.       --tls                                 Use TLS when communicating with the orderer endpoint
  22.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode approveformyorg

  1. Approve the chaincode definition for my organization.
  3. Usage:
  4.   peer lifecycle chaincode approveformyorg [flags]
  6. Flags:
  7.       --channel-config-policy string   The endorsement policy associated to this chaincode specified as a channel config policy reference
  8.   -C, --channelID string               The channel on which this command should be executed
  9.       --collections-config string      The fully qualified path to the collection JSON file including the file name
  10.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  11.   -E, --endorsement-plugin string      The name of the endorsement plugin to be used for this chaincode
  12.   -h, --help                           help for approveformyorg
  13.       --init-required                  Whether the chaincode requires invoking 'init'
  14.   -n, --name string                    Name of the chaincode
  15.       --package-id string              The identifier of the chaincode install package
  16.       --peerAddresses stringArray      The addresses of the peers to connect to
  17.       --sequence int                   The sequence number of the chaincode definition for the channel
  18.       --signature-policy string        The endorsement policy associated to this chaincode specified as a signature policy
  19.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  20.   -V, --validation-plugin string       The name of the validation plugin to be used for this chaincode
  21.   -v, --version string                 Version of the chaincode
  22.       --waitForEvent                   Whether to wait for the event from each peer's deliver filtered service signifying that the transaction has been committed successfully (default true)
  23.       --waitForEventTimeout duration   Time to wait for the event from each peer's deliver filtered service signifying that the 'invoke' transaction has been committed successfully (default 30s)
  25. Global Flags:
  26.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  27.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  28.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  29.       --connTimeout duration                Timeout for client to connect (default 3s)
  30.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  31.   -o, --orderer string                      Ordering service endpoint
  32.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  33.       --tls                                 Use TLS when communicating with the orderer endpoint
  34.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode queryapproved

  1. Query an organization's approved chaincode definition from its peer.
  3. Usage:
  4.   peer lifecycle chaincode queryapproved [flags]
  6. Flags:
  7.   -C, --channelID string               The channel on which this command should be executed
  8.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  9.   -h, --help                           help for queryapproved
  10.   -n, --name string                    Name of the chaincode
  11.   -O, --output string                  The output format for query results. Default is human-readable plain-text. json is currently the only supported format.
  12.       --peerAddresses stringArray      The addresses of the peers to connect to
  13.       --sequence int                   The sequence number of the chaincode definition for the channel
  14.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  16. Global Flags:
  17.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  18.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  19.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  20.       --connTimeout duration                Timeout for client to connect (default 3s)
  21.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  22.   -o, --orderer string                      Ordering service endpoint
  23.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  24.       --tls                                 Use TLS when communicating with the orderer endpoint
  25.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode checkcommitreadiness

  1. Check whether a chaincode definition is ready to be committed on a channel.
  3. Usage:
  4.   peer lifecycle chaincode checkcommitreadiness [flags]
  6. Flags:
  7.       --channel-config-policy string   The endorsement policy associated to this chaincode specified as a channel config policy reference
  8.   -C, --channelID string               The channel on which this command should be executed
  9.       --collections-config string      The fully qualified path to the collection JSON file including the file name
  10.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  11.   -E, --endorsement-plugin string      The name of the endorsement plugin to be used for this chaincode
  12.   -h, --help                           help for checkcommitreadiness
  13.       --init-required                  Whether the chaincode requires invoking 'init'
  14.   -n, --name string                    Name of the chaincode
  15.   -O, --output string                  The output format for query results. Default is human-readable plain-text. json is currently the only supported format.
  16.       --peerAddresses stringArray      The addresses of the peers to connect to
  17.       --sequence int                   The sequence number of the chaincode definition for the channel
  18.       --signature-policy string        The endorsement policy associated to this chaincode specified as a signature policy
  19.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  20.   -V, --validation-plugin string       The name of the validation plugin to be used for this chaincode
  21.   -v, --version string                 Version of the chaincode
  23. Global Flags:
  24.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  25.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  26.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  27.       --connTimeout duration                Timeout for client to connect (default 3s)
  28.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  29.   -o, --orderer string                      Ordering service endpoint
  30.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  31.       --tls                                 Use TLS when communicating with the orderer endpoint
  32.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode commit

  1. Commit the chaincode definition on the channel.
  3. Usage:
  4.   peer lifecycle chaincode commit [flags]
  6. Flags:
  7.       --channel-config-policy string   The endorsement policy associated to this chaincode specified as a channel config policy reference
  8.   -C, --channelID string               The channel on which this command should be executed
  9.       --collections-config string      The fully qualified path to the collection JSON file including the file name
  10.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  11.   -E, --endorsement-plugin string      The name of the endorsement plugin to be used for this chaincode
  12.   -h, --help                           help for commit
  13.       --init-required                  Whether the chaincode requires invoking 'init'
  14.   -n, --name string                    Name of the chaincode
  15.       --peerAddresses stringArray      The addresses of the peers to connect to
  16.       --sequence int                   The sequence number of the chaincode definition for the channel
  17.       --signature-policy string        The endorsement policy associated to this chaincode specified as a signature policy
  18.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  19.   -V, --validation-plugin string       The name of the validation plugin to be used for this chaincode
  20.   -v, --version string                 Version of the chaincode
  21.       --waitForEvent                   Whether to wait for the event from each peer's deliver filtered service signifying that the transaction has been committed successfully (default true)
  22.       --waitForEventTimeout duration   Time to wait for the event from each peer's deliver filtered service signifying that the 'invoke' transaction has been committed successfully (default 30s)
  24. Global Flags:
  25.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  26.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  27.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  28.       --connTimeout duration                Timeout for client to connect (default 3s)
  29.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  30.   -o, --orderer string                      Ordering service endpoint
  31.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  32.       --tls                                 Use TLS when communicating with the orderer endpoint
  33.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

peer lifecycle chaincode querycommitted

  1. Query the committed chaincode definitions by channel on a peer. Optional: provide a chaincode name to query a specific definition.
  3. Usage:
  4.   peer lifecycle chaincode querycommitted [flags]
  6. Flags:
  7.   -C, --channelID string               The channel on which this command should be executed
  8.       --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  9.   -h, --help                           help for querycommitted
  10.   -n, --name string                    Name of the chaincode
  11.   -O, --output string                  The output format for query results. Default is human-readable plain-text. json is currently the only supported format.
  12.       --peerAddresses stringArray      The addresses of the peers to connect to
  13.       --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag
  15. Global Flags:
  16.       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
  17.       --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
  18.       --clientauth                          Use mutual TLS when communicating with the orderer endpoint
  19.       --connTimeout duration                Timeout for client to connect (default 3s)
  20.       --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  21.   -o, --orderer string                      Ordering service endpoint
  22.       --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
  23.       --tls                                 Use TLS when communicating with the orderer endpoint
  24.       --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

Example Usage

peer lifecycle chaincode package example

A chaincode needs to be packaged before it can be installed on your peers. This example uses the peer lifecycle chaincode package command to package a Go chaincode.

  • Use the --path flag to indicate the location of the chaincode. The path must be a fully qualified path or a path relative to your present working directory.

  • Use the --label flag to provide a chaincode package label of myccv1 that your organization will use to identify the package.

    1. peer lifecycle chaincode package mycc.tar.gz --path $CHAINCODE_DIR --lang golang --label myccv1

peer lifecycle chaincode install example

After the chaincode is packaged, you can use the peer chaincode install command to install the chaincode on your peers.

  • Install the mycc.tar.gz package on peer0.org1.example.com:7051 (the peer defined by --peerAddresses).

    1. peer lifecycle chaincode install mycc.tar.gz --peerAddresses peer0.org1.example.com:7051

    If successful, the command will return the package identifier. The package ID is the package label combined with a hash of the chaincode package taken by the peer.

    1. 2019-03-13 13:48:53.691 UTC [cli.lifecycle.chaincode] submitInstallProposal -> INFO 001 Installed remotely: response:<status:200 payload:"\nEmycc:ebd89878c2bbccf62f68c36072626359376aa83c36435a058d453e8dbfd894cc" >
    2. 2019-03-13 13:48:53.691 UTC [cli.lifecycle.chaincode] submitInstallProposal -> INFO 002 Chaincode code package identifier: mycc:a7ca45a7cc85f1d89c905b775920361ed089a364e12a9b6d55ba75c965ddd6a9

peer lifecycle chaincode queryinstalled example

You need to use the chaincode package identifier to approve a chaincode definition for your organization. You can find the package ID for the chaincodes you have installed by using the peer lifecycle chaincode queryinstalled command:

  1. peer lifecycle chaincode queryinstalled --peerAddresses peer0.org1.example.com:7051

A successful command will return the package ID associated with the package label.

  1. Get installed chaincodes on peer:
  2. Package ID: myccv1:a7ca45a7cc85f1d89c905b775920361ed089a364e12a9b6d55ba75c965ddd6a9, Label: myccv1

  • You can also use the --output flag to have the CLI format the output as JSON.

    1. peer lifecycle chaincode queryinstalled --peerAddresses peer0.org1.example.com:7051 --output json

    If successful, the command will return the chaincodes you have installed as JSON.

    1. {
    2.   "installed_chaincodes": [
    3.     {
    4.       "package_id": "mycc_1:aab9981fa5649cfe25369fce7bb5086a69672a631e4f95c4af1b5198fe9f845b",
    5.       "label": "mycc_1",
    6.       "references": {
    7.         "mychannel": {
    8.           "chaincodes": [
    9.             {
    10.               "name": "mycc",
    11.               "version": "1"
    12.             }
    13.           ]
    14.         }
    15.       }
    16.     }
    17.   ]
    18. }

peer lifecycle chaincode getinstalledpackage example

You can retrieve an installed chaincode package from a peer using the peer lifecycle chaincode getinstalledpackage command. Use the package identifier returned by queryinstalled.

  • Use the --package-id flag to pass in the chaincode package identifier. Use the --output-directory flag to specify where to write the chaincode package. If the output directory is not specified, the chaincode package will be written in the current directory.
  1. peer lifecycle chaincode getinstalledpackage --package-id myccv1:a7ca45a7cc85f1d89c905b775920361ed089a364e12a9b6d55ba75c965ddd6a9 --output-directory /tmp --peerAddresses peer0.org1.example.com:7051

peer lifecycle chaincode calculatepackageid example

You can calculate the package ID from a packaged chaincode without installing the chaincode on peers using the peer lifecycle chaincode calculatepackageid command. This command will be useful, for example, in the following cases:

  • When multiple chaincode packages with the same label name are installed, it is possible to identify which ID corresponds to which package later.

  • To check whether a particular chaincode package is installed or not without installing that package.

Calculate the package ID for the mycc.tar.gz package:

  1. peer lifecycle chaincode calculatepackageid mycc.tar.gz

A successful command will return the package ID for the packaged chaincode.

  1. myccv1:cc7bb5f50a53c207f68d37e9423c32f968083282e5ffac00d41ffc5768dc1873

  • You can also use the --output flag to have the CLI format the output as JSON.

    1. peer lifecycle chaincode calculatepackageid mycc.tar.gz --output json

    If successful, the command will return the chaincode package ID as JSON.

    1. {
    2.   "package_id": "myccv1:cc7bb5f50a53c207f68d37e9423c32f968083282e5ffac00d41ffc5768dc1873"
    3. }

peer lifecycle chaincode approveformyorg example

Once the chaincode package has been installed on your peers, you can approve a chaincode definition for your organization. The chaincode definition includes the important parameters of chaincode governance, including the chaincode name, version and the endorsement policy.

Here is an example of the peer lifecycle chaincode approveformyorg command, which approves the definition of a chaincode named mycc at version 1.0 on channel mychannel.

  • Use the --package-id flag to pass in the chaincode package identifier. Use the --signature-policy flag to define an endorsement policy for the chaincode. Use the init-required flag to require the execution of an initialization function before other chaincode functions can be called.

    1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
    3. peer lifecycle chaincode approveformyorg  -o orderer.example.com:7050 --tls --cafile $ORDERER_CA --channelID mychannel --name mycc --version 1.0 --init-required --package-id myccv1:a7ca45a7cc85f1d89c905b775920361ed089a364e12a9b6d55ba75c965ddd6a9 --sequence 1 --signature-policy "AND ('Org1MSP.peer','Org2MSP.peer')"
    5. 2019-03-18 16:04:09.046 UTC [cli.lifecycle.chaincode] InitCmdFactory -> INFO 001 Retrieved channel (mychannel) orderer endpoint: orderer.example.com:7050
    6. 2019-03-18 16:04:11.253 UTC [chaincodeCmd] ClientWait -> INFO 002 txid [efba188ca77889cc1c328fc98e0bb12d3ad0abcda3f84da3714471c7c1e6c13c] committed with status (VALID) at peer0.org1.example.com:7051

  • You can also use the --channel-config-policy flag use a policy inside the channel configuration as the chaincode endorsement policy. The default endorsement policy is Channel/Application/Endorsement

    1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
    3. peer lifecycle chaincode approveformyorg -o orderer.example.com:7050 --tls --cafile $ORDERER_CA --channelID mychannel --name mycc --version 1.0 --init-required --package-id myccv1:a7ca45a7cc85f1d89c905b775920361ed089a364e12a9b6d55ba75c965ddd6a9 --sequence 1 --channel-config-policy Channel/Application/Admins
    5. 2019-03-18 16:04:09.046 UTC [cli.lifecycle.chaincode] InitCmdFactory -> INFO 001 Retrieved channel (mychannel) orderer endpoint: orderer.example.com:7050
    6. 2019-03-18 16:04:11.253 UTC [chaincodeCmd] ClientWait -> INFO 002 txid [efba188ca77889cc1c328fc98e0bb12d3ad0abcda3f84da3714471c7c1e6c13c] committed with status (VALID) at peer0.org1.example.com:7051

peer lifecycle chaincode queryapproved example

You can query an organization’s approved chaincode definition by using the peer lifecycle chaincode queryapproved command. You can use this command to see the details (including package ID) of approved chaincode definitions.

  • Here is an example of the peer lifecycle chaincode queryapproved command, which queries the approved definition of a chaincode named mycc at sequence number 1 on channel mychannel.

    1. peer lifecycle chaincode queryapproved -C mychannel -n mycc --sequence 1
    3. Approved chaincode definition for chaincode 'mycc' on channel 'mychannel':
    4. sequence: 1, version: 1, init-required: true, package-id: mycc_1:d02f72000e7c0f715840f51cb8d72d70bc1ba230552f8445dded0ec8b6e0b830, endorsement plugin: escc, validation plugin: vscc

    If NO package is specified for the approved definition, this command will display an empty package ID.

  • You can also use this command without specifying the sequence number in order to query the latest approved definition (latest: the newer of the currently defined sequence number and the next sequence number).

    1. peer lifecycle chaincode queryapproved -C mychannel -n mycc
    3. Approved chaincode definition for chaincode 'mycc' on channel 'mychannel':
    4. sequence: 3, version: 3, init-required: false, package-id: mycc_1:d02f72000e7c0f715840f51cb8d72d70bc1ba230552f8445dded0ec8b6e0b830, endorsement plugin: escc, validation plugin: vscc

  • You can also use the --output flag to have the CLI format the output as JSON.

    • When querying an approved chaincode definition for which package is specified

      1. peer lifecycle chaincode queryapproved -C mychannel -n mycc --sequence 1 --output json

      If successful, the command will return a JSON that has the approved chaincode definition for chaincode mycc at sequence number 1 on channel mychannel.

      1. {
      2.   "sequence": 1,
      3.   "version": "1",
      4.   "endorsement_plugin": "escc",
      5.   "validation_plugin": "vscc",
      6.   "validation_parameter": "EiAvQ2hhbm5lbC9BcHBsaWNhdGlvbi9FbmRvcnNlbWVudA==",
      7.   "collections": {},
      8.   "init_required": true,
      9.   "source": {
      10.     "Type": {
      11.       "LocalPackage": {
      12.         "package_id": "mycc_1:d02f72000e7c0f715840f51cb8d72d70bc1ba230552f8445dded0ec8b6e0b830"
      13.       }
      14.     }
      15.   }
      16. }

    • When querying an approved chaincode definition for which package is NOT specified

      1. peer lifecycle chaincode queryapproved -C mychannel -n mycc --sequence 2 --output json

      If successful, the command will return a JSON that has the approved chaincode definition for chaincode mycc at sequence number 2 on channel mychannel.

      1. {
      2.   "sequence": 2,
      3.   "version": "2",
      4.   "endorsement_plugin": "escc",
      5.   "validation_plugin": "vscc",
      6.   "validation_parameter": "EiAvQ2hhbm5lbC9BcHBsaWNhdGlvbi9FbmRvcnNlbWVudA==",
      7.   "collections": {},
      8.   "source": {
      9.     "Type": {
      10.       "Unavailable": {}
      11.     }
      12.   }
      13. }

peer lifecycle chaincode checkcommitreadiness example

You can check whether a chaincode definition is ready to be committed using the peer lifecycle chaincode checkcommitreadiness command, which will return successfully if a subsequent commit of the definition is expected to succeed. It also outputs which organizations have approved the chaincode definition. If an organization has approved the chaincode definition specified in the command, the command will return a value of true. You can use this command to learn whether enough channel members have approved a chaincode definition to meet the /Channel/Application/Endorsement policy (a majority by default) before the definition can be committed to a channel.

  • Here is an example of the peer lifecycle chaincode checkcommitreadiness command, which checks a chaincode named mycc at version 1.0 on channel mychannel.

    1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
    3. peer lifecycle chaincode checkcommitreadiness -o orderer.example.com:7050 --channelID mychannel --tls --cafile $ORDERER_CA --name mycc --version 1.0 --init-required --sequence 1

    If successful, the command will return the organizations that have approved the chaincode definition.

    1. Chaincode definition for chaincode 'mycc', version '1.0', sequence '1' on channel
    2. 'mychannel' approval status by org:
    3. Org1MSP: true
    4. Org2MSP: true

  • You can also use the --output flag to have the CLI format the output as JSON.

    1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
    3. peer lifecycle chaincode checkcommitreadiness -o orderer.example.com:7050 --channelID mychannel --tls --cafile $ORDERER_CA --name mycc --version 1.0 --init-required --sequence 1 --output json

    If successful, the command will return a JSON map that shows if an organization has approved the chaincode definition.

    1. {
    2.    "Approvals": {
    3.       "Org1MSP": true,
    4.       "Org2MSP": true
    5.    }
    6. }

peer lifecycle chaincode commit example

Once a sufficient number of organizations approve a chaincode definition for their organizations (a majority by default), one organization can commit the definition the channel using the peer lifecycle chaincode commit command:

  • This command needs to target the peers of other organizations on the channel to collect their organization endorsement for the definition.

    1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
    3. peer lifecycle chaincode commit -o orderer.example.com:7050 --channelID mychannel --name mycc --version 1.0 --sequence 1 --init-required --tls --cafile $ORDERER_CA --peerAddresses peer0.org1.example.com:7051 --peerAddresses peer0.org2.example.com:9051
    5. 2019-03-18 16:14:27.258 UTC [chaincodeCmd] ClientWait -> INFO 001 txid [b6f657a14689b27d69a50f39590b3949906b5a426f9d7f0dcee557f775e17882] committed with status (VALID) at peer0.org2.example.com:9051
    6. 2019-03-18 16:14:27.321 UTC [chaincodeCmd] ClientWait -> INFO 002 txid [b6f657a14689b27d69a50f39590b3949906b5a426f9d7f0dcee557f775e17882] committed with status (VALID) at peer0.org1.example.com:7051

peer lifecycle chaincode querycommitted example

You can query the chaincode definitions that have been committed to a channel by using the peer lifecycle chaincode querycommitted command. You can use this command to query the current definition sequence number before upgrading a chaincode.

  • You need to supply the chaincode name and channel name in order to query a specific chaincode definition and the organizations that have approved it.

    1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
    3. peer lifecycle chaincode querycommitted -o orderer.example.com:7050 --channelID mychannel --name mycc --tls --cafile $ORDERER_CA --peerAddresses peer0.org1.example.com:7051
    5. Committed chaincode definition for chaincode 'mycc' on channel 'mychannel':
    6. Version: 1, Sequence: 1, Endorsement Plugin: escc, Validation Plugin: vscc
    7. Approvals: [Org1MSP: true, Org2MSP: true]

  • You can also specify just the channel name in order to query all chaincode definitions on that channel.

    1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
    3. peer lifecycle chaincode querycommitted -o orderer.example.com:7050 --channelID mychannel --tls --cafile $ORDERER_CA --peerAddresses peer0.org1.example.com:7051
    5. Committed chaincode definitions on channel 'mychannel':
    6. Name: mycc, Version: 1, Sequence: 1, Endorsement Plugin: escc, Validation Plugin: vscc
    7. Name: yourcc, Version: 2, Sequence: 3, Endorsement Plugin: escc, Validation Plugin: vscc

  • You can also use the --output flag to have the CLI format the output as JSON.

    • For querying a specific chaincode definition

      1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
      3. peer lifecycle chaincode querycommitted -o orderer.example.com:7050 --channelID mychannel --name mycc --tls --cafile $ORDERER_CA --peerAddresses peer0.org1.example.com:7051 --output json

      If successful, the command will return a JSON that has committed chaincode definition for chaincode ‘mycc’ on channel ‘mychannel’.

      1. {
      2.   "sequence": 1,
      3.   "version": "1",
      4.   "endorsement_plugin": "escc",
      5.   "validation_plugin": "vscc",
      6.   "validation_parameter": "EiAvQ2hhbm5lbC9BcHBsaWNhdGlvbi9FbmRvcnNlbWVudA==",
      7.   "collections": {},
      8.   "init_required": true,
      9.   "approvals": {
      10.     "Org1MSP": true,
      11.     "Org2MSP": true
      12.   }
      13. }

      The validation_parameter is base64 encoded. An example of the command to decode it is as follows.

      1. echo EiAvQ2hhbm5lbC9BcHBsaWNhdGlvbi9FbmRvcnNlbWVudA== | base64 -d
      3.  /Channel/Application/Endorsement

    • For querying all chaincode definitions on that channel

      1. export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
      3. peer lifecycle chaincode querycommitted -o orderer.example.com:7050 --channelID mychannel --tls --cafile $ORDERER_CA --peerAddresses peer0.org1.example.com:7051 --output json

      If successful, the command will return a JSON that has committed chaincode definitions on channel ‘mychannel’.

      1. {
      2.   "chaincode_definitions": [
      3.     {
      4.       "name": "mycc",
      5.       "sequence": 1,
      6.       "version": "1",
      7.       "endorsement_plugin": "escc",
      8.       "validation_plugin": "vscc",
      9.       "validation_parameter": "EiAvQ2hhbm5lbC9BcHBsaWNhdGlvbi9FbmRvcnNlbWVudA==",
      10.       "collections": {},
      11.       "init_required": true
      12.     },
      13.     {
      14.       "name": "yourcc",
      15.       "sequence": 3,
      16.       "version": "2",
      17.       "endorsement_plugin": "escc",
      18.       "validation_plugin": "vscc",
      19.       "validation_parameter": "EiAvQ2hhbm5lbC9BcHBsaWNhdGlvbi9FbmRvcnNlbWVudA==",
      20.       "collections": {}
      21.     }
      22.   ]
      23. }

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.