resources

Documentation

Index

• type Claim
• type ClaimAttributes
• type ClaimListResponse
• type ClaimResponse
• type Details
  • func (d Details) MarshalJSON() ([]byte, error)
  • func (r *Details) Scan(src interface{}) error
  • func (d Details) String() string
  • func (d *Details) UnmarshalJSON(data []byte) error
  • func (r Details) Value() (driver.Value, error)
• type DocumentNullifier
• type DocumentNullifierAttributes
• type DocumentNullifierListResponse
• type DocumentNullifierResponse
• type EncapsulatedData
• type Flag
• type Flagger
• type Flags
  • func FlagsFromMask(mask int32, allFlags map[int32]string) Flags
• type GistData
• type GistDataAttributes
• type GistDataListResponse
• type GistDataResponse
• type GistProof
• type Included
  • func (c *Included) Add(includes ...Resource)
  • func (c Included) MarshalJSON() ([]byte, error)
  • func (c *Included) MustClaim(key Key) *Claim
  • func (c *Included) MustDocumentNullifier(key Key) *DocumentNullifier
  • func (c *Included) MustGistData(key Key) *GistData
  • func (c *Included) UnmarshalJSON(data []byte) error
• type Key
  • func NewKeyInt64(id int64, resourceType ResourceType) Key
  • func (r Key) AsRelation() *Relation
  • func (r *Key) GetKey() Key
  • func (r Key) GetKeyP() *Key
• type Links
• type Relation
• type RelationCollection
  • func (r RelationCollection) MarshalJSON() ([]byte, error)
• type Resource
• type ResourceType

Types

type Claim

type Claim struct {
	Key
	Attributes ClaimAttributes `json:"attributes"`
}

type ClaimAttributes

type ClaimAttributes struct {
	ClaimId   string `json:"claim_id"`
	IssuerDid string `json:"issuer_did"`
}

type ClaimListResponse

type ClaimListResponse struct {
	Data     []Claim  `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type ClaimResponse

type ClaimResponse struct {
	Data     Claim    `json:"data"`
	Included Included `json:"included"`
}

type Details

type Details json.RawMessage

func (Details) MarshalJSON

func (d Details) MarshalJSON() ([]byte, error)

MarshalJSON - casts Details to []byte

func (*Details) Scan

func (r *Details) Scan(src interface{}) error

Scan - implements db driver method for auto unmarshal

func (Details) String

func (d Details) String() string

func (*Details) UnmarshalJSON

func (d *Details) UnmarshalJSON(data []byte) error

UnmarshalJSON - casts data to Details

func (Details) Value

func (r Details) Value() (driver.Value, error)

Value - implements db driver method for auto marshal

type DocumentNullifier

type DocumentNullifier struct {
	Key
	Attributes DocumentNullifierAttributes `json:"attributes"`
}

type DocumentNullifierAttributes

type DocumentNullifierAttributes struct {
	DocumentNullifierHash string `json:"document_nullifier_hash"`
}

type DocumentNullifierListResponse

type DocumentNullifierListResponse struct {
	Data     []DocumentNullifier `json:"data"`
	Included Included            `json:"included"`
	Links    *Links              `json:"links"`
}

type DocumentNullifierResponse

type DocumentNullifierResponse struct {
	Data     DocumentNullifier `json:"data"`
	Included Included          `json:"included"`
}

type EncapsulatedData

type EncapsulatedData struct {
	Version             int
	PrivateKeyAlgorithm asn1.RawValue
	PrivateKey          struct {
		El1 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
		El2 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
		El3 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
		El4 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
		El5 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
		El6 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
		El7 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
		El8 struct {
			Integer  int
			OctetStr asn1.RawValue
		}
	}
}

type Flag

type Flag struct {
	Name  string `json:"name"`
	Value int32  `json:"value"`
}

type Flagger

type Flagger interface {
	IsFlag() bool
}

type Flags

type Flags struct {
	Mask   int32  `json:"mask"`
	Values []Flag `json:"flags"`
}

func FlagsFromMask

func FlagsFromMask(mask int32, allFlags map[int32]string) Flags

type GistData

type GistData struct {
	Key
	Attributes GistDataAttributes `json:"attributes"`
}

type GistDataAttributes

type GistDataAttributes struct {
	GistProof GistProof `json:"gist_proof"`
	GistRoot  string    `json:"gist_root"`
}

type GistDataListResponse

type GistDataListResponse struct {
	Data     []GistData `json:"data"`
	Included Included   `json:"included"`
	Links    *Links     `json:"links"`
}

type GistDataResponse

type GistDataResponse struct {
	Data     GistData `json:"data"`
	Included Included `json:"included"`
}

type GistProof

type GistProof struct {
	AuxExistence bool     `json:"aux_existence"`
	AuxIndex     string   `json:"aux_index"`
	AuxValue     string   `json:"aux_value"`
	Existence    bool     `json:"existence"`
	Index        string   `json:"index"`
	Root         string   `json:"root"`
	Siblings     []string `json:"siblings"`
	Value        string   `json:"value"`
}

type Included

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

Included - an array of Resource objects that are related to the primary data and/or each other (“included resources”).

func (*Included) Add

func (c *Included) Add(includes ...Resource)

Add - adds new include into collection. If one already present - skips it

func (Included) MarshalJSON

func (c Included) MarshalJSON() ([]byte, error)

MarshalJSON - marshals include collection as array of json objects

func (*Included) MustClaim

func (c *Included) MustClaim(key Key) *Claim

MustClaim - returns Claim from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) MustDocumentNullifier

func (c *Included) MustDocumentNullifier(key Key) *DocumentNullifier

MustDocumentNullifier - returns DocumentNullifier from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) MustGistData

func (c *Included) MustGistData(key Key) *GistData

MustGistData - returns GistData from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) UnmarshalJSON

func (c *Included) UnmarshalJSON(data []byte) error

UnmarshalJSON - unmarshal array of json objects into include collection

type Key

type Key struct {
	ID   string       `json:"id"`
	Type ResourceType `json:"type"`
}

func NewKeyInt64

func NewKeyInt64(id int64, resourceType ResourceType) Key

func (Key) AsRelation

func (r Key) AsRelation() *Relation

func (*Key) GetKey

func (r *Key) GetKey() Key

func (Key) GetKeyP

func (r Key) GetKeyP() *Key

type Links

type Links struct {
	First string `json:"first,omitempty"`
	Last  string `json:"last,omitempty"`
	Next  string `json:"next,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Self  string `json:"self,omitempty"`
}

type Relation

type Relation struct {
	Data  *Key   `json:"data,omitempty"`
	Links *Links `json:"links,omitempty"`
}

type RelationCollection

type RelationCollection struct {
	Data  []Key  `json:"data"`
	Links *Links `json:"links,omitempty"`
}

func (RelationCollection) MarshalJSON

func (r RelationCollection) MarshalJSON() ([]byte, error)

type Resource

type Resource interface {
	//GetKey - returns key of the Resource
	GetKey() Key
}

type ResourceType

type ResourceType string

const (
	CLAIMS     ResourceType = "claims"
	NULLIFIERS ResourceType = "nullifiers"
	GIST_DATAS ResourceType = "gist_datas"
)

List of ResourceType