Skip to content

Commit 581522e

Browse files
committed
chore: update CHANGELOG
1 parent 20f87a7 commit 581522e

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Polywrap Origin (0.11.0)
22
## Features
3+
**`@polywrap/core-js`:**
4+
* [PR-6](https://github.com/polywrap/javascript-client/pull/6) **Improved URI Inference**
5+
* Non-wrap URI schemes can now be used (ex: `https://domain.com/path`). The non-wrap scheme will be used as the authority, and all other contents will be shifted into the path.
6+
* Examples:
7+
* `https://domain.com/path` into `wrap://https/domain.com/path`
8+
* `ipfs://QmHASH` into `wrap://ipfs/QmHASH`
9+
310
**`@polywrap/client-config-builder-js`:**
411
* [PR-45](https://github.com/polywrap/javascript-client/pull/45) **Modular Config Bundles**
512
* The `DefaultBundle` has been broken apart into two separate bundles: `sys` and `web3`.

packages/core/src/types/Uri.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,23 @@ export interface UriConfig {
1919
// $start: Uri
2020
/**
2121
* A Polywrap URI. Some examples of valid URIs are:
22+
* wrap://https/domain.com
2223
* wrap://ipfs/QmHASH
2324
* wrap://ens/sub.domain.eth
24-
* wrap://fs/directory/file.txt
25-
* wrap://uns/domain.crypto
25+
* wrap://file/directory/file.txt
26+
*
27+
* Some example short-hand URIs (utilizing inference):
28+
* ipfs/QmHASH -> wrap://ipfs/QmHASH
29+
* https://domain.com -> wrap://https/domain.com
30+
*
31+
* URI inference is performed in the following ways:
32+
* 1. If wrap:// is missing, it will be added.
33+
* 2. If non-wrap schema exists, it becomes the authority.
2634
*
2735
* Breaking down the various parts of the URI, as it applies
2836
* to [the URI standard](https://tools.ietf.org/html/rfc3986#section-3):
2937
* **wrap://** - URI Scheme: differentiates Polywrap URIs.
30-
* **ipfs/** - URI Authority: allows the Polywrap URI resolution algorithm to determine an authoritative URI resolver.
38+
* **ens/** - URI Authority: allows the Polywrap URI resolution algorithm to determine an authoritative URI resolver.
3139
* **sub.domain.eth** - URI Path: tells the Authority where the Wrapper resides.
3240
*/
3341
export class Uri {

0 commit comments

Comments
 (0)