model

type AESKey [32]byte

type AccessKey struct {
	ID          string      `json:"id"`
	AccountID   string      `json:"account"`
	AccessLevel AccessLevel `json:"level"`
	Secret      string      `json:"secret,omitempty"`
	Type        string      `json:"type"`

	ManagementKey       string `json:"mgmtKey"`
	EncryptedManagedKey string `json:"emk,omitempty"`
	EncryptedHostedKey  string `json:"ehk,omitempty"`

	ManagementKeyPub ed25519.PublicKey  `json:"-"`
	ManagementKeyPrv ed25519.PrivateKey `json:"-"`
	ClientSecret     *AESKey            `json:"-"`
	ClientHMACKey    []byte             `json:"-"`
}

type AccessLevel int32

type AccessVerifier interface {
	// GetRecord returns a ledger record by its ID. Returns ErrRecordNotFound error
	// if record was not found.
	GetRecord(rid string) (*Record, error)
	// GetDataAssetState returns the state of the given data asset. Returns
	// ErrDataAssetNotFound error if data asset not found.
	GetDataAssetState(id string) (DataAssetState, error)
	// GetRecordState returns ledger record state for the given
	// record ID. It's useful to identify if the record
	// was published on the ledger (and its block ID) or if the lease
	// behind the record was revoked.
	GetRecordState(rid string) (*RecordState, error)
}

type Algorithm struct {
	Context any    `json:"@context,omitempty"`
	ID      string `json:"id"`
	Type    any    `json:"type"`
}

type BlobManager interface {
	GetBlob(res *StoredResource, accessToken string) (io.ReadCloser, error)
	SendBlob(data io.Reader, cleartext bool, vaultID string) (*StoredResource, error)
	PurgeBlob(res *StoredResource) error

	GetVaultMap() (map[string]*VaultProperties, error)
}

type Block struct {
	Number     int64  `json:"number"`
	Hash       string `json:"hash"`
	ParentHash string `json:"parentHash,omitempty"`
}

type Confirmation struct {
	Type       string              `json:"type"`
	Offer      *KnowledgeOffer     `json:"offer"`
	Terms      []*OfferTerms       `json:"terms,omitempty"`
	Provenance []*QuotedFromEntity `json:"provenance,omitempty"`
}

type ConsentReceipt struct {
	Version          string          `json:"version,omitempty"`
	Jurisdiction     string          `json:"jurisdiction,omitempty"`
	ConsentTimestamp uint64          `json:"consentTimestamp,omitempty"`
	CollectionMethod string          `json:"collectionMethod,omitempty"`
	ConsentReceiptID string          `json:"consentReceiptID,omitempty"`
	Subject          string          `json:"subject,omitempty"`
	DataController   *DataController `json:"dataController,omitempty"`
	Services         []*Service      `json:"services,omitempty"`
	PolicyURL        string          `json:"policyUrl,omitempty"`
	Sensitive        bool            `json:"sensitive,omitempty"`
	SpiCat           []string        `json:"spiCat,omitempty"`
}

type Criteria struct {
	ID      string           `json:"id"`
	Type    string           `json:"type"`
	Name    string           `json:"name,omitempty"`
	Version string           `json:"version,omitempty"`
	Params  []map[string]any `json:"parameters,omitempty"`
}

type DID struct {
	// ID is a decentralised identifier.
	ID string `json:"id" example:"did:piprate:9JA3ukzEXQeoTLyH9N2Jdp"`
	// VerKey public Ed25519 key in base58 encoding
	VerKey string `json:"verKey" example:"<public key in base58 encoding>"`
	// SignKey (optional) private Ed25519 key in base58 encoding
	SignKey string `json:"signKey,omitempty" example:"<private key in base58 encoding>"`
	// contains filtered or unexported fields
}

type DIDDocument struct {
	Context        any        `json:"@context,omitempty"`
	ID             string     `json:"id"`
	PublicKey      []any      `json:"publicKey,omitempty"`
	Authentication []any      `json:"authentication,omitempty"`
	Service        []any      `json:"service,omitempty"`
	Created        *time.Time `json:"created,omitempty"`
	Updated        *time.Time `json:"updated,omitempty"`
	Proof          *Proof     `json:"proof,omitempty"`
}

type DIDOption func(opts *didOptions)

type DIDProvider interface {
	CreateDIDDocument(ddoc *DIDDocument) error
	GetDIDDocument(iid string) (*DIDDocument, error)
}

type DataAssetState int

type DataController struct {
	OnBehalf         bool     `json:"onBehalf,omitempty"`
	Org              string   `json:"org,omitempty"`
	Contact          string   `json:"contact,omitempty"`
	Address          any      `json:"address,omitempty"`
	Email            string   `json:"email,omitempty"`
	Phone            string   `json:"phone,omitempty"`
	PIIControllerURL *url.URL `json:"piiControllerUrl,omitempty"`
}

type DataSet interface {
	// ID returns the dataset's record ID.
	ID() string
	// MetaResource returns a reader for the dataset's meta resource.
	MetaResource() (io.ReadCloser, error)
	// DecodeMetaResource is a convenience function that unmarshals the dataset's metadata into the given structure.
	DecodeMetaResource(obj any) error
	// Resources returns a list of resource IDs that belong to the dataset.
	Resources() []string
	// Resource returns a reader for the given resource within the dataset.
	Resource(id string) (io.ReadCloser, error)
	// DecodeResource is a convenience function that unmarshals the requested resource into the given structure.
	DecodeResource(id string, obj any) error
	// Lease returns the dataset's lease document
	Lease() *Lease
	// Impression returns the dataset's impression document (also available through Lease() )
	Impression() *Impression

	// Record returns the dataset's record structure
	Record() *Record
	// BlockNumber returns the number (ID) of the block where the dataset's record appeared.
	BlockNumber() int64
	// LockerID returns the ID of the locker that contains the dataset.
	LockerID() string
	// ParticipantID returns the ID (the corresponding identity's DID) of the locker participant
	// that submitted the dataset.
	ParticipantID() string
}

type Ed25519VerificationKey2018 struct {
	Context         any        `json:"@context,omitempty"`
	ID              string     `json:"id"`
	Type            string     `json:"type"`
	Controller      string     `json:"controller"`
	Expires         *time.Time `json:"expires,omitempty"`
	PublicKeyBase58 string     `json:"publicKeyBase58"`
}

type Impression struct {
	Context         any           `json:"@context"`
	ID              string        `json:"id"`
	Type            []string      `json:"type"`
	Asset           string        `json:"asset,omitempty"`
	ProvGraph       any           `json:"graph,omitempty"`
	WasAttributedTo string        `json:"wasAttributedTo,omitempty"`
	GeneratedAtTime *time.Time    `json:"generatedAtTime,omitempty"`
	MetaResource    *MetaResource `json:"resource,omitempty"`

	RevisionNumber   int64  `json:"revisionNumber,omitempty"`
	RevisionMessage  string `json:"revisionMessage,omitempty"`
	WasRevisionOf    string `json:"wasRevisionOf,omitempty"`
	SpecializationOf string `json:"specializationOf,omitempty"`

	Proof *Proof `json:"proof,omitempty"`
}

type KnowledgeOffer struct {
	ID               string        `json:"id"`
	Type             string        `json:"type"`
	Sender           string        `json:"sender"`
	Recipient        string        `json:"recipient"`
	Expires          *time.Time    `json:"expires,omitempty"`
	Asset            any           `json:"asset"`
	DatasetType      string        `json:"datasetType"`
	DatasetPreview   any           `json:"datasetPreview,omitempty"`
	RevisionNumber   int64         `json:"revisionNumber,omitempty"`
	WasRevisionOf    string        `json:"wasRevisionOf,omitempty"`
	SpecializationOf string        `json:"specializationOf,omitempty"`
	Terms            []*OfferTerms `json:"terms"`
	Proof            *Proof        `json:"proof,omitempty"`
}

type KnowledgeProspectus struct {
	Context any               `json:"@context"`
	ID      string            `json:"id"`
	Type    string            `json:"type"`
	Creator string            `json:"creator,omitempty"`
	Created *time.Time        `json:"created,omitempty"`
	Query   *KnowledgeQuery   `json:"query,omitempty"`
	Offers  []*KnowledgeOffer `json:"offers,omitempty"`
	Proof   *Proof            `json:"proof,omitempty"`
}

type KnowledgeQuery struct {
	Context  any        `json:"@context"`
	ID       string     `json:"id"`
	Type     string     `json:"type"`
	Creator  string     `json:"creator,omitempty"`
	Created  *time.Time `json:"created,omitempty"`
	Criteria *Criteria  `json:"criteria,omitempty"`
	Proof    *Proof     `json:"proof,omitempty"`
}

type KnowledgeSharingRequest struct {
	Context       any                  `json:"@context"`
	ID            string               `json:"id"`
	Type          string               `json:"type"`
	Creator       string               `json:"creator,omitempty"`
	Created       *time.Time           `json:"created,omitempty"`
	Prospectus    *KnowledgeProspectus `json:"prospectus,omitempty"`
	Locker        string               `json:"locker,omitempty"`
	Vault         string               `json:"vault,omitempty"`
	Confirmations []*Confirmation      `json:"confirmations"`
	Proof         *Proof               `json:"proof,omitempty"`
}

type KnowledgeSharingResult struct {
	RecordID     string `json:"recordId"`
	ImpressionID string `json:"impressionId"`
	Payload      any    `json:"payload,omitempty"`
}

type Lease struct {
	ID          string            `json:"id"`
	Type        string            `json:"type"`
	ExpiresAt   *time.Time        `json:"expire,omitempty"`
	Resources   []*StoredResource `json:"storage"`
	DataSetType string            `json:"datasetType"`
	Impression  *Impression       `json:"impression"`
	Provenance  *ProvEntity       `json:"provenance,omitempty"`
	Proof       *Proof            `json:"proof,omitempty"`
}

type Ledger interface {
	io.Closer

	// SubmitRecord adds a ledger records into the queue to be
	// included into the next block.
	SubmitRecord(r *Record) error
	// GetRecord returns a ledger record by its ID. Returns ErrRecordNotFound error
	// if record was not found.
	GetRecord(rid string) (*Record, error)
	// GetRecordState returns ledger record state for the given
	// record ID. It's useful to identify if the record
	// was published on the ledger (and its block ID) or if the lease
	// behind the record was revoked.
	GetRecordState(rid string) (*RecordState, error)
	// GetBlock returns a block definition for the given block number.
	GetBlock(bn int64) (*Block, error)
	// GetBlockRecords returns a list of all ledger records included
	// in the block as an array of arrays of strings:
	//     [record_id, routing_key, key_index]*
	// Returns ErrBlockNotFound error if block was not found.
	GetBlockRecords(bn int64) ([][]string, error)
	// GetGenesisBlock returns the definition of the genesis block.
	// If there is no genesis block yet, it will return nil as a block.
	GetGenesisBlock() (*Block, error)
	// GetTopBlock returns the definition of the top (latest) block.
	// If there are no blocks yet, it will return nil as a block.
	GetTopBlock() (*Block, error)
	// GetChain returns a sequence of block definitions of
	// the given length (depth), starting from the given block id
	GetChain(startNumber int64, depth int) ([]*Block, error)
	// GetDataAssetState returns the state of the given data asset. Returns
	// ErrDataAssetNotFound error if data asset not found.
	GetDataAssetState(id string) (DataAssetState, error)
	// GetAssetHead returns the record of type = head that defines the current asset head for the given ID.
	GetAssetHead(headID string) (*Record, error)
}

type Locker struct {
	// ID is the unique locker ID.
	ID string `json:"id"`
	// Name is the locker's name. These names are useful for locker documentation purposes.
	// They aren't used in any data processing.
	Name string `json:"name"`
	// AccessLevel is the locker's access level. Data wallet needs to be unlocked to a specific access level
	// to gain access to lockers at this level or higher.
	AccessLevel AccessLevel `json:"level"`
	// Participants is a list of locker participants.
	Participants []*LockerParticipant `json:"participants"`
	// Created is the locker's creation time. For documentation purposes only.
	Created *time.Time `json:"created"`
	// Expires is the time when the locker will expire. NOT SUPPORTED.
	Expires *time.Time `json:"expires,omitempty"`
	// Sealed is the time when the locker was sealed (closed). NOT SUPPORTED.
	Sealed *time.Time `json:"sealed,omitempty"`
	// FirstBlock is the block number that was the height of the chain when the locker was created.
	// It is guaranteed that all records for this locker will be in blocks AFTER this block.
	FirstBlock int64 `json:"firstBlock"`
	// LastBlock is the block number that was the height of the chain when the locker was sealed.
	// It is guaranteed that all records for this locker will be in blocks BEFORE this block.
	// NOT SUPPORTED.
	LastBlock int64 `json:"lastBlock,omitempty"`
	// ThirdPartyAcceptedAtBlock is the number of the block when the locker was accepted by the owner
	// when the owner acts as a third party (is not a participant on the locker)
	ThirdPartyAcceptedAtBlock int64 `json:"acceptedAtBlock,omitempty"`
}

type LockerParticipant struct {
	// ID is the participant's identity ID (DID)
	ID string `json:"id"`
	// SharedSecret is a Base64-encoded secret used to encrypt operations in the given locker (leases, etc)
	SharedSecret string `json:"sharedSecret,omitempty"`
	Self         bool   `json:"self,omitempty"`
	// RootPublicKey is a Base64-encoded root public key that can be used to identify if the specific record
	// was issued by this participant.
	RootPublicKey string `json:"rootPublicKey,omitempty"`
	// RootPrivateKeyEnc is a Base64-encoded, encrypted root HD key used to generate record's routing keys.
	RootPrivateKeyEnc string `json:"encryptedRootPrivateKey,omitempty"`
	// AcceptedAtBlock is the number of the block when the locker was accepted by the party
	// and registered in its root locker.
	AcceptedAtBlock int64 `json:"acceptedAtBlock,omitempty"`
	// contains filtered or unexported fields
}

type MerkleSigner interface {
	MerkleSign(identity string, key ed25519.PrivateKey) error
}

type MerkleVerifier interface {
	GetProof() *Proof
	MerkleVerify(key ed25519.PublicKey) (bool, error)
}

type MetaResource struct {
	// Asset is the meta resource's asset ID.
	Asset string `json:"id,omitempty"`
	// ContentType is the semantic type of the meta resource (and of the dataset).
	ContentType string `json:"contentType,omitempty"`
	// Fingerprint is the digital fingerprint of the meta resource. Because MetaResource
	// is signed as a part of impression, this fingerprint can verify if the meta resource
	// has been altered in any way.
	Fingerprint string `json:"fingerprint,omitempty"`
	// FingerprintAlgorithm is the Fingerprint's algorithm.
	FingerprintAlgorithm string `json:"fingerprintAlgorithm,omitempty"`
}

type NewBlockMessage struct {
	Type   string `json:"type"`
	Number int64  `json:"number"`
}

type OffChainStorage interface {
	GetOperation(opAddr string) ([]byte, error)
	SendOperation(opData []byte) (string, error)
	PurgeOperation(opAddr string) error
}

type OfferTerms struct {
	Duration int64 `json:"duration,omitempty"`
}

type OpType uint32

type PartyOption func() (*LockerParticipant, error)

type Proof struct {
	Type    string `json:"type"`
	Creator string `json:"creator"`
	Value   string `json:"proofValue"`
}

type ProvActivity struct {
	ID                   string             `json:"id,omitempty"`
	Type                 string             `json:"type"`
	Algorithm            string             `json:"algorithm"`
	Used                 any                `json:"used,omitempty"`
	QualifiedUsage       []*ProvUsage       `json:"qualifiedUsage,omitempty"`
	WasAssociatedWith    string             `json:"wasAssociatedWith,omitempty"`
	QualifiedAssociation []*ProvAssociation `json:"qualifiedAssociation,omitempty"`
}

type ProvAgent struct {
	ID              string `json:"id"`
	Type            string `json:"type"`
	ActedOnBehalfOf string `json:"actedOnBehalfOf,omitempty"`
}

type ProvAssociation struct {
	Type    string    `json:"type"`
	Agent   any       `json:"agent"`
	HadRole *ProvRole `json:"hadRole,omitempty"`
}

type ProvBundle struct {
	Context                any                  `json:"@context,omitempty"`
	ID                     string               `json:"id,omitempty"`
	Type                   string               `json:"type"`
	GeneratedAtTime        *time.Time           `json:"generatedAtTime,omitempty"`
	WasAttributedTo        string               `json:"wasAttributedTo,omitempty"`
	HadPrimarySource       string               `json:"hadPrimarySource,omitempty"`
	QualifiedPrimarySource []*ProvPrimarySource `json:"qualifiedPrimarySource,omitempty"`
	Graph                  any                  `json:"graph,omitempty"`

	Proof *Proof `json:"proof,omitempty"`
}

type ProvEntity struct {
	Context         any           `json:"@context,omitempty"`
	ID              string        `json:"id,omitempty"`
	Type            string        `json:"type"`
	WasAttributedTo string        `json:"wasAttributedTo,omitempty"`
	GeneratedAtTime *time.Time    `json:"generatedAtTime,omitempty"`
	WasGeneratedBy  *ProvActivity `json:"wasGeneratedBy,omitempty"`
	WasQuotedFrom   any           `json:"wasQuotedFrom,omitempty"`
	WasAccessibleTo any           `json:"wasAccessibleTo,omitempty"`
	ContentType     string        `json:"contentType,omitempty"`
	MentionOf       string        `json:"mentionOf,omitempty"`
	AsInBundle      string        `json:"asInBundle,omitempty"`

	Proof *Proof `json:"proof,omitempty"`
}

type ProvPrimarySource struct {
	Type      string `json:"type"`
	Entity    any    `json:"entity"`
	Algorithm string `json:"algorithm"`
}

type ProvRole struct {
	Type  string `json:"type"`
	Label string `json:"label"`
}

type ProvUsage struct {
	Type    string    `json:"type"`
	Entity  any       `json:"entity"`
	HadRole *ProvRole `json:"hadRole,omitempty"`
}

type QuotedFromEntity struct {
	ID            string `json:"id"`
	Type          string `json:"type"`
	WasQuotedFrom string `json:"wasQuotedFrom"`
}

type Record struct {
	// ID of the record. Currently, it's a hash of the record generated
	// by the Seal function (see below).
	ID string `json:"id"`
	// RoutingKey is a public key from the locker HD structure. It can be
	// used to filter specific messages from the ledger.
	RoutingKey string `json:"routingKey"`
	// KeyIndex is the index of the HD key used to produce the routing key.
	KeyIndex uint32 `json:"keyIndex"`
	// Operation is the type of the operation. May be removed from
	// the record in the future.
	Operation OpType `json:"operationType"`
	// OperationAddress is the address of the Operation (can be an asset ID, IPFS address, etc.)
	OperationAddress string `json:"address,omitempty"`
	// Flags contain a set of flags that modify the record's behaviour.
	// See RecordFlagXXX constants for examples.
	Flags uint32 `json:"flags,omitempty"`
	// AuthorisingCommitment is binary data which allows the originator
	// of the transaction to prove their role, without disclosing any
	// other information about this transaction
	AuthorisingCommitment string `json:"ac,omitempty"`
	// AuthorisingCommitmentType. for future use: there may be different
	// types of commitment structures.
	AuthorisingCommitmentType byte `json:"acType,omitempty"`
	// RequestingCommitment is binary data which allows the recipient of
	// the transaction to prove their right to access data without disclosing
	// any other information about this transaction
	RequestingCommitment string `json:"rc,omitempty"`
	// RequestingCommitmentType. for future use: there may be different types
	// of commitment structures.
	RequestingCommitmentType byte `json:"rcType,omitempty"`
	// ImpressionCommitment is binary data which allows a party to prove
	// that this record contains a specific impression, by combining
	// the impression ID with another artifact, a trapdoor.
	ImpressionCommitment string `json:"ic,omitempty"`
	// ImpressionCommitmentType. for future use: there may be different
	// types of commitment structures.
	ImpressionCommitmentType byte `json:"icType,omitempty"`

	// DataAssets is a list of data assets (blobs) attached to the record
	DataAssets []string `json:"dataAssets,omitempty"`

	SubjectRecord   string   `json:"subjectRecord,omitempty"`
	RevocationProof []string `json:"revocationProof,omitempty"`

	// HeadID is unique ID of the asset head.
	HeadID string `json:"headID,omitempty"`
	// HeadBody contains base64-encoded, encrypted head body (see PackHeadBody() ).
	HeadBody string `json:"headBody,omitempty"`

	// Signature contains a digital signature of the record, signed by
	// the record's private HD key
	Signature string `json:"signature"`

	Status RecordStatus `json:"status,omitempty"`
}

type RecordState struct {
	Status      RecordStatus `json:"status"`
	BlockNumber int64        `json:"number"`
}

type RecordStatus string

type SemanticAsset struct {
	Context any    `json:"@context,omitempty"`
	ID      string `json:"id"`
	Type    any    `json:"type"`
	Nonce   string `json:"nonce,omitempty"`

	Serial     bool `json:"isSerial,omitempty"`
	IsIdentity bool `json:"isIdentity,omitempty"`

	IsDigital            bool   `json:"isDigital,omitempty"`
	Fingerprint          string `json:"fingerprint,omitempty"`
	FingerprintAlgorithm string `json:"fingerprintAlgorithm,omitempty"`

	WasGeneratedBy map[string]any `json:"wasGeneratedBy,omitempty"`

	Proof *Proof `json:"proof,omitempty"`
}

type Service struct {
	ServiceName string `json:"serviceName,omitempty"`
}

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

type Signer interface {
	Sign(message []byte) []byte
}

type StoredResource struct {
	// ID is the resource ID.
	ID string `json:"id,omitempty"`
	// Type is always equal to TypeResource.
	Type string `json:"type"`
	// Asset is the data asset's content-addressable ID.
	Asset string `json:"asset,omitempty"`
	// Vault is the ID of the vault where the data asset is stored.
	Vault string `json:"vault"`
	// Method is the vault's method of storage. This field defines the meaning of Params field.
	Method string `json:"method"`
	// Params is key/value pairs that are specific to the selected Method. These parameters should be
	// sufficient to locate the resource blob in the vault.
	Params map[string]any `json:"params,omitempty"`
	// EncryptionKey is a Base64-encoded client side encryption key (if the asset was encrypted on the client side).
	EncryptionKey string `json:"encryptionKey,omitempty"`
	// MIMEType is the data asset's MIME type (if known).
	MIMEType string `json:"mimeType,omitempty"`
	// Size is the resource's size in bytes.
	Size int64 `json:"size,omitempty"`
}

type VaultProperties struct {
	// ID is the vault's ID.
	ID string
	// Name is the vault's name. Vault names should be unique within each instance of MetaLocker.
	Name string
	// Type is the vault's type. It defines the underlying technology.
	Type string
	// SSE is true if the vault provides Server Side Encryption. If it does, data sent to the vault
	// should not be encrypted on the client side.
	SSE bool
	// CAS is true if the vault generates content addressable IDs
	CAS bool
}

type Verifier interface {
	Verify(message, signature []byte) bool
}