Skip to content

polywrap/client-readiness

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Client Readiness Checklist

A "readiness checklist" for all Polywrap clients to adhere to.

Checklist

Feature βœ”οΈ Scenario πŸ’­ Required ❓ Spec πŸ“‹ JS πŸ“œ KT πŸ€– Swift πŸ¦… RS πŸ¦€ PY 🐍
wrap:// URIs
Create & sanitize a wrap:// URI Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Client Configuration
Add a wrap package Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Add a plugin package Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Add a plugin instance Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Add a URI redirect Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Add env variables Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Add interface implementations Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Add resolver Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Add resolver ext Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Invocation
Invoke a wrap function
(Wasm Runtime v0.1)
Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Invoke a plugin function Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Subinvoke: wrap -> wrap Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Subinvoke: wrap -> plugin Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Subinvoke: plugin -> wrap Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
wrap:// Resolution
Resolve a wrap package Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve a wrap instance Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve a redirect Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve wrap://http/ &
wrap://https/
Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve wrap://file/ &
wrap://fs/
Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve wrap://ipfs/ Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve wrap://ens/ contenthash No πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve wrap://ens/ text-records No πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolve wrap://wrapscan.io/ No πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
WRAP Features
Wrap Env Variables Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Wrap Interface Invocations Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
WRAP ABI Type Support
(U)Int(8|16|32) Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
String Yes TODO TODO TODO TODO TODO TODO
Bytes Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
Object Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ 🟑 βœ”οΈ
Enum Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
BigInt Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
BigNumber Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ βœ”οΈ
JSON Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ 🟑 βœ”οΈ
Array<T> Yes TODO TODO TODO TODO TODO TODO
Map<K, V> Yes πŸ” βœ”οΈ βœ”οΈ βœ”οΈ 🟑 βœ”οΈ
Error handling
Invoke Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Subinvoke Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ
Resolution Yes πŸ” βœ”οΈ ❌ ❌ βœ”οΈ βœ”οΈ

Build & Contribute

Prerequisites

Install

./install.sh

Usage

./run.sh [implementation] [feature]
  • implementation (e.g: js|rs|py)
  • feature (e.g: resolve_http|uri) -> check specs for all features

About

The current state of all Polywrap Clients in the ecosystem.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5