herbt_sdk_go

package module
v1.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 9, 2022 License: Apache-2.0 Imports: 50 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// KEY_ALIAS key of alias
	KEY_ALIAS = "alias"
	// KEY_ALIASES key of aliases
	KEY_ALIASES = "aliases"
	// KEY_CERT key of cert
	KEY_CERT = "cert"
)
View Source 
const (
	// DefaultRetryLimit 默认轮训交易结果最大次数
	DefaultRetryLimit = 10
	// DefaultRetryInterval 默认每次轮训交易结果时的等待时间，单位ms
	DefaultRetryInterval = 500
)
View Source 
const (
	// MaxConnCnt 单 Herbt 节点最大连接数
	MaxConnCnt = 1024
	// DefaultGetTxTimeout 查询交易超时时间
	DefaultGetTxTimeout = 10
	// DefaultSendTxTimeout 发送交易超时时间
	DefaultSendTxTimeout = 10
	// DefaultRpcClientMaxReceiveMessageSize 默认grpc客户端接收message最大值 4M
	DefaultRpcClientMaxReceiveMessageSize = 4
	// DefaultRpcClientMaxSendMessageSize 默认grpc客户端发送message最大值 4M
	DefaultRpcClientMaxSendMessageSize = 4
)
View Source 
const (
	// HibeMsgKey as a payload parameter
	HibeMsgKey = "hibe_msg"
	// HibeMsgIdKey Key as a hibeMsgMap parameter
	HibeMsgIdKey = "tx_id"
	// HibeMsgCipherTextKey Key as a hibeMsgMap parameter
	// The value of the key (CT) is the hibe_msg's message (ciphertext)
	HibeMsgCipherTextKey = "CT"
	// HibeParamsKey The value of the key (org_id) is the unique identifier of a HIBE params
	HibeParamsKey = "org_id"
	// HibeParamsValueKey The value of the key (params) is the Hibe's params
	HibeParamsValueKey = "params"
)

hibe msg's Keys

View Source 
const (
	// DefaultAuthType is default cert auth type
	DefaultAuthType = ""
)

Variables

View Source 
var AuthTypeToStringMap = map[AuthType]string{
	PermissionedWithCert: "permissionedwithcert",
	PermissionedWithKey:  "permissionedwithkey",
	Public:               "public",
}

AuthTypeToStringMap define auth type to string map

View Source 
var StringToAuthTypeMap = map[string]AuthType{
	"permissionedwithcert": PermissionedWithCert,
	"permissionedwithkey":  PermissionedWithKey,
	"public":               Public,
}

StringToAuthTypeMap define string to auth type map

Functions

func GetHerbtAddressFromCertPEM 

func GetHerbtAddressFromCertPEM(certPEM string) (string, error)

GetHerbtAddressFromCertPEM get herbt address from cert pem

func GetHerbtAddressFromCertPath 

func GetHerbtAddressFromCertPath(certPath string) (string, error)

GetHerbtAddressFromCertPath get herbt address from cert file path

func GetHerbtAddressFromPKHex 

func GetHerbtAddressFromPKHex(pkHex string, hashType crypto.HashType) (string, error)

GetHerbtAddressFromPKHex get herbt address from public key hex

func GetHerbtAddressFromPKPEM 

func GetHerbtAddressFromPKPEM(pkPEM string, hashType crypto.HashType) (string, error)

GetHerbtAddressFromPKPEM get herbt address from public key pem

func GetP11Handle 

func GetP11Handle() interface{}

GetP11Handle get global thread-safe pkcs11 handler

func NewCanonicalTxFetcherPools 

func NewCanonicalTxFetcherPools(config *ChainClientConfig) (map[string]ConnectionPool, error)

NewCanonicalTxFetcherPools 创建连接池

func SignPayload 

func SignPayload(keyPem, certPem []byte, payload *common.Payload) (*common.EndorsementEntry, error)

SignPayload sign payload Deprecated: use ./utils.MakeEndorserWithPem

func SignPayloadWithPath 

func SignPayloadWithPath(keyFilePath, crtFilePath string, payload *common.Payload) (*common.EndorsementEntry, error)

SignPayloadWithPath use key/cert file path to sign payload Deprecated: SignPayloadWithPath use ./utils.MakeEndorserWithPath instead.

Types

type ArchiveConfig 

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

ArchiveConfig Archive配置

func NewArchiveConfig 

func NewArchiveConfig(opts ...ArchiveOption) *ArchiveConfig

NewArchiveConfig new archive config

type ArchiveOption 

type ArchiveOption func(config *ArchiveConfig)

ArchiveOption define archive option func

func WithSecretKey 

func WithSecretKey(key string) ArchiveOption

WithSecretKey 设置Archive的secret key

type AuthType 

type AuthType uint32

AuthType define auth type of chain client 

const (
	// PermissionedWithCert permissioned with certificate
	PermissionedWithCert AuthType = iota + 1

	// PermissionedWithKey permissioned with public key
	PermissionedWithKey

	// Public public key
	Public
)

type CertAliasSigner 

type CertAliasSigner struct {
	PrivateKey crypto.PrivateKey
	Cert       *bcx509.Certificate
	OrgId      string
	CertAlias  string
}

CertAliasSigner define a cert alias signer in PermissionedWithCert mode

func (*CertAliasSigner) NewParticipant 

func (signer *CertAliasSigner) NewParticipant() (*accesscontrol.Participant, error)

NewParticipant new *accesscontrol.Participant

func (*CertAliasSigner) Sign 

func (signer *CertAliasSigner) Sign(payload *common.Payload) ([]byte, error)

Sign sign payload

type CertHashSigner 

type CertHashSigner struct {
	PrivateKey crypto.PrivateKey
	Cert       *bcx509.Certificate
	OrgId      string
	CertHash   []byte
}

CertHashSigner define a cert hash signer in PermissionedWithCert mode

func (*CertHashSigner) NewParticipant 

func (signer *CertHashSigner) NewParticipant() (*accesscontrol.Participant, error)

NewParticipant new *accesscontrol.Participant

func (*CertHashSigner) Sign 

func (signer *CertHashSigner) Sign(payload *common.Payload) ([]byte, error)

Sign sign payload

type CertModeSigner 

type CertModeSigner struct {
	PrivateKey crypto.PrivateKey
	Cert       *bcx509.Certificate
	OrgId      string
}

CertModeSigner define a classic cert signer in PermissionedWithCert mode

func (*CertModeSigner) NewParticipant 

func (signer *CertModeSigner) NewParticipant() (*accesscontrol.Participant, error)

NewParticipant new *accesscontrol.Participant

func (*CertModeSigner) Sign 

func (signer *CertModeSigner) Sign(payload *common.Payload) ([]byte, error)

Sign sign payload

type ChainClient 

type ChainClient struct {
	ConfigModel *utils.ChainClientConfigModel
	// contains filtered or unexported fields
}

ChainClient define herbt chain client to interact with node

func CreateChainClient 

func CreateChainClient(pool ConnectionPool, userCrtBytes, privKey, userCrtHash []byte, orgId, chainId string,
	enabledCrtHash int) (*ChainClient, error)

CreateChainClient create chain client and init chain client, returns *ChainClient

func NewChainClient 

func NewChainClient(opts ...ChainClientOption) (*ChainClient, error)

NewChainClient new chain client

func (*ChainClient) AddAlias 

func (cc *ChainClient) AddAlias() (*common.TxResponse, error)

AddAlias add cert alias to block chain network

func (*ChainClient) AddCert 

func (cc *ChainClient) AddCert() (*common.TxResponse, error)

AddCert add ChainClient myself cert hash to chain

func (*ChainClient) AttachGasLimit 

func (cc *ChainClient) AttachGasLimit(payload *common.Payload, limit *common.Limit) *common.Payload

AttachGasLimit attach gas limit for payload

func (*ChainClient) ChangeSigner 

func (cc *ChainClient) ChangeSigner(signerPrivKey crypto.PrivateKey, signerCrt *bcx509.Certificate,
	publicModeHashType crypto.HashType) error

ChangeSigner change ChainClient siger. signerCrt passes nil in Public or PermissionedWithKey mode publicModeHashType must be set in Public mode else set to zero value.

func (*ChainClient) CheckNewBlockChainConfig 

func (cc *ChainClient) CheckNewBlockChainConfig() error

CheckNewBlockChainConfig check chain configuration and load new chain dynamically

func (*ChainClient) CreateArchiveBlockPayload 

func (cc *ChainClient) CreateArchiveBlockPayload(targetBlockHeight uint64) (*common.Payload, error)

CreateArchiveBlockPayload create `archive block` payload

func (*ChainClient) CreateCertManageFrozenPayload 

func (cc *ChainClient) CreateCertManageFrozenPayload(certs []string) *common.Payload

CreateCertManageFrozenPayload create `cert manage frozen` payload

func (*ChainClient) CreateCertManagePayload 

func (cc *ChainClient) CreateCertManagePayload(method string, kvs []*common.KeyValuePair) *common.Payload

CreateCertManagePayload create `cert manage` payload

func (*ChainClient) CreateCertManageRevocationPayload 

func (cc *ChainClient) CreateCertManageRevocationPayload(certCrl string) *common.Payload

CreateCertManageRevocationPayload create `cert manage revocation` payload

func (*ChainClient) CreateCertManageUnfrozenPayload 

func (cc *ChainClient) CreateCertManageUnfrozenPayload(certs []string) *common.Payload

CreateCertManageUnfrozenPayload create `cert manage unfrozen` payload

func (*ChainClient) CreateChainConfigAlterAddrTypePayload 

func (cc *ChainClient) CreateChainConfigAlterAddrTypePayload(addrType string) (*common.Payload, error)

CreateChainConfigAlterAddrTypePayload create chain config alter address type payload

func (*ChainClient) CreateChainConfigBlockUpdatePayload 

func (cc *ChainClient) CreateChainConfigBlockUpdatePayload(txTimestampVerify bool, txTimeout, blockTxCapacity,
	blockSize, blockInterval, txParamterSize uint32) (*common.Payload, error)

CreateChainConfigBlockUpdatePayload create chain config block update payload

func (*ChainClient) CreateChainConfigConsensusExtAddPayload 

func (cc *ChainClient) CreateChainConfigConsensusExtAddPayload(kvs []*common.KeyValuePair) (*common.Payload, error)

CreateChainConfigConsensusExtAddPayload create chain config consensus ext add payload

func (*ChainClient) CreateChainConfigConsensusExtDeletePayload 

func (cc *ChainClient) CreateChainConfigConsensusExtDeletePayload(keys []string) (*common.Payload, error)

CreateChainConfigConsensusExtDeletePayload create chain config consensus ext delete payload

func (*ChainClient) CreateChainConfigConsensusExtUpdatePayload 

func (cc *ChainClient) CreateChainConfigConsensusExtUpdatePayload(kvs []*common.KeyValuePair) (*common.Payload, error)

CreateChainConfigConsensusExtUpdatePayload create chain config consensus ext update payload

func (*ChainClient) CreateChainConfigConsensusNodeIdAddPayload 

func (cc *ChainClient) CreateChainConfigConsensusNodeIdAddPayload(nodeOrgId string,
	nodeIds []string) (*common.Payload, error)

CreateChainConfigConsensusNodeIdAddPayload create chain config consensus node id add payload

func (*ChainClient) CreateChainConfigConsensusNodeIdDeletePayload 

func (cc *ChainClient) CreateChainConfigConsensusNodeIdDeletePayload(nodeOrgId,
	nodeId string) (*common.Payload, error)

CreateChainConfigConsensusNodeIdDeletePayload create chain config consensus node id delete payload

func (*ChainClient) CreateChainConfigConsensusNodeIdUpdatePayload 

func (cc *ChainClient) CreateChainConfigConsensusNodeIdUpdatePayload(nodeOrgId, nodeOldIds,
	nodeNewIds string) (*common.Payload, error)

CreateChainConfigConsensusNodeIdUpdatePayload create chain config consensus node id update payload

func (*ChainClient) CreateChainConfigConsensusNodeOrgAddPayload 

func (cc *ChainClient) CreateChainConfigConsensusNodeOrgAddPayload(nodeOrgId string,
	nodeIds []string) (*common.Payload, error)

CreateChainConfigConsensusNodeOrgAddPayload create chain config consensus node org add payload

func (*ChainClient) CreateChainConfigConsensusNodeOrgDeletePayload 

func (cc *ChainClient) CreateChainConfigConsensusNodeOrgDeletePayload(nodeOrgId string) (*common.Payload, error)

CreateChainConfigConsensusNodeOrgDeletePayload create chain config consensus node org delete payload

func (*ChainClient) CreateChainConfigConsensusNodeOrgUpdatePayload 

func (cc *ChainClient) CreateChainConfigConsensusNodeOrgUpdatePayload(nodeOrgId string,
	nodeIds []string) (*common.Payload, error)

CreateChainConfigConsensusNodeOrgUpdatePayload create chain config consensus node org update payload

func (*ChainClient) CreateChainConfigCoreUpdatePayload 

func (cc *ChainClient) CreateChainConfigCoreUpdatePayload(txSchedulerTimeout,
	txSchedulerValidateTimeout uint64) (*common.Payload, error)

CreateChainConfigCoreUpdatePayload create chain config core update payload

func (*ChainClient) CreateChainConfigEnableOrDisableGasPayload 

func (cc *ChainClient) CreateChainConfigEnableOrDisableGasPayload() (*common.Payload, error)

CreateChainConfigEnableOrDisableGasPayload create chain config enable or disable gas payload

func (*ChainClient) CreateChainConfigOptimizeChargeGasPayload 

func (cc *ChainClient) CreateChainConfigOptimizeChargeGasPayload(enable bool) (*common.Payload, error)

CreateChainConfigOptimizeChargeGasPayload create chain config optimize charge gas payload

func (*ChainClient) CreateChainConfigPermissionAddPayload 

func (cc *ChainClient) CreateChainConfigPermissionAddPayload(permissionResourceName string,
	policy *accesscontrol.Policy) (*common.Payload, error)

CreateChainConfigPermissionAddPayload create chain config permission add payload

func (*ChainClient) CreateChainConfigPermissionDeletePayload 

func (cc *ChainClient) CreateChainConfigPermissionDeletePayload(resourceName string) (*common.Payload, error)

CreateChainConfigPermissionDeletePayload create chain config permission delete payload

func (*ChainClient) CreateChainConfigPermissionUpdatePayload 

func (cc *ChainClient) CreateChainConfigPermissionUpdatePayload(permissionResourceName string,
	policy *accesscontrol.Policy) (*common.Payload, error)

CreateChainConfigPermissionUpdatePayload create chain config permission update payload

func (*ChainClient) CreateChainConfigTrustParticipantAddPayload 

func (cc *ChainClient) CreateChainConfigTrustParticipantAddPayload(trustParticipantOrgId, trustParticipantNodeId,
	trustParticipantRole, trustParticipantInfo string) (*common.Payload, error)

CreateChainConfigTrustParticipantAddPayload create chain config trust participant add payload

func (*ChainClient) CreateChainConfigTrustParticipantDeletePayload 

func (cc *ChainClient) CreateChainConfigTrustParticipantDeletePayload(trustParticipantInfo string) (*common.Payload, error)

CreateChainConfigTrustParticipantDeletePayload create chain config trust participant delete payload

func (*ChainClient) CreateChainConfigTrustRootAddPayload 

func (cc *ChainClient) CreateChainConfigTrustRootAddPayload(trustRootOrgId string,
	trustRootCrt []string) (*common.Payload, error)

CreateChainConfigTrustRootAddPayload create chain config trust root add payload

func (*ChainClient) CreateChainConfigTrustRootDeletePayload 

func (cc *ChainClient) CreateChainConfigTrustRootDeletePayload(trustRootOrgId string) (*common.Payload, error)

CreateChainConfigTrustRootDeletePayload create chain config trust root delete payload

func (*ChainClient) CreateChainConfigTrustRootUpdatePayload 

func (cc *ChainClient) CreateChainConfigTrustRootUpdatePayload(trustRootOrgId string,
	trustRootCrt []string) (*common.Payload, error)

CreateChainConfigTrustRootUpdatePayload create chain config trust root update payload

func (*ChainClient) CreateContractCreatePayload 

func (cc *ChainClient) CreateContractCreatePayload(contractName, version, byteCodeStringOrFilePath string,
	runtime common.RuntimeType, kvs []*common.KeyValuePair) (*common.Payload, error)

CreateContractCreatePayload create user contract creation payload

func (*ChainClient) CreateContractFreezePayload 

func (cc *ChainClient) CreateContractFreezePayload(contractName string) (*common.Payload, error)

CreateContractFreezePayload create user contract freeze payload

func (*ChainClient) CreateContractRevokePayload 

func (cc *ChainClient) CreateContractRevokePayload(contractName string) (*common.Payload, error)

CreateContractRevokePayload create user contract revoke payload

func (*ChainClient) CreateContractUnfreezePayload 

func (cc *ChainClient) CreateContractUnfreezePayload(contractName string) (*common.Payload, error)

CreateContractUnfreezePayload create user contract unfreeze payload

func (*ChainClient) CreateContractUpgradePayload 

func (cc *ChainClient) CreateContractUpgradePayload(contractName, version, byteCodeStringOrFilePath string,
	runtime common.RuntimeType, kvs []*common.KeyValuePair) (*common.Payload, error)

CreateContractUpgradePayload create user contract upgrade payload

func (*ChainClient) CreateDeleteCertsAliasPayload 

func (cc *ChainClient) CreateDeleteCertsAliasPayload(aliases []string) *common.Payload

CreateDeleteCertsAliasPayload create `delete certs alias` payload

func (*ChainClient) CreateFrozenGasAccountPayload 

func (cc *ChainClient) CreateFrozenGasAccountPayload(address string) (*common.Payload, error)

CreateFrozenGasAccountPayload create frozen gas account payload

func (*ChainClient) CreateHibeInitParamsTxPayloadParams 

func (cc *ChainClient) CreateHibeInitParamsTxPayloadParams(orgId string,
	hibeParams []byte) ([]*common.KeyValuePair, error)

CreateHibeInitParamsTxPayloadParams CreateHibeInitParamsTxPayloadParams

func (*ChainClient) CreateHibeTxPayloadParamsWithHibeParams 

func (cc *ChainClient) CreateHibeTxPayloadParamsWithHibeParams(plaintext []byte, receiverIds []string,
	paramsBytesList [][]byte, txId string, keyType crypto.KeyType) ([]*common.KeyValuePair, error)

CreateHibeTxPayloadParamsWithHibeParams CreateHibeTxPayloadParamsWithHibeParams

func (*ChainClient) CreateHibeTxPayloadParamsWithoutHibeParams 

func (cc *ChainClient) CreateHibeTxPayloadParamsWithoutHibeParams(contractName, queryParamsMethod string,
	plaintext []byte, receiverIds []string, receiverOrgIds []string, txId string, keyType crypto.KeyType,
	timeout int64) ([]*common.KeyValuePair, error)

CreateHibeTxPayloadParamsWithoutHibeParams CreateHibeTxPayloadParamsWithoutHibeParams

func (*ChainClient) CreateMultiSignReqPayload 

func (cc *ChainClient) CreateMultiSignReqPayload(pairs []*common.KeyValuePair) *common.Payload

CreateMultiSignReqPayload create multi sign payload

func (*ChainClient) CreatePayload 

func (cc *ChainClient) CreatePayload(txId string, txType common.TxType, contractName, method string,
	kvs []*common.KeyValuePair, seq uint64, limit *common.Limit) *common.Payload

CreatePayload create unsigned payload

func (*ChainClient) CreatePubkeyAddPayload 

func (cc *ChainClient) CreatePubkeyAddPayload(pubkey string, orgId string, role string) (*common.Payload, error)

CreatePubkeyAddPayload create pubkey add payload

func (*ChainClient) CreatePubkeyDelPayload 

func (cc *ChainClient) CreatePubkeyDelPayload(pubkey string, orgId string) (*common.Payload, error)

CreatePubkeyDelPayload create pubkey delete payload

func (*ChainClient) CreatePubkeyQueryPayload 

func (cc *ChainClient) CreatePubkeyQueryPayload(pubkey string) (*common.Payload, error)

CreatePubkeyQueryPayload create pubkey query payload

func (*ChainClient) CreateRechargeGasPayload 

func (cc *ChainClient) CreateRechargeGasPayload(rechargeGasList []*syscontract.RechargeGas) (*common.Payload, error)

CreateRechargeGasPayload create recharge gas payload

func (*ChainClient) CreateRefundGasPayload 

func (cc *ChainClient) CreateRefundGasPayload(address string, amount int64) (*common.Payload, error)

CreateRefundGasPayload create refund gas payload

func (*ChainClient) CreateRestoreBlockPayload 

func (cc *ChainClient) CreateRestoreBlockPayload(fullBlock []byte) (*common.Payload, error)

CreateRestoreBlockPayload create `restore block` payload

func (*ChainClient) CreateSetGasAdminPayload 

func (cc *ChainClient) CreateSetGasAdminPayload(address string) (*common.Payload, error)

CreateSetGasAdminPayload create set gas admin payload

func (*ChainClient) CreateSetInvokeBaseGasPayload 

func (cc *ChainClient) CreateSetInvokeBaseGasPayload(amount int64) (*common.Payload, error)

CreateSetInvokeBaseGasPayload create set invoke base gas payload

func (*ChainClient) CreateSubscribeBlockPayload 

func (cc *ChainClient) CreateSubscribeBlockPayload(startBlock, endBlock int64,
	withRWSet, onlyHeader bool) *common.Payload

CreateSubscribeBlockPayload create subscribe block payload

func (*ChainClient) CreateSubscribeContractEventPayload 

func (cc *ChainClient) CreateSubscribeContractEventPayload(startBlock, endBlock int64,
	contractName, topic string) *common.Payload

CreateSubscribeContractEventPayload create subscribe contract event payload

func (*ChainClient) CreateSubscribeTxPayload 

func (cc *ChainClient) CreateSubscribeTxPayload(startBlock, endBlock int64,
	contractName string, txIds []string) *common.Payload

CreateSubscribeTxPayload create subscribe tx payload

func (*ChainClient) CreateSystemContractAccessGrantPayload added in v1.5.1 

func (cc *ChainClient) CreateSystemContractAccessGrantPayload(grantContractList []string) (*common.Payload, error)

CreateSystemContractAccessGrantPayload create `system contract access grant` payload for grant access to a system contract

func (*ChainClient) CreateSystemContractAccessRevokePayload added in v1.5.1 

func (cc *ChainClient) CreateSystemContractAccessRevokePayload(revokeContractList []string) (*common.Payload, error)

CreateSystemContractAccessRevokePayload create `system contract access revoke` payload for revoke access to a system contract

func (*ChainClient) CreateUnfrozenGasAccountPayload 

func (cc *ChainClient) CreateUnfrozenGasAccountPayload(address string) (*common.Payload, error)

CreateUnfrozenGasAccountPayload create unfrozen gas account payload

func (*ChainClient) CreateUpdateCertByAliasPayload 

func (cc *ChainClient) CreateUpdateCertByAliasPayload(alias, newCertPEM string) *common.Payload

CreateUpdateCertByAliasPayload create `update cert by alias` payload

func (*ChainClient) DecryptHibeTxByTxId 

func (cc *ChainClient) DecryptHibeTxByTxId(localId string, hibeParams []byte, hibePrvKey []byte, txId string,
	keyType crypto.KeyType) ([]byte, error)

DecryptHibeTxByTxId DecryptHibeTxByTxId

func (*ChainClient) DeleteCert 

func (cc *ChainClient) DeleteCert(certHashes []string) (*common.TxResponse, error)

DeleteCert delete myself cert hash on chain

func (*ChainClient) DeleteCertsAlias 

func (cc *ChainClient) DeleteCertsAlias(payload *common.Payload, endorsers []*common.EndorsementEntry,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

DeleteCertsAlias delete certs alias on chain

func (*ChainClient) DisableCertHash 

func (cc *ChainClient) DisableCertHash() error

DisableCertHash disable cert hash logic

func (*ChainClient) EasyCodecItemToParamsMap 

func (cc *ChainClient) EasyCodecItemToParamsMap(items []*serialize.EasyCodecItem) map[string][]byte

EasyCodecItemToParamsMap easy codec items to params map

func (*ChainClient) EnableAlias 

func (cc *ChainClient) EnableAlias() error

EnableAlias enable cert alias logic

func (*ChainClient) EnableCertHash 

func (cc *ChainClient) EnableCertHash() error

EnableCertHash Cert Hash logic

func (*ChainClient) EstimateGas 

func (cc *ChainClient) EstimateGas(payload *common.Payload) (uint64, error)

EstimateGas estimate gas used of payload

func (*ChainClient) GenerateTxRequest 

func (cc *ChainClient) GenerateTxRequest(payload *common.Payload,
	endorsers []*common.EndorsementEntry) (*common.TxRequest, error)

GenerateTxRequest sign payload and generate *common.TxRequest

func (*ChainClient) GenerateTxRequestBySigner 

func (cc *ChainClient) GenerateTxRequestBySigner(payload *common.Payload, endorsers []*common.EndorsementEntry,
	signer Signer) (*common.TxRequest, error)

GenerateTxRequestBySigner sign payload and generate *common.TxRequest use signer to sign payload if it is not nil. use cc.privateKey to sign payload if signer is nil.

func (*ChainClient) GetArchivedBlockByHash 

func (cc *ChainClient) GetArchivedBlockByHash(blockHash string, withRWSet bool) (*common.BlockInfo, error)

GetArchivedBlockByHash get archived block by block hash, returns *common.BlockInfo

func (*ChainClient) GetArchivedBlockByHeight 

func (cc *ChainClient) GetArchivedBlockByHeight(blockHeight uint64, withRWSet bool) (*common.BlockInfo, error)

GetArchivedBlockByHeight get archived block by block height, returns *common.BlockInfo

func (*ChainClient) GetArchivedBlockByTxId 

func (cc *ChainClient) GetArchivedBlockByTxId(txId string, withRWSet bool) (*common.BlockInfo, error)

GetArchivedBlockByTxId get archived block by tx id, returns *common.BlockInfo

func (*ChainClient) GetArchivedBlockFromMySQL 

func (cc *ChainClient) GetArchivedBlockFromMySQL(blockHeight uint64) (*store.BlockWithRWSet, error)

GetArchivedBlockFromMySQL get archived block from Mysql, returns *store.BlockWithRWSet

func (*ChainClient) GetArchivedBlockHeight 

func (cc *ChainClient) GetArchivedBlockHeight() (uint64, error)

GetArchivedBlockHeight get archived block height

func (*ChainClient) GetArchivedFullBlockByHeight 

func (cc *ChainClient) GetArchivedFullBlockByHeight(blockHeight uint64) (*store.BlockWithRWSet, error)

GetArchivedFullBlockByHeight get archived full block by block height, returns *store.BlockWithRWSet

func (*ChainClient) GetArchivedTxByTxId 

func (cc *ChainClient) GetArchivedTxByTxId(txId string) (*common.TransactionInfo, error)

GetArchivedTxByTxId get archived tx by tx id, returns *common.TransactionInfo

func (*ChainClient) GetAuthType 

func (cc *ChainClient) GetAuthType() AuthType

GetAuthType get auth type of cc

func (*ChainClient) GetBlockByHash 

func (cc *ChainClient) GetBlockByHash(blockHash string, withRWSet bool) (*common.BlockInfo, error)

GetBlockByHash get block by block hash, returns *common.BlockInfo

func (*ChainClient) GetBlockByHeight 

func (cc *ChainClient) GetBlockByHeight(blockHeight uint64, withRWSet bool) (*common.BlockInfo, error)

GetBlockByHeight get block by block height, returns *common.BlockInfo

func (*ChainClient) GetBlockByHeightTruncate 

func (cc *ChainClient) GetBlockByHeightTruncate(blockHeight uint64, withRWSet bool, truncateLength int,
	truncateModel string) (*common.BlockInfo, error)

GetBlockByHeightTruncate 根据区块高度获得区块，但是对于长度超过100的ParameterValue则清空Value @param blockHeight @param withRWSet @param truncateLength 截断的长度设置 @param truncateModel 截断的模式设置:hash,truncate,empty @return *common.BlockInfo @return error

func (*ChainClient) GetBlockByTxId 

func (cc *ChainClient) GetBlockByTxId(txId string, withRWSet bool) (*common.BlockInfo, error)

GetBlockByTxId get block by tx id, returns *common.BlockInfo

func (*ChainClient) GetBlockHeaderByHeight 

func (cc *ChainClient) GetBlockHeaderByHeight(blockHeight uint64) (*common.BlockHeader, error)

GetBlockHeaderByHeight get block header by block height

func (*ChainClient) GetBlockHeightByHash 

func (cc *ChainClient) GetBlockHeightByHash(blockHash string) (uint64, error)

GetBlockHeightByHash get block height by block hash

func (*ChainClient) GetBlockHeightByTxId 

func (cc *ChainClient) GetBlockHeightByTxId(txId string) (uint64, error)

GetBlockHeightByTxId get block height by tx id

func (*ChainClient) GetCertHash 

func (cc *ChainClient) GetCertHash() ([]byte, error)

GetCertHash get cert hash on chain

func (*ChainClient) GetCertPEM 

func (cc *ChainClient) GetCertPEM() []byte

GetCertPEM get cert pem of cc

func (*ChainClient) GetChainConfig 

func (cc *ChainClient) GetChainConfig() (*config.ChainConfig, error)

GetChainConfig get chain config

func (*ChainClient) GetChainConfigByBlockHeight 

func (cc *ChainClient) GetChainConfigByBlockHeight(blockHeight uint64) (*config.ChainConfig, error)

GetChainConfigByBlockHeight get chain config by block height

func (*ChainClient) GetChainConfigPermissionList 

func (cc *ChainClient) GetChainConfigPermissionList() ([]*config.ResourcePolicy, error)

GetChainConfigPermissionList get chain config

func (*ChainClient) GetChainConfigSequence 

func (cc *ChainClient) GetChainConfigSequence() (uint64, error)

GetChainConfigSequence get chain config sequence

func (*ChainClient) GetChainInfo 

func (cc *ChainClient) GetChainInfo() (*discovery.ChainInfo, error)

GetChainInfo get chain info

func (*ChainClient) GetContractInfo 

func (cc *ChainClient) GetContractInfo(contractName string) (*common.Contract, error)

GetContractInfo get contract info by contract name, returns *common.Contract

func (*ChainClient) GetContractList 

func (cc *ChainClient) GetContractList() ([]*common.Contract, error)

GetContractList get all contracts from block chain, include user contract and system contract

func (*ChainClient) GetCurrentBlockHeight 

func (cc *ChainClient) GetCurrentBlockHeight() (uint64, error)

GetCurrentBlockHeight get current block height

func (*ChainClient) GetDisabledSystemContractList added in v1.5.1 

func (cc *ChainClient) GetDisabledSystemContractList() ([]string, error)

GetDisabledSystemContractList get all disabled system contracts, returns contracts name list

func (*ChainClient) GetEnabledCrtHash 

func (cc *ChainClient) GetEnabledCrtHash() bool

GetEnabledCrtHash check whether the cert hash logic is enabled

func (*ChainClient) GetFromArchiveStore 

func (cc *ChainClient) GetFromArchiveStore(blockHeight uint64) (*store.BlockWithRWSet, error)

GetFromArchiveStore get block from archive storage, currently supported storage is Mysql. required sdk config file `archive` configured returns *store.BlockWithRWSet

func (*ChainClient) GetFullBlockByHeight 

func (cc *ChainClient) GetFullBlockByHeight(blockHeight uint64) (*store.BlockWithRWSet, error)

GetFullBlockByHeight get full block by block height, returns *store.BlockWithRWSet

func (*ChainClient) GetGasAccountStatus 

func (cc *ChainClient) GetGasAccountStatus(address string) (bool, error)

GetGasAccountStatus get gas account status

func (*ChainClient) GetGasAdmin 

func (cc *ChainClient) GetGasAdmin() (string, error)

GetGasAdmin get gas admin on chain, returns gas admin address

func (*ChainClient) GetGasBalance 

func (cc *ChainClient) GetGasBalance(address string) (int64, error)

GetGasBalance returns gas balance of address

func (*ChainClient) GetHashType 

func (cc *ChainClient) GetHashType() crypto.HashType

GetHashType get hash type of cc

func (*ChainClient) GetHerbtServerVersion 

func (cc *ChainClient) GetHerbtServerVersion() (string, error)

GetHerbtServerVersion get herbt version

func (*ChainClient) GetLastBlock 

func (cc *ChainClient) GetLastBlock(withRWSet bool) (*common.BlockInfo, error)

GetLastBlock get last block

func (*ChainClient) GetLastConfigBlock 

func (cc *ChainClient) GetLastConfigBlock(withRWSet bool) (*common.BlockInfo, error)

GetLastConfigBlock get last config block

func (*ChainClient) GetLocalCertAlias 

func (cc *ChainClient) GetLocalCertAlias() string

GetLocalCertAlias get local cert alias of cc

func (*ChainClient) GetMerklePathByTxId 

func (cc *ChainClient) GetMerklePathByTxId(txId string) ([]byte, error)

GetMerklePathByTxId get merkle path by tx id

func (*ChainClient) GetNodeChainList 

func (cc *ChainClient) GetNodeChainList() (*discovery.ChainList, error)

GetNodeChainList get node chain list

func (*ChainClient) GetPoolStatus 

func (cc *ChainClient) GetPoolStatus() (*txpool.TxPoolStatus, error)

GetPoolStatus Returns the max size of config transaction pool and common transaction pool, the num of config transaction in queue and pendingCache, and the the num of common transaction in queue and pendingCache.

func (*ChainClient) GetPrivateKey 

func (cc *ChainClient) GetPrivateKey() crypto.PrivateKey

GetPrivateKey get private key of cc

func (*ChainClient) GetPublicKey 

func (cc *ChainClient) GetPublicKey() crypto.PublicKey

GetPublicKey get public key of cc

func (*ChainClient) GetSyncResult 

func (cc *ChainClient) GetSyncResult(txId string) (*common.Result, error)

GetSyncResult get sync result of tx

func (*ChainClient) GetTxByTxId 

func (cc *ChainClient) GetTxByTxId(txId string) (*common.TransactionInfo, error)

GetTxByTxId get tx by tx id, returns *common.TransactionInfo

func (*ChainClient) GetTxByTxIdTruncate 

func (cc *ChainClient) GetTxByTxIdTruncate(txId string, withRWSet bool, truncateLength int,
	truncateModel string) (*common.TransactionInfoWithRWSet, error)

GetTxByTxIdTruncate 根据TxId获得Transaction对象，并根据参数进行截断 @param txId @param withRWSet @param truncateLength @param truncateModel @return *common.TransactionInfoWithRWSet @return error

func (*ChainClient) GetTxIdsByTypeAndStage 

func (cc *ChainClient) GetTxIdsByTypeAndStage(txType txpool.TxType, txStage txpool.TxStage) ([]string, error)

GetTxIdsByTypeAndStage Returns config or common txIds in different stage. txType may be TxType_CONFIG_TX, TxType_COMMON_TX, (TxType_CONFIG_TX|TxType_COMMON_TX) txStage may be TxStage_IN_QUEUE, TxStage_IN_PENDING, (TxStage_IN_QUEUE|TxStage_IN_PENDING)

func (*ChainClient) GetTxRequest 

func (cc *ChainClient) GetTxRequest(contractName, method, txId string, kvs []*common.KeyValuePair) (
	*common.TxRequest, error)

GetTxRequest build tx request, returns *common.TxRequest

func (*ChainClient) GetTxWithRWSetByTxId 

func (cc *ChainClient) GetTxWithRWSetByTxId(txId string) (*common.TransactionInfoWithRWSet, error)

GetTxWithRWSetByTxId get tx with rwset by tx id

func (*ChainClient) GetTxsInPoolByTxIds 

func (cc *ChainClient) GetTxsInPoolByTxIds(txIds []string) ([]*common.Transaction, []string, error)

GetTxsInPoolByTxIds Retrieve the transactions by the txIds from the txPool, return transactions in the txPool and txIds not in txPool. default query upper limit is 1w transaction, and error is returned if the limit is exceeded.

func (*ChainClient) GetUserCrtHash 

func (cc *ChainClient) GetUserCrtHash() []byte

GetUserCrtHash get user cert hash of cc

func (*ChainClient) InvokeContract 

func (cc *ChainClient) InvokeContract(contractName, method, txId string, kvs []*common.KeyValuePair, timeout int64,
	withSyncResult bool) (*common.TxResponse, error)

InvokeContract invoke contract

func (*ChainClient) InvokeContractBySigner 

func (cc *ChainClient) InvokeContractBySigner(contractName, method, txId string, kvs []*common.KeyValuePair,
	timeout int64, withSyncResult bool, limit *common.Limit,
	signer Signer) (*common.TxResponse, error)

InvokeContractBySigner invoke contract with specified signer. use signer to sign payload if it is not nil. use cc.privateKey to sign payload if signer is nil.

func (*ChainClient) InvokeContractWithLimit 

func (cc *ChainClient) InvokeContractWithLimit(contractName, method, txId string, kvs []*common.KeyValuePair,
	timeout int64, withSyncResult bool, limit *common.Limit) (*common.TxResponse, error)

InvokeContractWithLimit invoke contract with specified gas limit

func (*ChainClient) InvokeSystemContract 

func (cc *ChainClient) InvokeSystemContract(contractName, method, txId string, kvs []*common.KeyValuePair,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

InvokeSystemContract invoke system contract

func (*ChainClient) IsEnableNormalKey 

func (cc *ChainClient) IsEnableNormalKey() bool

IsEnableNormalKey whether to use normal key

func (*ChainClient) MultiSignContractQuery 

func (cc *ChainClient) MultiSignContractQuery(txId string) (*common.TxResponse, error)

MultiSignContractQuery query online multi sign

func (*ChainClient) MultiSignContractReq 

func (cc *ChainClient) MultiSignContractReq(payload *common.Payload) (*common.TxResponse, error)

MultiSignContractReq send online multi sign contract request to node

func (*ChainClient) MultiSignContractVote 

func (cc *ChainClient) MultiSignContractVote(multiSignReqPayload *common.Payload,
	endorser *common.EndorsementEntry, isAgree bool) (*common.TxResponse, error)

MultiSignContractVote send online multi sign vote request to node

func (*ChainClient) Pkcs11Config 

func (cc *ChainClient) Pkcs11Config() *Pkcs11Config

Pkcs11Config get pkcs11 config of cc

func (*ChainClient) QueryCert 

func (cc *ChainClient) QueryCert(certHashes []string) (*common.CertInfos, error)

QueryCert query cert on chain, returns *common.CertInfos

func (*ChainClient) QueryCertsAlias 

func (cc *ChainClient) QueryCertsAlias(aliases []string) (*common.AliasInfos, error)

QueryCertsAlias query cert alias on chain, returns *common.AliasInfos

func (*ChainClient) QueryContract 

func (cc *ChainClient) QueryContract(contractName, method string, kvs []*common.KeyValuePair,
	timeout int64) (*common.TxResponse, error)

QueryContract query contract

func (*ChainClient) QueryHibeParamsWithOrgId 

func (cc *ChainClient) QueryHibeParamsWithOrgId(contractName, method, orgId string, timeout int64) ([]byte, error)

QueryHibeParamsWithOrgId QueryHibeParamsWithOrgId

func (*ChainClient) QuerySystemContract 

func (cc *ChainClient) QuerySystemContract(contractName, method string, kvs []*common.KeyValuePair,
	timeout int64) (*common.TxResponse, error)

QuerySystemContract query system contract

func (*ChainClient) SendArchiveBlockRequest 

func (cc *ChainClient) SendArchiveBlockRequest(payload *common.Payload, timeout int64) (*common.TxResponse, error)

SendArchiveBlockRequest send `archive block` request to node grpc server

func (*ChainClient) SendCertManageRequest 

func (cc *ChainClient) SendCertManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

SendCertManageRequest send cert manage request to node

func (*ChainClient) SendChainConfigUpdateRequest 

func (cc *ChainClient) SendChainConfigUpdateRequest(payload *common.Payload, endorsers []*common.EndorsementEntry,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

SendChainConfigUpdateRequest send chain config update request to node

func (*ChainClient) SendContractManageRequest 

func (cc *ChainClient) SendContractManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

SendContractManageRequest send user contract manage request to node

func (*ChainClient) SendGasManageRequest 

func (cc *ChainClient) SendGasManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

SendGasManageRequest send gas manage request to node

func (*ChainClient) SendPubkeyManageRequest 

func (cc *ChainClient) SendPubkeyManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

SendPubkeyManageRequest send pubkey manage request to node

func (*ChainClient) SendRestoreBlockRequest 

func (cc *ChainClient) SendRestoreBlockRequest(payload *common.Payload, timeout int64) (*common.TxResponse, error)

SendRestoreBlockRequest send `restore block` request to node grpc server

func (*ChainClient) SendTxRequest 

func (cc *ChainClient) SendTxRequest(txRequest *common.TxRequest, timeout int64,
	withSyncResult bool) (*common.TxResponse, error)

SendTxRequest send tx request to node

func (*ChainClient) SignArchivePayload 

func (cc *ChainClient) SignArchivePayload(payload *common.Payload) (*common.Payload, error)

SignArchivePayload sign archive payload, currently do nothing

func (*ChainClient) SignCertManagePayload 

func (cc *ChainClient) SignCertManagePayload(payload *common.Payload) (*common.EndorsementEntry, error)

SignCertManagePayload sign `cert manage` payload

func (*ChainClient) SignChainConfigPayload 

func (cc *ChainClient) SignChainConfigPayload(payload *common.Payload) (*common.EndorsementEntry, error)

SignChainConfigPayload sign chain config payload

func (*ChainClient) SignContractManagePayload 

func (cc *ChainClient) SignContractManagePayload(payload *common.Payload) (*common.EndorsementEntry, error)

SignContractManagePayload sign user contract manage payload

func (*ChainClient) SignDeleteAliasPayload 

func (cc *ChainClient) SignDeleteAliasPayload(payload *common.Payload) (*common.EndorsementEntry, error)

SignDeleteAliasPayload sign `delete alias` payload

func (*ChainClient) SignPayload 

func (cc *ChainClient) SignPayload(payload *common.Payload) (*common.EndorsementEntry, error)

SignPayload sign payload, returns *common.EndorsementEntry

func (*ChainClient) SignUpdateCertByAliasPayload 

func (cc *ChainClient) SignUpdateCertByAliasPayload(payload *common.Payload) (*common.EndorsementEntry, error)

SignUpdateCertByAliasPayload sign `update cert by alias` payload

func (*ChainClient) Stop 

func (cc *ChainClient) Stop() error

Stop stop chain client

func (*ChainClient) Subscribe 

func (cc *ChainClient) Subscribe(ctx context.Context, payload *common.Payload) (<-chan interface{}, error)

Subscribe returns channel of subscribed items

func (*ChainClient) SubscribeBlock 

func (cc *ChainClient) SubscribeBlock(ctx context.Context, startBlock, endBlock int64, withRWSet,
	onlyHeader bool) (<-chan interface{}, error)

SubscribeBlock block subscription, returns channel of subscribed blocks

func (*ChainClient) SubscribeContractEvent 

func (cc *ChainClient) SubscribeContractEvent(ctx context.Context, startBlock, endBlock int64,
	contractName, topic string) (<-chan interface{}, error)

SubscribeContractEvent contract event subscription, returns channel of subscribed contract events

func (*ChainClient) SubscribeTx 

func (cc *ChainClient) SubscribeTx(ctx context.Context, startBlock, endBlock int64, contractName string,
	txIds []string) (<-chan interface{}, error)

SubscribeTx tx subscription, returns channel of subscribed txs

func (*ChainClient) UpdateCertByAlias 

func (cc *ChainClient) UpdateCertByAlias(payload *common.Payload, endorsers []*common.EndorsementEntry,
	timeout int64, withSyncResult bool) (*common.TxResponse, error)

UpdateCertByAlias update cert by alias on chain

type ChainClientConfig 

type ChainClientConfig struct {
	ConfigModel *utils.ChainClientConfigModel
	// contains filtered or unexported fields
}

ChainClientConfig define chain client configuration

type ChainClientOption 

type ChainClientOption func(*ChainClientConfig)

ChainClientOption define chain client option func

func AddChainClientNodeConfig 

func AddChainClientNodeConfig(nodeConfig *NodeConfig) ChainClientOption

AddChainClientNodeConfig 添加 Herbt 节点地址及连接数配置

func WithArchiveConfig 

func WithArchiveConfig(conf *ArchiveConfig) ChainClientOption

WithArchiveConfig 设置Archive配置

func WithAuthType 

func WithAuthType(authType string) ChainClientOption

WithAuthType specified auth type

func WithChainClientAlias 

func WithChainClientAlias(alias string) ChainClientOption

WithChainClientAlias specified cert alias

func WithChainClientChainId 

func WithChainClientChainId(chainId string) ChainClientOption

WithChainClientChainId 添加ChainId

func WithChainClientLogger 

func WithChainClientLogger(logger utils.Logger) ChainClientOption

WithChainClientLogger 设置Logger对象，便于日志打印

func WithChainClientOrgId 

func WithChainClientOrgId(orgId string) ChainClientOption

WithChainClientOrgId 添加OrgId

func WithConfPath 

func WithConfPath(confPath string) ChainClientOption

WithConfPath 设置配置文件路径

func WithCryptoConfig 

func WithCryptoConfig(conf *CryptoConfig) ChainClientOption

WithCryptoConfig 设置crypto配置

func WithEnableNormalKey 

func WithEnableNormalKey(enableNormalKey bool) ChainClientOption

WithEnableNormalKey specified use normal key or not

func WithEnableSyncCanonicalTxResult 

func WithEnableSyncCanonicalTxResult(enable bool) ChainClientOption

WithEnableSyncCanonicalTxResult 设置是否启用 同步获取权威的公认的交易结果，即超过半数共识的交易。默认不启用。

func WithEnableTxResultDispatcher 

func WithEnableTxResultDispatcher(enable bool) ChainClientOption

WithEnableTxResultDispatcher 设置是否启用 异步订阅机制获取交易结果。 默认不启用，如不启用将继续使用轮训机制获取交易结果。

func WithPkcs11Config 

func WithPkcs11Config(conf *Pkcs11Config) ChainClientOption

WithPkcs11Config 设置pkcs11配置

func WithRPCClientConfig 

func WithRPCClientConfig(conf *RPCClientConfig) ChainClientOption

WithRPCClientConfig 设置grpc客户端配置

func WithRetryInterval 

func WithRetryInterval(interval int) ChainClientOption

WithRetryInterval 设置 chain client 同步模式下，每次轮训交易结果时的等待时间，单位：ms

func WithRetryLimit 

func WithRetryLimit(limit int) ChainClientOption

WithRetryLimit 设置 chain client 同步模式下，轮训获取交易结果时的最大轮训次数

func WithUserCrtBytes 

func WithUserCrtBytes(userCrtBytes []byte) ChainClientOption

WithUserCrtBytes 添加用户证书文件内容配置

func WithUserCrtFilePath 

func WithUserCrtFilePath(userCrtFilePath string) ChainClientOption

WithUserCrtFilePath 添加用户证书文件路径配置

func WithUserEncKeyPwd 

func WithUserEncKeyPwd(pwd string) ChainClientOption

WithUserEncKeyPwd 配置国密双证书模式下用户私钥密码

func WithUserKeyBytes 

func WithUserKeyBytes(userKeyBytes []byte) ChainClientOption

WithUserKeyBytes 添加用户私钥文件内容配置

func WithUserKeyFilePath 

func WithUserKeyFilePath(userKeyFilePath string) ChainClientOption

WithUserKeyFilePath 添加用户私钥文件路径配置

func WithUserKeyPwd 

func WithUserKeyPwd(pwd string) ChainClientOption

WithUserKeyPwd 配置用户私钥密码

func WithUserSignCrtBytes 

func WithUserSignCrtBytes(userSignCrtBytes []byte) ChainClientOption

WithUserSignCrtBytes 添加用户签名证书文件内容配置

func WithUserSignCrtFilePath 

func WithUserSignCrtFilePath(userSignCrtFilePath string) ChainClientOption

WithUserSignCrtFilePath 添加用户签名证书文件路径配置

func WithUserSignKeyBytes 

func WithUserSignKeyBytes(userSignKeyBytes []byte) ChainClientOption

WithUserSignKeyBytes 添加用户签名私钥文件内容配置

func WithUserSignKeyFilePath 

func WithUserSignKeyFilePath(userSignKeyFilePath string) ChainClientOption

WithUserSignKeyFilePath 添加用户签名私钥文件路径配置

func WithUserSignKeyPwd 

func WithUserSignKeyPwd(pwd string) ChainClientOption

WithUserSignKeyPwd 配置用户签名私钥密码

type ClientConnectionPool 

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

ClientConnectionPool 客户端连接池结构定义

func NewConnPool 

func NewConnPool(config *ChainClientConfig) (*ClientConnectionPool, error)

NewConnPool 创建连接池

func NewConnPoolWithOptions 

func NewConnPoolWithOptions(opts ...ChainClientOption) (*ClientConnectionPool, error)

NewConnPoolWithOptions new conn pool with optioins, returns *ClientConnectionPool

func (*ClientConnectionPool) Close 

func (pool *ClientConnectionPool) Close() error

Close 关闭连接池

type ConnectionPool 

type ConnectionPool interface {
	Close() error
	// contains filtered or unexported methods
}

ConnectionPool grpc connection pool interface

type CryptoConfig 

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

CryptoConfig define crypto config

func NewCryptoConfig 

func NewCryptoConfig(opts ...CryptoOption) *CryptoConfig

NewCryptoConfig 根据传入参数创建新的CryptoConfig对象 @param opts @return *CryptoConfig

type CryptoOption 

type CryptoOption func(config *CryptoConfig)

CryptoOption define crypto option func

func WithHashAlgo 

func WithHashAlgo(hashType string) CryptoOption

WithHashAlgo 公钥模式下：添加用户哈希算法配置

type NodeConfig 

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

NodeConfig 节点配置

func NewNodeConfig 

func NewNodeConfig(opts ...NodeOption) *NodeConfig

NewNodeConfig new node config, returns *NodeConfig

type NodeOption 

type NodeOption func(config *NodeConfig)

NodeOption define node option func

func WithNodeAddr 

func WithNodeAddr(addr string) NodeOption

WithNodeAddr 设置节点地址

func WithNodeCACerts 

func WithNodeCACerts(caCerts []string) NodeOption

WithNodeCACerts 添加CA证书内容

func WithNodeCAPaths 

func WithNodeCAPaths(caPaths []string) NodeOption

WithNodeCAPaths 添加CA证书路径

func WithNodeConnCnt 

func WithNodeConnCnt(connCnt int) NodeOption

WithNodeConnCnt 设置节点连接数

func WithNodeTLSHostName 

func WithNodeTLSHostName(tlsHostName string) NodeOption

WithNodeTLSHostName use tls host name

func WithNodeUseTLS 

func WithNodeUseTLS(useTLS bool) NodeOption

WithNodeUseTLS 设置是否启动TLS开关

type PermissionedWithKeyModeSigner 

type PermissionedWithKeyModeSigner struct {
	PrivateKey crypto.PrivateKey
	HashType   crypto.HashType
	OrgId      string
}

PermissionedWithKeyModeSigner define a signer in PermissionedWithKey mode

func (*PermissionedWithKeyModeSigner) NewParticipant 

func (signer *PermissionedWithKeyModeSigner) NewParticipant() (*accesscontrol.Participant, error)

NewMember new *accesscontrol.Participant

func (*PermissionedWithKeyModeSigner) Sign 

func (signer *PermissionedWithKeyModeSigner) Sign(payload *common.Payload) ([]byte, error)

Sign sign payload

type Pkcs11Config 

type Pkcs11Config struct {
	// 是否开启pkcs11, 如果为 ture 则下面所有的字段都是必填
	Enabled bool
	// interface type of lib, support pkcs11 and sdf
	Type string
	// path to the .so file of pkcs11 interface
	Library string
	// label for the slot to be used
	Label string
	// password to logon the HSM(Hardware security module)
	Password string
	// size of HSM session cache
	SessionCacheSize int
	// hash algorithm used to compute SKI, eg, SHA256
	Hash string
}

Pkcs11Config pkcs11配置

func NewPkcs11Config 

func NewPkcs11Config(enabled bool, typ, libPath, label, password string,
	sessionCacheSize int, hashAlgo string) *Pkcs11Config

NewPkcs11Config new pkcs11 config

type PublicModeSigner 

type PublicModeSigner struct {
	PrivateKey crypto.PrivateKey
	HashType   crypto.HashType
}

PublicModeSigner define a signer in Public mode

func (*PublicModeSigner) NewParticipant 

func (signer *PublicModeSigner) NewParticipant() (*accesscontrol.Participant, error)

NewParticipant new *accesscontrol.Participant

func (*PublicModeSigner) Sign 

func (signer *PublicModeSigner) Sign(payload *common.Payload) ([]byte, error)

Sign sign payload

type RPCClientConfig 

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

RPCClientConfig RPC Client 链接配置

func NewRPCClientConfig 

func NewRPCClientConfig(opts ...RPCClientOption) *RPCClientConfig

NewRPCClientConfig new rpc client config

type RPCClientOption 

type RPCClientOption func(config *RPCClientConfig)

RPCClientOption define rpc client option func

func WithRPCClientGetTxTimeout 

func WithRPCClientGetTxTimeout(timeout int64) RPCClientOption

WithRPCClientGetTxTimeout 设置RPC Client的查询交易超时时间

func WithRPCClientMaxReceiveMessageSize 

func WithRPCClientMaxReceiveMessageSize(size int) RPCClientOption

WithRPCClientMaxReceiveMessageSize 设置RPC Client的Max Receive Message Size

func WithRPCClientMaxSendMessageSize 

func WithRPCClientMaxSendMessageSize(size int) RPCClientOption

WithRPCClientMaxSendMessageSize 设置RPC Client的Max Send Message Size

func WithRPCClientSendTxTimeout 

func WithRPCClientSendTxTimeout(timeout int64) RPCClientOption

WithRPCClientSendTxTimeout 设置RPC Client的发送交易超时时间

type SDKInterface 

type SDKInterface interface {
	// ## 1 用户合约接口
	// ### 1.1 创建合约待签名payload生成
	// **参数说明**
	//   - contractName: 合约名
	//   - version: 版本号
	//   - byteCodeStringOrFilePath: 支持传入合约二进制文件路径或Hex或Base64编码的string
	//   - runtime: 合约运行环境
	//   - kvs: 合约初始化参数
	// “`go
	CreateContractCreatePayload(contractName, version, byteCodeStringOrFilePath string, runtime common.RuntimeType,
		kvs []*common.KeyValuePair) (*common.Payload, error)

	// ### 1.2 升级合约待签名payload生成
	// **参数说明**
	//   - contractName: 合约名
	//   - version: 版本号
	//   - byteCodeStringOrFilePath: 支持传入合约二进制文件路径或Hex或Base64编码的string
	//   - runtime: 合约运行环境
	//   - kvs: 合约升级参数
	// “`go
	CreateContractUpgradePayload(contractName, version, byteCodeStringOrFilePath string, runtime common.RuntimeType,
		kvs []*common.KeyValuePair) (*common.Payload, error)

	// ### 1.3 冻结合约payload生成
	// **参数说明**
	//   - contractName: 合约名
	// “`go
	CreateContractFreezePayload(contractName string) (*common.Payload, error)

	// ### 1.4 解冻合约payload生成
	// **参数说明**
	//   - contractName: 合约名
	// “`go
	CreateContractUnfreezePayload(contractName string) (*common.Payload, error)

	// ### 1.5 吊销合约payload生成
	// **参数说明**
	//   - contractName: 合约名
	// “`go
	CreateContractRevokePayload(contractName string) (*common.Payload, error)

	// ### 1.6 合约管理获取Payload签名
	// **参数说明**
	//   - payload: 待签名payload
	// “`go
	SignContractManagePayload(payload *common.Payload) (*common.EndorsementEntry, error)

	// ### 1.7 发送合约管理请求（创建、更新、冻结、解冻、吊销）
	// **参数说明**
	//   - payload: 交易payload
	//   - endorsers: 背书签名信息列表
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	SendContractManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry, timeout int64,
		withSyncResult bool) (*common.TxResponse, error)

	// ### 1.8 合约调用
	// **参数说明**
	//   - contractName: 合约名称
	//   - method: 合约方法
	//   - txId: 交易ID
	//           格式要求：长度为64字节，字符在a-z0-9
	//           可为空，若为空字符串，将自动生成txId
	//   - kvs: 合约参数
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	//   - limit: transaction limitation，执行交易时的资源消耗上限，设为nil则不设置上限
	// “`go
	InvokeContract(contractName, method, txId string, kvs []*common.KeyValuePair, timeout int64,
		withSyncResult bool) (*common.TxResponse, error)
	InvokeContractWithLimit(contractName, method, txId string, kvs []*common.KeyValuePair, timeout int64,
		withSyncResult bool, limit *common.Limit) (*common.TxResponse, error)

	// ### 1.9 合约查询接口调用
	// **参数说明**
	//   - contractName: 合约名称
	//   - method: 合约方法
	//   - kvs: 合约参数
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	// “`go
	QueryContract(contractName, method string, kvs []*common.KeyValuePair, timeout int64) (*common.TxResponse, error)

	// ### 1.10 构造待发送交易体
	// **参数说明**
	//   - contractName: 合约名称
	//   - method: 合约方法
	//   - txId: 交易ID
	//           格式要求：长度为64字节，字符在a-z0-9
	//           可为空，若为空字符串，将自动生成txId
	//   - kvs: 合约参数
	// “`go
	GetTxRequest(contractName, method, txId string, kvs []*common.KeyValuePair) (*common.TxRequest, error)

	// ### 1.11 发送已构造好的交易体
	// **参数说明**
	//   - txRequest: 已构造好的交易体
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	SendTxRequest(txRequest *common.TxRequest, timeout int64, withSyncResult bool) (*common.TxResponse, error)

	// ## 2 系统合约接口
	// ### 2.1 根据交易Id查询交易
	// **参数说明**
	//   - txId: 交易ID
	// “`go
	GetTxByTxId(txId string) (*common.TransactionInfo, error)

	// ### 2.2 根据交易Id查询包含rwset的交易
	// **参数说明**
	//   - txId: 交易ID
	// “`go
	GetTxWithRWSetByTxId(txId string) (*common.TransactionInfoWithRWSet, error)

	// ### 2.3 根据区块高度查询区块
	// **参数说明**
	//   - blockHeight: 指定区块高度，若为-1，将返回最新区块
	//   - withRWSet: 是否返回读写集
	// “`go
	GetBlockByHeight(blockHeight uint64, withRWSet bool) (*common.BlockInfo, error)

	// ### 2.4 根据区块高度查询完整区块
	// **参数说明**
	//   - blockHeight: 指定区块高度，若为-1，将返回最新区块
	// “`go
	GetFullBlockByHeight(blockHeight uint64) (*store.BlockWithRWSet, error)

	// ### 2.5 根据区块哈希查询区块
	// **参数说明**
	//   - blockHash: 指定区块Hash
	//   - withRWSet: 是否返回读写集
	// “`go
	GetBlockByHash(blockHash string, withRWSet bool) (*common.BlockInfo, error)

	// ### 2.6 根据交易Id查询区块
	// **参数说明**
	//   - txId: 交易ID
	//   - withRWSet: 是否返回读写集
	// “`go
	GetBlockByTxId(txId string, withRWSet bool) (*common.BlockInfo, error)

	// ### 2.7 查询最新的配置块
	// **参数说明**
	//   - withRWSet: 是否返回读写集
	// “`go
	GetLastConfigBlock(withRWSet bool) (*common.BlockInfo, error)

	// ### 2.8 查询最新区块
	// **参数说明**
	//   - withRWSet: 是否返回读写集
	// “`go
	GetLastBlock(withRWSet bool) (*common.BlockInfo, error)

	// ### 2.9 查询节点加入的链信息
	//    - 返回ChainId清单
	// “`go
	GetNodeChainList() (*discovery.ChainList, error)

	// ### 2.10 查询链信息
	//   - 包括：当前链最新高度，链节点信息
	// “`go
	GetChainInfo() (*discovery.ChainInfo, error)

	// ### 2.11 根据交易Id获取区块高度
	// **参数说明**
	//   - txId: 交易ID
	// “`go
	GetBlockHeightByTxId(txId string) (uint64, error)

	// ### 2.12 根据区块Hash获取区块高度
	// **参数说明**
	//   - blockHash: 指定区块Hash
	// “`go
	GetBlockHeightByHash(blockHash string) (uint64, error)

	// ### 2.13 查询当前最新区块高度
	// “`go
	GetCurrentBlockHeight() (uint64, error)

	// ### 2.14 根据区块高度查询区块头
	// **参数说明**
	//   - blockHeight: 指定区块高度，若为-1，将返回最新区块头
	// “`go
	GetBlockHeaderByHeight(blockHeight uint64) (*common.BlockHeader, error)

	// ### 2.15 系统合约调用
	// **参数说明**
	//   - contractName: 合约名称
	//   - method: 合约方法
	//   - txId: 交易ID
	//           格式要求：长度为64字节，字符在a-z0-9
	//           可为空，若为空字符串，将自动生成txId
	//   - kvs: 合约参数
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	InvokeSystemContract(contractName, method, txId string, kvs []*common.KeyValuePair, timeout int64,
		withSyncResult bool) (*common.TxResponse, error)

	// ### 2.16 系统合约查询接口调用
	// **参数说明**
	//   - contractName: 合约名称
	//   - method: 合约方法
	//   - kvs: 合约参数
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	// “`go
	QuerySystemContract(contractName, method string, kvs []*common.KeyValuePair, timeout int64) (*common.TxResponse, error)

	// ### 2.17 根据交易Id获取Merkle路径
	// **参数说明**
	//   - txId: 交易ID
	// “`go
	GetMerklePathByTxId(txId string) ([]byte, error)

	// ### 2.18 开放系统合约
	// **参数说明**
	//   - grantContractList: 需要开放的系统合约字符串数组
	// “`go
	CreateSystemContractAccessGrantPayload(grantContractList []string) (*common.Payload, error)

	// ### 2.19 弃用系统合约
	// **参数说明**
	//   - revokeContractList: 需要弃用的系统合约字符串数组
	// “`go
	CreateSystemContractAccessRevokePayload(revokeContractList []string) (*common.Payload, error)

	// ### 2.20 查询指定合约的信息，包括系统合约和用户合约
	// **参数说明**
	//   - contractName: 指定查询的合约名字，包括系统合约和用户合约
	// “`go
	GetContractInfo(contractName string) (*common.Contract, error)

	// ### 2.21 查询所有的合约名单，包括系统合约和用户合约
	// **返回值说明**
	//   - []*common.Contract: 链上所有的合约列表，包括系统合约和用户合约
	// “`go
	GetContractList() ([]*common.Contract, error)

	// ### 2.22 查询已禁用的系统合约名单
	// **返回值说明**
	//   - []string: 链上已禁用的系统合约名字列表
	// “`go
	GetDisabledSystemContractList() ([]string, error)

	// ## 3 链配置接口
	// ### 3.1 查询最新链配置
	// “`go
	GetChainConfig() (*config.ChainConfig, error)

	// ### 3.2 根据指定区块高度查询最近链配置
	// **参数说明**
	//   - blockHeight: 指定区块高度
	//     如果当前区块就是配置块，直接返回当前区块的链配置
	// “`go
	GetChainConfigByBlockHeight(blockHeight uint64) (*config.ChainConfig, error)

	// ### 3.3 查询最新链配置序号Sequence
	//   - 用于链配置更新
	// “`go
	GetChainConfigSequence() (uint64, error)

	// ### 3.4 链配置更新获取Payload签名
	// **参数说明**
	//   - payload: 待签名payload
	// “`go
	SignChainConfigPayload(payload *common.Payload) (*common.EndorsementEntry, error)

	// ### 3.5 发送链配置更新请求
	// **参数说明**
	//   - payload: 待签名payload
	//   - endorsers: 背书签名信息列表
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	SendChainConfigUpdateRequest(payload *common.Payload, endorsers []*common.EndorsementEntry, timeout int64,
		withSyncResult bool) (*common.TxResponse, error)

	// ### 3.6 更新Core模块待签名payload生成
	// **参数说明**
	//   - txSchedulerTimeout: 交易调度器从交易池拿到交易后, 进行调度的时间，其值范围为(0, 60], 若设置为0，则抛出错误
	//   - txSchedulerValidateTimeout: 交易调度器从区块中拿到交易后, 进行验证的超时时间，其值范围为(0, 60], 若设置为0，则抛出错误
	// “`go
	CreateChainConfigCoreUpdatePayload(txSchedulerTimeout, txSchedulerValidateTimeout uint64) (*common.Payload, error)

	// ### 3.7 更新链配置的区块相关参数待签名payload生成
	// **参数说明**
	//   - txTimestampVerify: 是否需要开启交易时间戳校验
	//   - (以下参数，若无需修改，请置为-1)
	//   - txTimeout: 交易时间戳的过期时间(秒)，其值范围为[600, +∞)
	//   - blockTxCapacity: 区块中最大交易数，其值范围为(0, +∞]
	//   - blockSize: 区块最大限制，单位MB，其值范围为(0, +∞]
	//   - blockInterval: 出块间隔，单位:ms，其值范围为[10, +∞]
	//   - txParamterSize: 交易的参数的最大值限制，单位：MB，其值范围为[0,100]
	// “`go
	CreateChainConfigBlockUpdatePayload(txTimestampVerify bool, txTimeout, blockTxCapacity, blockSize,
		blockInterval, txParamterSize uint32) (*common.Payload, error)

	// ### 3.8 添加信任组织根证书待签名payload生成
	// **参数说明**
	//   - trustRootOrgId: 组织Id
	//   - trustRootCrt: 根证书
	// “`go
	CreateChainConfigTrustRootAddPayload(trustRootOrgId string, trustRootCrt []string) (*common.Payload, error)

	// ### 3.9 更新信任组织根证书待签名payload生成
	// **参数说明**
	//   - trustRootOrgId: 组织Id
	//   - trustRootCrt: 根证书
	// “`go
	CreateChainConfigTrustRootUpdatePayload(trustRootOrgId string, trustRootCrt []string) (*common.Payload, error)

	// ### 3.10 删除信任组织根证书待签名payload生成
	// **参数说明**
	//   - trustRootOrgId: 组织Id
	// “`go
	CreateChainConfigTrustRootDeletePayload(trustRootOrgId string) (*common.Payload, error)

	// ### 3.11 添加信任成员证书待签名payload生成
	// **参数说明**
	//   - trustParticipantOrgId: 组织Id
	//   - trustParticipantNodeId: 节点Id
	//   - trustParticipantRole: 成员角色
	//   - trustParticipantInfo: 成员信息内容
	// “`go
	CreateChainConfigTrustParticipantAddPayload(trustParticipantOrgId, trustParticipantNodeId,
		trustParticipantRole, trustParticipantInfo string) (*common.Payload, error)

	// ### 3.12 删除信任成员证书待签名payload生成
	// **参数说明**
	//   - trustParticipantInfo: 成员信息内容
	// “`go
	CreateChainConfigTrustParticipantDeletePayload(trustParticipantInfo string) (*common.Payload, error)

	// ### 3.13 添加权限配置待签名payload生成
	// **参数说明**
	//   - permissionResourceName: 权限名
	//   - policy: 权限规则
	// “`go
	CreateChainConfigPermissionAddPayload(permissionResourceName string,
		policy *accesscontrol.Policy) (*common.Payload, error)

	// ### 3.14 更新权限配置待签名payload生成
	// **参数说明**
	//   - permissionResourceName: 权限名
	//   - policy: 权限规则
	// “`go
	CreateChainConfigPermissionUpdatePayload(permissionResourceName string,
		policy *accesscontrol.Policy) (*common.Payload, error)

	// ### 3.15 删除权限配置待签名payload生成
	// **参数说明**
	//   - permissionResourceName: 权限名
	// “`go
	CreateChainConfigPermissionDeletePayload(permissionResourceName string) (*common.Payload, error)

	// ### 3.16 添加共识节点地址待签名payload生成
	// **参数说明**
	//   - nodeOrgId: 节点组织Id
	//   - nodeIds: 节点Id
	// “`go
	CreateChainConfigConsensusNodeIdAddPayload(nodeOrgId string, nodeIds []string) (*common.Payload, error)

	// ### 3.17 更新共识节点地址待签名payload生成
	// **参数说明**
	//   - nodeOrgId: 节点组织Id
	//   - nodeOldNodeId: 节点原Id
	//   - nodeNewNodeId: 节点新Id
	// “`go
	CreateChainConfigConsensusNodeIdUpdatePayload(nodeOrgId, nodeOldNodeId, nodeNewNodeId string) (*common.Payload, error)

	// ### 3.18 删除共识节点地址待签名payload生成
	// **参数说明**
	//   - nodeOrgId: 节点组织Id
	//   - nodeId: 节点Id
	// “`go
	CreateChainConfigConsensusNodeIdDeletePayload(nodeOrgId, nodeId string) (*common.Payload, error)

	// ### 3.19 添加共识节点待签名payload生成
	// **参数说明**
	//   - nodeOrgId: 节点组织Id
	//   - nodeIds: 节点Id
	// “`go
	CreateChainConfigConsensusNodeOrgAddPayload(nodeOrgId string, nodeIds []string) (*common.Payload, error)

	// ### 3.20 更新共识节点待签名payload生成
	// **参数说明**
	//   - nodeOrgId: 节点组织Id
	//   - nodeIds: 节点Id
	// “`go
	CreateChainConfigConsensusNodeOrgUpdatePayload(nodeOrgId string, nodeIds []string) (*common.Payload, error)

	// ### 3.21 删除共识节点待签名payload生成
	// **参数说明**
	//   - nodeOrgId: 节点组织Id
	// “`go
	CreateChainConfigConsensusNodeOrgDeletePayload(nodeOrgId string) (*common.Payload, error)

	// ### 3.22 添加共识扩展字段待签名payload生成
	// **参数说明**
	//   - kvs: 字段key、value对
	// “`go
	CreateChainConfigConsensusExtAddPayload(kvs []*common.KeyValuePair) (*common.Payload, error)

	// ### 3.23 更新共识扩展字段待签名payload生成
	// **参数说明**
	//   - kvs: 字段key、value对
	// “`go
	CreateChainConfigConsensusExtUpdatePayload(kvs []*common.KeyValuePair) (*common.Payload, error)

	// ### 3.24 删除共识扩展字段待签名payload生成
	// **参数说明**
	//   - keys: 待删除字段
	// “`go
	CreateChainConfigConsensusExtDeletePayload(keys []string) (*common.Payload, error)

	// ### 3.25 修改地址类型payload生成
	// **参数说明**
	//   - addrType: 地址类型，0-Herbt
	// “`go
	CreateChainConfigAlterAddrTypePayload(addrType string) (*common.Payload, error)

	// ### 3.26 启用或停用Gas计费开关payload生成
	// “`go
	CreateChainConfigEnableOrDisableGasPayload() (*common.Payload, error)

	// ### 3.27 开启或关闭链配置的Gas优化payload生成
	// “`go
	CreateChainConfigOptimizeChargeGasPayload(enable bool) (*common.Payload, error)

	// ### 3.28  查询最新权限配置列表
	// “`go
	GetChainConfigPermissionList() ([]*config.ResourcePolicy, error)

	// ## 4 证书管理接口
	// ### 4.1 用户证书添加
	// **参数说明**
	//   - 在common.TxResponse.ContractResult.Result字段中返回成功添加的certHash
	// “`go
	AddCert() (*common.TxResponse, error)

	// ### 4.2 用户证书删除
	// **参数说明**
	//   - certHashes: 证书Hash列表
	// “`go
	DeleteCert(certHashes []string) (*common.TxResponse, error)

	// ### 4.3 用户证书查询
	// **参数说明**
	//   - certHashes: 证书Hash列表
	// **返回值说明**
	//   - *common.CertInfos: 包含证书Hash和证书内容的列表
	// “`go
	QueryCert(certHashes []string) (*common.CertInfos, error)

	// ### 4.4 获取用户证书哈希
	// “`go
	GetCertHash() ([]byte, error)

	// ### 4.5 生成证书管理操作Payload（三合一接口）
	// **参数说明**
	//   - method: CERTS_FROZEN(证书冻结)/CERTS_UNFROZEN(证书解冻)/CERTS_REVOCATION(证书吊销)
	//   - kvs: 证书管理操作参数
	// “`go
	CreateCertManagePayload(method string, kvs []*common.KeyValuePair) *common.Payload

	// ### 4.6 生成证书冻结操作Payload
	// **参数说明**
	//   - certs: X509证书列表
	// “`go
	CreateCertManageFrozenPayload(certs []string) *common.Payload

	// ### 4.7 生成证书解冻操作Payload
	// **参数说明**
	//   - certs: X509证书列表
	// “`go
	CreateCertManageUnfrozenPayload(certs []string) *common.Payload

	// ### 4.8 生成证书吊销操作Payload
	// **参数说明**
	//   - certs: X509证书列表
	// “`go
	CreateCertManageRevocationPayload(certCrl string) *common.Payload

	// ### 4.9 待签payload签名
	//  *一般需要使用具有管理员权限账号进行签名*
	// **参数说明**
	//   - payload: 待签名payload
	// “`go
	SignCertManagePayload(payload *common.Payload) (*common.EndorsementEntry, error)

	// ### 4.10 发送证书管理请求（证书冻结、解冻、吊销）
	// **参数说明**
	//   - payload: 交易payload
	//   - endorsers: 背书签名信息列表
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	SendCertManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry, timeout int64,
		withSyncResult bool) (*common.TxResponse, error)

	// ## 5 消息订阅接口
	// ### 5.1 区块订阅
	// **参数说明**
	//   - startBlock: 订阅起始区块高度，若为-1，表示订阅实时最新区块
	//   - endBlock: 订阅结束区块高度，若为-1，表示订阅实时最新区块
	//   - withRwSet: 是否返回读写集
	//   - onlyHeader: 若设置为true，将忽略withRwSet选项，仅返回区块头（common.BlockHeader）,若设置为false，将返回common.BlockInfo
	// “`go
	SubscribeBlock(ctx context.Context, startBlock, endBlock int64, withRWSet, onlyHeader bool) (<-chan interface{}, error)

	// ### 5.2 交易订阅
	// **参数说明**
	//   - startBlock: 订阅起始区块高度，若为-1，表示订阅实时最新区块
	//   - endBlock: 订阅结束区块高度，若为-1，表示订阅实时最新区块
	//   - contractName ：指定订阅指定合约的交易，可以传用户合约名称或系统合约名称，若为空，表示订阅所有合约的交易
	//   - txIds: 订阅txId列表，若为空，表示订阅所有txId
	// “`go
	SubscribeTx(ctx context.Context, startBlock, endBlock int64, contractName string,
		txIds []string) (<-chan interface{}, error)

	// ### 5.3 合约事件订阅
	// **参数说明**
	//   - startBlock: 订阅起始区块高度，若为-1，表示订阅实时最新区块
	//   - endBlock: 订阅结束区块高度，若为-1，表示订阅实时最新区块
	//   - contractName ：指定订阅的合约名称
	//   - topic ：指定订阅主题
	// “`go
	SubscribeContractEvent(ctx context.Context, startBlock, endBlock int64, contractName,
		topic string) (<-chan interface{}, error)

	// ### 5.4 多合一订阅
	// **参数说明**
	//   - txType: 订阅交易类型，目前已支持：区块消息订阅(common.TxType_SUBSCRIBE_BLOCK_INFO)、交易消息订阅(common.TxType_SUBSCRIBE_TX_INFO)
	//   - payloadBytes: 消息订阅参数payload
	// “`go
	Subscribe(ctx context.Context, payloadBytes *common.Payload) (<-chan interface{}, error)

	// ## 6 证书压缩
	// *开启证书压缩可以减小交易包大小，提升处理性能*
	// ### 6.1 启用压缩证书功能
	// “`go
	EnableCertHash() error

	// ### 6.2 停用压缩证书功能
	// “`go
	DisableCertHash() error

	// ## 7 层级属性加密类接口
	// > 注意：层级属性加密模块 `Id` 使用 `/` 作为分隔符，例如： Org1/Ou1/Participant1
	// ### 7.1 生成层级属性参数初始化交易 payload
	// **参数说明**
	//   - orgId: 参与方组织 id
	//   - hibeParams: 传入序列化后的hibeParams byte数组
	// “`go
	CreateHibeInitParamsTxPayloadParams(orgId string, hibeParams []byte) ([]*common.KeyValuePair, error)

	// ### 7.2 生成层级属性加密交易 payload，加密参数已知
	// **参数说明**
	//   - plaintext: 待加密交易消息明文
	//   - receiverIds: 消息接收者 id 列表，需和 paramsList 一一对应
	//   - paramsBytesList: 消息接收者对应的加密参数，需和 receiverIds 一一对应
	//   - txId: 以交易 Id 作为链上存储 hibeMsg 的 Key, 如果不提供存储的信息可能被覆盖
	//   - keyType: 对明文进行对称加密的方法，请传入 common 中 crypto 包提供的方法，目前提供AES和SM4两种方法
	// “`go
	CreateHibeTxPayloadParamsWithHibeParams(plaintext []byte, receiverIds []string, paramsBytesList [][]byte, txId string,
		keyType crypto.KeyType) ([]*common.KeyValuePair, error)

	// ### 7.3 生成层级属性加密交易 payload，参数由链上查询得出
	// **参数说明**
	//   - contractName: 合约名
	//   - queryParamsMethod: 链上查询 hibe.Params 的合约方法
	//   - plaintext: 待加密交易消息明文
	//   - receiverIds: 消息接收者 id 列表，需和 paramsList 一一对应
	//   - paramsList: 消息接收者对应的加密参数，需和 receiverIds 一一对应
	//   - receiverOrgIds: 链上查询 hibe Params 的 Key 列表，需要和 receiverIds 一一对应
	//   - txId: 以交易 Id 作为链上存储 hibeMsg 的 Key, 如果不提供存储的信息可能被覆盖
	//   - keyType: 对明文进行对称加密的方法，请传入 common 中 crypto 包提供的方法，目前提供AES和SM4两种方法
	//   - timeout: （内部查询 HibeParams 的）超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	// “`go
	CreateHibeTxPayloadParamsWithoutHibeParams(contractName, queryParamsMethod string, plaintext []byte,
		receiverIds []string, receiverOrgIds []string, txId string, keyType crypto.KeyType,
		timeout int64) ([]*common.KeyValuePair, error)

	// ### 7.4 查询某一组织的加密公共参数，返回其序列化后的byte数组
	// **参数说明**
	//   - contractName: 合约名
	//   - method: 查询的合约方法名
	//   - orgId: 参与方 id
	//   - timeout: 查询超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	// “`go
	QueryHibeParamsWithOrgId(contractName, method, orgId string, timeout int64) ([]byte, error)

	// ### 7.5 已知交易id，根据私钥解密密文交易
	// **参数说明**
	//   - localId: 本地层级属性加密 id
	//   - hibeParams: hibeParams 序列化后的byte数组
	//   - hibePrivKey: hibe私钥序列化后的byte数组
	//   - txId: 层级属性加密交易 id
	//   - keyType: 对加密信息进行对称解密的方法，请和加密时使用的方法保持一致，请传入 common 中 crypto 包提供的方法，目前提供AES和SM4两种方法
	// “`go
	DecryptHibeTxByTxId(localId string, hibeParams []byte, hibePrvKey []byte, txId string,
		keyType crypto.KeyType) ([]byte, error)

	// ## 8 数据归档接口
	// **（注意：请使用归档工具cmc进行归档操作，以下接口是归档原子接口，并不包括归档完整流程）**
	// ### 8.1 获取已归档区块高度
	// **参数说明**
	//   - 输出已归档的区块高度
	// “`go
	GetArchivedBlockHeight() (uint64, error)

	// ### 8.2 构造数据归档区块Payload
	// **参数说明**
	//   - targetBlockHeight: 归档目标区块高度
	// “`go
	CreateArchiveBlockPayload(targetBlockHeight uint64) (*common.Payload, error)

	// ### 8.3 构造归档数据恢复Payload
	// **参数说明**
	//   - fullBlock: 完整区块数据（对应结构：store.BlockWithRWSet）
	// “`go
	CreateRestoreBlockPayload(fullBlock []byte) (*common.Payload, error)

	// ### 8.4 获取归档操作Payload签名
	// **参数说明**
	//   - payload: 指向payload对象的指针
	// “`go
	SignArchivePayload(payload *common.Payload) (*common.Payload, error)

	// ### 8.5 发送归档请求
	// **参数说明**
	//   - payload: 指向payload对象的指针
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	// “`go
	SendArchiveBlockRequest(payload *common.Payload, timeout int64) (*common.TxResponse, error)

	// ### 8.6 归档数据恢复
	// **参数说明**
	//   - payload: 指向payload对象的指针
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	// “`go
	SendRestoreBlockRequest(payload *common.Payload, timeout int64) (*common.TxResponse, error)

	// ### 8.7 根据交易Id查询已归档交易
	// **参数说明**
	//   - txId: 交易ID
	// “`go
	GetArchivedTxByTxId(txId string) (*common.TransactionInfo, error)

	// ### 8.8 根据区块高度查询已归档区块
	// **参数说明**
	//   - blockHeight: 指定区块高度
	//   - withRWSet: 是否返回读写集
	// “`go
	GetArchivedBlockByHeight(blockHeight uint64, withRWSet bool) (*common.BlockInfo, error)

	// ### 8.9 根据区块高度查询已归档完整区块(包含：区块数据、读写集、合约事件日志)
	// **参数说明**
	//   - blockHeight: 指定区块高度
	// “`go
	GetArchivedFullBlockByHeight(blockHeight uint64) (*store.BlockWithRWSet, error)

	// ### 8.10 根据区块哈希查询已归档区块
	// **参数说明**
	//   - blockHash: 指定区块Hash
	//   - withRWSet: 是否返回读写集
	// “`go
	GetArchivedBlockByHash(blockHash string, withRWSet bool) (*common.BlockInfo, error)

	// ### 8.11 根据交易Id查询已归档区块
	// **参数说明**
	//   - txId: 交易ID
	//   - withRWSet: 是否返回读写集
	// “`go
	GetArchivedBlockByTxId(txId string, withRWSet bool) (*common.BlockInfo, error)

	// ## 9 系统类接口
	// ### 9.1 SDK停止接口
	// *关闭连接池连接，释放资源*
	// “`go
	Stop() error

	// ### 9.2 获取链版本
	// “`go
	GetHerbtServerVersion() (string, error)

	// ## 10 公钥身份类接口
	// ### 10.1 构造添加公钥身份请求
	// **参数说明**
	//   - pubkey: 公钥信息
	//   - orgId: 组织id
	//   - role:   角色，支持client,light,common
	// “`go
	CreatePubkeyAddPayload(pubkey string, orgId string, role string) (*common.Payload, error)

	// ### 10.2 构造删除公钥身份请求
	// **参数说明**
	//   - pubkey: 公钥信息
	//   - orgId: 组织id
	// “`go
	CreatePubkeyDelPayload(pubkey string, orgId string) (*common.Payload, error)

	// ### 10.3 构造查询公钥身份请求
	// **参数说明**
	//   - pubkey: 公钥信息
	// “`go
	CreatePubkeyQueryPayload(pubkey string) (*common.Payload, error)

	// ### 10.4 发送公钥身份管理请求（添加、删除）
	// **参数说明**
	//   - payload: 交易payload
	//   - endorsers: 背书签名信息列表
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	SendPubkeyManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry, timeout int64,
		withSyncResult bool) (*common.TxResponse, error)

	// ## 11 多签类接口
	// ### 11.1 发起多签请求
	// **参数说明**
	//   - payload: 待签名payload
	// “`go
	MultiSignContractReq(payload *common.Payload) (*common.TxResponse, error)

	// ### 11.2 发起多签投票
	// **参数说明**
	//   - payload: 待签名payload
	//   - endorser: 投票人对多签请求 payload 的签名信息
	//   - isAgree: 投票人对多签请求是否同意，true为同意，false则反对
	// “`go
	MultiSignContractVote(payload *common.Payload,
		endorser *common.EndorsementEntry, isAgree bool) (*common.TxResponse, error)

	// ### 11.3 根据txId查询多签状态
	// **参数说明**
	//   - txId: 需要查询的多签请求交易Id
	// “`go
	MultiSignContractQuery(txId string) (*common.TxResponse, error)

	// ### 11.4 根据发起多签请求所需的参数构建payload
	// **参数说明**
	//   - pairs: 发起多签请求所需的参数
	// “`go
	CreateMultiSignReqPayload(pairs []*common.KeyValuePair) *common.Payload

	// ## 12 gas管理相关接口
	// ### 12.1 构造设置gas管理员payload
	// **参数说明**
	//   - address: gas管理员的地址
	// “`go
	CreateSetGasAdminPayload(address string) (*common.Payload, error)

	// ### 12.2 查询gas管理员
	// **返回值说明**
	//   - string: gas管理员的账号地址
	// “`go
	GetGasAdmin() (string, error)

	// ### 12.3 构造 充值gas账户 payload
	// **参数说明**
	//   - rechargeGasList: 一个或多个gas账户充值指定gas数量
	// “`go
	CreateRechargeGasPayload(rechargeGasList []*syscontract.RechargeGas) (*common.Payload, error)

	// ### 12.4 查询gas账户余额
	// **参数说明**
	//   - address: 查询gas余额的账户地址
	// “`go
	GetGasBalance(address string) (int64, error)

	// ### 12.5 构造 退还gas账户的gas payload
	// **参数说明**
	//   - address: 退还gas的账户地址
	//   - amount: 退还gas的数量
	// “`go
	CreateRefundGasPayload(address string, amount int64) (*common.Payload, error)

	// ### 12.6 构造 冻结指定gas账户 payload
	// **参数说明**
	//   - address: 冻结指定gas账户的账户地址
	// “`go
	CreateFrozenGasAccountPayload(address string) (*common.Payload, error)

	// ### 12.7 构造 解冻指定gas账户 payload
	// **参数说明**
	//   - address: 解冻指定gas账户的账户地址
	// “`go
	CreateUnfrozenGasAccountPayload(address string) (*common.Payload, error)

	// ### 12.8 查询gas账户的状态
	// **参数说明**
	//   - address: 解冻指定gas账户的账户地址
	// **返回值说明**
	//   - bool: true表示账号未被冻结，false表示账号已被冻结
	// “`go
	GetGasAccountStatus(address string) (bool, error)

	// ### 12.9 发送gas管理类请求
	// **参数说明**
	//   - payload: 交易payload
	//   - endorsers: 背书签名信息列表
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	SendGasManageRequest(payload *common.Payload, endorsers []*common.EndorsementEntry, timeout int64,
		withSyncResult bool) (*common.TxResponse, error)

	// ### 12.10 为payload添加gas limit
	// **参数说明**
	//   - payload: 交易payload
	//   - limit: transaction limitation，执行交易时的资源消耗上限
	// “`go
	AttachGasLimit(payload *common.Payload, limit *common.Limit) *common.Payload

	// ### 12.11 估算交易的gas消耗量
	// **参数说明**
	//   - payload: 待估算gas消耗量的交易payload
	// **返回值说明**
	//   - uint64: 估算出的gas消耗量
	// “`go
	EstimateGas(payload *common.Payload) (uint64, error)

	// ### 12.12 构造 配置账户基础gas消耗数量 payload
	// **参数说明**
	//   - amount: 基础gas消耗数量
	// “`go
	CreateSetInvokeBaseGasPayload(amount int64) (*common.Payload, error)

	// ## 13 别名相关接口
	// ### 13.1 添加别名
	// “`go
	AddAlias() (*common.TxResponse, error)

	// ### 13.2 构造`更新别名的证书`payload
	// **参数说明**
	//   - alias: 带更新证书的别名
	//   - newCertPEM: 新的证书，此新证书将替换掉alias关联的证书
	// “`go
	CreateUpdateCertByAliasPayload(alias, newCertPEM string) *common.Payload

	// ### 13.3 签名`更新别名的证书`payload
	// **参数说明**
	//   - payload: 交易payload
	// “`go
	SignUpdateCertByAliasPayload(payload *common.Payload) (*common.EndorsementEntry, error)

	// ### 13.4 发起`更新别名的证书`交易
	// **参数说明**
	//   - payload: 交易payload
	//   - endorsers: 背书签名信息列表
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	UpdateCertByAlias(payload *common.Payload, endorsers []*common.EndorsementEntry,
		timeout int64, withSyncResult bool) (*common.TxResponse, error)

	// ### 13.5 查询别名详细信息
	// **参数说明**
	//   - aliases: 带查询的证书别名切片，根据这些别名查询返回AliasInfos
	// “`go
	QueryCertsAlias(aliases []string) (*common.AliasInfos, error)

	// ### 13.6 构造`删除别名`payload
	// **参数说明**
	//   - aliases: 带删除的证书别名切片
	// “`go
	CreateDeleteCertsAliasPayload(aliases []string) *common.Payload

	// ### 13.7 签名`删除别名`payload
	// **参数说明**
	//   - payload: 交易payload
	// “`go
	SignDeleteAliasPayload(payload *common.Payload) (*common.EndorsementEntry, error)

	// ### 13.8 发起`删除别名`交易
	// **参数说明**
	//   - payload: 交易payload
	//   - endorsers: 背书签名信息列表
	//   - timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s
	//   - withSyncResult: 是否同步获取交易执行结果
	//            当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo
	//            当为false时，若成功调用，common.TxResponse.ContractResult为空，可以通过common.TxResponse.TxId查询交易结果
	// “`go
	DeleteCertsAlias(payload *common.Payload, endorsers []*common.EndorsementEntry,
		timeout int64, withSyncResult bool) (*common.TxResponse, error)

	// ## 14 交易池相关接口
	// ### 14.1 获取交易池状态
	// “`go
	GetPoolStatus() (*txpool.TxPoolStatus, error)

	// ### 14.2 获取不同交易类型和阶段中的交易Id列表。
	// **参数说明**
	//   - txType: 交易类型 在pb的txpool包中进行了定义
	//   - txStage: 交易阶段 在pb的txpool包中进行了定义
	// **返回值说明**
	//   - []string: 交易Id列表
	// “`go
	GetTxIdsByTypeAndStage(txType txpool.TxType, txStage txpool.TxStage) ([]string, error)

	// ### 14.3 根据txIds获取交易池中存在的txs，并返回交易池缺失的tx的txIds
	// **参数说明**
	//   - txIds: 交易Id列表
	// **返回值说明**
	//   - []*common.Transaction: 交易池中存在的txs
	//   - []string: 交易池缺失的tx的txIds
	// “`go
	GetTxsInPoolByTxIds(txIds []string) ([]*common.Transaction, []string, error)
}

SDKInterface # Herbt Go SDK 接口说明

type Signer 

type Signer interface {
	// Sign sign payload
	Sign(payload *common.Payload) (signature []byte, err error)
	// NewParticipant new *accesscontrol.Participant
	NewParticipant() (*accesscontrol.Participant, error)
}

Signer define interface of all kinds of signer in different mode

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.