You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: addresses-scheme/readme.md
+37-7Lines changed: 37 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,11 @@ The IPFS address scheme is described in [the IPFS whitepaper](https://github.com
7
7
8
8
The discussions around `ipfs:` vs. `dweb:` is a confusing one that's been going on since @jbenet published the [IPFS whitepaper](https://ipfs.io/ipfs/QmR7GSQM93Cx5eAg6a6yRzNde1FQv7uL6X1o4k7zrJa3LX/ipfs.draft3.pdf), with a number of other approaches being proposed. That design discussion has been going on for a long time, with many lengthy discussions in github issues.
9
9
10
+
## Competing Goals
11
+
10
12
There are a few goals tugging against each other:
11
13
1. The Noble Goal: Unify the filesystem-database-web rift
12
-
2. The Quick Fix: Conform to URL orthodoxy
14
+
2. The Goal of a Quick Fix: Conform to URL orthodoxy
13
15
3. The Design Goal: Create Addresses that People will Love Using
14
16
4. The Clean-Namespaces Goal: Avoid polluting the scheme namespace with multiple schemes
15
17
@@ -18,11 +20,11 @@ This has led to some competing approaches -- mainly the 'dweb:' Approach and the
18
20
Regardless of which goals and approaches resonate with you, there are a number of important factors that have to be handled by any schema. A number of those factors are collected & discussed in these issues:
## The Noble Goal: Unify the filesystem-database-web rift
23
+
###The Noble Goal: Unify the filesystem-database-web rift
22
24
23
25
In short, @jbenet (creator of IPFS) wants to fix a mistake that happened 25-30 years ago and sees this current decision as an inflection point where we either A) use this "decentralization" moment to fix the problem or B) let all these decentralized protocols worsen the problem by going along with the existing momentum. In @gozala's words (voicing the perspective of web browser implementers), "While I think that’s a very noble goal, I think it would be hard to sell for a very pragmatic crowd".
24
26
25
-
### Unify the filesystem-database-web rift
27
+
####Unify the filesystem-database-web rift
26
28
27
29
In conversations documented [here](https://github.com/ipfs/in-web-browsers/issues/4), @jbenet and @gozala cover this topic relatively concisely.
28
30
@@ -38,23 +40,23 @@ also
38
40
39
41
> A minor reason is not having to force people to swallow N shemes (ipfs:// ipns:// ipld:// and counting), and instead use one that muxes.
40
42
41
-
### ... but don't let it prevent pragmatism.
43
+
####... but don't let it prevent pragmatism.
42
44
43
45
@gozala encouraged pragmatism:
44
46
> While I think that’s a very noble goal, I think it would be hard to sell for a very pragmatic crowd like browser vendors. I frequently see standardization process taking specs into least ambitious and most pragmatic direction, I often disagree, but I think often times that’s only way to make progress. Maybe some version of this goal could be articulated in [less] perfectionistic manner and in a more pragmatic one ?
45
47
46
48
@jbenet agreed to that pragmatism:
47
49
> **These goals are secondary in time to getting browser adoption. Meaning that we CAN do things like recommend ipfs:// ipns:// ipld://** IF browser vendors think that it's unlikely to get adoption this way now. We can work on unifying the fs-db-web rift later. **We're not dogmatic, we're pragmatic.** But we want to make sure we push in the right places and try to make as much as we can better.
48
50
49
-
## The Quick Fix: Conform to URL orthodoxy.
51
+
###The Goal of a Quick Fix: Conform to URL orthodoxy.
50
52
51
53
The short-term fix that people reach for is to create an `ipfs:` schema, as proposed in https://github.com/ipfs/specs/pull/139. This would conform to established habits around the use of URLs.
52
54
53
-
## The Design Goal: Create Addresses that People will Love Using
55
+
###The Design Goal: Create Addresses that People will Love Using
54
56
55
57
From a design perspective, the challenge is to create a schema that makes intuitive sense, maximizes possibilities, and allows people to identify content with addresses that are reliable, powerful, and pleasant to use.
56
58
57
-
## The Clean-Namespaces Goal: Avoid polluting the scheme namespace with multiple schemes
59
+
###The Clean-Namespaces Goal: Avoid polluting the scheme namespace with multiple schemes
58
60
59
61
If we do this wrong, the growth of decentralized web technologies will cause a proliferation of schemes that will quickly become unwieldy, will discourage interoperability, and will maintain a high barrier to innovation in the protocol space.
60
62
@@ -63,6 +65,11 @@ If we do this wrong, the growth of decentralized web technologies will cause a p
63
65
### Strengths of this Approach
64
66
65
67
_PLEASE HELP FILL THESE_
68
+
69
+
#### Strength: Prevents Proliferation of Schemes and Namespaces
70
+
71
+
NOT doing this now effectively shuts down future possibilities by making new namespaces "not worth doing the work of introducing a URL scheme".
72
+
66
73
#### Strength: Getting away from the `://`
67
74
as @lidel[comments](https://github.com/ipfs/specs/pull/153#discussion_r104291285)
68
75
> I kinda like this _aesthetic_. No matter what prefix is picked, it looks better than anything with `://`
@@ -74,6 +81,18 @@ as @lidel [comments](https://github.com/ipfs/specs/pull/153#discussion_r10429128
74
81
### Criticisms of this Approach
75
82
_PLEASE HELP FILL THESE_
76
83
84
+
#### Criticism: It's not clear how this helps the whole ecosystem
> I feel it should be explicitly stated in the document if this single scheme aims to be for IPFS ecosystem only, or something that can be adopted by other distributed systems.
87
+
>
88
+
> If we want to share it with others, eg. Ethereum, Tor Onion Services etc, then I see potential problem with single scheme: who is responsible for muxing when multiple vendors are in play?
89
+
Let's say we have: `dweb://ipfs/Qmbar..` and `dweb://foo/buz`. If IPFS browser add-on provides handler for `dweb://`, FOO is unable to handle its own URIs.
90
+
We should plan for this now, and have contingency written down..
91
+
92
+
#### Criticism: Doesn't fit with the way Browsers identify origins
93
+
94
+
Some current browsers have trouble with the construction: origin = a:/b/c because they expect: `origin = a:/b`, even though that's not in the URI spec.
95
+
77
96
### Designing the `dweb:` Schema
78
97
79
98
A draft spec for the `dweb:` schema is under way at https://github.com/ipfs/in-web-browsers/issues/28
@@ -82,6 +101,14 @@ A draft spec for the `dweb:` schema is under way at https://github.com/ipfs/in-w
82
101
83
102
The short-term fix that people reach for is to create an `ipfs:` schema, as proposed in https://github.com/ipfs/specs/pull/139. That approach seems simple at first, but it's got problems.
84
103
104
+
### Strengths of this Approach
105
+
106
+
#### Strength: Fits with Established Conventions & Expectations around URLs
107
+
108
+
#### Strength: Fits with the way browsers identify origins
109
+
110
+
When enforcing the Single Origin Policy, some current browsers expect: `origin = a:/b`, even though that's not what the URI spec calls for. The `ipfs:` approach fits with that expectation, with URIs like `ipfs:/<root-hash>/foo/bar`, the origin would be `ipfs:/<root-hash>`
111
+
85
112
### Criticisms of this Approach
86
113
87
114
#### Criticism 1: We want IPFS, IPNS and IPLD to be handled by a single schema
@@ -92,6 +119,9 @@ The `dweb:` schema dodges this by treating IPFS and IPNS as namespaces within a
92
119
#### Criticism 2: This would worsen the filesystem-database-web rift
93
120
See [The Noble Goal: Unify the filesystem-database-web rift](#the-noble-goal-unify-the-filesystem-database-web-rift) above.
94
121
122
+
#### Criticism 3: Will Prevent Innovation by making it hard to mint new namespaces
123
+
If we don't push for the `dweb:` approach it will prevent innovation by making it hard to mint new namespaces on the (content-addressed) web.
0 commit comments