Skip to content

Commit

Permalink
specs frontmatter
Browse files Browse the repository at this point in the history
  • Loading branch information
localredhead committed May 3, 2018
1 parent d05b291 commit c687f35
Show file tree
Hide file tree
Showing 17 changed files with 207 additions and 7 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
---
title: "Uport Specs"
index: 0
category: "reference"
type: "content"
tags:
- programming
- stuff
- other
---

# uPort Specs

uPort is a platform for user centric identity and communication. The platform currently consists of our mobile app, Ethereum smart contracts and number of open protocols for signed messages and message flow.
Expand Down
12 changes: 12 additions & 0 deletions flows/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Uport Request Flows"
index: 1
prefix: "/flows"
category: "reference"
type: "content"
tags:
- programming
- stuff
- other
---

# Uport Request Flows

A request will typically be signed by a client app and sent to mobile app using this generic request flow:
Expand Down
12 changes: 12 additions & 0 deletions flows/privatechain.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Private Chain Provisioning Flows"
index: 1
prefix: "/flows"
category: "reference"
type: "content"
tags:
- programming
- stuff
- other
---

# Private Chain Provisioning Flow

Experimental support for supporting Ethereum Accounts on private chains.
Expand Down
13 changes: 13 additions & 0 deletions flows/selectivedisclosure.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
---
title: "Selective Disclosure Flow"
index: 2
prefix: "/flows"
date: "01/01/2017"
category: "reference"
type: "content"
tags:
- programming
- stuff
- other
---

# Selective Disclosure Flow

A client application can request various information from the user.
Expand Down
12 changes: 12 additions & 0 deletions flows/tx.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Ethereum Transaction Flow"
index: 2
prefix: "/flows"
category: "reference"
type: "content"
tags:
- programming
- stuff
- other
---

# Ethereum Transaction Flow

A client application can request that a user signs an Ethereum transaction.
Expand Down
14 changes: 13 additions & 1 deletion flows/verification.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# Send Verified Claim Flow
---
title: "Send Verification Flow"
index: 3
prefix: "/flows"
category: "reference"
type: "content"
tags:
- programming
- stuff
- other
---

# Send Verification Flow

A client application can verify information about a user

Expand Down
12 changes: 12 additions & 0 deletions messages/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Off-chain Messages"
category: "reference"
index: 0
prefix: "/messages"
type: "content"
tags:
- programming
- stuff
- other
---

# Off-chain Messages

Most request and responses are performed privately off-chain between the different parties to a flow.
Expand Down
12 changes: 12 additions & 0 deletions messages/privatechain.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Private Chain Provisioning"
category: "reference"
index: 0
prefix: "/messages"
type: "content"
tags:
- programming
- stuff
- other
---

# Private Chain Provisioning Message

A Private Chain Provisioning Message can be used for adding an account created on a private Ethereum chain to a users Uport Mobile App.
Expand Down
12 changes: 12 additions & 0 deletions messages/sharereq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Selective Disclosure Request"
category: "reference"
index: 0
prefix: "/messages"
type: "content"
tags:
- programming
- stuff
- other
---

# Selective Disclosure Request

The Selective Disclosure Request is created by a client app and sent to a user's mobile app during the [Selective Disclosure Flow](../flows/selectivedisclosure.md).
Expand Down
12 changes: 12 additions & 0 deletions messages/shareresp.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Off-chain Messages"
category: "reference"
index: 0
prefix: "/messages"
type: "content"
tags:
- programming
- stuff
- other
---

# Selective Disclosure Response

The Selective Disclosure Response is created by a users mobile app as a response to a [Selective Disclosure Request](sharereq.md) during the [Selective Disclosure Flow](../flows/selectivedisclosure.md).
Expand Down
17 changes: 15 additions & 2 deletions messages/verification.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# Verified Claim
---
title: "Veriication"
category: "reference"
index: 0
prefix: "/messages"
type: "content"
tags:
- programming
- stuff
- other
---


# Verification

A Verified Claim is a statement issued by a third party verifying claims about an identity [Verified Claim Flow](../flows/verification.md).

Expand Down Expand Up @@ -42,6 +55,6 @@ Some times multiple claims are actually a single claim. A good example is an add

### Claim Taxonomy

uPort is agnostic to different claim types. This allows you to plug in your own taxonomy of claims or use an existing taxonomy that works in your industry.
uPort is agnostic to different claim types. This allows you to plug in your own taxonomy of claims or use an existing taxonomy that works in your industry.

If you don't need to follow a specific taxonomy of claims, we recommend that you find suitable claim types within [Schema.org](http://schema.org).
16 changes: 12 additions & 4 deletions pki/identitydocument.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Identity Document"
category: "reference"
index: 0
prefix: "/pki"
type: "content"
tags:
- programming
- stuff
- other
---

# Identity Document

Note this format will be deprecated soon and replaced by a standard [DID Document](./diddocument.md).
Expand Down Expand Up @@ -44,7 +56,3 @@ Name | Description | Required
`name` | Name of identity | no
`description` | Description of identity | no
`image` | Avatar or logo of identity (Uses [ImageObject](http://schema.org/ImageObject) with `contentUrl`) | no




12 changes: 12 additions & 0 deletions pki/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Uport PKI"
category: "reference"
index: 0
prefix: "/pki"
type: "content"
tags:
- programming
- stuff
- other
---

# uPort PKI

uPort implements a simple yet general purpose decentralized PKI system, making it easy to create and verify off-chain JWT messages.
Expand Down
12 changes: 12 additions & 0 deletions rest-apis/fuel-server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Transaction Fueling Server"
category: "reference"
index: 0
prefix: "/rest-apis"
type: "content"
tags:
- programming
- stuff
- other
---

# Transaction Fueling Server

All transactions on Ethereum like networks are paid using transaction fees known as `gas`. To avoid the requirement for all end users to fund themselves with ETH on their respective networks we support a transaction fueling service, which will be called if the users account does not have enough funds available to fuel the transaction
Expand Down
12 changes: 12 additions & 0 deletions rest-apis/relay-server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Meta Transaction Relaying Server"
category: "reference"
index: 0
prefix: "/rest-apis"
type: "content"
tags:
- programming
- stuff
- other
---

# Meta Transaction Relaying Server

All transactions on Ethereum like networks are paid using transaction fees known as `gas`. To avoid the requirement for all end users to fund themselves with ETH on their respective networks we support [meta transactions](https://medium.com/uport/making-uport-smart-contracts-smarter-part-3-fixing-user-experience-with-meta-transactions-105209ed43e0) which allows a 3rd party transaction fueling service to fund and relay transactions without requiring pre-funding the users account.
Expand Down
11 changes: 11 additions & 0 deletions transports/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
---
title: "Request/Response Transports"
category: "reference"
index: 0
type: "content"
tags:
- programming
- stuff
- other
---

# Request/Response Transports

## Requests
Expand Down
12 changes: 12 additions & 0 deletions transports/push.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: "Push Notification Transport"
category: "reference"
index: 0
prefix: "/transports"
type: "content"
tags:
- programming
- stuff
- other
---

# Push Notification Transport
Push notifications is a transport for sending requests to users. To make sure that the push notification service does not learn any information about what is in the request itself, all requests have to be encrypted. This means that sending a request as a push notification has two steps; encryption and a REST call.

Expand Down

0 comments on commit c687f35

Please sign in to comment.