Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
nitro-neal committed Sep 9, 2024
1 parent cd1a430 commit 28d229a
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/API_DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ CLASS VerifiablePresentation
PUBLIC DATA issuance_date: datetime
PUBLIC DATA expiration_date: datetime?
PUBLIC DATA verifiable_credential: []string
PUBLIC DATA additional_data: Map<string, string>?
CONSTRUCTOR create(holder: string, vc_jwts: []string, options: VerifiablePresentationCreateOptions?)
CONSTRUCTOR from_vp_jwt(vp_jwt: string, verify: bool)
Expand All @@ -182,6 +183,7 @@ CLASS VerifiablePresentationCreateOptions
PUBLIC DATA type: []string?
PUBLIC DATA issuance_date: datetime?
PUBLIC DATA expiration_date: datetime?
PUBLIC DATA additional_data: Map<string, string>?
```

## Presentation Exchange (PEX)
Expand All @@ -196,6 +198,7 @@ CLASS PresentationDefinition
PUBLIC DATA input_descriptors: []InputDescriptor
METHOD select_credentials(vc_jwts: []string): []string
METHOD create_presentation_from_credentials(vc_jwts: []string): (PresentationSubmission, []string)
```

### `InputDescriptor`
Expand Down Expand Up @@ -246,6 +249,46 @@ CLASS Filter
PUBLIC DATA contains: Filter?
```

### `PresentationSubmission`

```pseudocode!
CLASS PresentationSubmission
PUBLIC DATA id: string
PUBLIC DATA definition_id: string
PUBLIC DATA descriptor_map: []InputDescriptorMapping
```

### `InputDescriptorMapping`

```pseudocode!
CLASS InputDescriptorMapping
PUBLIC DATA id: string
PUBLIC DATA format: string
PUBLIC DATA path: string
PUBLIC DATA path_nested: InputDescriptorMapping?
```

### `SubmissionRequirement`

```pseudocode!
CLASS SubmissionRequirement
PUBLIC DATA rule: SubmissionRequirementRule
PUBLIC DATA from: string?
PUBLIC DATA from_nested: []SubmissionRequirement?
PUBLIC DATA name: string?
PUBLIC DATA purpose: string?
PUBLIC DATA count: uint32?
PUBLIC DATA min: uint32?
PUBLIC DATA max: uint32?
```

### `SubmissionRequirementRule`

```pseudocode!
ENUM SubmissionRequirementRule
All
Pick
```
# Crypto

## `Jwk`
Expand Down

0 comments on commit 28d229a

Please sign in to comment.