ccmetadata

Documentation

Overview

# Copyright State Street Corp. All Rights Reserved. # # SPDX-License-Identifier: Apache-2.0

Index

• Constants
• func ValidateMetadataFile(filePathName string, fileBytes []byte) error
• type InvalidIndexContentError
  • func (e *InvalidIndexContentError) Error() string
• type MetadataProvider
• type TargzMetadataProvider
  • func (tgzProv *TargzMetadataProvider) GetMetadataAsTarEntries() ([]byte, error)
• type UnhandledDirectoryError
  • func (e *UnhandledDirectoryError) Error() string

Constants

const AllowedCharsCollectionName = "[A-Za-z0-9_-]+"

AllowedCharsCollectionName captures the regex pattern for a valid collection name

Functions

func ValidateMetadataFile

func ValidateMetadataFile(filePathName string, fileBytes []byte) error

ValidateMetadataFile checks that metadata files are valid according to the validation rules of the file's directory

Types

type InvalidIndexContentError

type InvalidIndexContentError struct {
	// contains filtered or unexported fields
}

InvalidIndexContentError is returned for metadata files with invalid content

func (*InvalidIndexContentError) Error

func (e *InvalidIndexContentError) Error() string

type MetadataProvider

type MetadataProvider interface {
	GetMetadataAsTarEntries() ([]byte, error)
}

MetadataProvider is implemented by each platform in a platform specific manner. It can process metadata stored in ChaincodeDeploymentSpec in different formats. The common format is targz. Currently users expect the metadata to be presented as tar file entries (directly extracted from chaincode stored in targz format). In future, we would like provide better abstraction by extending the interface

type TargzMetadataProvider

type TargzMetadataProvider struct {
	Code []byte
}

TargzMetadataProvider provides Metadata from chaincode packaged in Targz format (go, java and node platforms)

func (*TargzMetadataProvider) GetMetadataAsTarEntries

func (tgzProv *TargzMetadataProvider) GetMetadataAsTarEntries() ([]byte, error)

GetMetadataAsTarEntries extracts metata data from ChaincodeDeploymentSpec

type UnhandledDirectoryError

type UnhandledDirectoryError struct {
	// contains filtered or unexported fields
}

UnhandledDirectoryError is returned for metadata files in unhandled directories

func (*UnhandledDirectoryError) Error

func (e *UnhandledDirectoryError) Error() string