Documentation
This is an automatically generated documentation for Documentation.
Namespaces
\Bloock
Classes
| Class | Description |
|---|---|
Bloock | Provides a centralized configuration for the Bloock SDK library. For information about Bloock SDK in Go, see https://bloock.com. |
\Bloock\Client
Classes
| Class | Description |
|---|---|
AuthenticityClient | Represents a client for interacting with the Bloock Authenticity service. |
AvailabilityClient | Represents a client for interacting with the Bloock Availability service. |
EncryptionClient | Represents a client for interacting with the Bloock Encryption service. |
IdentityClient | Represents a client for interacting with the Bloock Identity service. |
IdentityCoreClient | Represents a client for interacting with the Bloock Identity service. |
IntegrityClient | Provides functionality to interact with the Bloock Integrity service. |
KeyClient | Provides functionality to interact with the Bloock Keys service. |
RecordBuilder | Assists in constructing records with various configurations. |
RecordClient | Provides functionality for creating records using various data sources and to interact with the Bloock Record service. |
WebhookClient | Provides functionality for interacting with Bloock webhooks. |
\Bloock\Config
Classes
| Class | Description |
|---|---|
Config |
\Bloock\Entity\Authenticity
Classes
| Class | Description |
|---|---|
HashAlg | Represents different hash algorithms. |
Signature | Represents a cryptographic signature along with additional metadata. |
SignatureAlg | Represents different signature algorithms. |
SignatureHeaderJws | Represents the header of a JSON Web Signature (JWS). RFC 7515. |
SignatureJws | Represents a JSON Web Signature (JWS). RFC 7515. |
Signer | Represents a signer with various key types and additional configurations. |
\Bloock\Entity\Availability
Classes
| Class | Description |
|---|---|
HostedLoader | Represents a loader for hosted data availability. |
HostedPublisher | Represents a publisher for hosted data availability. |
IpfsLoader | Represents a loader for IPFS data availability. |
IpfsPublisher | Represents a publisher for IPFS data availability. |
LoaderArgs | Represents the arguments for a data loader. |
PublisherArgs | Represents the arguments for a data publisher. |
Interfaces
| Interface | Description |
|---|---|
Loader | |
Publisher |
\Bloock\Entity\Encryption
Classes
| Class | Description |
|---|---|
Encrypter | Represents an encryption configuration with various key types and access control. |
EncryptionAlg | Represents encryption algorithm types. |
\Bloock\Entity\Identity
Classes
| Class | Description |
|---|---|
Attribute | Represents an attribute with an identifier and a corresponding value. |
AttributeDescriptor | Represents a descriptor for an attribute. |
BooleanAttribute | Represents an attribute with a boolean value. |
BooleanAttributeDescriptor | Represents a descriptor for a boolean attribute. |
Credential | Represents a verifiable credential with its associated information. Verifiable Credentials Data Model v2.0. |
CredentialBuilder | Helps construct credentials by specifying various attributes. |
CredentialCoreBuilder | Helps construct credentials by specifying various attributes. |
CredentialProof | Represents the proof associated with a credential, including signature and sparse merkle tree proof. |
CredentialReceipt | Represents a receipt for a credential, including the credential itself, its ID, and type. |
CredentialSchema | Represents the schema information for a credential, including its ID and type. |
CredentialStatus | Represents the status information for a credential, including its ID, revocation nonce, and type. |
DateAttribute | Represents an attribute with a date value, including its key and formatted value. |
DateAttributeDescriptor | Represents a descriptor for a date attribute, including its display name, ID, description, and required status. |
DatetimeAttribute | Represents an attribute with a datetime value. |
DatetimeAttributeDescriptor | Represents a descriptor for an attribute with a datetime value. |
DecimalAttribute | Represents an attribute with a decimal value. |
DecimalAttributeDescriptor | Represents a descriptor for an attribute with a decimal value. |
DecimalEnumAttributeDescriptor | Represents a descriptor for an attribute with a decimal enum value. |
Did | Represents a DID. |
DidMethod | Represents the type of method did. |
Holder | Represents a Holder identity. |
IntegerAttribute | Represents an attribute with an integer value. |
IntegerAttributeDescriptor | Represents a descriptor for an attribute with an integer value. |
IntegerEnumAttributeDescriptor | Represents a descriptor for an attribute with an integer enum value. |
Issuer | Represents an Issuer identity. |
IssuerStateReceipt | Represents a receipt for the issuer's state. |
PublishIntervalParams | Represents different publish intervals. |
Schema | Represents a schema with its attributes. |
SchemaBuilder | Is a builder pattern for constructing schema instances. |
StringAttribute | Represents an attribute with a string value. |
StringAttributeDescriptor | Represents a descriptor for an attribute with a string value. |
StringEnumAttributeDescriptor | Represents a descriptor for an attribute with a string enum value. |
VerificationReceipt | Represents a receipt for a verification session. |
\Bloock\Entity\Integrity
Classes
| Class | Description |
|---|---|
Anchor | Represents information about an anchor. |
AnchorNetwork | Represents information about an anchor network. |
Network | Represents a network. |
Proof | Represents a proof, including leaves, nodes, depth, bitmap, and anchor information. |
ProofAnchor | Represents a proof anchor. |
RecordReceipt | Represents a receipt for a record, including anchor ID, client, record, and status information. |
\Bloock\Entity\Key
Classes
| Class | Description |
|---|---|
AccessControl | Represents access control information, including Time-based One-Time Password (TOTP) and secret-based access. |
AccessControlSecret | Represents a secret used for secret-based access control. |
AccessControlTotp | Represents a Time-based One-Time Password (TOTP) code used for access control. |
AccessControlType | Represents the access control type a cryptographic key. |
CertificateType | Represents the type of certificate. |
EcdsaKeyPair | Represents an ecdsa key pair, with private and public key. |
ImportCertificateParams | Represents the parameters for importing a certificate. |
Key | Represents a key entity that can be either a ManagedKey or a LocalKey. |
KeyPair | Represents a pair of public and private keys. |
KeyProtectionLevel | Represents the protection level of a cryptographic key. |
KeyType | Represents the type of cryptographic key. |
LocalCertificate | Represents a local certificate along with its password. |
LocalCertificateArgs | Represents the parameters for generating a local certificate. |
LocalKey | Represents a local key with its public and private components. |
Managed | Represents a managed entity that can be either a ManagedKey or a ManagedCertificate. |
ManagedCertificate | Represents a managed certificate with its details. |
ManagedCertificateParams | Represents parameters for creating a managed certificate. |
ManagedKey | Represents a managed key. |
ManagedKeyParams | Represents the parameters for creating a managed key. |
RsaKeyPair | Represents a rsa key pair, with private and public key. |
SubjectCertificateParams | Represents parameters for generating a subject certificate. |
TotpAccessControlReceipt | Represents a receipt for a Time-based One-Time Password (TOTP) access control. |
\Bloock\Entity\Record
Classes
| Class | Description |
|---|---|
AuthenticityDetails | Represents details related to the authenticity of a record, including signatures. |
AvailabilityDetails | Represents details related to the availability of a record, including content type and size. |
EncryptionDetails | Represents details related to the encryption of a record, including algorithm, key, and subject. |
IntegrityDetails | Represents details related to the integrity of a record, including hash and proof. |
Record | Represents a record with payload, hash, and configuration data. |
RecordDetails | Represents all details related to a record, including integrity, authenticity, encryption, and availability details. |
Automatically generated on 2024-04-02