cleanup awcp package, version bump to 0.2.3
This commit is contained in:
+15
-2
@@ -1,3 +1,16 @@
|
|||||||
# awcp (package documentation)
|
# awcp: Aepp-Waellet Communication Protocol.
|
||||||
|
|
||||||
Please click the word "Documentation" in the sidebar
|
Mostly an internal package.
|
||||||
|
|
||||||
|
Page scripts (aepps) and wallet browser extensions (waellets) need to talk to
|
||||||
|
each other. This package contains
|
||||||
|
|
||||||
|
1. type definitions of the messages
|
||||||
|
2. a list of error codes
|
||||||
|
|
||||||
|
[src/awcp.ts](./src/awcp.ts) contains a detailed explanation of how the
|
||||||
|
protocol is structured.
|
||||||
|
|
||||||
|
[Sidekick](../../sidekick/) exhibits how to use this from the perspective of
|
||||||
|
the page script (aepp), and [Jack Russell](../../jrx) exhibits how to use this
|
||||||
|
from the perspective of the waellet.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
{type, library}.
|
{type, library}.
|
||||||
{realm, local}.
|
{realm, local}.
|
||||||
{name, awcp}.
|
{name, awcp}.
|
||||||
{version, "0.2.2"}.
|
{version, "0.2.3"}.
|
||||||
{deps, []}.
|
{deps, []}.
|
||||||
|
|||||||
@@ -15,11 +15,12 @@
|
|||||||
* this.
|
* this.
|
||||||
*
|
*
|
||||||
* Keep in mind that these messages are not secret. Any browser extension or
|
* Keep in mind that these messages are not secret. Any browser extension or
|
||||||
* foreign page script can intercept these messages. Imagine as an (imperfect)
|
* foreign page script can intercept these messages, and inject messages of
|
||||||
* analogy that you work in an office. Everyone's mail is dumped on the floor
|
* their own. Imagine as an (imperfect) analogy that you work in an office.
|
||||||
* in the middle of the office, and you are responsible for picking out which
|
* Everyone's mail is dumped on the floor in the middle of the office. You are
|
||||||
* letters are addressed to you. Anyone else can pick up letters addressed to
|
* responsible for picking out which letters are addressed to you. Anyone else
|
||||||
* you, and read them.
|
* can pick up letters addressed to you, and read them. Anyone else can also
|
||||||
|
* place their own letters in the pile.
|
||||||
*
|
*
|
||||||
* This module defines the shape of the messages that are sent. There are several
|
* This module defines the shape of the messages that are sent. There are several
|
||||||
* layers to the onion, each corresponding to natural branch points in the
|
* layers to the onion, each corresponding to natural branch points in the
|
||||||
|
|||||||
Reference in New Issue
Block a user