Pharpend/develop (#1)
* move stuff in here * reorganizing because zx needs to feel special * add base58/base64 explainer draft
This commit is contained in:
pharpend
@@ -0,0 +1,4 @@
|
|||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
erl_crash.dump
|
||||||
|
*.beam
|
||||||
@@ -1 +1,54 @@
|
|||||||
# Vanillae
|
# Vanillae
|
||||||
|
|
||||||
|
Vanillae is an Aeternity tool suite meant for small business use cases. Focus
|
||||||
|
is placed on simplicity, code quality, and good documentation.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
### Applications
|
||||||
|
|
||||||
|
- Jaeck Russell (Erlang)
|
||||||
|
|
||||||
|
A minimal browser wallet extension.
|
||||||
|
|
||||||
|
- jex (Erlang)
|
||||||
|
|
||||||
|
A TypeScript/JavaScript package manager that avoids a large class of
|
||||||
|
NPM-related security issues.
|
||||||
|
|
||||||
|
- vlogd (Erlang)
|
||||||
|
|
||||||
|
**NOT FOR PRODUCTION USAGE**
|
||||||
|
|
||||||
|
Simple HTTP server that just logs requests it gets.
|
||||||
|
|
||||||
|
|
||||||
|
### Erlang Libraries
|
||||||
|
|
||||||
|
- vanillae
|
||||||
|
|
||||||
|
|
||||||
|
### TypeScript Libraries
|
||||||
|
|
||||||
|
- awcp
|
||||||
|
|
||||||
|
Aepp/waellet communication protocol
|
||||||
|
|
||||||
|
This is just type definitions, what data the wallet expects from the Aepp,
|
||||||
|
and what data the aepp expects from the waellet.
|
||||||
|
|
||||||
|
- libjr
|
||||||
|
|
||||||
|
This is the complement to sidekick. It essentially is sidekick from the
|
||||||
|
perspective of the waellet.
|
||||||
|
|
||||||
|
- sidekick
|
||||||
|
|
||||||
|
This a TypeScript/JavaScript library for talking to Aeternity browser wallets
|
||||||
|
(e.g. Superhero, Jaeck Russell) from the perspective of an "aepp" (i.e. your
|
||||||
|
website's JavaScript).
|
||||||
|
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- base64 versus base58 explainer
|
||||||
|
|||||||
@@ -0,0 +1,245 @@
|
|||||||
|
# Base58/Base64 Number Encoding Schema in Detail
|
||||||
|
|
||||||
|
## tldr
|
||||||
|
|
||||||
|
```erlang
|
||||||
|
b58_enc(Bits) ->
|
||||||
|
NBits = bit_size(Bits),
|
||||||
|
<<BitNum:NBits>> = Bits,
|
||||||
|
b58_enc(BitNum, []).
|
||||||
|
|
||||||
|
b58_enc(0, Acc) ->
|
||||||
|
lists:map(fun b58_int2char/1, Acc);
|
||||||
|
b58_enc(BitNum, Acc) ->
|
||||||
|
Q = BitNum div 58,
|
||||||
|
R = BitNum rem 58,
|
||||||
|
b58_enc(Q, [R | Acc]).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
b58_dec(Str) ->
|
||||||
|
Ns = lists:map(fun b58_char2int/1, Str),
|
||||||
|
b58_dec(Ns, 0).
|
||||||
|
|
||||||
|
b58_dec([N | Ns], Acc) ->
|
||||||
|
NewAcc = (Acc*58) + N,
|
||||||
|
b58_dec(Ns, NewAcc);
|
||||||
|
b58_dec([], FinalAccN) ->
|
||||||
|
MinNBits = trunc(math:log2(FinalAccN) + 1),
|
||||||
|
NBytes = ceil(MinNBits / 8),
|
||||||
|
NBits = NBytes * 8,
|
||||||
|
<<FinalAccN:NBits>>.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
b64_enc(<<A:6, B:6, C:6, D:6, Rest/binary>>) ->
|
||||||
|
CA = b64_int2char(A),
|
||||||
|
CB = b64_int2char(B),
|
||||||
|
CC = b64_int2char(C),
|
||||||
|
CD = b64_int2char(D),
|
||||||
|
[CA, CB, CC, CD | b64_enc(Rest)],
|
||||||
|
b64_enc(<<A:6, B:6, C:4>>) ->
|
||||||
|
CA = b64_int2char(A),
|
||||||
|
CB = b64_int2char(B),
|
||||||
|
CC = b64_int2char(C bsl 2),
|
||||||
|
[CA, CB, CC, $=];
|
||||||
|
b64_enc(<<A:6, B:2>>) ->
|
||||||
|
CA = b64_int2char(A),
|
||||||
|
CB = b64_int2char(B bsl 4),
|
||||||
|
[CA, CB, $=, $=];
|
||||||
|
b64_enc(<<>>) ->
|
||||||
|
[].
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
b64_dec(Base64_String) ->
|
||||||
|
b64_dec(Base64_String, <<>>).
|
||||||
|
|
||||||
|
b64_dec([W, X, $=, $=], Acc) ->
|
||||||
|
NW = b64_char2int(W),
|
||||||
|
NX = b64_char2int(X),
|
||||||
|
<<LastByte:8, 0:4>> = <<NW:6, NX:6>>,
|
||||||
|
<<Acc/binary, LastByte:8>>;
|
||||||
|
b64_dec([W, X, Y, $=], Acc) ->
|
||||||
|
NW = b64_char2int(W),
|
||||||
|
NX = b64_char2int(X),
|
||||||
|
NY = b64_char2int(Y),
|
||||||
|
<<B1:8, B2:8, 0:2>> = <<NW:6, NX:6, NY:6>>,
|
||||||
|
<<Acc/binary, B1:8, B2:8>>;
|
||||||
|
b64_dec([], Acc) ->
|
||||||
|
Acc;
|
||||||
|
b64_dec([W, X, Y, Z | Rest], Acc) ->
|
||||||
|
NW = b64_char2int(W),
|
||||||
|
NX = b64_char2int(X),
|
||||||
|
NY = b64_char2int(Y),
|
||||||
|
NZ = b64_char2int(Z),
|
||||||
|
NewAcc = <<Acc/binary, NW:6, NX:6, NY:6, NZ:6>>,
|
||||||
|
b64_dec(Rest, NewAcc).
|
||||||
|
```
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
This document explains the Base58 and Base64 notations, and the algorithms
|
||||||
|
for working with them. I wrote this document because I had a fair bit of
|
||||||
|
difficulty working this out for myself, even with a strong math background.
|
||||||
|
I couldn't find any resource on the internet explaining all of this simply.
|
||||||
|
|
||||||
|
Code examples are given in Erlang and TypeScript. These are the two most
|
||||||
|
common languages used within the Aeternity project, and both happen to be
|
||||||
|
languges that make these tasks easy. This document assumes you are familiar
|
||||||
|
with either/both languages. Even if that's not true, Erlang is a very simple
|
||||||
|
and clean language, so the code should be pretty self-explanatory if you read
|
||||||
|
it.
|
||||||
|
|
||||||
|
Base64 is kind of annoying but it's pretty straightforward to code. My
|
||||||
|
initial assumption was that Base58 was in some way "the same" algorithm but
|
||||||
|
with `n = 58` instead of `n = 64`. When I went to look up the spec, I found
|
||||||
|
this ([source](https://digitalbazaar.github.io/base58-spec/))
|
||||||
|
|
||||||
|
> ### 3. The Base58 Encoding Algorithm
|
||||||
|
>
|
||||||
|
> To encode an array of bytes to a Base58 encoded value, run the following
|
||||||
|
> algorithm. All mathematical operations MUST be performed using integer
|
||||||
|
> arithmetic. Start by initializing a `zero_counter` to zero (`0x0`), an
|
||||||
|
> `encoding_flag` to zero (`0x0`), a `b58_bytes` array, a `b58_encoding`
|
||||||
|
> array, and a `carry` value to zero (`0x0`). For each byte in the array of
|
||||||
|
> bytes and while `carry` does not equal zero (`0x0`) after the first
|
||||||
|
> iteration:
|
||||||
|
>
|
||||||
|
> 1. If `encoding_flag` is not set, and if the byte is a zero (`0x0`),
|
||||||
|
> increment the value of `zero_counter`. If the value is not zero `(0x0)`,
|
||||||
|
> set `encoding_flag` to true `(0x1)`.
|
||||||
|
> 2. If `encoding_flag` is set, multiply the current byte value by 256 and add
|
||||||
|
> it to `carry`.
|
||||||
|
> 3. Set the corresponding byte value in `b58_bytes` to the value of `carry`
|
||||||
|
> modulus 58.
|
||||||
|
> 4. Set `carry` to the value of `carry` divided by 58.
|
||||||
|
>
|
||||||
|
> Once the `b58_bytes` array has been constructed, generate the final
|
||||||
|
> `b58_encoding` using the following algorithm. Set the first `zero_counter`
|
||||||
|
> bytes in `b58_encoding` to `1`. Then, for every byte in `b58_array`, map the
|
||||||
|
> byte value using the Base58 alphabet in the previous section to its
|
||||||
|
> corresponding character in `b58_encoding`. Return `b58_encoding` as the
|
||||||
|
> Base58 representation of the input array of bytes.
|
||||||
|
|
||||||
|
I personally have no idea what that does. I found a YouTube video that
|
||||||
|
explained the Base58 algorithm in a way that made a lot more sense.
|
||||||
|
([source](https://youtu.be/GedV3S9X89c)). The video gave a clear enough
|
||||||
|
explanation of the Base58 algorithm that I could _figure out_ what is going on
|
||||||
|
and why it makes sense. I was able to relate what I was seeing in the video to
|
||||||
|
background context I happen to have from mathematics. But the video didn't
|
||||||
|
provide that context.
|
||||||
|
|
||||||
|
I want this document to explain what both algorithms do, why they make sense,
|
||||||
|
how they are different, and why they _have_ to be different. All with code
|
||||||
|
examples and sufficient mathematical context.
|
||||||
|
|
||||||
|
Let's get started.
|
||||||
|
|
||||||
|
Any data stored in a computer is represented as an integer. For the purposes of
|
||||||
|
this discussion, we're going to assume all integers are non-negative (greater
|
||||||
|
than or equal to 0). The discussion below can easily be modified to accomodate
|
||||||
|
negative integers. This would add a small amount of annoying complexity in
|
||||||
|
exchange for no gain in conceptual clarity. Nothing we are doing requires
|
||||||
|
dealing with negative numbers.
|
||||||
|
|
||||||
|
The problem we are interested in is _how do we represent really big integers in
|
||||||
|
plain text?_.
|
||||||
|
|
||||||
|
The first point I want you to take away is that **these are two totally
|
||||||
|
different solutions**. Do not be fooled by the name. It is **NOT** the
|
||||||
|
case that these are two instances of the same "Base N"
|
||||||
|
algorithm, just one is `N = 64` and one is `N = 58`. **These are two totally
|
||||||
|
different approaches to solving the same problem.**
|
||||||
|
|
||||||
|
More precisely, the underlying mathematics behind the two notations is very
|
||||||
|
similar, but the algorithms for producing them are very different. More detail
|
||||||
|
later.
|
||||||
|
|
||||||
|
Like I said, any given piece of data is---from the perspective of your
|
||||||
|
computer---just a very big integer. The difference between the two algorithms
|
||||||
|
is, roughly:
|
||||||
|
|
||||||
|
1. The Base64 algorithm thinks of that integer as a "stream of digits"
|
||||||
|
2. The Base58 algorithm thinks of that integer as a "pure integer," kind of
|
||||||
|
the way math thinks of an integer: the integer _itself_ is a different
|
||||||
|
thing than the way the integer is _represented_.
|
||||||
|
|
||||||
|
Base64 encoding/decoding involves a straightforward translation back and forth
|
||||||
|
from the machine representation of integers, without thinking too much (or at
|
||||||
|
all) about the math involved.
|
||||||
|
|
||||||
|
Base58 encoding/decoding requires thinking about the integer from a more mathy
|
||||||
|
point of view. That weird arcane algorithm above is what happens when you try
|
||||||
|
to phrase the mathematics in terms of the machine representation of
|
||||||
|
really big integers.
|
||||||
|
|
||||||
|
We're going to focus on the mathy point of view and then circle back to the
|
||||||
|
weird arcane algorithm later on.
|
||||||
|
|
||||||
|
There is actually a good reason we don't use decimal notation for really big
|
||||||
|
integers: it's extremely wasteful.
|
||||||
|
|
||||||
|
I'll explain the following in more detail in a later section. Roll with me. To
|
||||||
|
any piece of data there is associated a quantity called **information**. The
|
||||||
|
_unit_ of information is the _bit_, in the same sense that the unit of length
|
||||||
|
is the meter.
|
||||||
|
|
||||||
|
1. There are 256 distinct bytes. A single byte (machine digit)
|
||||||
|
contains exactly 8 bits $8 = \log_2 256$ of information.
|
||||||
|
|
||||||
|
2. There are 10 distinct decimal ("Base10") symbols. A single decimal digit
|
||||||
|
contains approximately 3.32 bits (`3.32 ~ log2(10)`) of information.
|
||||||
|
|
||||||
|
3. There are 64 distinct Base64 symbols. A single Base64 digit contains
|
||||||
|
exactly $6$ bits (`6 = log2(64)`) of information.
|
||||||
|
|
||||||
|
4. There are 58 distinct Base58 symbols. A single Base58 digit contains
|
||||||
|
approximately 5.86 bits (`5.86 ~ log2(58)`) of information.
|
||||||
|
|
||||||
|
What this means is, in base64 notation, each symbol consumes 6 bits of
|
||||||
|
information, roughly twice the rate of decimal notation (~3.32 bits per
|
||||||
|
symbol). What this means in practice is that a number written in Base64
|
||||||
|
notation is about half as long as a number written in decimal notation.
|
||||||
|
|
||||||
|
For instance, the number `K = 90 682 877 680 429`
|
||||||
|
|
||||||
|
1. requires 14 digits (count them!) in decimal notation
|
||||||
|
|
||||||
|
$$
|
||||||
|
\frac{(\log_2 K) \text{ bits}}
|
||||||
|
{(\log_2 10) \text{ bits per symbol}}
|
||||||
|
\approx
|
||||||
|
\frac{46.37 \text{ bits}}
|
||||||
|
{ 3.37 \text{ bits per symbol}}
|
||||||
|
\approx 13.96 \text{ symbols}
|
||||||
|
$$
|
||||||
|
|
||||||
|
2. requires 8 digits in Base64 notation (`UnnAthst`)
|
||||||
|
|
||||||
|
$$
|
||||||
|
\frac{(\log_2 K) \text{ bits}}
|
||||||
|
{(\log_2 64) \text{ bits per symbol}}
|
||||||
|
\approx
|
||||||
|
\frac{46.37 \text{ bits}}
|
||||||
|
{ 6 \text{ bits per symbol}}
|
||||||
|
\approx 7.73 \text{ symbols}
|
||||||
|
$$
|
||||||
|
|
||||||
|
3. requires 8 digits in Base58 notation (`i55xNZNt`)
|
||||||
|
|
||||||
|
$$
|
||||||
|
\frac{(\log_2 K) \text{ bits}}
|
||||||
|
{(\log_2 58) \text{ bits per symbol}}
|
||||||
|
\approx
|
||||||
|
\frac{46.37 \text{ bits}}
|
||||||
|
{ 5.86 \text{ bits per symbol}}
|
||||||
|
\approx 7.91 \text{ symbols}
|
||||||
|
$$
|
||||||
|
|
||||||
|
As you can see, the difference in space complexity between Base58 and Base64 is
|
||||||
|
pretty small, but the difference between Base10 is pretty large. Base58 has
|
||||||
|
the same alphabet (set of symbols) as Base64, minus a handful that can cause
|
||||||
|
readability or manual input issues. For instance, the Base64 alphabet contains
|
||||||
|
both the symbol `0` (numeral zero) and `O` (uppercase letter `o`). The Base58
|
||||||
|
alphabet contains neither.
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*.beam
|
||||||
|
dist_js
|
||||||
|
sidekick_dist
|
||||||
|
docs
|
||||||
|
examples/examples_dist_js
|
||||||
|
www_tree
|
||||||
|
prose
|
||||||
|
*.hi
|
||||||
|
*.o
|
||||||
|
sidekick_mindist
|
||||||
|
sidekick_fulldist
|
||||||
|
dist
|
||||||
|
jx_mindist
|
||||||
|
*jx_include*
|
||||||
|
jex_mindist
|
||||||
|
erl_crash.dump
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Peter Harpending
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||||
|
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||||
|
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||||
|
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||||
|
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||||
|
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||||
|
PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
all: prepare build
|
||||||
|
|
||||||
|
deploy: prepare build mindist push
|
||||||
|
|
||||||
|
prepare:
|
||||||
|
jx pull -f
|
||||||
|
|
||||||
|
build:
|
||||||
|
jx build -f
|
||||||
|
|
||||||
|
mindist:
|
||||||
|
jx mindist -f
|
||||||
|
|
||||||
|
push:
|
||||||
|
jx push -f
|
||||||
@@ -0,0 +1,490 @@
|
|||||||
|
# Sidekick
|
||||||
|
|
||||||
|
Sidekick is a simple JavaScript library for talking to an Aeternity
|
||||||
|
browser wallet extension such as Superhero from the document context
|
||||||
|
of a webpage.
|
||||||
|
|
||||||
|
| **Thing** | **URL** |
|
||||||
|
| --- | --- |
|
||||||
|
| Bug Tracker | https://gitlab.com/DoctorAjayKumar/sidekick/-/issues |
|
||||||
|
| Documentation | http://orangepill.healthcare/projects/sidekick/current/docs |
|
||||||
|
| Examples | https://gitlab.com/DoctorAjayKumar/sidekick/-/tree/master/examples |
|
||||||
|
| Git repository | https://gitlab.com/DoctorAjayKumar/sidekick |
|
||||||
|
| Homepage | http://orangepill.healthcare/projects/sidekick |
|
||||||
|
| License | ./LICENSE.txt |
|
||||||
|
| Maintainer | Dr. Ajay Kumar PHD <DoctorAjayKumar@protonmail.com> |
|
||||||
|
| Releases | http://orangepill.healthcare/projects/sidekick/releases |
|
||||||
|
|
||||||
|
|
||||||
|
> One of the most important things for designing a computer, which I
|
||||||
|
> think most designers don't do, is you study the problem you want to
|
||||||
|
> solve. And then use what you learn from studying the problem you
|
||||||
|
> want to solve to put in the mechanisms needed to solve it in the
|
||||||
|
> computer you're building. No more, no less.
|
||||||
|
|
||||||
|
— Gerald Jay Sussman
|
||||||
|
|
||||||
|
### What sidekick is NOT
|
||||||
|
|
||||||
|
Sidekick is **not** ideal if you operate in the Node/NPM ecosystem. If you are
|
||||||
|
working in the Node/NPM ecosystem, you probably want the [Aeternity JavaScript
|
||||||
|
SDK](https://github.com/aeternity/aepp-sdk-js/). Every single
|
||||||
|
Aeternity-related thing you could ever possibly want to do is possible to
|
||||||
|
accomplish with the SDK.
|
||||||
|
|
||||||
|
All that Sidekick knows how to do is talk to a browser wallet extension. In an
|
||||||
|
application, there is a great deal of necessary functionality (e.g. forming
|
||||||
|
transactions for the wallet to sign) which sidekick assumes your server-side
|
||||||
|
code has already handled.
|
||||||
|
|
||||||
|
In all software there is a tradeoff between simplicity and number of features.
|
||||||
|
Sidekick is very simple: 2300 lines of TypeScript, including comments, with no
|
||||||
|
dependencies. Therefore Sidekick intentionally only has a very limited set of
|
||||||
|
features.
|
||||||
|
|
||||||
|
|
||||||
|
# How to use this library
|
||||||
|
|
||||||
|
To obtain this library, download and unpack a release tarball
|
||||||
|
|
||||||
|
wget http://zxq9.com/projects/vanillae/sidekick/releases/sidekick_dist_X-Y-Z.tar.gz
|
||||||
|
tar xzvf sidekick_dist_X-Y-Z.tar.gz
|
||||||
|
|
||||||
|
You *should* be able to get all of the functionality you need just
|
||||||
|
from the exposed functions in the `sidekick` module. (If this is not
|
||||||
|
the case, please report this as a bug.)
|
||||||
|
|
||||||
|
You probably want to read the documentation of:
|
||||||
|
|
||||||
|
sidekick.js : top-level function calls
|
||||||
|
awcp/awcp.js : explains the return types of top-level sidekick
|
||||||
|
functions, explains what sidekick actually does
|
||||||
|
for you, and explains how all the various
|
||||||
|
modules fit together
|
||||||
|
skylight.js : main data structure in sidekick
|
||||||
|
helpers.js : what it sounds like
|
||||||
|
|
||||||
|
There are examples explained in this document. Their source can be
|
||||||
|
found in full in the GitLab repository, link above. The examples
|
||||||
|
exhibit how to interact with the standard release tarball using
|
||||||
|
TypeScript.
|
||||||
|
|
||||||
|
|
||||||
|
## General flow of Sidekick usage
|
||||||
|
|
||||||
|
1. Import the sidekick.js file:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as sk from '/path/to/sidekick_dist_X-Y-Z/dist_js/sidekick.js'
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a `Skylight`. This is the main data structure of Sidekick.
|
||||||
|
|
||||||
|
There are two ways to do this
|
||||||
|
|
||||||
|
1. `start_dwim() : Promise<Skylight>`
|
||||||
|
|
||||||
|
This is probably the one you want. It starts up the Skylight
|
||||||
|
and does the handshake with the wallet (will pop up the
|
||||||
|
little window for your user). The effect of this is to
|
||||||
|
populate all the variables like the user's public key.
|
||||||
|
|
||||||
|
Note that this is an async function. It doesn't return until
|
||||||
|
the handshake is complete.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Needs to be wrapped in an async function in order to use
|
||||||
|
// await keyword
|
||||||
|
async function main() : Promise<void> {
|
||||||
|
let my_skylight = await sk.start_dwim();
|
||||||
|
...
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
|
```
|
||||||
|
|
||||||
|
2. `start : Skylight`
|
||||||
|
|
||||||
|
This is the vanilla option. All it does is create the
|
||||||
|
Skylight object.
|
||||||
|
|
||||||
|
Beware that this does start up a message queue that passively
|
||||||
|
listens for messages from the wallet.
|
||||||
|
|
||||||
|
|
||||||
|
3. Pass the skylight in to various functions along with additional
|
||||||
|
calldata generated by your server-side backend code.
|
||||||
|
|
||||||
|
|
||||||
|
## Example 1: Hello World
|
||||||
|
|
||||||
|
The effect of this example is to print "hello world" to the JS
|
||||||
|
console (Ctrl+Shift+C in most browsers). This example is included for
|
||||||
|
debugging/mental-quicksand-escape purposes.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Hello world: Sidekick</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Sidekick Example: Hello World</h1>
|
||||||
|
|
||||||
|
<h4>Check the console</h4>
|
||||||
|
<script type="module">
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
sk.hello();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
The important lines are
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script type="module">
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
sk.hello();
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
This shows
|
||||||
|
|
||||||
|
- you need to use `type="module"` in order for imports to work
|
||||||
|
- how to do an import
|
||||||
|
- how to call functions from an imported module
|
||||||
|
|
||||||
|
|
||||||
|
## Example 2: get the user to sign a transaction
|
||||||
|
|
||||||
|
Anything you will want the user to do (e.g. sign smart contracts) is
|
||||||
|
contained in "get the user to sign a transaction". This example
|
||||||
|
illustrates the basic things you need to do in order to accomplish
|
||||||
|
that.
|
||||||
|
|
||||||
|
Sidekick does not provide functionality for forming the transaction
|
||||||
|
string you want the user to sign. Your backend should be doing that.
|
||||||
|
|
||||||
|
The example here uses a shim library called `parasite`, which you can find in
|
||||||
|
the GitLab repository in the `examples` directory. Parasite is just a rewrite
|
||||||
|
layer in front of the `testnet.aeternity.io` JSON interface. It is not suitable
|
||||||
|
for usage in production.
|
||||||
|
|
||||||
|
This is adapted from
|
||||||
|
[`examples/examples_src_ts/do_a_transfer.ts`][dat_ts]. The
|
||||||
|
difference is that `do_a_transfer.ts` is written against
|
||||||
|
[`examples/examples_html/do_a_transfer.html`][dat_html]. It contains
|
||||||
|
a lot of unnecessary detail, like doing things in response to buttons
|
||||||
|
being clicked, and filling in DOM textboxes with the results of things.
|
||||||
|
|
||||||
|
The full example has logic that resembles a register machine, rather
|
||||||
|
than a functional program. This example is closer to a functional
|
||||||
|
program.
|
||||||
|
|
||||||
|
[dat_html]: https://gitlab.com/DoctorAjayKumar/sidekick/-/blob/master/examples/examples_html/do_a_transfer.html
|
||||||
|
[dat_ts]: https://gitlab.com/DoctorAjayKumar/sidekick/-/blob/master/examples/examples_src_ts/do_a_transfer.ts
|
||||||
|
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as ae_node from './parasite/ae_node.js';
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
|
||||||
|
async function
|
||||||
|
main()
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 1: MAKE A SKYLIGHT
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
let skl : sk.Skylight =
|
||||||
|
await sk.start_dwim(sk.TIMEOUT_DEF_DETECT,
|
||||||
|
sk.TIMEOUT_DEF_CONNECT,
|
||||||
|
sk.TIMEOUT_DEF_ADDRESS);
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 2: GET THE USER'S ADDRESS
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
let user_addr : string =
|
||||||
|
await sk.address(skl, sk.TIMEOUT_DEF_ADDRESS);
|
||||||
|
|
||||||
|
// faster/non-async:
|
||||||
|
//
|
||||||
|
// let user_addr = skl.waellet_address
|
||||||
|
//
|
||||||
|
// the non-commented code
|
||||||
|
//
|
||||||
|
// - will crash if the wallet isn't connected
|
||||||
|
// - will query the wallet for the address if the wallet *is*
|
||||||
|
// connected but the skl.waellet_address field *is not*
|
||||||
|
// populated
|
||||||
|
// - will crash if that times out after the second argument
|
||||||
|
// number of milliseconds
|
||||||
|
//
|
||||||
|
// if you know with 100% certainty that the address field will be
|
||||||
|
// populated (which we do here, because we used connect_dwim),
|
||||||
|
// then it's safe to just grab the field from the skylight
|
||||||
|
//
|
||||||
|
// The problem is that if the address field isn't populated, the
|
||||||
|
// commented code defaults to `undefined`, rather than crashing
|
||||||
|
// with an error message and callstack trace
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 3: FORM THE TRANSACTION
|
||||||
|
//
|
||||||
|
// This will be different for your application, because you're
|
||||||
|
// not using parasite (right?)
|
||||||
|
//
|
||||||
|
// You need to figure out how to make something like `tx_obj` on
|
||||||
|
// your own.
|
||||||
|
//
|
||||||
|
// `tx_obj` is just `{tx: "some_base58_garbage"}`.
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
|
||||||
|
let target_addr : string =
|
||||||
|
'ak_dvNHMgVvdSgDchLsmcUpuFTbMBGfG3E5V9KZnNjLYPyEhcqnL';
|
||||||
|
|
||||||
|
// amount is in aettos
|
||||||
|
let amount : number = 1;
|
||||||
|
let endpoint : string = ae_node.URL_TESTNET;
|
||||||
|
let spendtx = {'recipient_id' : target_addr,
|
||||||
|
'amount' : amount,
|
||||||
|
'fee' : ae_node.MIN_FEE,
|
||||||
|
'sender_id' : user_addr,
|
||||||
|
'payload' : ""};
|
||||||
|
let tx_obj = await ae_node.PostSpend(endpoint, spendtx);
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 4: HAVE THE USER SIGN THE TRANSACTION
|
||||||
|
//
|
||||||
|
// There are two options:
|
||||||
|
//
|
||||||
|
// 1. `tx_sign_no_propagate` simply has the wallet sign the
|
||||||
|
// transaction, and return the signed transaction back to you
|
||||||
|
//
|
||||||
|
// 2. `tx_sign_yes_propagate` has the wallet sign the transaction
|
||||||
|
// and also propagates it into the network. It returns a more
|
||||||
|
// elaborate data structure, which is documented in somewhere
|
||||||
|
// the AWCP module documentation.
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
|
||||||
|
let result =
|
||||||
|
await sk.tx_sign_no_propagate(skl,
|
||||||
|
tx_obj,
|
||||||
|
sk.NETWORK_ID_TESTNET,
|
||||||
|
sk.TIMEOUT_DEF_SIGN);
|
||||||
|
|
||||||
|
console.log(result);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# Known pitfalls
|
||||||
|
|
||||||
|
- See notes in sidekick module about potential state crossups if your
|
||||||
|
document logic is multi-threaded.
|
||||||
|
|
||||||
|
- Has only been tested against Firefox-on-Linux
|
||||||
|
|
||||||
|
- Have not worked out good user idioms for handling errors
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# How the release is structured and why
|
||||||
|
|
||||||
|
The idea of the release is that it contains exactly what is needed in
|
||||||
|
order to drop Sidekick into your project and start using it. No more,
|
||||||
|
no less.
|
||||||
|
|
||||||
|
A release has the following structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
sidekick_dist_X-Y-Z/
|
||||||
|
dist_js/............tsc-generated human-readable JS tree
|
||||||
|
foo.js..............the actual code that is run
|
||||||
|
foo.d.ts............included so that your TypeScript code can
|
||||||
|
typecheck against sidekick
|
||||||
|
foo.js.map..........debug symbols that map foo.js to
|
||||||
|
locations in the TypeScript source
|
||||||
|
src_ts/.............included so that the browser's debugger works
|
||||||
|
foo.ts
|
||||||
|
README.txt
|
||||||
|
LICENSE.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
We use semantic versioning: `X.Y.Z`
|
||||||
|
|
||||||
|
- A change in `X` means an API-breaking change
|
||||||
|
- A change in `Y` means an non-breaking API change
|
||||||
|
- A change in `Z` means no change to the API
|
||||||
|
|
||||||
|
There is no documentation included in the release. There is
|
||||||
|
autogenerated API documentation linked above, which is generated from
|
||||||
|
this file and the sources that are included in the release.
|
||||||
|
|
||||||
|
|
||||||
|
## What each file does
|
||||||
|
|
||||||
|
```
|
||||||
|
src_ts/.....................TypeScript source for sidekick library
|
||||||
|
awcp/.......................Aepp-Waellet Communication Protocol
|
||||||
|
awcp.ts.....................Protocol definition
|
||||||
|
msgq.ts.....................Block-on-raseev implementation
|
||||||
|
msgr.ts.....................Protocol implementation
|
||||||
|
helpers.ts..................what it sounds like
|
||||||
|
sidekick.ts.................top-level module
|
||||||
|
skylight.ts.................primary data structure
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Where is the NPM package or the webpack bundle?
|
||||||
|
|
||||||
|
There isn't one.
|
||||||
|
|
||||||
|
|
||||||
|
### Why?
|
||||||
|
|
||||||
|
Sidekick is a library that deals with cryptocurrency. The security
|
||||||
|
model is based on transparency and trust. A user must be able to
|
||||||
|
inspect code that is running on his hardware handling his money.
|
||||||
|
|
||||||
|
We don't support NPM because of the security issues that NPM
|
||||||
|
introduces. Briefly, the code can change at any time under the
|
||||||
|
developer's nose without the developer knowing. The [leftpad
|
||||||
|
debacle][lpad] and the [RIAEvangelist debacle][ria] are good examples
|
||||||
|
of the types of vulnerabilities that package managers like NPM
|
||||||
|
enable.
|
||||||
|
|
||||||
|
[lpad]: https://archive.ph/Qsh7j
|
||||||
|
[ria]: https://archive.ph/OF5I9
|
||||||
|
|
||||||
|
We don't use something like webpack because that introduces an opaque
|
||||||
|
rewrite using an untrusted tool. Webpack could plausibly alter the
|
||||||
|
runtime behavior of the program, and we would have no way to detect
|
||||||
|
that. Even if we trusted webpack, how do we obtain webpack? NPM.
|
||||||
|
So.
|
||||||
|
|
||||||
|
It is debatable whether or not we should trust the TypeScript
|
||||||
|
compiler (TSC). On the whole, TSC probably makes Sidekick more
|
||||||
|
secure, simply by virtue of increasing overall code quality and
|
||||||
|
eliminating the largest categories of potential bugs. Moreover, the
|
||||||
|
output that TSC produces is human-readable, and has a very
|
||||||
|
straightforward mapping to the original source code. A human can
|
||||||
|
easily read the TSC-generated JavaScript tree, even without the aid
|
||||||
|
of the source map, and have a high degree of faith that the code is
|
||||||
|
trustworthy and that TSC is behaving as promised.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# How to obtain the source tree
|
||||||
|
|
||||||
|
The source tree is included in your release. You can clone the
|
||||||
|
git repository with
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://gitlab.com/DoctorAjayKumar/sidekick.git
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Repo file tree (non-exhaustive)
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
examples/...................Examples
|
||||||
|
contract-examples/..........Example Sophia smart contracts
|
||||||
|
examples_html/..............Low-budget example interfaces
|
||||||
|
do_a_transfer.html......Send money to an arbitrary address
|
||||||
|
hello.html..............Hello world
|
||||||
|
ide.html................Play around with smart contracts
|
||||||
|
examples_src_ts/............TypeScript source for each example
|
||||||
|
parasite/...................JavaScript shim that does what
|
||||||
|
your backend code ordinarily
|
||||||
|
would do
|
||||||
|
ae_compiler.ts..............Talk to a remote Sophia
|
||||||
|
compiler JSON HTTP interface
|
||||||
|
ae_node.ts..................Talk to a node (for forming
|
||||||
|
transactions, querying chain,
|
||||||
|
etc)
|
||||||
|
net.ts......................Network helper functions
|
||||||
|
do_a_transfer.ts........Send money to an arbitrary address
|
||||||
|
ide.ts..................Play around with smart contracts
|
||||||
|
tsconfig.json...............Examples-specific tsc configuration
|
||||||
|
src_ts/.....................TypeScript source for sidekick library
|
||||||
|
awcp/.......................Aepp-Waellet Communication Protocol
|
||||||
|
awcp.ts.....................Protocol definition
|
||||||
|
msgq.ts.....................Block-on-raseev implementation
|
||||||
|
msgr.ts.....................Protocol implementation
|
||||||
|
helpers.ts..................what it sounds like
|
||||||
|
sidekick.ts.................top-level module
|
||||||
|
skylight.ts.................primary data structure
|
||||||
|
LICENSE.txt.................MIT License
|
||||||
|
Makefile....................Makefile
|
||||||
|
make........................Equivalent to `make build`
|
||||||
|
make build..................Run tsc
|
||||||
|
make clean..................rm -r dist_js sidekick_dist docs \
|
||||||
|
examples/examples_dist_js
|
||||||
|
make dist...................Build a release tarball directory
|
||||||
|
make jsdoc..................Build the HTML documentation
|
||||||
|
make build_examples.........cd examples && tsc
|
||||||
|
make serve_examples.........cd examples && python3 -m \
|
||||||
|
http.server 8001
|
||||||
|
README.txt..................This file
|
||||||
|
STYLE_GUIDE.md..............Explains why the code looks so weird
|
||||||
|
TODO.md.....................what it sounds like
|
||||||
|
tsconfig.json...............Configuration file for tsc
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# How to build a release
|
||||||
|
|
||||||
|
You will need the TypeScript compiler installed. See prereqs section.
|
||||||
|
|
||||||
|
make dist
|
||||||
|
|
||||||
|
|
||||||
|
## Prereqs for building source files
|
||||||
|
|
||||||
|
If you want to edit and rebuild the source files, you need TypeScript
|
||||||
|
installed, and you should update npm.
|
||||||
|
|
||||||
|
npm install -g typescript
|
||||||
|
npm install -g npm
|
||||||
|
|
||||||
|
## Protip: avoid using `sudo npm install -g`
|
||||||
|
|
||||||
|
If you want to avoid using sudo
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir ~/.npm-packages
|
||||||
|
npm config set prefix "${HOME}/.npm-packages"
|
||||||
|
```
|
||||||
|
|
||||||
|
Edit `~/.bashrc` or `~/.zshrc` with
|
||||||
|
|
||||||
|
```
|
||||||
|
NPM_PACKAGES="${HOME}/.npm-packages"
|
||||||
|
export PATH=$NPM_PACKAGES/bin:$PATH
|
||||||
|
```
|
||||||
|
|
||||||
|
Source: https://github.com/sindresorhus/guides/blob/main/npm-global-without-sudo.md
|
||||||
|
|
||||||
|
|
||||||
|
# How to build and view documentation
|
||||||
|
|
||||||
|
```
|
||||||
|
make build_docs
|
||||||
|
make serve_docs
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{type, library}.
|
||||||
|
{realm, local}.
|
||||||
|
{name, awcp}.
|
||||||
|
{version, "0.1.0"}.
|
||||||
|
{deps, []}.
|
||||||
@@ -0,0 +1,724 @@
|
|||||||
|
/**
|
||||||
|
* # AWCP: aepp-waellet communication protocol
|
||||||
|
*
|
||||||
|
* Suppose you are the aepp and you want to communicate with a waellet. What
|
||||||
|
* you do is pick an `EventTarget` (typically `window`), and listen to its
|
||||||
|
* `MessageEvent`s, via something like
|
||||||
|
*
|
||||||
|
* ```typescript
|
||||||
|
* window.addEventListener('message', my_listener);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* You then communicate with the wallet by sending messages back over the
|
||||||
|
* `EventTarget`
|
||||||
|
*
|
||||||
|
* 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
|
||||||
|
* protocol.
|
||||||
|
*
|
||||||
|
* 1. The `MessageEvent` layer. This is what is actually sent as an event.
|
||||||
|
* This is an opaque object that is built into every runtime's standard
|
||||||
|
* library: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent
|
||||||
|
*
|
||||||
|
* The `MessageEvent` has a field called `data`, which corresponds to the
|
||||||
|
* next layer.
|
||||||
|
*
|
||||||
|
* 2. The `EventData` layer. This is what goes in `message_event.data`. The
|
||||||
|
* structure that goes in here is one of
|
||||||
|
*
|
||||||
|
* 1. `EventData_W2A`: waellet-to-aepp
|
||||||
|
* 2. `EventData_A2W`: aepp-to-waellet
|
||||||
|
*
|
||||||
|
* This layer corresponds to the "am I supposed to pay attention to this
|
||||||
|
* event?" branch point.
|
||||||
|
*
|
||||||
|
* Those data structures mentioned above have two fields.
|
||||||
|
*
|
||||||
|
* 1. `type` is a string which is either `"to_aepp"` or `"to_waellet"`
|
||||||
|
* 2. `data` contains the next layer
|
||||||
|
*
|
||||||
|
* ```typescript
|
||||||
|
* type EventData_W2A
|
||||||
|
* <t extends any>
|
||||||
|
* = {type : "to_aepp",
|
||||||
|
* data : t};
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* ``` typescript
|
||||||
|
* type EventData_A2W
|
||||||
|
* <t extends any>
|
||||||
|
* = {type : "to_waellet",
|
||||||
|
* data : t};
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* 3. We're at `message_event.data.data`. The idiom here is "JSON RPC", which
|
||||||
|
* is sort of a poor man's HTTP.
|
||||||
|
*
|
||||||
|
* In general, the wallet is the server and the aepp is the client.
|
||||||
|
*
|
||||||
|
* If you are the aepp, usually you are handling a response to a request
|
||||||
|
* you sent to the waellet. For instance, you formed a transaction and
|
||||||
|
* sent it to the waellet to sign, and the waellet is sending you back
|
||||||
|
* either the signed transaction or an error (e.g. user rejected the
|
||||||
|
* transaction).
|
||||||
|
*
|
||||||
|
* The exception to this pattern is the wallet notifying you that it
|
||||||
|
* exists, which is the only time the waellet sends a request (a "cast", or
|
||||||
|
* a "notification") to the aepp. __In no event does the aepp send a
|
||||||
|
* response to the waellet.__
|
||||||
|
*
|
||||||
|
* I am not 100% sure what RPC stands for, but it will be helpful to think
|
||||||
|
* about it as "remote procedure call". More below. This layer roughly
|
||||||
|
* corresponds to the "given that I am supposed to pay attention to this
|
||||||
|
* event, what am I supposed to do with this information?"
|
||||||
|
*
|
||||||
|
* All requests have a `method` field (a string) and a `params` field (an
|
||||||
|
* object). There are two types of requests:
|
||||||
|
*
|
||||||
|
* 1. "casts" (the RPC standard calls these "notifications"). These do not
|
||||||
|
* need a response. This is only used for the waellet announcing it
|
||||||
|
* exists.
|
||||||
|
*
|
||||||
|
* 2. "calls". These have an `id` field, and get a response. These are
|
||||||
|
* used when the aepp is requesting the waellet to do something. The
|
||||||
|
* response will have the same `id` field and the same `method` field.
|
||||||
|
*
|
||||||
|
* 4. So far nothing we've talked about is specific to Aeternity, Vanillae,
|
||||||
|
* JR, or sidekick. This fourth layer is the actual semantics of the
|
||||||
|
* messaging protocol between the aepp and the waellet.
|
||||||
|
*
|
||||||
|
* By analogy, the first two layers are developing something like TCP. The
|
||||||
|
* third layer is developing HTTP. And this layer is the actual routing
|
||||||
|
* table of your website, which carries with it the expected semantics of
|
||||||
|
* how the website is supposed to behave.
|
||||||
|
*
|
||||||
|
* This module DOES __NOT__ exhaustively define all of the communication
|
||||||
|
* protocol that occurs in the SDK, only the subset that I have encountered
|
||||||
|
* in practice.
|
||||||
|
*
|
||||||
|
* The first layer is defined by the runtime, not here. So we're starting with
|
||||||
|
* layer 2.
|
||||||
|
*
|
||||||
|
* # Notes on JSON RPC 2.0
|
||||||
|
*
|
||||||
|
* I have subtly changed the RPC protocol to
|
||||||
|
*
|
||||||
|
* 1. improve it in such a way that it is easier to use in code
|
||||||
|
* 2. more accurately represent how it is used in practice
|
||||||
|
*
|
||||||
|
* The only difference here is that the `params` field of requests is
|
||||||
|
* non-optional, and must be an object (the RPC standard allows arrays).
|
||||||
|
*
|
||||||
|
* ## Requests
|
||||||
|
*
|
||||||
|
* I have adapted the verbiage here, borrowing from Erlang, to make a
|
||||||
|
* distinction between
|
||||||
|
*
|
||||||
|
* 1. casts (RPC calls these "notifications"): these
|
||||||
|
*
|
||||||
|
* 1. do __NOT__ have an `id` field
|
||||||
|
* 2. __AND__ do __NOT__ require a response.
|
||||||
|
*
|
||||||
|
* 2. calls: these
|
||||||
|
*
|
||||||
|
* 1. __DO__ have an `id` field
|
||||||
|
* 2. __AND__ __DO__ require a response.
|
||||||
|
*
|
||||||
|
* The `RpcCall` and `RpcResp` data structures each have an `id_n` type
|
||||||
|
* parameter.
|
||||||
|
*
|
||||||
|
* The purpose of this is to notate (and possibly enforce) at the type level
|
||||||
|
* the constraint that, given a call with say `id = 7`, the response must also
|
||||||
|
* have `id = 7`.
|
||||||
|
*
|
||||||
|
* # Links
|
||||||
|
*
|
||||||
|
* - `MessageEvent`s: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent
|
||||||
|
* - JSON RPC 2.0 https://www.jsonrpc.org/specification
|
||||||
|
*
|
||||||
|
* @module
|
||||||
|
*/
|
||||||
|
|
||||||
|
// TODO: TS code style guide
|
||||||
|
// TODO: annotate everything with examples
|
||||||
|
// TODONE: enumerate RPC errors
|
||||||
|
// TODO: move Safe in here
|
||||||
|
// TODO: constants for method names
|
||||||
|
|
||||||
|
|
||||||
|
//=============================================================================
|
||||||
|
// IMPORTS
|
||||||
|
//=============================================================================
|
||||||
|
|
||||||
|
//import type {
|
||||||
|
// ERROR_TYPE_RpcInvalidTransactionError,
|
||||||
|
// ERROR_TYPE_RpcBroadcastError,
|
||||||
|
// ERROR_TYPE_RpcRejectedByUserError,
|
||||||
|
// ERROR_TYPE_RpcUnsupportedProtocolError,
|
||||||
|
// ERROR_TYPE_RpcConnectionDenyError,
|
||||||
|
// ERROR_TYPE_RpcNotAuthorizeError,
|
||||||
|
// ERROR_TYPE_RpcPermissionDenyError,
|
||||||
|
// ERROR_TYPE_RpcInternalError,
|
||||||
|
// ERROR_TYPE_RpcMethodNotFoundError,
|
||||||
|
//} from './errcode.js';
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//=============================================================================
|
||||||
|
// EXPORTS
|
||||||
|
//=============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
export {
|
||||||
|
// error code constants
|
||||||
|
ERROR_CODE_RpcInvalidTransactionError,
|
||||||
|
ERROR_CODE_RpcBroadcastError,
|
||||||
|
ERROR_CODE_RpcRejectedByUserError,
|
||||||
|
ERROR_CODE_RpcUnsupportedProtocolError,
|
||||||
|
ERROR_CODE_RpcConnectionDenyError,
|
||||||
|
ERROR_CODE_RpcNotAuthorizeError,
|
||||||
|
ERROR_CODE_RpcPermissionDenyError,
|
||||||
|
ERROR_CODE_RpcInternalError,
|
||||||
|
ERROR_CODE_RpcMethodNotFoundError,
|
||||||
|
// Layer 2: events
|
||||||
|
EventData_W2A,
|
||||||
|
EventData_A2W,
|
||||||
|
// Layer 3: RPC
|
||||||
|
RpcError,
|
||||||
|
RpcCast,
|
||||||
|
RpcCall,
|
||||||
|
RpcResp_error,
|
||||||
|
RpcResp_ok,
|
||||||
|
RpcResp,
|
||||||
|
RpcResp_Any,
|
||||||
|
// Layer 4: specific semantics
|
||||||
|
// connection.announcePresence
|
||||||
|
Params_W2A_connection_announcePresence,
|
||||||
|
RpcCast_W2A_connection_announcePresence,
|
||||||
|
EventData_W2A_connection_announcePresence,
|
||||||
|
// connection.open
|
||||||
|
Params_A2W_connection_open,
|
||||||
|
Result_W2A_connection_open,
|
||||||
|
RpcCall_A2W_connection_open,
|
||||||
|
RpcResp_W2A_connection_open,
|
||||||
|
EventData_A2W_connection_open,
|
||||||
|
EventData_W2A_connection_open,
|
||||||
|
// address.subscribe
|
||||||
|
Params_A2W_address_subscribe,
|
||||||
|
Result_W2A_address_subscribe,
|
||||||
|
RpcCall_A2W_address_subscribe,
|
||||||
|
RpcResp_W2A_address_subscribe,
|
||||||
|
EventData_A2W_address_subscribe,
|
||||||
|
EventData_W2A_address_subscribe,
|
||||||
|
//// transaction.sign (propagate)
|
||||||
|
//Params_A2W_tx_sign_yesprop,
|
||||||
|
//Result_W2A_tx_sign_yesprop,
|
||||||
|
//RpcCall_A2W_tx_sign_yesprop,
|
||||||
|
//RpcResp_W2A_tx_sign_yesprop,
|
||||||
|
//EventData_A2W_tx_sign_yesprop,
|
||||||
|
//EventData_W2A_tx_sign_yesprop,
|
||||||
|
// transaction.sign (do not propagate)
|
||||||
|
Params_A2W_tx_sign_noprop,
|
||||||
|
Result_W2A_tx_sign_noprop,
|
||||||
|
RpcCall_A2W_tx_sign_noprop,
|
||||||
|
RpcResp_W2A_tx_sign_noprop,
|
||||||
|
EventData_A2W_tx_sign_noprop,
|
||||||
|
EventData_W2A_tx_sign_noprop
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//=============================================================================
|
||||||
|
// LAYER 2: WHO IS THIS MESSAGE FOR
|
||||||
|
//
|
||||||
|
// The first layer is defined by the runtime, not here. So we're starting with
|
||||||
|
// layer 2.
|
||||||
|
//=============================================================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the data that is sent from the wallet to the aepp through the Event
|
||||||
|
* bus
|
||||||
|
*/
|
||||||
|
type EventData_W2A
|
||||||
|
<t extends any>
|
||||||
|
= {type : "to_aepp",
|
||||||
|
data : t};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the data that is sent from the aepp to the wallet through the Event
|
||||||
|
* bus
|
||||||
|
*/
|
||||||
|
type EventData_A2W
|
||||||
|
<t extends any>
|
||||||
|
= {type : "to_waellet",
|
||||||
|
data : t};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//=============================================================================
|
||||||
|
// LAYER 3: JSON RPC 2.0
|
||||||
|
//
|
||||||
|
// It should be noted in general that the id field exists as a type parameter
|
||||||
|
// so that we can use the type system to denote ID matches in callbacks.
|
||||||
|
//
|
||||||
|
// Remember, in TypeScript's type system, values are valid types.
|
||||||
|
//
|
||||||
|
// So `(_arg0: Foo<3, string>) => Bar<3, number>` is a valid type
|
||||||
|
//=============================================================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `const ERROR_CODE_RpcInvalidTransactionError = 2;`
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L92
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcInvalidTransactionError = 2;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `const ERROR_CODE_RpcBroadcastError = 3;`
|
||||||
|
*
|
||||||
|
* See
|
||||||
|
* https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L108
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcBroadcastError = 3;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `const ERROR_CODE_RpcRejectedByUserError = 4;`
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L122
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcRejectedByUserError = 4;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `const ERROR_CODE_RpcUnsupportedProtocolError = 5;`
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L140
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcUnsupportedProtocolError = 5;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This error occurs when the user rejects your attempt to connect. (I think)
|
||||||
|
*
|
||||||
|
* The error name here is ungrammatical but following the lead of the SDK.
|
||||||
|
*
|
||||||
|
* `const ERROR_CODE_RpcConnectionDenyError = 9;`
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L155
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcConnectionDenyError = 9;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This error occurs when you are not connected to the wallet.
|
||||||
|
*
|
||||||
|
* The error name here is ungrammatical but following the lead of the SDK.
|
||||||
|
*
|
||||||
|
* `const ERROR_CODE_RpcNotAuthorizeError = 10;`
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L171
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcNotAuthorizeError = 10;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This error occurs when you are not `address.subscribe`d to the wallet (I think?)
|
||||||
|
*
|
||||||
|
* The error name here is ungrammatical but following the lead of the SDK.
|
||||||
|
*
|
||||||
|
* `const ERROR_CODE_RpcPermissionDenyError = 11;`
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L186
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcPermissionDenyError = 11;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the general "something went wrong, i dunno" negative error.
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L196-L209
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcInternalError = 12;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is presumably the equivalent of the HTTP 404 error
|
||||||
|
*
|
||||||
|
* See https://github.com/aeternity/aepp-sdk-js/blob/1065da9a46b8dbfe60a2c3e5646e7422ee7e495e/src/aepp-wallet-communication/schema.ts#L211-L224
|
||||||
|
*/
|
||||||
|
const ERROR_CODE_RpcMethodNotFoundError = -32601;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Error data inside the `error` field of a RpcResp_Err
|
||||||
|
*/
|
||||||
|
type RpcError
|
||||||
|
= {code : number,
|
||||||
|
message : string,
|
||||||
|
data? : any};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-----------------------------------------------------------------------------
|
||||||
|
// Requests
|
||||||
|
//-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This type is used for "notifications", i.e. messages sent from the client to
|
||||||
|
* the server that do not need a response. An example is the wallet announcing
|
||||||
|
* it exists.
|
||||||
|
*/
|
||||||
|
type RpcCast
|
||||||
|
<method_s extends string,
|
||||||
|
params_t extends object>
|
||||||
|
= {jsonrpc : "2.0",
|
||||||
|
method : method_s,
|
||||||
|
params : params_t};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This type is used for requests from the client to the server that require a
|
||||||
|
* response.
|
||||||
|
*/
|
||||||
|
type RpcCall
|
||||||
|
<method_s extends string,
|
||||||
|
params_t extends object>
|
||||||
|
= {jsonrpc : "2.0",
|
||||||
|
id : number | string,
|
||||||
|
method : method_s,
|
||||||
|
params : params_t};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-----------------------------------------------------------------------------
|
||||||
|
// Responses
|
||||||
|
//-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the shape of unsuccessful responses
|
||||||
|
*/
|
||||||
|
type RpcResp_error
|
||||||
|
<method_s extends string>
|
||||||
|
= {jsonrpc : "2.0",
|
||||||
|
id : number | string,
|
||||||
|
method : method_s,
|
||||||
|
error : RpcError};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the shape of successful responses
|
||||||
|
*/
|
||||||
|
type RpcResp_ok
|
||||||
|
<method_s extends string,
|
||||||
|
result_t extends any>
|
||||||
|
= {jsonrpc : "2.0",
|
||||||
|
id : number | string,
|
||||||
|
method : method_s,
|
||||||
|
result : result_t};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the shape of generic responses
|
||||||
|
*/
|
||||||
|
type RpcResp
|
||||||
|
<method_s extends string,
|
||||||
|
result_t extends any>
|
||||||
|
= RpcResp_ok<method_s, result_t>
|
||||||
|
| RpcResp_error<method_s>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Most generic possible response
|
||||||
|
*/
|
||||||
|
type RpcResp_Any = RpcResp<string, any>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//=============================================================================
|
||||||
|
// LAYER 4: VANILLAE-SPECIFIC MESSAGE PROTOCOL
|
||||||
|
//
|
||||||
|
// https://github.com/aeternity/aepp-sdk-js/blob/a435e9df5c94004bcd16326b26c38a9c0b284279/src/aepp-wallet-communication/schema.ts#L32-L42
|
||||||
|
//
|
||||||
|
// Only the request/responses that I have actually encountered in practice are
|
||||||
|
// enumerated here. There are many more things that the SDK code appears to
|
||||||
|
// use which I did not encounter in the wild.
|
||||||
|
//=============================================================================
|
||||||
|
|
||||||
|
// TODO: need to do more experimentation with superhero to see what sorts of
|
||||||
|
// messages it sends back to the other requests
|
||||||
|
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
// connection.announcePresence
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Waellet-to-aepp parameters of "connection.announcePresence" cast
|
||||||
|
*
|
||||||
|
* (layer 4)
|
||||||
|
*/
|
||||||
|
type Params_W2A_connection_announcePresence
|
||||||
|
= {id : string,
|
||||||
|
name : string,
|
||||||
|
origin : string,
|
||||||
|
type : "window" | "extension"};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shape of the waellet-to-aepp "connection.announcePresence" RPC cast
|
||||||
|
*
|
||||||
|
* (layer 3)
|
||||||
|
*/
|
||||||
|
type RpcCast_W2A_connection_announcePresence
|
||||||
|
= RpcCast<"connection.announcePresence",
|
||||||
|
Params_W2A_connection_announcePresence>;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The actual waellet-to-aepp event passed when the wallet announces it exists
|
||||||
|
*
|
||||||
|
* (layer 2)
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
*
|
||||||
|
* ```json
|
||||||
|
* {
|
||||||
|
* "type": "to_aepp",
|
||||||
|
* "data": {
|
||||||
|
* "jsonrpc": "2.0",
|
||||||
|
* "method": "connection.announcePresence",
|
||||||
|
* "params": {
|
||||||
|
* "id": "{aee9e933-52b6-410a-8c3f-99c6be596b4e}",
|
||||||
|
* "name": "Superhero",
|
||||||
|
* "networkId": "ae_mainnet",
|
||||||
|
* "origin": "moz-extension://ee425d81-d5b2-44b6-9406-4da31b019e7c",
|
||||||
|
* "type": "extension"
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
type EventData_W2A_connection_announcePresence
|
||||||
|
= EventData_W2A<RpcCast_W2A_connection_announcePresence>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
// connection.open
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parameters of aepp-to-waellet "connection.open" call
|
||||||
|
*
|
||||||
|
* (layer 4)
|
||||||
|
*/
|
||||||
|
type Params_A2W_connection_open
|
||||||
|
= {name : string,
|
||||||
|
version : 1,
|
||||||
|
networkId? : string};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Result type of "connection.open" call
|
||||||
|
*
|
||||||
|
* Same as `Params_W2A_connection_open` empirically
|
||||||
|
*
|
||||||
|
* (layer 4)
|
||||||
|
*/
|
||||||
|
type Result_W2A_connection_open
|
||||||
|
= Params_W2A_connection_announcePresence;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shape of aepp-to-waellet "connection.open" RPC call
|
||||||
|
*
|
||||||
|
* (layer 3)
|
||||||
|
*/
|
||||||
|
type RpcCall_A2W_connection_open
|
||||||
|
= RpcCall<"connection.open",
|
||||||
|
Params_A2W_connection_open>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shape of waellet-to-aepp "connection.open" RPC response
|
||||||
|
*
|
||||||
|
* (layer 3)
|
||||||
|
*/
|
||||||
|
type RpcResp_W2A_connection_open
|
||||||
|
= RpcResp<"connection.open",
|
||||||
|
Result_W2A_connection_open>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The actual aepp-to-waellet "connection.open" event data passed over the message bus
|
||||||
|
*
|
||||||
|
* (layer 2)
|
||||||
|
*/
|
||||||
|
type EventData_A2W_connection_open
|
||||||
|
= EventData_A2W<RpcCall_A2W_connection_open>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The actual waellet-to-aepp "connection.open" event data passed over the message bus
|
||||||
|
*
|
||||||
|
* (layer 2)
|
||||||
|
*/
|
||||||
|
type EventData_W2A_connection_open
|
||||||
|
= EventData_W2A<RpcResp_W2A_connection_open>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
// address.subscribe
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parameter type of aepp-to-waellet "address.subscribe" call
|
||||||
|
*
|
||||||
|
* (layer 4)
|
||||||
|
*/
|
||||||
|
type Params_A2W_address_subscribe
|
||||||
|
= {type : "subscribe",
|
||||||
|
value : "connected"};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Result type of waellet-to-aepp "address.subscribe response
|
||||||
|
*
|
||||||
|
* (layer 4)
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* {subscription : ["connected"],
|
||||||
|
* address : {current : {"ak_2Wsa8iAmAm917evwDEZjouvPUXKx2nUv5Uz8e8oNXTDfDXnMRN": {}},
|
||||||
|
* connected : {}}}
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
type Result_W2A_address_subscribe
|
||||||
|
= {subscription : ["connected"],
|
||||||
|
address : {current : object,
|
||||||
|
connected : object}};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shape of aepp-to-waellet "address.subscribe" RPC call
|
||||||
|
*
|
||||||
|
* (layer 3)
|
||||||
|
*/
|
||||||
|
type RpcCall_A2W_address_subscribe
|
||||||
|
= RpcCall<"address.subscribe",
|
||||||
|
Params_A2W_address_subscribe>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Result of waellet-to-aepp "address.subscribe" response
|
||||||
|
*
|
||||||
|
* (layer 3)
|
||||||
|
*/
|
||||||
|
type RpcResp_W2A_address_subscribe
|
||||||
|
= RpcResp<"address.subscribe",
|
||||||
|
Result_W2A_address_subscribe>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Actual aepp-to-waellet "address.subscribe" event data sent over the message bus
|
||||||
|
*
|
||||||
|
* (layer 2)
|
||||||
|
*/
|
||||||
|
type EventData_A2W_address_subscribe
|
||||||
|
= EventData_A2W<RpcCall_A2W_address_subscribe>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Actual waellet-to-aepp "address.subscribe" event data sent over the message bus
|
||||||
|
*
|
||||||
|
* (layer 2)
|
||||||
|
*/
|
||||||
|
type EventData_W2A_address_subscribe
|
||||||
|
= EventData_W2A<RpcResp_W2A_address_subscribe>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
// transaction.sign (do not propagate)
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parameters for "transaction.sign" (do not propagate)
|
||||||
|
*
|
||||||
|
* (layer 4)
|
||||||
|
*/
|
||||||
|
type Params_A2W_tx_sign_noprop
|
||||||
|
= {tx : string,
|
||||||
|
returnSigned : true,
|
||||||
|
networkId : string}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Success result type for "transaction.sign" (do not propagate)
|
||||||
|
*
|
||||||
|
* (layer 4)
|
||||||
|
*/
|
||||||
|
type Result_W2A_tx_sign_noprop
|
||||||
|
= {signedTransaction : string};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request type for "transaction.sign" (do not propagate)
|
||||||
|
*
|
||||||
|
* (layer 3)
|
||||||
|
*/
|
||||||
|
type RpcCall_A2W_tx_sign_noprop
|
||||||
|
= RpcCall<"transaction.sign",
|
||||||
|
Params_A2W_tx_sign_noprop>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Response type for "transaction.sign" (do not propagate)
|
||||||
|
*
|
||||||
|
* (layer 3)
|
||||||
|
*/
|
||||||
|
type RpcResp_W2A_tx_sign_noprop
|
||||||
|
= RpcResp<"transaction.sign",
|
||||||
|
Result_W2A_tx_sign_noprop>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Event data for aepp-to-waellet "transaction.sign" (do not propagate) message
|
||||||
|
*
|
||||||
|
* (layer 2)
|
||||||
|
*/
|
||||||
|
type EventData_A2W_tx_sign_noprop
|
||||||
|
= EventData_A2W<RpcCall_A2W_tx_sign_noprop>;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Event data for aepp-to-waellet "transaction.sign" (do not propagate) response
|
||||||
|
*
|
||||||
|
* (layer 2)
|
||||||
|
*/
|
||||||
|
type EventData_W2A_tx_sign_noprop
|
||||||
|
= EventData_W2A<RpcResp_W2A_tx_sign_noprop>;
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
{"compilerOptions" : {"target" : "es2022",
|
||||||
|
"strict" : true,
|
||||||
|
"esModuleInterop" : true,
|
||||||
|
"skipLibCheck" : true,
|
||||||
|
"forceConsistentCasingInFileNames" : true,
|
||||||
|
"noImplicitAny" : true,
|
||||||
|
"strictNullChecks" : true,
|
||||||
|
"strictPropertyInitialization" : true,
|
||||||
|
"sourceMap" : true,
|
||||||
|
"outDir" : "dist",
|
||||||
|
"declaration" : true},
|
||||||
|
"$schema" : "https://json.schemastore.org/tsconfig",
|
||||||
|
"display" : "Recommended",
|
||||||
|
"include" : ["src/**/*"],
|
||||||
|
"exclude" : ["src/jx_include"],
|
||||||
|
"composite" : true}
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
jex_mindist
|
||||||
|
dist
|
||||||
|
src/jex_include
|
||||||
|
erl_crash.dump
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Peter Harpending
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||||
|
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||||
|
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||||
|
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||||
|
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||||
|
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||||
|
PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
all: pull build
|
||||||
|
deploy: pull build mindist push
|
||||||
|
|
||||||
|
pull:
|
||||||
|
jx pull -f
|
||||||
|
|
||||||
|
build:
|
||||||
|
jx build -f
|
||||||
|
|
||||||
|
mindist:
|
||||||
|
jx mindist -f
|
||||||
|
|
||||||
|
push:
|
||||||
|
jx push -f
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{type, library}.
|
||||||
|
{realm, local}.
|
||||||
|
{name, parasite}.
|
||||||
|
{version, "0.1.0"}.
|
||||||
|
{deps, []}.
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
/*******************************************************************
|
||||||
|
** Compiler API
|
||||||
|
**
|
||||||
|
** The manner in which this module is laid out differs meaningfully
|
||||||
|
** from the `ae_node` module.
|
||||||
|
**
|
||||||
|
** - ae_node basically exposes a subset of the node interface as
|
||||||
|
** functions. It only black-boxes away the networking aspects.
|
||||||
|
**
|
||||||
|
** - part of the reason for this is that the data structures that get
|
||||||
|
** sent to the node tend to be pretty involved (lots of fields)
|
||||||
|
**
|
||||||
|
** - in general, the node interface is significantly more complicated
|
||||||
|
** than the compiler interface
|
||||||
|
**
|
||||||
|
** - by contrast, the data structures that get sent to the compiler
|
||||||
|
** tend to be pretty simple and only have a small number of fields
|
||||||
|
**
|
||||||
|
** - the manner in which this manifests is that ae_node functions
|
||||||
|
** tend to have a weird esoteric data structure as the input,
|
||||||
|
** because otherwise there would be too many parameters.
|
||||||
|
**
|
||||||
|
** here, there are few parameters, and they are passed directly
|
||||||
|
**
|
||||||
|
** - in general, the compiler has fewer things it can do, and the
|
||||||
|
** things it does tend to depend on less information. so this
|
||||||
|
** interface is significantly simpler than the node interface
|
||||||
|
*******************************************************************/
|
||||||
|
|
||||||
|
import * as net from './net.js';
|
||||||
|
|
||||||
|
const URL_COMPILER = 'https://compiler.aepps.com';
|
||||||
|
// endpoints
|
||||||
|
const EPT_CompileContract = URL_COMPILER + '/compile';
|
||||||
|
const EPT_EncodeCalldata = URL_COMPILER + '/encode-calldata';
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// HELPERS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// make a CompileOpts data structure
|
||||||
|
function
|
||||||
|
compile_options(filename: string)
|
||||||
|
: object
|
||||||
|
{
|
||||||
|
return {"backend" : "fate",
|
||||||
|
"file_system" : {},
|
||||||
|
"src_file" : filename};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// API CALLS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// send back compile response
|
||||||
|
async function
|
||||||
|
CompileContract(code : string,
|
||||||
|
filename : string)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let send_obj =
|
||||||
|
{"code" : code,
|
||||||
|
"options" : compile_options(filename)};
|
||||||
|
|
||||||
|
let response = await net.post_json_response(EPT_CompileContract, send_obj);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
EncodeCalldata(code : string,
|
||||||
|
filename : string,
|
||||||
|
function_name : string,
|
||||||
|
function_args : Array<string>)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let send_obj =
|
||||||
|
{"source" : code,
|
||||||
|
"options" : compile_options(filename),
|
||||||
|
"function" : function_name,
|
||||||
|
"arguments" : function_args};
|
||||||
|
|
||||||
|
let response = await net.post_json_response(EPT_EncodeCalldata, send_obj);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
export {
|
||||||
|
CompileContract,
|
||||||
|
EncodeCalldata
|
||||||
|
}
|
||||||
@@ -0,0 +1,272 @@
|
|||||||
|
/********************************************************************
|
||||||
|
** Node API: functions for talking to an Aeternity node
|
||||||
|
**
|
||||||
|
** In the future, everything that this module does will be replaced
|
||||||
|
** by the backend.
|
||||||
|
**
|
||||||
|
** Functions should be sorted in alphabetical order.
|
||||||
|
**
|
||||||
|
** Names are what they are in the documentation
|
||||||
|
**
|
||||||
|
** Useful links:
|
||||||
|
**
|
||||||
|
** - HTML API docs : https://api-docs.aeternity.io/
|
||||||
|
** - YAML API docs : https://github.com/aeternity/aeternity/blob/master/apps/aehttp/priv/swagger.yaml
|
||||||
|
**
|
||||||
|
********************************************************************/
|
||||||
|
|
||||||
|
|
||||||
|
import * as net from './net.js'
|
||||||
|
import * as ae_compiler from './ae_compiler.js'
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// CONSTANTS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
export const MIN_FEE = 16660000000000;
|
||||||
|
export const MIN_CONTRACT_FEE = 79080000000000;
|
||||||
|
export const MIN_GAS_PRICE = 1000000000;
|
||||||
|
export const URL_MAINNET = "https://mainnet.aeternity.io/v2";
|
||||||
|
export const URL_TESTNET = "https://testnet.aeternity.io/v2";
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// CANONICAL TYPES ("MODELS") FROM THE DOCUMENTATION
|
||||||
|
//
|
||||||
|
// All of these names are as given in the documentation except `Error`
|
||||||
|
// (which is a reserve term in JS), renamed to `ErrorReason`
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// Error
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/definitions/Error
|
||||||
|
// Docs: https://github.com/aeternity/aeternity/blob/v6.4.0/apps/aehttp/priv/swagger.yaml#L3168-L3172
|
||||||
|
type ErrorReason = {reason: string};
|
||||||
|
|
||||||
|
type Tx = {tx: string};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// FUNCTIONS
|
||||||
|
//
|
||||||
|
// The names here follow their names in the documentation
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// GetAccountNextNonce: /accounts/{pubkey}/next-nonce
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/account/GetAccountNextNonce
|
||||||
|
//
|
||||||
|
// > Get an account's next nonce; This is computed according to
|
||||||
|
// > whatever is the current account nonce and what transactions are
|
||||||
|
// > currently present in the transaction pool
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
type GetAccountNextNonce_params = {pubkey : string,
|
||||||
|
strategy? : "max" | "continuity"};
|
||||||
|
|
||||||
|
type GetAccountNextNonce_ret = {next_nonce: string};
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
GetAccountNextNonce(endpoint_url : string,
|
||||||
|
params : GetAccountNextNonce_params)
|
||||||
|
: Promise< GetAccountNextNonce_ret
|
||||||
|
| ErrorReason>
|
||||||
|
{
|
||||||
|
let pubkey = params.pubkey;
|
||||||
|
let url = `${endpoint_url}/accounts/${pubkey}/next-nonce`;
|
||||||
|
|
||||||
|
// if the "strategy" field is present, add it as a ?strategy=x
|
||||||
|
// option
|
||||||
|
//
|
||||||
|
// note if the field is absent from `params`, then
|
||||||
|
// `params.strategy` will be `undefined`, which in js whacko
|
||||||
|
// world is "falsy"
|
||||||
|
let strategy = params.strategy;
|
||||||
|
if (strategy)
|
||||||
|
{
|
||||||
|
let addon = `?strategy=${strategy}`;
|
||||||
|
url += addon;
|
||||||
|
}
|
||||||
|
|
||||||
|
// irrespective of the response code, this is what we return
|
||||||
|
// so branching is gay
|
||||||
|
let ret = await net.get_json(url);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// PostContractCreate
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/contract/PostContractCreate
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// > Get a contract_create transaction object
|
||||||
|
|
||||||
|
|
||||||
|
type ContractCreateTx = {owner_id : string,
|
||||||
|
nonce? : number,
|
||||||
|
code : string,
|
||||||
|
vm_version : number,
|
||||||
|
abi_version : number,
|
||||||
|
deposit : number,
|
||||||
|
amount : number,
|
||||||
|
gas : number,
|
||||||
|
gas_price : number,
|
||||||
|
fee : number,
|
||||||
|
ttl? : number,
|
||||||
|
call_data : string};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
PostContractCreate(endpoint_url : string,
|
||||||
|
body_obj : ContractCreateTx)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
// console.log('body_obj', body_obj);
|
||||||
|
let url = `${endpoint_url}/debug/contracts/create`;
|
||||||
|
let ret = await net.post_json_response(url, body_obj);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
create_contract(whoami : string,
|
||||||
|
code : string,
|
||||||
|
filename : string,
|
||||||
|
init_args : Array<string>)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let code_resp = await ae_compiler.CompileContract(code, filename);
|
||||||
|
let code_json = await code_resp.json();
|
||||||
|
let bytecode = code_json.bytecode;
|
||||||
|
|
||||||
|
let calldata_resp = await ae_compiler.EncodeCalldata(code, filename, "init", init_args);
|
||||||
|
// assert(calldata_resp.ok);
|
||||||
|
let calldata_json = await calldata_resp.json();
|
||||||
|
let calldata = calldata_json.calldata;
|
||||||
|
|
||||||
|
let cctx: ContractCreateTx =
|
||||||
|
{owner_id : whoami,
|
||||||
|
code : bytecode,
|
||||||
|
vm_version : 7,
|
||||||
|
abi_version : 3,
|
||||||
|
deposit : 0,
|
||||||
|
amount : 0,
|
||||||
|
gas : 25000,
|
||||||
|
gas_price : 1*MIN_GAS_PRICE,
|
||||||
|
fee : 1*MIN_CONTRACT_FEE,
|
||||||
|
call_data : calldata};
|
||||||
|
|
||||||
|
let ret = await PostContractCreate(URL_TESTNET, cctx);
|
||||||
|
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// PostSpend: /debug/transactions/spend
|
||||||
|
//
|
||||||
|
// Docs:
|
||||||
|
// - Input type : https://api-docs.aeternity.io/#/definitions/SpendTx
|
||||||
|
// - Return type : https://api-docs.aeternity.io/#/definitions/Tx
|
||||||
|
// - Function : https://api-docs.aeternity.io/#/transaction/PostSpend
|
||||||
|
//
|
||||||
|
// > Get a spend transaction object
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// SpendTx
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/definitions/SpendTx
|
||||||
|
// Docs: https://github.com/aeternity/aeternity/blob/v6.4.0/apps/aehttp/priv/swagger.yaml#L2187-L2209
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
type SpendTx =
|
||||||
|
{recipient_id : string,
|
||||||
|
amount : number,
|
||||||
|
fee : number,
|
||||||
|
ttl? : number,
|
||||||
|
sender_id : string,
|
||||||
|
nonce? : number,
|
||||||
|
payload : string};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
PostSpend(endpoint_url : string,
|
||||||
|
body_obj : SpendTx)
|
||||||
|
: Promise<Tx | ErrorReason>
|
||||||
|
{
|
||||||
|
let url = `${endpoint_url}/debug/transactions/spend`;
|
||||||
|
let ret = await net.post_json(url, body_obj);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// PostTransaction
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/contract/PostTransaction
|
||||||
|
//
|
||||||
|
// > Post a new transaction
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
async function
|
||||||
|
PostTransaction(endpoint_url : string,
|
||||||
|
body_obj : Tx)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
// console.log('body_obj', body_obj);
|
||||||
|
let url = `${endpoint_url}/transactions`;
|
||||||
|
let ret = await net.post_json_response(url, body_obj);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// GetTransactionInfoByHash
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/contract/GetTransactionInfoByHash
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
async function
|
||||||
|
GetTransactionInfoByHash(endpoint_url : string,
|
||||||
|
hash : string)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
// console.log('body_obj', body_obj);
|
||||||
|
let url = `${endpoint_url}/transactions/${hash}/info`;
|
||||||
|
let ret = await net.get_json_response(url);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// EXPORTS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// type exports
|
||||||
|
export type {
|
||||||
|
ErrorReason,
|
||||||
|
Tx,
|
||||||
|
SpendTx,
|
||||||
|
ContractCreateTx
|
||||||
|
};
|
||||||
|
|
||||||
|
export {
|
||||||
|
GetAccountNextNonce,
|
||||||
|
PostContractCreate,
|
||||||
|
create_contract,
|
||||||
|
PostSpend,
|
||||||
|
PostTransaction
|
||||||
|
};
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
//-------------------------------------------------------------------
|
||||||
|
// Common networking functions
|
||||||
|
//
|
||||||
|
// Mozilla fetch docs : https://developer.mozilla.org/en-US/docs/Web/API/fetch
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/* pf = pretty format
|
||||||
|
*/
|
||||||
|
function pf(x : any) : string
|
||||||
|
{
|
||||||
|
return JSON.stringify(x, undefined, 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// FUNCTIONS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// GET request with return type of JSON
|
||||||
|
async function
|
||||||
|
get_json(url: string)
|
||||||
|
: Promise<any>
|
||||||
|
{
|
||||||
|
let response = await fetch(url);
|
||||||
|
let ret = await response.json();
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// GET request with return type of JSON
|
||||||
|
async function
|
||||||
|
get_json_response(url: string)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let response = await fetch(url);
|
||||||
|
//let ret = await response.json();
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// POST request with content type of json and return type of JSON
|
||||||
|
async function
|
||||||
|
post_json(url : string,
|
||||||
|
body_obj : any)
|
||||||
|
: Promise<any>
|
||||||
|
{
|
||||||
|
let body_str = pf(body_obj);
|
||||||
|
let req_opts = {method : 'POST',
|
||||||
|
body : body_str,
|
||||||
|
headers : {"Content-Type": "application/json"}};
|
||||||
|
let response = await fetch(url, req_opts);
|
||||||
|
let ret = await response.json();
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
post_json_response(url : string,
|
||||||
|
body_obj : any)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let body_str = pf(body_obj);
|
||||||
|
let req_opts = {method : 'POST',
|
||||||
|
body : body_str,
|
||||||
|
headers : {"Content-Type": "application/json"}};
|
||||||
|
let response = await fetch(url, req_opts);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// EXPORTS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
export {
|
||||||
|
get_json,
|
||||||
|
get_json_response,
|
||||||
|
post_json,
|
||||||
|
post_json_response
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
{"compilerOptions" : {"target" : "es2022",
|
||||||
|
"strict" : true,
|
||||||
|
"esModuleInterop" : true,
|
||||||
|
"skipLibCheck" : true,
|
||||||
|
"forceConsistentCasingInFileNames" : true,
|
||||||
|
"noImplicitAny" : true,
|
||||||
|
"strictNullChecks" : true,
|
||||||
|
"strictPropertyInitialization" : true,
|
||||||
|
"sourceMap" : true,
|
||||||
|
"outDir" : "dist",
|
||||||
|
"declaration" : true},
|
||||||
|
"$schema" : "https://json.schemastore.org/tsconfig",
|
||||||
|
"display" : "Recommended",
|
||||||
|
"include" : ["src/**/*"],
|
||||||
|
"exclude" : ["src/jx_include"],
|
||||||
|
"composite" : true}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*.beam
|
||||||
|
dist_js
|
||||||
|
sidekick_dist
|
||||||
|
docs
|
||||||
|
examples/examples_dist_js
|
||||||
|
www_tree
|
||||||
|
prose
|
||||||
|
*.hi
|
||||||
|
*.o
|
||||||
|
sidekick_mindist
|
||||||
|
sidekick_fulldist
|
||||||
|
dist
|
||||||
|
jx_mindist
|
||||||
|
*jx_include*
|
||||||
|
jex_mindist
|
||||||
|
src/jex_include
|
||||||
|
erl_crash.dump
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Peter Harpending
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||||
|
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||||
|
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||||
|
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||||
|
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||||
|
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||||
|
PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
all: prepare build
|
||||||
|
|
||||||
|
deploy: prepare build mindist push
|
||||||
|
|
||||||
|
prepare:
|
||||||
|
jx pull -f
|
||||||
|
|
||||||
|
build:
|
||||||
|
jx build -f
|
||||||
|
|
||||||
|
mindist:
|
||||||
|
jx mindist -f
|
||||||
|
|
||||||
|
push:
|
||||||
|
jx push -f
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
# Sidekick
|
||||||
|
|
||||||
|
Sidekick is a simple JavaScript library for talking to an Aeternity
|
||||||
|
browser wallet extension such as Jaeck Russell or Superhero from the document
|
||||||
|
context of a webpage.
|
||||||
|
|
||||||
|
> One of the most important things for designing a computer, which I
|
||||||
|
> think most designers don't do, is you study the problem you want to
|
||||||
|
> solve. And then use what you learn from studying the problem you
|
||||||
|
> want to solve to put in the mechanisms needed to solve it in the
|
||||||
|
> computer you're building. No more, no less.
|
||||||
|
|
||||||
|
— Gerald Jay Sussman
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Build Prereqs
|
||||||
|
|
||||||
|
Assuming Ubuntu 18.04. Adapt these instructions for your own system.
|
||||||
|
|
||||||
|
You need
|
||||||
|
|
||||||
|
- `npm` to build TypeScript
|
||||||
|
- `tsc` to compile
|
||||||
|
- [`jx`][jx] to orchestrate the build properly
|
||||||
|
- Python 3.6 or later to run `jx`
|
||||||
|
|
||||||
|
[jx]: https://gitlab.com/pharpend/jx/-/tree/master/#jx-secure-typescript-package-manager
|
||||||
|
|
||||||
|
Steps
|
||||||
|
|
||||||
|
sudo snap refresh
|
||||||
|
sudo snap install node --channel 18/stable
|
||||||
|
npm install -g typescript
|
||||||
|
wget https://gitlab.com/pharpend/jx/-/raw/master/jx -O ~/.local/bin/jx
|
||||||
|
chmod u+x ~/.local/bin/jx
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Protip: avoid using `sudo npm install -g`
|
||||||
|
|
||||||
|
If you want to avoid using sudo
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir ~/.npm-packages
|
||||||
|
npm config set prefix "${HOME}/.npm-packages"
|
||||||
|
```
|
||||||
|
|
||||||
|
Edit `~/.bashrc` or `~/.zshrc` with
|
||||||
|
|
||||||
|
```
|
||||||
|
NPM_PACKAGES="${HOME}/.npm-packages"
|
||||||
|
export PATH=$NPM_PACKAGES/bin:$PATH
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Build
|
||||||
|
|
||||||
|
make
|
||||||
|
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
There is a repository of examples at https://gitlab.com/pharpend/sidekick_examples.git
|
||||||
|
|
||||||
|
# What sidekick is NOT
|
||||||
|
|
||||||
|
Sidekick is **not** ideal if you operate in the Node/NPM ecosystem. If you are
|
||||||
|
working in the Node/NPM ecosystem, you probably want the [Aeternity JavaScript
|
||||||
|
SDK](https://github.com/aeternity/aepp-sdk-js/). Every single
|
||||||
|
Aeternity-related thing you could ever possibly want to do is possible to
|
||||||
|
accomplish with the SDK.
|
||||||
|
|
||||||
|
All that Sidekick knows how to do is talk to a browser wallet extension. In an
|
||||||
|
application, there is a great deal of necessary functionality (e.g. forming
|
||||||
|
transactions for the wallet to sign) which sidekick assumes your server-side
|
||||||
|
code has already handled.
|
||||||
|
|
||||||
|
In all software there is a tradeoff between simplicity and number of features.
|
||||||
|
Sidekick is very simple: 2300 lines of TypeScript, including comments, with no
|
||||||
|
dependencies. Therefore Sidekick intentionally only has a very limited set of
|
||||||
|
features.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Where is the NPM package or the webpack bundle?
|
||||||
|
|
||||||
|
There isn't one.
|
||||||
|
|
||||||
|
## Why?
|
||||||
|
|
||||||
|
Sidekick is a library that deals with cryptocurrency. The security
|
||||||
|
model is based on transparency and trust. A user must be able to
|
||||||
|
inspect code that is running on his hardware handling his money.
|
||||||
|
|
||||||
|
We don't support NPM because of the security issues that NPM
|
||||||
|
introduces. Briefly, the code can change at any time under the
|
||||||
|
developer's nose without the developer knowing. The [leftpad
|
||||||
|
debacle][lpad] and the [RIAEvangelist debacle][ria] are good examples
|
||||||
|
of the types of vulnerabilities that package managers like NPM
|
||||||
|
enable.
|
||||||
|
|
||||||
|
[lpad]: https://archive.ph/Qsh7j
|
||||||
|
[ria]: https://archive.ph/OF5I9
|
||||||
|
|
||||||
|
We don't use something like webpack because that introduces an opaque
|
||||||
|
rewrite using an untrusted tool. Webpack could plausibly alter the
|
||||||
|
runtime behavior of the program, and we would have no way to detect
|
||||||
|
that. Even if we trusted webpack, how do we obtain webpack? NPM.
|
||||||
|
So.
|
||||||
|
|
||||||
|
It is debatable whether or not we should trust the TypeScript
|
||||||
|
compiler (TSC). On the whole, TSC probably makes Sidekick more
|
||||||
|
secure, simply by virtue of increasing overall code quality and
|
||||||
|
eliminating the largest categories of potential bugs. Moreover, the
|
||||||
|
output that TSC produces is human-readable, and has a very
|
||||||
|
straightforward mapping to the original source code. A human can
|
||||||
|
easily read the TSC-generated JavaScript tree, even without the aid
|
||||||
|
of the source map, and have a high degree of faith that the code is
|
||||||
|
trustworthy and that TSC is behaving as promised.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Source: https://github.com/sindresorhus/guides/blob/main/npm-global-without-sudo.md
|
||||||
|
|
||||||
|
|
||||||
|
# How to build and view documentation
|
||||||
|
|
||||||
|
```
|
||||||
|
make build_docs
|
||||||
|
make serve_docs
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
src/jx_include
|
||||||
|
dist/
|
||||||
|
erl_crash.dump
|
||||||
|
src/jex_include
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Peter Harpending
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||||
|
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||||
|
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||||
|
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||||
|
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||||
|
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||||
|
PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
all: prepare build
|
||||||
|
|
||||||
|
prepare:
|
||||||
|
jx pull -f
|
||||||
|
|
||||||
|
build:
|
||||||
|
jx build -f
|
||||||
|
|
||||||
|
serve:
|
||||||
|
python3 -m http.server 8001
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
# sidekick examples
|
||||||
|
|
||||||
|
# TODO
|
||||||
|
|
||||||
|
- form a spend transaction
|
||||||
|
- transfer money on testnet
|
||||||
|
- retrieve transaction info
|
||||||
|
|
||||||
|
# Build Prereqs
|
||||||
|
|
||||||
|
Assuming Ubuntu 18.04. Adapt these instructions for your own system.
|
||||||
|
|
||||||
|
You need
|
||||||
|
|
||||||
|
- `npm` to build TypeScript
|
||||||
|
- `tsc` to compile
|
||||||
|
- [`jx`][jx] to orchestrate the build properly
|
||||||
|
- [sidekick][sk] as a dependency
|
||||||
|
- Python 3.6 or later to run `jx`
|
||||||
|
|
||||||
|
[jx]: https://gitlab.com/pharpend/jx/-/tree/master/#jx-secure-typescript-package-manager
|
||||||
|
|
||||||
|
Steps
|
||||||
|
|
||||||
|
# install node and tsc
|
||||||
|
sudo snap refresh
|
||||||
|
sudo snap install node --channel 18/stable
|
||||||
|
npm install -g typescript
|
||||||
|
# install dependencies
|
||||||
|
mkdir vanillae && cd vanillae
|
||||||
|
git clone https://gitlab.com/pharpend/jx
|
||||||
|
git clone https://gitlab.com/pharpend/sidekick
|
||||||
|
chmod u+x ~/.local/bin/jx
|
||||||
|
git clone https
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Protip: avoid using `sudo npm install -g`
|
||||||
|
|
||||||
|
If you want to avoid using sudo
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir ~/.npm-packages
|
||||||
|
npm config set prefix "${HOME}/.npm-packages"
|
||||||
|
```
|
||||||
|
|
||||||
|
Edit `~/.bashrc` or `~/.zshrc` with
|
||||||
|
|
||||||
|
```
|
||||||
|
NPM_PACKAGES="${HOME}/.npm-packages"
|
||||||
|
export PATH=$NPM_PACKAGES/bin:$PATH
|
||||||
|
```
|
||||||
|
|
||||||
|
## How to build
|
||||||
|
|
||||||
|
You need
|
||||||
|
|
||||||
|
- [TypeScript compiler `tsc`](https://www.typescriptlang.org/download)
|
||||||
|
- [HTTP logging server vlogd](https://gitlab.com/pharpend/vlogd)
|
||||||
|
- [Build tool `jx`](https://gitlab.com/pharpend/jx)
|
||||||
|
- Build [sidekick](https://gitlab.com/pharpend/sidekick) separately
|
||||||
|
- Python 3.6 or later
|
||||||
|
- `make`
|
||||||
|
|
||||||
|
#### Build
|
||||||
|
|
||||||
|
You need to build [sidekick](https://gitlab.com/pharpend/sidekick) separately
|
||||||
|
|
||||||
|
```
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
|
#### View
|
||||||
|
|
||||||
|
Many of the examples assume there is an HTTP server at `localhost:8841`
|
||||||
|
which responds positively to POST requests at `/`
|
||||||
|
|
||||||
|
[vlogd](https://gitlab.com/pharpend/vlogd) is such a server, but you can roll
|
||||||
|
your own if you want.
|
||||||
|
|
||||||
|
```
|
||||||
|
make serve
|
||||||
|
firefox localhost:8001
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Build
|
||||||
|
|
||||||
|
make
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Sidekick Example: Connecting to Wallet</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<!-- link tree -->
|
||||||
|
<ul><li>
|
||||||
|
<a href="/">Examples</a>
|
||||||
|
<ul><li>
|
||||||
|
<b>Connecting to wallet</b>
|
||||||
|
</li></ul>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
|
<h1>Sidekick Example: Connecting to wallet</h1>
|
||||||
|
|
||||||
|
<h1>Page variables</h1>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Wallet Address: <code class="pv-address"></code></li>
|
||||||
|
<li>SpendTx Base58: <code class="pv-spendtx-base58"></code></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<!-- step 1 detect -->
|
||||||
|
|
||||||
|
<h1>1. Detect wallet</h1>
|
||||||
|
<button id="detect">Detect</button>
|
||||||
|
<h4 id="detected" style="color: red;">not detected</h4>
|
||||||
|
<pre id="detect-info"></pre>
|
||||||
|
|
||||||
|
<h1>2. Connect to wallet</h1>
|
||||||
|
<button id="connect">Connect</button>
|
||||||
|
<h4 id="connected" style="color: red;">not connected</h4>
|
||||||
|
<pre id="connect-info"></pre>
|
||||||
|
|
||||||
|
<h1>3. Get the wallet address</h1>
|
||||||
|
<button id="address">Address</button>
|
||||||
|
<h4 id="addressed" style="color: red;">not addressed</h4>
|
||||||
|
<pre id="address-info"></pre>
|
||||||
|
|
||||||
|
<h1>4. Sign a transaction</h1>
|
||||||
|
|
||||||
|
<h2>4.1 Transaction info (information needed from you)</h2>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Source address (step 3): <code class="pv-address"></code></li>
|
||||||
|
<li>Target address: <input type="text" id="tx-info-target" value="ak_wM8yFU8eSETXU7VSN48HMDmevGoCMiuveQZgkPuRn1nTiRqyv"></input></li>
|
||||||
|
<li>Amount (aettos): <input type="text" id="tx-info-amount" value="10"></input></li>
|
||||||
|
<li>Network: (FIXME: radio buttons)</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>4.2 Form transaction (using parasite)</h2>
|
||||||
|
|
||||||
|
<p>This uses a shim JavaScript library called parasite to form the transaction
|
||||||
|
data for the wallet to sign. In a commercial application, this should be done
|
||||||
|
by your backend</p>
|
||||||
|
|
||||||
|
<button id='mk-spendtx'>Make SpendTx</button>
|
||||||
|
|
||||||
|
<h5>SpendTx JS object</h5>
|
||||||
|
<pre id="spendtx-json"></pre>
|
||||||
|
|
||||||
|
<h5>SpendTx Base58</h5>
|
||||||
|
<pre class="pv-spendtx-base58"></pre>
|
||||||
|
|
||||||
|
<h2>4.3 Sign the transaction (sidekick)</h2>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li><pre class="pv-spendtx-base58"></pre></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<button id="sign-spendtx">Sign Transaction</button>
|
||||||
|
|
||||||
|
<h5>Result:</h5>
|
||||||
|
<pre id="sign-spendtx-result"></pre>
|
||||||
|
|
||||||
|
<h2>4.4 Propagate the transaction (parasite)</h2>
|
||||||
|
|
||||||
|
<h2>4.5 Verify the transaction was propagated (parasite)</h2>
|
||||||
|
|
||||||
|
<!-- script -->
|
||||||
|
<script type="module" src="dist/connection.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
@@ -0,0 +1,32 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Sidekick Example: Hello World</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<!-- Link tree -->
|
||||||
|
<ul><li>
|
||||||
|
<a href="../">Examples</a>
|
||||||
|
<ul><li>
|
||||||
|
<b>Hello world</b>
|
||||||
|
</li></ul>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h1>Sidekick Example: Hello World</h1>
|
||||||
|
|
||||||
|
<h4>Check the console</h4>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This example just demonstrates how to import sidekick and call functions
|
||||||
|
from the module. Useful for debugging purposes, or getting out of mental
|
||||||
|
quicksand.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- script -->
|
||||||
|
<script type="module" src="./dist/hello.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Sidekick Examples: Home</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<!-- link tree -->
|
||||||
|
<ul><li>
|
||||||
|
<b>Examples</b>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
|
<h1>Sidekick Examples</h1>
|
||||||
|
<ol>
|
||||||
|
<li><a href="./hello.html">Hello World</a></li>
|
||||||
|
<!--
|
||||||
|
<li><a href="./logging.html">Console Logging</a></li>
|
||||||
|
<li><a href="./logging_http.html">HTTP Logging</a></li>
|
||||||
|
<li><a href="./detection.html">Detecting Wallet</a></li>
|
||||||
|
-->
|
||||||
|
<li><a href="./connection.html">Connecting to Wallet</a></li>
|
||||||
|
</ol>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
{type, site}.
|
||||||
|
{realm, local}.
|
||||||
|
{name, sk_examples}.
|
||||||
|
{version, "0.1.0"}.
|
||||||
|
{deps, ["local-awcp-0.1.0",
|
||||||
|
"local-parasite-0.1.0",
|
||||||
|
"local-sidekick-0.1.0"]}.
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Sidekick Example: console logger</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<!-- link tree -->
|
||||||
|
<ul><li>
|
||||||
|
<a href="/">Examples</a>
|
||||||
|
<ul><li>
|
||||||
|
<b>Logging</b>
|
||||||
|
</li></ul>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
|
<h1>Sidekick Example: console logger</h1>
|
||||||
|
|
||||||
|
<h4>check the console</h4>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This example illustrates a debugging feature of sidekick. Sidekick
|
||||||
|
and the wallet each communicate with the other by sending
|
||||||
|
<code>MessageEvent</code>s to <code>window</code>. The code in this example
|
||||||
|
adds a listener to the <code>window</code> which just
|
||||||
|
<code>console.log</code>s each <code>MessageEvent</code>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<!-- script -->
|
||||||
|
<script type="module" src="dist/logging.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
import * as sk from './jx_include/ppr-sidekick-0.1.0/dist/sidekick.js'
|
||||||
|
|
||||||
|
let logger = new sk.ConsoleLogger();
|
||||||
|
logger.listen(window);
|
||||||
|
|
||||||
|
window.postMessage("I have questions regarding my vehicle's extended warranty.");
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Sidekick Example: HTTP logger</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<!-- link tree -->
|
||||||
|
<ul><li>
|
||||||
|
<a href="/">Examples</a>
|
||||||
|
<ul><li>
|
||||||
|
<b>HTTP Logging</b>
|
||||||
|
</li></ul>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
|
<h1>Sidekick Example: HTTP Logger</h1>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
You need to have an HTTP server listening on port <code>8841</code>. You
|
||||||
|
can use <a href="https://gitlab.com/pharpend/vlogd">vlogd</a>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<!-- script -->
|
||||||
|
<script type="module" src="dist/logging_http.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import * as sk from './jx_include/ppr-sidekick-0.1.0/dist/sidekick.js'
|
||||||
|
|
||||||
|
//var body_count = 1;
|
||||||
|
//
|
||||||
|
//function
|
||||||
|
//message_event_to_request
|
||||||
|
// (evt : {data: object})
|
||||||
|
//{
|
||||||
|
// let url = 'http://localhost:8841/';
|
||||||
|
// let body = JSON.stringify(evt.data, undefined, 4);
|
||||||
|
// let result = new Request(url, {method: 'POST', body: body});
|
||||||
|
// return result;
|
||||||
|
//}
|
||||||
|
|
||||||
|
let cl = new sk.ConsoleLogger();
|
||||||
|
cl.listen(window);
|
||||||
|
|
||||||
|
let hl = new sk.HttpLogger('http://localhost:8841/');
|
||||||
|
hl.listen(window);
|
||||||
|
|
||||||
|
let logger = new sk.SeqLogger([cl, hl]);
|
||||||
|
|
||||||
|
window.postMessage("I have questions regarding my vehicle's extended warranty.");
|
||||||
@@ -0,0 +1,219 @@
|
|||||||
|
import * as ae_node from './jex_include/local-parasite-0.1.0/dist/ae_node.js';
|
||||||
|
import * as awcp from './jex_include/local-awcp-0.1.0/dist/awcp.js';
|
||||||
|
import * as sk from './jex_include/local-sidekick-0.1.0/dist/sidekick.js';
|
||||||
|
|
||||||
|
var pv_address: string;
|
||||||
|
var pv_spendtx_base58: string;
|
||||||
|
|
||||||
|
function
|
||||||
|
set_pv_address
|
||||||
|
(new_address: string)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
pv_address = new_address;
|
||||||
|
for (let elt of document.getElementsByClassName('pv-address'))
|
||||||
|
{
|
||||||
|
elt.innerHTML = new_address;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function
|
||||||
|
set_pv_spendtx_base58
|
||||||
|
(new_address: string)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
pv_spendtx_base58 = new_address;
|
||||||
|
for (let elt of document.getElementsByClassName('pv-spendtx-base58'))
|
||||||
|
{
|
||||||
|
elt.innerHTML = new_address;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
detect
|
||||||
|
(logger: sk.Logger)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let h4 = document.getElementById("detected")!;
|
||||||
|
let pre = document.getElementById("detect-info")!;
|
||||||
|
|
||||||
|
h4.innerHTML = 'detecting...';
|
||||||
|
h4.style.color = 'GoldenRod';
|
||||||
|
|
||||||
|
// try to detect the wallet
|
||||||
|
// will fail on timeout error
|
||||||
|
// console logger
|
||||||
|
let maybe_wallet_info =//: sk.Safe<awcp.EventData_W2A_connection_announcePresence, sk.TimeoutError> =
|
||||||
|
await sk.detect(sk.TIMEOUT_DEF_DETECT_MS, "failed to detect wallet", logger);
|
||||||
|
|
||||||
|
console.log(maybe_wallet_info);
|
||||||
|
|
||||||
|
// ok means wallet was detected
|
||||||
|
if (maybe_wallet_info.ok)
|
||||||
|
{
|
||||||
|
h4.innerHTML = "detected";
|
||||||
|
h4.style.color = "green";
|
||||||
|
pre.innerHTML = JSON.stringify(maybe_wallet_info.result, undefined, 4);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
h4.innerHTML = "error";
|
||||||
|
h4.style.color = "crimson";
|
||||||
|
pre.innerHTML = JSON.stringify(maybe_wallet_info.error, undefined, 4);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function
|
||||||
|
connect
|
||||||
|
(logger: sk.Logger)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
// this is not working
|
||||||
|
// I am creating and posting an identical message to the working example
|
||||||
|
// it must be a mismatch in the extraneous properties of the MessageEvent that is causing the problem
|
||||||
|
let h4 = document.getElementById("connected")!;
|
||||||
|
let pre = document.getElementById("connect-info")!;
|
||||||
|
|
||||||
|
h4.innerHTML = 'connecting...';
|
||||||
|
h4.style.color = 'GoldenRod';
|
||||||
|
|
||||||
|
// try to connect to the wallet
|
||||||
|
// will fail on timeout error
|
||||||
|
// console logger
|
||||||
|
let maybe_wallet_info = await sk.connect(
|
||||||
|
'ske-connect-1',
|
||||||
|
{name: 'sidekick examples',
|
||||||
|
version: 1},
|
||||||
|
sk.TIMEOUT_DEF_CONNECT_MS,
|
||||||
|
"failed to connect to wallet",
|
||||||
|
logger
|
||||||
|
);
|
||||||
|
|
||||||
|
console.log(maybe_wallet_info);
|
||||||
|
|
||||||
|
// ok means wallet was connected
|
||||||
|
if (maybe_wallet_info.ok)
|
||||||
|
{
|
||||||
|
h4.innerHTML = "connected";
|
||||||
|
h4.style.color = "green";
|
||||||
|
pre.innerHTML = JSON.stringify(maybe_wallet_info.result, undefined, 4);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
h4.innerHTML = "error";
|
||||||
|
h4.style.color = "crimson";
|
||||||
|
pre.innerHTML = JSON.stringify(maybe_wallet_info.error, undefined, 4);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function
|
||||||
|
address
|
||||||
|
(logger: sk.Logger)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
// this is not working
|
||||||
|
// I am creating and posting an identical message to the working example
|
||||||
|
// it must be a mismatch in the extraneous properties of the MessageEvent that is causing the problem
|
||||||
|
let h4 = document.getElementById("addressed")!;
|
||||||
|
let pre = document.getElementById("address-info")!;
|
||||||
|
|
||||||
|
h4.innerHTML = 'addressing...';
|
||||||
|
h4.style.color = 'GoldenRod';
|
||||||
|
|
||||||
|
// try to address to the wallet
|
||||||
|
// will fail on timeout error
|
||||||
|
// console logger
|
||||||
|
let maybe_wallet_info = await sk.address(
|
||||||
|
'ske-address-1',
|
||||||
|
{type: 'subscribe',
|
||||||
|
value: 'connected'},
|
||||||
|
sk.TIMEOUT_DEF_ADDRESS_MS,
|
||||||
|
"failed to address to wallet",
|
||||||
|
logger
|
||||||
|
);
|
||||||
|
|
||||||
|
console.log(maybe_wallet_info);
|
||||||
|
|
||||||
|
// ok means wallet was addressed
|
||||||
|
if (maybe_wallet_info.ok)
|
||||||
|
{
|
||||||
|
h4.innerHTML = "addressed";
|
||||||
|
h4.style.color = "green";
|
||||||
|
pre.innerHTML = JSON.stringify(maybe_wallet_info.result, undefined, 4);
|
||||||
|
// update global variable
|
||||||
|
let the_address = Object.keys(maybe_wallet_info.result.address.current)[0];
|
||||||
|
set_pv_address(the_address);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
h4.innerHTML = "error";
|
||||||
|
h4.style.color = "crimson";
|
||||||
|
pre.innerHTML = JSON.stringify(maybe_wallet_info.error, undefined, 4);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function
|
||||||
|
form_tx
|
||||||
|
(logger: sk.Logger)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
// @ts-ignore
|
||||||
|
let recipient_id = document.getElementById('tx-info-target')!.value;
|
||||||
|
// @ts-ignore
|
||||||
|
let amount = parseInt(document.getElementById('tx-info-amount')!.value);
|
||||||
|
let fee = ae_node.MIN_FEE;
|
||||||
|
let sender_id = pv_address;
|
||||||
|
let payload = 'hainana';
|
||||||
|
let spendtx = {recipient_id : recipient_id,
|
||||||
|
amount : amount,
|
||||||
|
fee : fee,
|
||||||
|
sender_id : sender_id,
|
||||||
|
payload : payload};
|
||||||
|
document.getElementById('spendtx-json')!.innerHTML =
|
||||||
|
JSON.stringify(spendtx, undefined, 4);
|
||||||
|
let tx = await ae_node.PostSpend(ae_node.URL_TESTNET, spendtx);
|
||||||
|
// @ts-ignore
|
||||||
|
set_pv_spendtx_base58(tx.tx);
|
||||||
|
//document.getElementById('spendtx-base58')!.innerHTML =
|
||||||
|
// JSON.stringify(tx, undefined, 4);
|
||||||
|
//
|
||||||
|
}
|
||||||
|
|
||||||
|
async function
|
||||||
|
sign_tx
|
||||||
|
(logger: sk.Logger)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let sign_params = {
|
||||||
|
tx: pv_spendtx_base58,
|
||||||
|
// returnsigned: false tells it to propagate the transaction
|
||||||
|
// returnsigned: true just signs it and returns the signed tx back
|
||||||
|
returnSigned: true as true,
|
||||||
|
networkId: "ae_uat"
|
||||||
|
};
|
||||||
|
let signedTx = await sk.tx_sign_noprop('sk-tx-sign-1', sign_params, sk.TIMEOUT_DEF_TX_SIGN_NOPROP_MS, 'sign transaction timed out', logger);
|
||||||
|
document.getElementById("sign-spendtx-result")!.innerHTML = JSON.stringify(signedTx, undefined, 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
function
|
||||||
|
main
|
||||||
|
()
|
||||||
|
{
|
||||||
|
// want to create a logger down here
|
||||||
|
let logger = sk.cl();
|
||||||
|
// custom logger
|
||||||
|
window.addEventListener('message', function(evt) { if("to_waellet" === evt.data.type) {console.log(evt)} });
|
||||||
|
// the !s are typescript jizz to turn off the warning that the return value
|
||||||
|
// of getElementById might be null
|
||||||
|
document.getElementById('detect')!.onclick = function() { detect(logger); } ;
|
||||||
|
document.getElementById('connect')!.onclick = function() { connect(logger); };
|
||||||
|
document.getElementById('address')!.onclick = function() { address(logger); };
|
||||||
|
document.getElementById('mk-spendtx')!.onclick = function() { form_tx(logger); };
|
||||||
|
document.getElementById('sign-spendtx')!.onclick = function() { sign_tx(logger); };
|
||||||
|
|
||||||
|
//set_pv_address("ak_2XhCkjzTwcq1coXSSzHJoMZkUzTwnjH88zmPGkkowUsFNTo9UE");
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
import * as sk from './jex_include/local-sidekick-0.1.0/dist/sidekick.js';
|
||||||
|
|
||||||
|
sk.hello();
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
{"compilerOptions" : {"target" : "es2022",
|
||||||
|
"strict" : true,
|
||||||
|
"esModuleInterop" : true,
|
||||||
|
"skipLibCheck" : true,
|
||||||
|
"forceConsistentCasingInFileNames" : true,
|
||||||
|
"noImplicitAny" : true,
|
||||||
|
"strictNullChecks" : true,
|
||||||
|
"strictPropertyInitialization" : true,
|
||||||
|
"sourceMap" : true,
|
||||||
|
"outDir" : "dist",
|
||||||
|
"declaration" : true},
|
||||||
|
"$schema" : "https://json.schemastore.org/tsconfig",
|
||||||
|
"display" : "Recommended",
|
||||||
|
"include" : ["src/**/*"],
|
||||||
|
"exclude" : ["src/jex_include"],
|
||||||
|
"composite" : true}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 2.8 KiB |
Binary file not shown.
@@ -0,0 +1,5 @@
|
|||||||
|
{type, library}.
|
||||||
|
{realm, local}.
|
||||||
|
{name, sidekick}.
|
||||||
|
{version, "0.1.0"}.
|
||||||
|
{deps, ["local-awcp-0.1.0"]}.
|
||||||
@@ -0,0 +1,187 @@
|
|||||||
|
# Style Guide
|
||||||
|
|
||||||
|
- Generally, try to write TypeScript that is more like Erlang and
|
||||||
|
less like Javascript
|
||||||
|
|
||||||
|
- Code is read more often than it is written. So be kind to people
|
||||||
|
reading the code. Make it obvious and simple.
|
||||||
|
|
||||||
|
- All of these rules are fuzzy and there are times where it is good
|
||||||
|
or necessary to break them. You're an adult, use your best
|
||||||
|
judgment.
|
||||||
|
|
||||||
|
- It's OK to write code with a larger number of lines if the result
|
||||||
|
is code that is more readable.
|
||||||
|
|
||||||
|
- Don't try to be l33t. Boring code is best
|
||||||
|
|
||||||
|
- Don't sacrifice readability for "performance". It's far easier to
|
||||||
|
optimize inefficient/correct code than to correct
|
||||||
|
efficient/incorrect code.
|
||||||
|
|
||||||
|
- It should be simple. It should just work. And it should be obvious
|
||||||
|
to anyone reading the code why it works.
|
||||||
|
|
||||||
|
- Prefer `let` over `var` or `const`
|
||||||
|
|
||||||
|
- Avoid taking advantage of mutability. A recursive function is
|
||||||
|
usually better than a loop
|
||||||
|
|
||||||
|
```js
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
- Put your "this does stuff" code in a function called `main` and
|
||||||
|
then call it.
|
||||||
|
|
||||||
|
```js
|
||||||
|
// no
|
||||||
|
do_something();
|
||||||
|
do_something_else();
|
||||||
|
|
||||||
|
// yes
|
||||||
|
function main()
|
||||||
|
{
|
||||||
|
do_something();
|
||||||
|
do_something_else();
|
||||||
|
}
|
||||||
|
main();
|
||||||
|
```
|
||||||
|
|
||||||
|
- Every `if` should have an `else`
|
||||||
|
|
||||||
|
```js
|
||||||
|
// no
|
||||||
|
function foo(bar)
|
||||||
|
{
|
||||||
|
if (some_condition(bar))
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
do_something();
|
||||||
|
do_something_else();
|
||||||
|
}
|
||||||
|
|
||||||
|
// yes
|
||||||
|
function foo(bar)
|
||||||
|
{
|
||||||
|
if (some_condition(bar))
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
do_something();
|
||||||
|
do_something_else();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Avoid hidden state like the plague (this means don't make objects;
|
||||||
|
use records instead). All of your ingredients should be declared
|
||||||
|
visually near where they are used.
|
||||||
|
|
||||||
|
This means no oopy jogger jizz, "stamps", etc
|
||||||
|
|
||||||
|
- Every function should have a unique name so that someone unfamiliar
|
||||||
|
with the codebase can `grep -rn function_name` and find it
|
||||||
|
immediately
|
||||||
|
|
||||||
|
- Do not use the ternary operator `returnValue = condition ? ifTrue :
|
||||||
|
else`. It's just obnoxious (most of the time)
|
||||||
|
|
||||||
|
- In general, avoid binary operators. If you must use them, don't be
|
||||||
|
niggardly with parentheses. Disambiguating infix precedence is a
|
||||||
|
nightmare.
|
||||||
|
|
||||||
|
- Inequalities should follow the left-to-right orientation of the number line
|
||||||
|
|
||||||
|
```js
|
||||||
|
// cringe
|
||||||
|
let x = y > z;
|
||||||
|
|
||||||
|
// based
|
||||||
|
let x = z < y;
|
||||||
|
```
|
||||||
|
|
||||||
|
- Don't assume the person reading the code is a domain expert in
|
||||||
|
JavaScript. Avoid using weird JS syntax or runtime quirks.
|
||||||
|
|
||||||
|
- If you must, put weird things in variables or functions that have a
|
||||||
|
semantic name
|
||||||
|
|
||||||
|
```js
|
||||||
|
// wat
|
||||||
|
if (window == window.parent)
|
||||||
|
{
|
||||||
|
...
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
...
|
||||||
|
}
|
||||||
|
|
||||||
|
// obvious
|
||||||
|
let we_are_executing_this_in_a_browser = (window == window.parent);
|
||||||
|
if (we_are_executing_this_in_a_browser)
|
||||||
|
{
|
||||||
|
...
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Names should be in `snake_case`
|
||||||
|
|
||||||
|
- Indentation is 4 spaces
|
||||||
|
|
||||||
|
- Align things that deserve to be aligned
|
||||||
|
|
||||||
|
```js
|
||||||
|
function foo(bar : x,
|
||||||
|
baz : y,
|
||||||
|
quux : z)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Open and close braces should align vertically so someone reading
|
||||||
|
can just scan to find the other delimiter.
|
||||||
|
|
||||||
|
```js
|
||||||
|
// yuck
|
||||||
|
if (condition) {
|
||||||
|
...
|
||||||
|
} else if (some_other_condition) {
|
||||||
|
...
|
||||||
|
} else {
|
||||||
|
...
|
||||||
|
}
|
||||||
|
|
||||||
|
// nice
|
||||||
|
// it's easy for a reader to visually match the open/close braces,
|
||||||
|
// and then to look at the line immediately above the opening brace
|
||||||
|
// to see what the code block corresponds to
|
||||||
|
if (condition)
|
||||||
|
{
|
||||||
|
...
|
||||||
|
}
|
||||||
|
else if (some_other_condition)
|
||||||
|
{
|
||||||
|
...
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Avoid sawtoothy code with a lot of nesting. If you're writing
|
||||||
|
sawtoothy code, you should probably factor it into many simple
|
||||||
|
functions.
|
||||||
|
|
||||||
|
- It is much easier to understand 20 simple functions than 1
|
||||||
|
complicated function.
|
||||||
@@ -0,0 +1,250 @@
|
|||||||
|
- DONE start skylight in ignore state
|
||||||
|
- DONE add `listen` and `ignore` calls
|
||||||
|
- DONE fix examples
|
||||||
|
- polish examples with prose so it's more clear what is going on
|
||||||
|
- fix documentation
|
||||||
|
- test against other browsers/operating systems
|
||||||
|
- work out crash-handling examples
|
||||||
|
- make a documentation release
|
||||||
|
- (maybe) add `console.debug` messages
|
||||||
|
- add internal logging
|
||||||
|
- add POST logging
|
||||||
|
- add safe error handling
|
||||||
|
- future: add JR logging
|
||||||
|
|
||||||
|
- DONE rpc errors enumerate
|
||||||
|
- flush out logging and safety
|
||||||
|
- timeout errors
|
||||||
|
- write out everything
|
||||||
|
- logging
|
||||||
|
- we might want something like traverse... hmm... think about it
|
||||||
|
- look at "address.get" instead of "address.subscribe"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- async monad structure
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
alpha:
|
||||||
|
|
||||||
|
|
||||||
|
- DONE add more sophisticated examples to README
|
||||||
|
- sign a spendtx
|
||||||
|
- mention that anything else you're going to want the user to do
|
||||||
|
(e.g. sign a smart contract) is just telling the user to sign a
|
||||||
|
transaction
|
||||||
|
- you are responsible for forming the calldata and the
|
||||||
|
transaction
|
||||||
|
- DONE `site_tree` target for sidekick
|
||||||
|
- DONE check all the FIXMEs and TODOs and NOTEs
|
||||||
|
- DONE polish examples
|
||||||
|
- DONE add constants for default timeouts
|
||||||
|
|
||||||
|
beta:
|
||||||
|
|
||||||
|
- work out idioms for application developers to handle errors
|
||||||
|
- add examples showing how the user should handle/differentiate
|
||||||
|
between different types of errors that can occur (e.g. timeouts,
|
||||||
|
user-rejections).
|
||||||
|
|
||||||
|
possibly need to write classes or something for each different type of
|
||||||
|
error. not sure.
|
||||||
|
|
||||||
|
- one more pass over documentation
|
||||||
|
- double check when confirm-connect modal is given to user
|
||||||
|
- test against other browsers and other operating systems
|
||||||
|
|
||||||
|
- DONE expose low-level skylight primitives in sidekick module (`connect`,
|
||||||
|
`detect`, `address`, `listen`, `ignore`).
|
||||||
|
- DONE get rid of all possible instances of `as` (some are necessary
|
||||||
|
because TypeScript is dumb, a handful are because I am dumb. The
|
||||||
|
because-I-am-dumb ones should be fixed)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
DONE:
|
||||||
|
|
||||||
|
- DONE propagate timeout shit into examples
|
||||||
|
|
||||||
|
- DONE awcp errors
|
||||||
|
|
||||||
|
- DONE timing (done except need to double check when confirm-connect
|
||||||
|
modal is given to user)
|
||||||
|
|
||||||
|
I am *probably* not going to fix the message queue threading thing.
|
||||||
|
Because any fix requires completely gutting the push/pop idiom which
|
||||||
|
is so nice in the MsgQ and simplifies the code dramatically. I can't
|
||||||
|
imagine an instance that would actually occur in practice where that
|
||||||
|
would be an issue. And people who are going to do shit like that
|
||||||
|
deserve to have to write their own secondary state layer. So \shrug.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- every single function that interacts with the wallet needs a
|
||||||
|
timeout parameter. it cannot simply be the same for every single
|
||||||
|
thing. the user might take 5 minutes to review a transaction, but
|
||||||
|
putting a 5 minute timeout on "detect if the wallet is there" is
|
||||||
|
really fucking stupid and fucking retarded as shit.
|
||||||
|
|
||||||
|
- awcp needs to be modified to have error types as the returns for
|
||||||
|
everything
|
||||||
|
- somewhere in the callchain, either in skylight, msgr, or msgq,
|
||||||
|
errors need to be caught and exceptions need to be thrown
|
||||||
|
- throwing an exception is good enough, we don't need to get fancier
|
||||||
|
- the lack of real sum types and "crash fast" idioms in typescript is
|
||||||
|
a real bummer. can't blame typescript. there's no real way to fix
|
||||||
|
this, this is simply a deficiency of the JavaScript idiom.
|
||||||
|
|
||||||
|
this could be fixed in a erlang-on-wasm language, but maintaining
|
||||||
|
that would be way more of a pain than working around this.
|
||||||
|
|
||||||
|
so, alas
|
||||||
|
|
||||||
|
- add more examples to readme
|
||||||
|
- all examples need to use only top level functions
|
||||||
|
- test in other browsers
|
||||||
|
- make errors great again
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- DONE (it doesn't, it needs the network id even just to do a
|
||||||
|
signature; why is beyond me, but i will probably figure out when we
|
||||||
|
do jaeck russell [will find out if it's an aeternity constraint, or
|
||||||
|
if this is a superhero constraint; i.e. is superhero imposing this
|
||||||
|
constraint for no reason, or is there something at the protocol
|
||||||
|
level where in order to sign a transaction, it needs the network
|
||||||
|
id? don't know, but will find out I suppose]).
|
||||||
|
|
||||||
|
test to see if noprop transaction works if we remove the network id
|
||||||
|
(it should right? it's just cryptography. who knows? satan. because
|
||||||
|
satan wrote this code)
|
||||||
|
|
||||||
|
|
||||||
|
- DONE constants like network id need to be passed in as top level
|
||||||
|
parameters to inputs
|
||||||
|
- DONE explain awcp
|
||||||
|
|
||||||
|
- DONE get examples to work
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Sidekick should
|
||||||
|
|
||||||
|
- know how to:
|
||||||
|
|
||||||
|
- build a distribution
|
||||||
|
- build its documentaiion
|
||||||
|
|
||||||
|
- "examples" should be converted to a test suite
|
||||||
|
|
||||||
|
Look into:
|
||||||
|
|
||||||
|
- jest
|
||||||
|
- jasmine
|
||||||
|
- chai
|
||||||
|
- mocha
|
||||||
|
|
||||||
|
update: these test suites are retarded
|
||||||
|
|
||||||
|
- move examples back in here but frame them as tests
|
||||||
|
|
||||||
|
Sidekick should NOT
|
||||||
|
|
||||||
|
- version control documentation
|
||||||
|
- version control distribution
|
||||||
|
|
||||||
|
- vanillae website should contain documentation
|
||||||
|
- should host examples (maybe?) (maybe make a separate distribution
|
||||||
|
of just examples?)
|
||||||
|
|
||||||
|
- I think maybe the constraint of "download it, run a makefile and it
|
||||||
|
just works" with no non-standard tooling is too severe.
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- DONE remove webpack jizz
|
||||||
|
- DONE separate things that talk to the network in `parasite` package
|
||||||
|
- fix examples
|
||||||
|
- add js doc comments
|
||||||
|
- generally clean up code
|
||||||
|
- add "info pages" type things
|
||||||
|
- make website with documentation
|
||||||
|
- figure out the right way to serve both js-dist and typescript
|
||||||
|
source tree so that source maps work as expected
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- separate types for RPC requests and RPC responses (in particular
|
||||||
|
the `result` and `params` properties)
|
||||||
|
|
||||||
|
See <https://www.jsonrpc.org/specification>
|
||||||
|
|
||||||
|
- change vim theme
|
||||||
|
- msgq really is specialized to JSON RPC 2.0
|
||||||
|
|
||||||
|
- figure out how to turn off "implicit null" warnings in just the
|
||||||
|
`msgq.ts` files
|
||||||
|
|
||||||
|
- fill out stuff from the schema: <https://github.com/aeternity/aepp-sdk-js/blob/develop/src/utils/aepp-wallet-communication/schema.ts>
|
||||||
|
|
||||||
|
- get a contract page working
|
||||||
|
|
||||||
|
- fix the obnoxious styling
|
||||||
|
|
||||||
|
- factor out the stylesheet
|
||||||
|
|
||||||
|
- figure out a better build/directory structure
|
||||||
|
|
||||||
|
- in particular, we're at the point where sidekick needs to be
|
||||||
|
separated from the examples "packed"
|
||||||
|
|
||||||
|
- ok, I know how to do that
|
||||||
|
- have sidekick compile into the `sidekick-js-dist` directory or
|
||||||
|
something
|
||||||
|
- move javascript examples into inline scripts?
|
||||||
|
- hmm
|
||||||
|
- I don't like either approach
|
||||||
|
- i need to pee
|
||||||
|
- and brush my teeth
|
||||||
|
- and have a think
|
||||||
|
- and get more coffee
|
||||||
|
- but I really need to pee
|
||||||
|
- bye
|
||||||
|
|
||||||
|
- make the "do a transfer example" complete (show the transfer, have
|
||||||
|
a "do another transfer" thing)
|
||||||
|
|
||||||
|
- clearly define the protocol, and how the different components of
|
||||||
|
the protocol compose
|
||||||
|
|
||||||
|
- the Window messaging infrastructure (Link: mozilla docs)
|
||||||
|
- the JSON RPC 2.0 (link: https://www.jsonrpc.org/specification)
|
||||||
|
- the domain-specific messaging protocol (link: random schema file
|
||||||
|
on aeternity/aepp-sdk-js GitHub)
|
||||||
|
|
||||||
|
- `msg_protocol/gen_rpc2.ts`:
|
||||||
|
- `gen_rpc2.Request` and `gen_rpc2.Response` (generic types)
|
||||||
|
- `msg_protocol/window_messages.ts`
|
||||||
|
- this is simply the `to_aepp` and `to_waellet` distinctions
|
||||||
|
|
||||||
|
- TypeScript generics:
|
||||||
|
https://www.typescriptlang.org/docs/handbook/2/generics.html
|
||||||
|
|
||||||
|
- `awcp`: aepp-waellet communication protocol
|
||||||
|
- `awcp_aepp`: aepp end of AWCP
|
||||||
|
|
||||||
|
- I think a msgr module that does "send a message with this type and
|
||||||
|
get a response back with another type" would be appropriate
|
||||||
|
|
||||||
|
going to commit
|
||||||
|
|
||||||
|
|
||||||
|
- implement `msgr` according to spec
|
||||||
|
- refactor skylight to use msgr
|
||||||
|
- do something similar for node api
|
||||||
|
- make sidekick the thing that exports functions that interface
|
||||||
|
between Skylight, AeNode, and the Compiler
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Hello</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<script type="module" src="./async_tests.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
async function step1()
|
||||||
|
{
|
||||||
|
console.log('step 1');
|
||||||
|
throw new Error('step 1');
|
||||||
|
}
|
||||||
|
|
||||||
|
async function step2()
|
||||||
|
{
|
||||||
|
console.log('step 1');
|
||||||
|
throw new Error('step 1');
|
||||||
|
}
|
||||||
|
|
||||||
|
async function step3()
|
||||||
|
{
|
||||||
|
console.log('step 1');
|
||||||
|
throw new Error('step 1');
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main()
|
||||||
|
{
|
||||||
|
await step1();
|
||||||
|
await step2();
|
||||||
|
await step3();
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
/*
|
||||||
|
* Maerket Base Contract
|
||||||
|
*
|
||||||
|
* Author: Craig Everett <ceverett@tsuriai.jp>
|
||||||
|
* Copyright: Tsuriai Corporation (2022)
|
||||||
|
* License: GPLv3
|
||||||
|
* Version: 0.1
|
||||||
|
*
|
||||||
|
* This is the base contract for the maerket.
|
||||||
|
* It is responsible for:
|
||||||
|
* - A library of valid contracts by type (sales offers, auctions, etc.)
|
||||||
|
* - Managing the authorized key list of maerket maesters
|
||||||
|
* - Providing a single known endpoint to discover deployed, active contracts
|
||||||
|
* - Managing the lifecycle of a maerket contract
|
||||||
|
*
|
||||||
|
* Lifecycle of a sales offer:
|
||||||
|
* 1. The seller calls MaerketBase.post_sale() to create his SaleOffer
|
||||||
|
* 2. Sale proceeds
|
||||||
|
* IF it is succesful, the contract calls MaerketBase.close()
|
||||||
|
* IF it is revoked by seller, the contract calls MaerketBase.close()
|
||||||
|
* IF it times out or is killed by the maesters, one calls MaerketBase.kill()
|
||||||
|
*/
|
||||||
|
|
||||||
|
@compiler == 6.1
|
||||||
|
|
||||||
|
include "List.aes"
|
||||||
|
|
||||||
|
contract interface SaleOffer =
|
||||||
|
entrypoint init : (address, address, int, int) => void
|
||||||
|
payable entrypoint do_a_backflip : () => void
|
||||||
|
|
||||||
|
|
||||||
|
contract MaerketBase =
|
||||||
|
record state =
|
||||||
|
{contracts : map(int, SaleOffer),
|
||||||
|
template : SaleOffer,
|
||||||
|
maesters : list(address),
|
||||||
|
tsuriai : address}
|
||||||
|
|
||||||
|
stateful entrypoint init(template : SaleOffer,
|
||||||
|
maesters : list(address),
|
||||||
|
tsuriai : address) : state =
|
||||||
|
{contracts = {},
|
||||||
|
template = template,
|
||||||
|
maesters = maesters,
|
||||||
|
tsuriai = tsuriai}
|
||||||
|
|
||||||
|
public entrypoint template() : SaleOffer =
|
||||||
|
state.template
|
||||||
|
|
||||||
|
public entrypoint lookup(id: int) : SaleOffer =
|
||||||
|
switch(Map.lookup(id, state.contracts))
|
||||||
|
Some(target) =>
|
||||||
|
target
|
||||||
|
None =>
|
||||||
|
abort("Bad ID!")
|
||||||
|
|
||||||
|
public stateful entrypoint post_sale(id: int, price: int) : SaleOffer =
|
||||||
|
require(price > 0, "You cannot pay someone to buy things, Mr. Keynes.")
|
||||||
|
require(!Map.member(id, state.contracts),
|
||||||
|
"People don't think it be like it is, but it do.")
|
||||||
|
switch(Chain.clone(ref = state.template,
|
||||||
|
protected = true,
|
||||||
|
state.tsuriai,
|
||||||
|
Contract.address,
|
||||||
|
id,
|
||||||
|
price))
|
||||||
|
Some(posted) =>
|
||||||
|
put(state{contracts = state.contracts{[id] = posted}})
|
||||||
|
posted
|
||||||
|
None =>
|
||||||
|
abort("Bad sale!")
|
||||||
|
|
||||||
|
public stateful entrypoint close(id: int) : bool =
|
||||||
|
switch(Map.lookup(id, state.contracts))
|
||||||
|
Some(target) =>
|
||||||
|
require(target.address == Call.caller, "Bad caller")
|
||||||
|
put(state{contracts = Map.delete(id, state.contracts)})
|
||||||
|
true
|
||||||
|
None =>
|
||||||
|
false
|
||||||
|
|
||||||
|
public stateful entrypoint update_maesters(keys: list(address)) : unit =
|
||||||
|
require(Call.caller == state.tsuriai, "Nuh, uh uh! You didn't say the magic word!")
|
||||||
|
put(state{maesters = keys})
|
||||||
|
|
||||||
|
public stateful entrypoint epstein(id: int) : bool =
|
||||||
|
require(List.contains(Call.caller, state.maesters),
|
||||||
|
"C'mon, man! You only got the husband and son!")
|
||||||
|
switch(Map.lookup(id, state.contracts))
|
||||||
|
Some(target) =>
|
||||||
|
put(state{contracts = Map.delete(id, state.contracts)})
|
||||||
|
target.do_a_backflip()
|
||||||
|
true
|
||||||
|
None =>
|
||||||
|
false
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
|
||||||
|
@compiler >= 6
|
||||||
|
|
||||||
|
include "String.aes"
|
||||||
|
|
||||||
|
contract CryptoHamster =
|
||||||
|
|
||||||
|
record state = {
|
||||||
|
index : int,
|
||||||
|
map_hamsters : map(string, hamster),
|
||||||
|
testvalue: int}
|
||||||
|
|
||||||
|
record hamster = {
|
||||||
|
id : int,
|
||||||
|
name : string,
|
||||||
|
dna : int}
|
||||||
|
|
||||||
|
stateful entrypoint init() =
|
||||||
|
{ index = 1,
|
||||||
|
map_hamsters = {},
|
||||||
|
testvalue = 42}
|
||||||
|
|
||||||
|
public entrypoint read_test_value() : int =
|
||||||
|
state.testvalue
|
||||||
|
|
||||||
|
public entrypoint return_caller() : address =
|
||||||
|
Call.caller
|
||||||
|
|
||||||
|
public entrypoint cause_error() : unit =
|
||||||
|
require(2 == 1, "require failed")
|
||||||
|
|
||||||
|
public stateful entrypoint add_test_value(one: int, two: int) : int =
|
||||||
|
put(state{testvalue = one + two})
|
||||||
|
one + two
|
||||||
|
|
||||||
|
public entrypoint locally_add_two(one: int, two: int) : int =
|
||||||
|
one + two
|
||||||
|
|
||||||
|
public stateful entrypoint statefully_add_two(one: int, two: int) : int=
|
||||||
|
put(state{testvalue = one + two})
|
||||||
|
state.testvalue
|
||||||
|
|
||||||
|
stateful entrypoint create_hamster(hamster_name: string) =
|
||||||
|
require(!name_exists(hamster_name), "Name is already taken")
|
||||||
|
let dna : int = generate_random_dna(hamster_name)
|
||||||
|
create_hamster_by_name_dna(hamster_name, dna)
|
||||||
|
|
||||||
|
entrypoint name_exists(name: string) : bool =
|
||||||
|
Map.member(name, state.map_hamsters)
|
||||||
|
|
||||||
|
entrypoint get_hamster_dna(name: string, test: option(int)) : int =
|
||||||
|
require(name_exists(name), "There is no hamster with that name!")
|
||||||
|
|
||||||
|
let needed_hamster : hamster = state.map_hamsters[name]
|
||||||
|
|
||||||
|
needed_hamster.dna
|
||||||
|
|
||||||
|
private stateful function create_hamster_by_name_dna(name: string, dna: int) =
|
||||||
|
let new_hamster : hamster = {
|
||||||
|
id = state.index,
|
||||||
|
name = name,
|
||||||
|
dna = dna}
|
||||||
|
|
||||||
|
put(state{map_hamsters[name] = new_hamster})
|
||||||
|
put(state{index = (state.index + 1)})
|
||||||
|
|
||||||
|
private function generate_random_dna(name: string) : int =
|
||||||
|
get_block_hash_bytes_as_int() - Chain.timestamp + state.index
|
||||||
|
|
||||||
|
private function get_block_hash_bytes_as_int() : int =
|
||||||
|
switch(Chain.block_hash(Chain.block_height - 1))
|
||||||
|
None => abort("blockhash not found")
|
||||||
|
Some(bytes) => Bytes.to_int(bytes)
|
||||||
|
|
||||||
|
entrypoint test(name: string) : hash =
|
||||||
|
String.sha3(name)
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
contract Floyd =
|
||||||
|
type state = unit
|
||||||
|
|
||||||
|
stateful entrypoint init() =
|
||||||
|
()
|
||||||
|
|
||||||
|
entrypoint sayHello() : string =
|
||||||
|
"hello"
|
||||||
|
|
||||||
|
entrypoint x() : int =
|
||||||
|
0
|
||||||
@@ -0,0 +1,200 @@
|
|||||||
|
/*
|
||||||
|
* Maerket Sales Offer
|
||||||
|
*
|
||||||
|
* Author: Craig Everett <ceverett@tsuriai.jp>
|
||||||
|
* Copyright: Tsuriai Corporation (2022)
|
||||||
|
* License: GPLv3
|
||||||
|
* Version: 0.1
|
||||||
|
*
|
||||||
|
* Sale offers at Maerket (maerket.psychobitch.party) are clones of this contract.
|
||||||
|
* (The name might be a little weird, but who looks at domain names anymore anyway?)
|
||||||
|
* When a sale offer is created on the site, the seller signs a contract call to
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* Calls to clones of this contract can come from five sources:
|
||||||
|
* 1. The base contract (that cloned it in the first place)
|
||||||
|
* - init(maerket : MaerketBase, // Get born
|
||||||
|
* id : int,
|
||||||
|
* price : int)
|
||||||
|
* - do_a_backflip() // Get the opposite of born
|
||||||
|
* 2. Sellers who posted clones of this contract
|
||||||
|
* - adjust(price : int) // update price
|
||||||
|
* - accept() // Sale is DONE
|
||||||
|
* - refuse() // Cancel a negotation
|
||||||
|
* - revoke() // Invalidate and disable this offer
|
||||||
|
* 3. Buyers who are interested in buying through this contract
|
||||||
|
* - bid(price : int) // Update the bid amout in negotiation
|
||||||
|
* - hold() // Set HOLD for price negotiation
|
||||||
|
* - cancel() // Back out of a purchase
|
||||||
|
* 4. Maerket (the base contract)
|
||||||
|
* - reassign(tsuriai : address) // Reset Tsuriai's payable address
|
||||||
|
* 5. The maerket's network service (or the public)
|
||||||
|
* - price() // Check current contract price
|
||||||
|
* - status() // Check contract status
|
||||||
|
*/
|
||||||
|
|
||||||
|
@compiler == 6.1
|
||||||
|
|
||||||
|
contract interface MaerketBase =
|
||||||
|
stateful entrypoint close : (int) => bool
|
||||||
|
|
||||||
|
|
||||||
|
contract SalesOffer =
|
||||||
|
record state =
|
||||||
|
{id : int,
|
||||||
|
maerket : MaerketBase,
|
||||||
|
price : int,
|
||||||
|
buyer : option(address),
|
||||||
|
status : status,
|
||||||
|
tsuriai : address}
|
||||||
|
|
||||||
|
datatype status = OPEN | NEGO | HOLD | DONE
|
||||||
|
|
||||||
|
|
||||||
|
// Seller Interface
|
||||||
|
stateful entrypoint init(tsuriai : address,
|
||||||
|
maerket : MaerketBase,
|
||||||
|
id : int,
|
||||||
|
price : int) : state =
|
||||||
|
{id = id,
|
||||||
|
maerket = maerket,
|
||||||
|
price = price,
|
||||||
|
buyer = None,
|
||||||
|
status = OPEN,
|
||||||
|
tsuriai = tsuriai}
|
||||||
|
|
||||||
|
public stateful entrypoint adjust(price : int) : unit =
|
||||||
|
require(state.status != DONE, "HiLlArY wUz HeRe.")
|
||||||
|
require(Call.caller == Contract.creator, "Nacho shop!")
|
||||||
|
require(price > 0, "You can't pay people to buy things, Mr. Keynes.")
|
||||||
|
switch(state.buyer)
|
||||||
|
Some(buyer) =>
|
||||||
|
if(Contract.balance > price)
|
||||||
|
Chain.spend(buyer, Contract.balance - price)
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
|
None =>
|
||||||
|
dead_claim()
|
||||||
|
put(state{price = price})
|
||||||
|
|
||||||
|
public stateful entrypoint accept() : bool =
|
||||||
|
require(state.status == NEGO, "Sale is not under negotiation.")
|
||||||
|
require(Call.caller == Contract.creator, "Nacho shop!")
|
||||||
|
require(Contract.balance >= state.price, "Insufficient funds!")
|
||||||
|
Chain.spend(state.tsuriai, calc_fee())
|
||||||
|
Chain.spend(Contract.creator, Contract.balance)
|
||||||
|
put(state{status = DONE})
|
||||||
|
state.maerket.close(state.id)
|
||||||
|
|
||||||
|
public stateful entrypoint refuse() : unit =
|
||||||
|
require(state.status == NEGO || state.status == HOLD,
|
||||||
|
"Sale is not under negotiation.")
|
||||||
|
require(Call.caller == Contract.creator, "Nacho shop!")
|
||||||
|
refund()
|
||||||
|
put(state{buyer = None})
|
||||||
|
put(state{status = OPEN})
|
||||||
|
|
||||||
|
public stateful entrypoint revoke() : bool =
|
||||||
|
require(state.status != DONE, "HiLlArY wUz HeRe.")
|
||||||
|
require(Call.caller == Contract.creator, "Nacho shop!")
|
||||||
|
switch(state.status)
|
||||||
|
OPEN => dead_claim()
|
||||||
|
NEGO => refund()
|
||||||
|
HOLD => refund()
|
||||||
|
put(state{status = DONE})
|
||||||
|
state.maerket.close(state.id)
|
||||||
|
|
||||||
|
|
||||||
|
// Buyer Interface
|
||||||
|
public stateful payable entrypoint bid(amount: int) : unit =
|
||||||
|
require(state.status != DONE, "HiLlArY wUz HeRe.")
|
||||||
|
require(amount >= state.price, "Stop being poor.")
|
||||||
|
switch(state.status)
|
||||||
|
OPEN =>
|
||||||
|
require(Call.value >= state.price, "Stop being poor.")
|
||||||
|
put(state{status = NEGO})
|
||||||
|
put(state{buyer = Some(Call.caller)})
|
||||||
|
NEGO =>
|
||||||
|
switch(state.buyer)
|
||||||
|
Some(buyer) =>
|
||||||
|
require(Call.caller == buyer, "Nacho bid.")
|
||||||
|
require(Contract.balance >= state.price, "Stop being poor.")
|
||||||
|
if(Contract.balance > amount)
|
||||||
|
Chain.spend(buyer, Contract.balance - amount)
|
||||||
|
HOLD =>
|
||||||
|
switch(state.buyer)
|
||||||
|
Some(buyer) =>
|
||||||
|
require(Call.caller == buyer, "Nacho bid.")
|
||||||
|
require(Contract.balance >= state.price, "Stop being poor.")
|
||||||
|
if(Contract.balance > amount)
|
||||||
|
Chain.spend(buyer, Contract.balance - amount)
|
||||||
|
put(state{status = NEGO})
|
||||||
|
|
||||||
|
public stateful entrypoint hold() : unit =
|
||||||
|
require(state.status == NEGO, "Sale is not in negotiation")
|
||||||
|
switch(state.buyer)
|
||||||
|
Some(buyer) =>
|
||||||
|
require(Call.caller == buyer, "Nacho bid!")
|
||||||
|
put(state{status = HOLD})
|
||||||
|
None =>
|
||||||
|
abort("Nacho bid!")
|
||||||
|
|
||||||
|
public stateful entrypoint cancel() : unit =
|
||||||
|
require(state.status == NEGO || state.status == HOLD, "Wrong status")
|
||||||
|
switch(state.buyer)
|
||||||
|
Some(buyer) =>
|
||||||
|
require(Call.caller == buyer, "Nacho bid!")
|
||||||
|
Chain.spend(state.tsuriai, calc_fee())
|
||||||
|
put(state{buyer = None})
|
||||||
|
put(state{status = OPEN})
|
||||||
|
Chain.spend(buyer, Contract.balance)
|
||||||
|
None =>
|
||||||
|
abort("Nacho bid!")
|
||||||
|
|
||||||
|
|
||||||
|
// Maerket Interface
|
||||||
|
public stateful entrypoint reassign(tsuriai : address) : unit =
|
||||||
|
require(Call.caller == state.maerket.address || Call.origin == state.tsuriai,
|
||||||
|
"Knock it off, stinky")
|
||||||
|
put(state{tsuriai = tsuriai})
|
||||||
|
|
||||||
|
public stateful entrypoint sweep_the_table() : bool =
|
||||||
|
require(state.status == DONE, "Hillary has not yet arrived.")
|
||||||
|
require(Call.caller == state.tsuriai, "Nope.")
|
||||||
|
dead_claim()
|
||||||
|
|
||||||
|
|
||||||
|
// Service/Public Network Interface
|
||||||
|
public entrypoint price() : int =
|
||||||
|
state.price
|
||||||
|
|
||||||
|
public entrypoint status() : string =
|
||||||
|
switch(state.status)
|
||||||
|
OPEN => "open"
|
||||||
|
NEGO => "nego"
|
||||||
|
HOLD => "hold"
|
||||||
|
DONE => "done"
|
||||||
|
|
||||||
|
|
||||||
|
// Utilities
|
||||||
|
function calc_fee() : int =
|
||||||
|
Contract.balance / 50
|
||||||
|
|
||||||
|
private stateful function refund() : bool =
|
||||||
|
if(Contract.balance > 0)
|
||||||
|
switch(state.buyer)
|
||||||
|
Some(buyer) =>
|
||||||
|
Chain.spend(buyer, Contract.balance)
|
||||||
|
true
|
||||||
|
None =>
|
||||||
|
false
|
||||||
|
else
|
||||||
|
false
|
||||||
|
|
||||||
|
private stateful function dead_claim() : bool =
|
||||||
|
if(Contract.balance > 0)
|
||||||
|
Chain.spend(state.tsuriai, Contract.balance)
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="../style.css">
|
||||||
|
<title>Do a transfer: Sidekick</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="../../">Sidekick</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="../">Examples</a></li>
|
||||||
|
<ul><li><b>Do a transfer</b></li></ul>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h1>Sidekick Example: Do A Transfer</h1>
|
||||||
|
|
||||||
|
<!-- Connect to a wallet -->
|
||||||
|
<h3>Example 1: transfer 1 aetto to <code>@mystery</code></h1>
|
||||||
|
<ol>
|
||||||
|
<li class="step1 current">
|
||||||
|
<p>Connect to Superhero:</p>
|
||||||
|
<button class="step1 current" id="btn-step1">Click Me</button>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Address: <code id="user-wallet-address">(not connected)</code>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="step2 disabled">
|
||||||
|
Enter address of recipient and amount:
|
||||||
|
|
||||||
|
<label for="recip">Recipient:</label>
|
||||||
|
<input id="step2-recip" class="step2 disabled" type="text" value="ak_dvNHMgVvdSgDchLsmcUpuFTbMBGfG3E5V9KZnNjLYPyEhcqnL">
|
||||||
|
<br>
|
||||||
|
|
||||||
|
<label for="amt">Amount (aettos):</label>
|
||||||
|
<input id="step2-amt" class="step2 diabled" type="text" value="1">
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<button class="step2 disabled" id="btn-step2">Go!</button>
|
||||||
|
</li>
|
||||||
|
<li class="step3 disabled">
|
||||||
|
Transaction:
|
||||||
|
|
||||||
|
<pre><code id="step3-transaction-info"></code></pre>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<script type="module" src="../examples_dist_js/do_a_transfer.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="../style.css">
|
||||||
|
<title>Hello world: Sidekick</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="/">Home</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="../">Examples</a></li>
|
||||||
|
<ul><li><b>Hello world</b></li></ul>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h1>Sidekick Example: Hello World</h1>
|
||||||
|
|
||||||
|
<h4>Check the console</h4>
|
||||||
|
<script type="module">
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
sk.hello();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,218 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="../style.css">
|
||||||
|
<title>Sidekick Example: Sophia Development IDE</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="/">Home</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="../">Examples</a></li>
|
||||||
|
<ul><li><b>Sophia IDE</b></li></ul>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h1>Sidekick Example: Sophia IDE</h1>
|
||||||
|
|
||||||
|
<!-- USER INPUT -->
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<label for="template-name">Insert Template:</label>
|
||||||
|
<select name="template-name" id="template-name">
|
||||||
|
<option value="floyd.aes">floyd.aes</option>
|
||||||
|
<option value="crypto_hamster.aes">crypto_hamster.aes</option>
|
||||||
|
<option value="base_contract.aes">Maerket base contract</option>
|
||||||
|
<option value="sales_contract.aes">Maerket sales contract</option>
|
||||||
|
</select>
|
||||||
|
<button id="insert-template-button">Insert!</button>
|
||||||
|
</li>
|
||||||
|
<!-- filename -->
|
||||||
|
<li>
|
||||||
|
<label for="the-filename">Filename (optional)</label>
|
||||||
|
<input type="text" id="the-filename" value="floyd.aes">
|
||||||
|
</li>
|
||||||
|
<!-- code -->
|
||||||
|
<li>
|
||||||
|
<label for="the-code">Code:</label>
|
||||||
|
<br/>
|
||||||
|
<textarea id="the-code" cols="80" rows="25">contract Floyd =
|
||||||
|
type state = unit
|
||||||
|
|
||||||
|
stateful entrypoint init() =
|
||||||
|
()
|
||||||
|
|
||||||
|
entrypoint sayHello() : string =
|
||||||
|
"hello"
|
||||||
|
|
||||||
|
entrypoint x() : int =
|
||||||
|
0
|
||||||
|
</textarea>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<!-- COMPILE SHIT -->
|
||||||
|
<h3>Compile</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<!-- compile button -->
|
||||||
|
<li>
|
||||||
|
<button id="compile-button">Compile</button>
|
||||||
|
</li>
|
||||||
|
<!-- clear button -->
|
||||||
|
<li>
|
||||||
|
<button id="compile-clear">Clear Result</button>
|
||||||
|
</li>
|
||||||
|
<!-- result code -->
|
||||||
|
<li>
|
||||||
|
<label for="compile-result-status">Status:</label>
|
||||||
|
<div id="compile-result-status"></div>
|
||||||
|
</li>
|
||||||
|
<!-- result -->
|
||||||
|
<li>
|
||||||
|
<label for="compile-result-json">Result:</li>
|
||||||
|
<br>
|
||||||
|
<textarea id="compile-result-json" cols="80" rows="5" disabled></textarea>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<!-- ENCODE CALLDATA -->
|
||||||
|
<h3>Encode Calldata</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<!-- function name input-->
|
||||||
|
<li>
|
||||||
|
Function name (to call constructor, call <code>init</code>)
|
||||||
|
<br>
|
||||||
|
<input type="text" id="EncodeCalldata-function-name">
|
||||||
|
</li>
|
||||||
|
<!-- function args input-->
|
||||||
|
<li>
|
||||||
|
Function arguments
|
||||||
|
|
||||||
|
<br>
|
||||||
|
Rules:
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Arguments must be an array of JSON strings</li>
|
||||||
|
<li>Strings must be double-quoted <a href="/why.html">(why?)</a></li>
|
||||||
|
<li>
|
||||||
|
Literal strings must be escape-quoted.
|
||||||
|
<br>
|
||||||
|
|
||||||
|
For instance, to call function <code>foo</code> with argument
|
||||||
|
<code>"bar"</code>, you would put
|
||||||
|
<code>foo</code>
|
||||||
|
above, and put below <code>["\"bar\""]</code>.
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<textarea id="EncodeCalldata-function-args" cols="80" rows="1">[]</textarea>
|
||||||
|
</li>
|
||||||
|
<!-- encode button-->
|
||||||
|
<li>
|
||||||
|
<button id="EncodeCalldata-button">Encode</button>
|
||||||
|
</li>
|
||||||
|
<!-- clear button-->
|
||||||
|
<li>
|
||||||
|
<button id="EncodeCalldata-button-clear">Clear</button>
|
||||||
|
</li>
|
||||||
|
<!-- encode result status -->
|
||||||
|
<li>
|
||||||
|
<label for="EncodeCalldata-result-status">Encode Result Status:</label>
|
||||||
|
<div id="EncodeCalldata-result-status"></div>
|
||||||
|
</li>
|
||||||
|
<!-- encode result json -->
|
||||||
|
<li>
|
||||||
|
<label for="EncodeCalldata-result-json">Encode Result:</label>
|
||||||
|
<br>
|
||||||
|
<textarea id="EncodeCalldata-result-json" cols="80" rows="5" disabled></textarea>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<!-- CONNECT TO SUPERHERO -->
|
||||||
|
<h3>Deploy contract</h3>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
<button id="connect-to-superhero">Connect to Superhero</button>
|
||||||
|
<br>
|
||||||
|
User wallet address:
|
||||||
|
<br>
|
||||||
|
<textarea id="user-wallet-address" cols="80" rows="1" disabled></textarea>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<!-- function args input-->
|
||||||
|
<li>
|
||||||
|
Constructor arguments
|
||||||
|
|
||||||
|
<br>
|
||||||
|
Rules:
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Arguments must be an array of JSON strings</li>
|
||||||
|
<li>Strings must be double-quoted <a href="/why.html">(why?)</a></li>
|
||||||
|
<li>
|
||||||
|
Literal strings must be escape-quoted.
|
||||||
|
<br>
|
||||||
|
|
||||||
|
For instance, to call function <code>foo</code> with argument
|
||||||
|
<code>"bar"</code>, you would put
|
||||||
|
<code>foo</code>
|
||||||
|
above, and put below <code>["\"bar\""]</code>.
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<textarea id="deploy-function-args" cols="80" rows="1">[]</textarea>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<button id="contract-create-button">Deploy</button>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<!-- contract-create result status -->
|
||||||
|
<li>
|
||||||
|
<label for="contract-create-result-status">ContractCreate Result Status:</label>
|
||||||
|
<div id="contract-create-result-status"></div>
|
||||||
|
</li>
|
||||||
|
<!-- contract-create result json -->
|
||||||
|
<li>
|
||||||
|
<label for="contract-create-result-json">ContractCreate Result:</label>
|
||||||
|
<br>
|
||||||
|
<textarea id="contract-create-result-json" cols="80" rows="10" disabled></textarea>
|
||||||
|
</li>
|
||||||
|
<!--
|
||||||
|
<li>
|
||||||
|
<button id="superhero-sign-btn">Have Superhero Sign It</button>
|
||||||
|
</li>
|
||||||
|
-->
|
||||||
|
<li>
|
||||||
|
Sign Result:
|
||||||
|
<br>
|
||||||
|
<textarea id="superhero-sign-result-json" cols="80" rows="35" disabled></textarea>
|
||||||
|
</li>
|
||||||
|
<!-- Deploy Result -->
|
||||||
|
<li>
|
||||||
|
PostTransaction Return Status:
|
||||||
|
<div id="post-transaction-result-status"></div>
|
||||||
|
</li>
|
||||||
|
<!-- Deploy Result -->
|
||||||
|
<li>
|
||||||
|
PostTransaction Result:
|
||||||
|
<br>
|
||||||
|
<textarea id="post-transaction-result-json" cols="80" rows="35" disabled></textarea>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<!-- CONTRACT CREATE TRANSACTION -->
|
||||||
|
|
||||||
|
<!-- CONTRACT CALL TRANSACTION -->
|
||||||
|
|
||||||
|
<!-- SCRIPT -->
|
||||||
|
<script type="module" src="../examples_dist_js/ide.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="../style.css">
|
||||||
|
<title>Sidekick Example: Maerket</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="/">Home</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="../">Examples</a></li>
|
||||||
|
<ul><li><b>Maerket</b></li></ul>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h1>Sidekick example: Maerket</h1>
|
||||||
|
|
||||||
|
<h2>NYI</h2>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,160 @@
|
|||||||
|
import * as ae_node from './parasite/ae_node.js';
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Transfer money to target address
|
||||||
|
*/
|
||||||
|
async function
|
||||||
|
transfer(skl : sk.Skylight,
|
||||||
|
target_addr : string,
|
||||||
|
amount : number)
|
||||||
|
: Promise<any>
|
||||||
|
{
|
||||||
|
let endpoint = ae_node.URL_TESTNET;
|
||||||
|
let src_addr = await sk.address(skl, sk.TIMEOUT_DEF_ADDRESS);
|
||||||
|
let spendtx = {'recipient_id' : target_addr,
|
||||||
|
'amount' : amount,
|
||||||
|
'fee' : ae_node.MIN_FEE,
|
||||||
|
'sender_id' : src_addr,
|
||||||
|
'payload' : ""};
|
||||||
|
let tx_obj = await ae_node.PostSpend(endpoint, spendtx) as ae_node.Tx;
|
||||||
|
let ret =
|
||||||
|
await sk.tx_sign_no_propagate(skl,
|
||||||
|
tx_obj,
|
||||||
|
sk.NETWORK_ID_TESTNET,
|
||||||
|
sk.TIMEOUT_DEF_SIGN);
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
function
|
||||||
|
current_to_done(class_name : string)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
let class_items = document.getElementsByClassName(class_name);
|
||||||
|
for (let class_item of class_items)
|
||||||
|
{
|
||||||
|
class_item.classList.remove('current');
|
||||||
|
class_item.classList.add('done');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
function
|
||||||
|
disabled_to_current(class_name : string)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
let class_items = document.getElementsByClassName(class_name);
|
||||||
|
for (let class_item of class_items)
|
||||||
|
{
|
||||||
|
class_item.classList.remove('disabled');
|
||||||
|
class_item.classList.add('current');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// connect to superhero do what I mean
|
||||||
|
async function
|
||||||
|
step1(skl : sk.Skylight)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
//// await sk.connect_dwim(skl,
|
||||||
|
//// sk.TIMEOUT_DEF_DETECT,
|
||||||
|
//// sk.TIMEOUT_DEF_CONNECT,
|
||||||
|
//// sk.TIMEOUT_DEF_ADDRESS);
|
||||||
|
|
||||||
|
//console.log('telling to listen!');
|
||||||
|
//await sk.listen(skl);
|
||||||
|
//console.log('listening!');
|
||||||
|
|
||||||
|
//console.log('detecting!');
|
||||||
|
//await sk.detect_dwim(skl, sk.);
|
||||||
|
//console.log('detected!');
|
||||||
|
|
||||||
|
//console.log('connecting!');
|
||||||
|
//await skl.connect(60000);
|
||||||
|
//console.log('connected!');
|
||||||
|
|
||||||
|
//console.log('addressing!');
|
||||||
|
//await skl.address(60000);
|
||||||
|
//console.log('addressed!');
|
||||||
|
//// sk.TIMEOUT_DEF_DETECT,
|
||||||
|
//// sk.TIMEOUT_DEF_CONNECT,
|
||||||
|
//// sk.TIMEOUT_DEF_ADDRESS);
|
||||||
|
|
||||||
|
// get wallet address
|
||||||
|
let wallet_addr = await sk.handshake_def(skl);
|
||||||
|
|
||||||
|
// put it in the thing
|
||||||
|
// bang = turn off the null warning
|
||||||
|
document.getElementById('user-wallet-address')!.innerHTML = wallet_addr;
|
||||||
|
|
||||||
|
// update style
|
||||||
|
current_to_done('step1');
|
||||||
|
disabled_to_current('step2');
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// do tx
|
||||||
|
async function
|
||||||
|
step2(skl : sk.Skylight)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
// The angle bracket is typescript type inference jizz; doesn't
|
||||||
|
// change runtime behavior
|
||||||
|
//
|
||||||
|
// https://stackoverflow.com/questions/12989741/the-property-value-does-not-exist-on-value-of-type-htmlelement
|
||||||
|
let target_addr = (<HTMLInputElement>document.getElementById('step2-recip')).value;
|
||||||
|
let amts = (<HTMLInputElement>document.getElementById('step2-amt')).value;
|
||||||
|
let amt = parseInt(amts);
|
||||||
|
|
||||||
|
// FIXME (dak)
|
||||||
|
// @ts-ignore implicit any
|
||||||
|
let my_transfer = await transfer(skl, target_addr, amt);
|
||||||
|
let my_transfer_text = sk.pf(my_transfer);
|
||||||
|
|
||||||
|
// add info
|
||||||
|
// bang is typescript jizz which means assume not null
|
||||||
|
document.getElementById("step3-transaction-info")!.innerHTML =
|
||||||
|
my_transfer_text;
|
||||||
|
|
||||||
|
// update style
|
||||||
|
current_to_done('step2');
|
||||||
|
disabled_to_current('step3');
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async function main()
|
||||||
|
{
|
||||||
|
//// this turns on the console logger
|
||||||
|
//sidekick.snoop_console();
|
||||||
|
|
||||||
|
let skl = await sk.start();
|
||||||
|
|
||||||
|
// as = type inference helper; doesn't affect runtime js
|
||||||
|
let step1_fun =
|
||||||
|
async function()
|
||||||
|
{
|
||||||
|
step1(skl)
|
||||||
|
}
|
||||||
|
let step2_fun =
|
||||||
|
async function()
|
||||||
|
{
|
||||||
|
step2(skl)
|
||||||
|
}
|
||||||
|
|
||||||
|
// the exclamation point turns off the "object is possibly null"
|
||||||
|
// typecheck
|
||||||
|
document.getElementById('btn-step1')!.addEventListener('click', step1_fun);
|
||||||
|
document.getElementById('btn-step2')!.addEventListener('click', step2_fun);
|
||||||
|
|
||||||
|
//let foo = async () => {console.log(my_skylight.msgr.msgq.queue);};
|
||||||
|
//while(true) {
|
||||||
|
// await foo();
|
||||||
|
// await helpers.sleep(1000);
|
||||||
|
//}
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
@@ -0,0 +1,222 @@
|
|||||||
|
// TODO: make this all into top-level calls
|
||||||
|
|
||||||
|
import * as ae_compiler from './parasite/ae_compiler.js';
|
||||||
|
import * as ae_node from './parasite/ae_node.js';
|
||||||
|
import * as sidekick from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
|
||||||
|
|
||||||
|
function
|
||||||
|
value_of_id
|
||||||
|
(str : string)
|
||||||
|
: string
|
||||||
|
{
|
||||||
|
// angle bracket jizz is type inference jizz; does not change
|
||||||
|
// runtime behavior;
|
||||||
|
//
|
||||||
|
// https://stackoverflow.com/questions/12989741/the-property-value-does-not-exist-on-value-of-type-htmlelement
|
||||||
|
return (<HTMLInputElement>document.getElementById(str)).value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// COMPILE
|
||||||
|
|
||||||
|
async function
|
||||||
|
user_clicked_insert
|
||||||
|
()
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let template_name = value_of_id("template-name");
|
||||||
|
let template_resp = await fetch(`http://localhost:8001/contract-examples/${template_name}`);
|
||||||
|
let template_code = await template_resp.text();
|
||||||
|
|
||||||
|
// Angle brackets are type inference jizz
|
||||||
|
//
|
||||||
|
// https://stackoverflow.com/questions/12989741/the-property-value-does-not-exist-on-value-of-type-htmlelement
|
||||||
|
(<HTMLInputElement>document.getElementById('the-filename')).value = template_name;
|
||||||
|
// bang turns off null warning
|
||||||
|
document.getElementById('the-code')!.innerHTML = template_code;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// COMPILE
|
||||||
|
async function
|
||||||
|
user_clicked_compile
|
||||||
|
()
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let code = value_of_id('the-code');
|
||||||
|
let filename = value_of_id('the-filename');
|
||||||
|
|
||||||
|
console.log('code:');
|
||||||
|
console.log(code);
|
||||||
|
|
||||||
|
let response = await ae_compiler.CompileContract(code, filename);
|
||||||
|
let status_n = response.status;
|
||||||
|
let status_t = response.statusText;
|
||||||
|
let result_json = await response.json();
|
||||||
|
|
||||||
|
console.log('status_n', status_n);
|
||||||
|
console.log('status_t', status_t);
|
||||||
|
console.log('result_t', result_json);
|
||||||
|
|
||||||
|
// bang turns off typescript possibly null warning
|
||||||
|
document.getElementById('compile-result-status')!.innerText = `${status_n} ${status_t}`;
|
||||||
|
document.getElementById('compile-result-json')!.innerHTML = sidekick.pf(result_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
function
|
||||||
|
user_clicked_clear
|
||||||
|
()
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
// bang turns off typescript possibly null warning
|
||||||
|
document.getElementById('compile-result-status')!.innerText = '';
|
||||||
|
document.getElementById('compile-result-json')!.innerHTML = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// ENCODE CALLDATA
|
||||||
|
async function
|
||||||
|
user_clicked_encode
|
||||||
|
()
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let code = value_of_id('the-code');
|
||||||
|
let filename = value_of_id('the-filename');
|
||||||
|
let fn_name = value_of_id('EncodeCalldata-function-name');
|
||||||
|
let fn_args_s = value_of_id('EncodeCalldata-function-args');
|
||||||
|
let fn_args = JSON.parse(fn_args_s);
|
||||||
|
|
||||||
|
let response =
|
||||||
|
await ae_compiler.EncodeCalldata(code,
|
||||||
|
filename,
|
||||||
|
fn_name,
|
||||||
|
fn_args);
|
||||||
|
let status_n = response.status;
|
||||||
|
let status_t = response.statusText;
|
||||||
|
let result_json = await response.json();
|
||||||
|
|
||||||
|
console.log('status_n', status_n);
|
||||||
|
console.log('status_t', status_t);
|
||||||
|
console.log('result_t', result_json);
|
||||||
|
|
||||||
|
// bang turns off null warnings in tsc
|
||||||
|
document.getElementById('EncodeCalldata-result-status')!.innerText = `${status_n} ${status_t}`;
|
||||||
|
document.getElementById('EncodeCalldata-result-json')!.innerHTML = sidekick.pf(result_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
function
|
||||||
|
user_clicked_encode_clear
|
||||||
|
()
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
// bang turns off null warnings in tsc
|
||||||
|
document.getElementById('EncodeCalldata-result-status')!.innerText = '';
|
||||||
|
document.getElementById('EncodeCalldata-result-json')!.innerText = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// CONNECT TO SUPERHERO
|
||||||
|
async function
|
||||||
|
user_clicked_connect
|
||||||
|
(skl : sidekick.Skylight)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let wallet_addr = await sidekick.handshake_def(skl);
|
||||||
|
|
||||||
|
// put it in the thing
|
||||||
|
// bang turns off maybe null typescript warning
|
||||||
|
document.getElementById('user-wallet-address')!.innerHTML = wallet_addr;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
user_clicked_create
|
||||||
|
(skl : sidekick.Skylight)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
// create_contract(whoami : string,
|
||||||
|
// code : string,
|
||||||
|
// filename : string,
|
||||||
|
// init_args : Array<string>)
|
||||||
|
let whoami = await sidekick.address(skl, sidekick.TIMEOUT_DEF_ADDRESS);
|
||||||
|
let code = value_of_id('the-code');
|
||||||
|
let filename = value_of_id('the-filename');
|
||||||
|
let fn_args_s = value_of_id('deploy-function-args');
|
||||||
|
let fn_args = JSON.parse(fn_args_s);
|
||||||
|
|
||||||
|
let resp = await ae_node.create_contract(whoami, code, filename, fn_args);
|
||||||
|
let resp_status_n = await resp.status;
|
||||||
|
let resp_status_t = await resp.statusText;
|
||||||
|
let resp_json = await resp.json();
|
||||||
|
|
||||||
|
// bang tsc null warning jizz
|
||||||
|
document.getElementById('contract-create-result-status')!.innerText = `${resp_status_n} ${resp_status_t}`;
|
||||||
|
document.getElementById('contract-create-result-json')!.innerHTML = sidekick.pf(resp_json);
|
||||||
|
|
||||||
|
// sign
|
||||||
|
let tx_base58str = resp_json.tx;
|
||||||
|
let tx_obj = {tx: tx_base58str};
|
||||||
|
let result = await sidekick.tx_sign_yes_propagate(skl, tx_obj, sidekick.NETWORK_ID_TESTNET, sidekick.TIMEOUT_DEF_SIGN);
|
||||||
|
|
||||||
|
// bang tsc null warning jizz
|
||||||
|
document.getElementById('superhero-sign-result-json')!.innerHTML = sidekick.pf(result);
|
||||||
|
|
||||||
|
// // try to post transaction
|
||||||
|
// console.log('attempting to post transaction');
|
||||||
|
// let posttx_resp = await ae_node.PostTransaction(ae_node.URL_TESTNET, {tx: result.signedTransaction});
|
||||||
|
// let posttx_resp_status_n = await posttx_resp.status;
|
||||||
|
// let posttx_resp_status_t = await posttx_resp.statusText;
|
||||||
|
// let posttx_resp_json = await posttx_resp.json();
|
||||||
|
//
|
||||||
|
// // fill in boxes
|
||||||
|
// // bang is tsc null checking warning turn off thing
|
||||||
|
// document.getElementById('post-transaction-result-status')!.innerHTML = `${posttx_resp_status_n} ${posttx_resp_status_t}`;
|
||||||
|
// document.getElementById('post-transaction-result-json')!.innerHTML = helpers.pf(posttx_resp_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// MAIN
|
||||||
|
async function
|
||||||
|
main
|
||||||
|
()
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
// bang tsc null warning jizz
|
||||||
|
// TEMPLATE NAME
|
||||||
|
document.getElementById('insert-template-button')!.addEventListener('click', user_clicked_insert);
|
||||||
|
|
||||||
|
// COMPILE
|
||||||
|
document.getElementById('compile-button')!.addEventListener('click', user_clicked_compile);
|
||||||
|
document.getElementById('compile-clear')!.addEventListener('click', user_clicked_clear);
|
||||||
|
|
||||||
|
// ENCODE CALLDATA
|
||||||
|
document.getElementById('EncodeCalldata-button')!.addEventListener('click', user_clicked_encode);
|
||||||
|
document.getElementById('EncodeCalldata-button-clear')!.addEventListener('click', user_clicked_encode_clear);
|
||||||
|
|
||||||
|
|
||||||
|
// DEPLOY
|
||||||
|
|
||||||
|
// this turns on the console logger
|
||||||
|
sidekick.snoop_console();
|
||||||
|
let my_skylight = await sidekick.start();
|
||||||
|
|
||||||
|
// connect button
|
||||||
|
document .getElementById('connect-to-superhero')!
|
||||||
|
.addEventListener('click',
|
||||||
|
function () { user_clicked_connect(my_skylight) });
|
||||||
|
// create button
|
||||||
|
document .getElementById('contract-create-button')!
|
||||||
|
.addEventListener('click',
|
||||||
|
function () { user_clicked_create(my_skylight) });
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
/*******************************************************************
|
||||||
|
** Compiler API
|
||||||
|
**
|
||||||
|
** The manner in which this module is laid out differs meaningfully
|
||||||
|
** from the `ae_node` module.
|
||||||
|
**
|
||||||
|
** - ae_node basically exposes a subset of the node interface as
|
||||||
|
** functions. It only black-boxes away the networking aspects.
|
||||||
|
**
|
||||||
|
** - part of the reason for this is that the data structures that get
|
||||||
|
** sent to the node tend to be pretty involved (lots of fields)
|
||||||
|
**
|
||||||
|
** - in general, the node interface is significantly more complicated
|
||||||
|
** than the compiler interface
|
||||||
|
**
|
||||||
|
** - by contrast, the data structures that get sent to the compiler
|
||||||
|
** tend to be pretty simple and only have a small number of fields
|
||||||
|
**
|
||||||
|
** - the manner in which this manifests is that ae_node functions
|
||||||
|
** tend to have a weird esoteric data structure as the input,
|
||||||
|
** because otherwise there would be too many parameters.
|
||||||
|
**
|
||||||
|
** here, there are few parameters, and they are passed directly
|
||||||
|
**
|
||||||
|
** - in general, the compiler has fewer things it can do, and the
|
||||||
|
** things it does tend to depend on less information. so this
|
||||||
|
** interface is significantly simpler than the node interface
|
||||||
|
*******************************************************************/
|
||||||
|
|
||||||
|
import * as net from './net.js';
|
||||||
|
|
||||||
|
const URL_COMPILER = 'https://compiler.aepps.com';
|
||||||
|
// endpoints
|
||||||
|
const EPT_CompileContract = URL_COMPILER + '/compile';
|
||||||
|
const EPT_EncodeCalldata = URL_COMPILER + '/encode-calldata';
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// HELPERS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// make a CompileOpts data structure
|
||||||
|
function
|
||||||
|
compile_options(filename: string)
|
||||||
|
: object
|
||||||
|
{
|
||||||
|
return {"backend" : "fate",
|
||||||
|
"file_system" : {},
|
||||||
|
"src_file" : filename};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// API CALLS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// send back compile response
|
||||||
|
async function
|
||||||
|
CompileContract(code : string,
|
||||||
|
filename : string)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let send_obj =
|
||||||
|
{"code" : code,
|
||||||
|
"options" : compile_options(filename)};
|
||||||
|
|
||||||
|
let response = await net.post_json_response(EPT_CompileContract, send_obj);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
EncodeCalldata(code : string,
|
||||||
|
filename : string,
|
||||||
|
function_name : string,
|
||||||
|
function_args : Array<string>)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let send_obj =
|
||||||
|
{"source" : code,
|
||||||
|
"options" : compile_options(filename),
|
||||||
|
"function" : function_name,
|
||||||
|
"arguments" : function_args};
|
||||||
|
|
||||||
|
let response = await net.post_json_response(EPT_EncodeCalldata, send_obj);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
export {
|
||||||
|
CompileContract,
|
||||||
|
EncodeCalldata
|
||||||
|
}
|
||||||
@@ -0,0 +1,272 @@
|
|||||||
|
/********************************************************************
|
||||||
|
** Node API: functions for talking to an Aeternity node
|
||||||
|
**
|
||||||
|
** In the future, everything that this module does will be replaced
|
||||||
|
** by the backend.
|
||||||
|
**
|
||||||
|
** Functions should be sorted in alphabetical order.
|
||||||
|
**
|
||||||
|
** Names are what they are in the documentation
|
||||||
|
**
|
||||||
|
** Useful links:
|
||||||
|
**
|
||||||
|
** - HTML API docs : https://api-docs.aeternity.io/
|
||||||
|
** - YAML API docs : https://github.com/aeternity/aeternity/blob/master/apps/aehttp/priv/swagger.yaml
|
||||||
|
**
|
||||||
|
********************************************************************/
|
||||||
|
|
||||||
|
|
||||||
|
import * as net from './net.js'
|
||||||
|
import * as ae_compiler from './ae_compiler.js'
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// CONSTANTS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
export const MIN_FEE = 16660000000000;
|
||||||
|
export const MIN_CONTRACT_FEE = 79080000000000;
|
||||||
|
export const MIN_GAS_PRICE = 1000000000;
|
||||||
|
export const URL_MAINNET = "https://mainnet.aeternity.io/v2";
|
||||||
|
export const URL_TESTNET = "https://testnet.aeternity.io/v2";
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// CANONICAL TYPES ("MODELS") FROM THE DOCUMENTATION
|
||||||
|
//
|
||||||
|
// All of these names are as given in the documentation except `Error`
|
||||||
|
// (which is a reserve term in JS), renamed to `ErrorReason`
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// Error
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/definitions/Error
|
||||||
|
// Docs: https://github.com/aeternity/aeternity/blob/v6.4.0/apps/aehttp/priv/swagger.yaml#L3168-L3172
|
||||||
|
type ErrorReason = {reason: string};
|
||||||
|
|
||||||
|
type Tx = {tx: string};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// FUNCTIONS
|
||||||
|
//
|
||||||
|
// The names here follow their names in the documentation
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// GetAccountNextNonce: /accounts/{pubkey}/next-nonce
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/account/GetAccountNextNonce
|
||||||
|
//
|
||||||
|
// > Get an account's next nonce; This is computed according to
|
||||||
|
// > whatever is the current account nonce and what transactions are
|
||||||
|
// > currently present in the transaction pool
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
type GetAccountNextNonce_params = {pubkey : string,
|
||||||
|
strategy? : "max" | "continuity"};
|
||||||
|
|
||||||
|
type GetAccountNextNonce_ret = {next_nonce: string};
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
GetAccountNextNonce(endpoint_url : string,
|
||||||
|
params : GetAccountNextNonce_params)
|
||||||
|
: Promise< GetAccountNextNonce_ret
|
||||||
|
| ErrorReason>
|
||||||
|
{
|
||||||
|
let pubkey = params.pubkey;
|
||||||
|
let url = `${endpoint_url}/accounts/${pubkey}/next-nonce`;
|
||||||
|
|
||||||
|
// if the "strategy" field is present, add it as a ?strategy=x
|
||||||
|
// option
|
||||||
|
//
|
||||||
|
// note if the field is absent from `params`, then
|
||||||
|
// `params.strategy` will be `undefined`, which in js whacko
|
||||||
|
// world is "falsy"
|
||||||
|
let strategy = params.strategy;
|
||||||
|
if (strategy)
|
||||||
|
{
|
||||||
|
let addon = `?strategy=${strategy}`;
|
||||||
|
url += addon;
|
||||||
|
}
|
||||||
|
|
||||||
|
// irrespective of the response code, this is what we return
|
||||||
|
// so branching is gay
|
||||||
|
let ret = await net.get_json(url);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// PostContractCreate
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/contract/PostContractCreate
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// > Get a contract_create transaction object
|
||||||
|
|
||||||
|
|
||||||
|
type ContractCreateTx = {owner_id : string,
|
||||||
|
nonce? : number,
|
||||||
|
code : string,
|
||||||
|
vm_version : number,
|
||||||
|
abi_version : number,
|
||||||
|
deposit : number,
|
||||||
|
amount : number,
|
||||||
|
gas : number,
|
||||||
|
gas_price : number,
|
||||||
|
fee : number,
|
||||||
|
ttl? : number,
|
||||||
|
call_data : string};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
PostContractCreate(endpoint_url : string,
|
||||||
|
body_obj : ContractCreateTx)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
// console.log('body_obj', body_obj);
|
||||||
|
let url = `${endpoint_url}/debug/contracts/create`;
|
||||||
|
let ret = await net.post_json_response(url, body_obj);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
create_contract(whoami : string,
|
||||||
|
code : string,
|
||||||
|
filename : string,
|
||||||
|
init_args : Array<string>)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let code_resp = await ae_compiler.CompileContract(code, filename);
|
||||||
|
let code_json = await code_resp.json();
|
||||||
|
let bytecode = code_json.bytecode;
|
||||||
|
|
||||||
|
let calldata_resp = await ae_compiler.EncodeCalldata(code, filename, "init", init_args);
|
||||||
|
// assert(calldata_resp.ok);
|
||||||
|
let calldata_json = await calldata_resp.json();
|
||||||
|
let calldata = calldata_json.calldata;
|
||||||
|
|
||||||
|
let cctx: ContractCreateTx =
|
||||||
|
{owner_id : whoami,
|
||||||
|
code : bytecode,
|
||||||
|
vm_version : 7,
|
||||||
|
abi_version : 3,
|
||||||
|
deposit : 0,
|
||||||
|
amount : 0,
|
||||||
|
gas : 25000,
|
||||||
|
gas_price : 1*MIN_GAS_PRICE,
|
||||||
|
fee : 1*MIN_CONTRACT_FEE,
|
||||||
|
call_data : calldata};
|
||||||
|
|
||||||
|
let ret = await PostContractCreate(URL_TESTNET, cctx);
|
||||||
|
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// PostSpend: /debug/transactions/spend
|
||||||
|
//
|
||||||
|
// Docs:
|
||||||
|
// - Input type : https://api-docs.aeternity.io/#/definitions/SpendTx
|
||||||
|
// - Return type : https://api-docs.aeternity.io/#/definitions/Tx
|
||||||
|
// - Function : https://api-docs.aeternity.io/#/transaction/PostSpend
|
||||||
|
//
|
||||||
|
// > Get a spend transaction object
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// SpendTx
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/definitions/SpendTx
|
||||||
|
// Docs: https://github.com/aeternity/aeternity/blob/v6.4.0/apps/aehttp/priv/swagger.yaml#L2187-L2209
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
type SpendTx =
|
||||||
|
{recipient_id : string,
|
||||||
|
amount : number,
|
||||||
|
fee : number,
|
||||||
|
ttl? : number,
|
||||||
|
sender_id : string,
|
||||||
|
nonce? : number,
|
||||||
|
payload : string};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
PostSpend(endpoint_url : string,
|
||||||
|
body_obj : SpendTx)
|
||||||
|
: Promise<Tx | ErrorReason>
|
||||||
|
{
|
||||||
|
let url = `${endpoint_url}/debug/transactions/spend`;
|
||||||
|
let ret = await net.post_json(url, body_obj);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// PostTransaction
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/contract/PostTransaction
|
||||||
|
//
|
||||||
|
// > Post a new transaction
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
async function
|
||||||
|
PostTransaction(endpoint_url : string,
|
||||||
|
body_obj : Tx)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
// console.log('body_obj', body_obj);
|
||||||
|
let url = `${endpoint_url}/transactions`;
|
||||||
|
let ret = await net.post_json_response(url, body_obj);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// GetTransactionInfoByHash
|
||||||
|
//
|
||||||
|
// Docs: https://api-docs.aeternity.io/#/contract/GetTransactionInfoByHash
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
async function
|
||||||
|
GetTransactionInfoByHash(endpoint_url : string,
|
||||||
|
hash : string)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
// console.log('body_obj', body_obj);
|
||||||
|
let url = `${endpoint_url}/transactions/${hash}/info`;
|
||||||
|
let ret = await net.get_json_response(url);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// EXPORTS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// type exports
|
||||||
|
export type {
|
||||||
|
ErrorReason,
|
||||||
|
Tx,
|
||||||
|
SpendTx,
|
||||||
|
ContractCreateTx
|
||||||
|
};
|
||||||
|
|
||||||
|
export {
|
||||||
|
GetAccountNextNonce,
|
||||||
|
PostContractCreate,
|
||||||
|
create_contract,
|
||||||
|
PostSpend,
|
||||||
|
PostTransaction
|
||||||
|
};
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
//-------------------------------------------------------------------
|
||||||
|
// Common networking functions
|
||||||
|
//
|
||||||
|
// Mozilla fetch docs : https://developer.mozilla.org/en-US/docs/Web/API/fetch
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/* pf = pretty format
|
||||||
|
*/
|
||||||
|
function pf(x : any) : string
|
||||||
|
{
|
||||||
|
return JSON.stringify(x, undefined, 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// FUNCTIONS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
|
||||||
|
// GET request with return type of JSON
|
||||||
|
async function
|
||||||
|
get_json(url: string)
|
||||||
|
: Promise<any>
|
||||||
|
{
|
||||||
|
let response = await fetch(url);
|
||||||
|
let ret = await response.json();
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// GET request with return type of JSON
|
||||||
|
async function
|
||||||
|
get_json_response(url: string)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let response = await fetch(url);
|
||||||
|
//let ret = await response.json();
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// POST request with content type of json and return type of JSON
|
||||||
|
async function
|
||||||
|
post_json(url : string,
|
||||||
|
body_obj : any)
|
||||||
|
: Promise<any>
|
||||||
|
{
|
||||||
|
let body_str = pf(body_obj);
|
||||||
|
let req_opts = {method : 'POST',
|
||||||
|
body : body_str,
|
||||||
|
headers : {"Content-Type": "application/json"}};
|
||||||
|
let response = await fetch(url, req_opts);
|
||||||
|
let ret = await response.json();
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async function
|
||||||
|
post_json_response(url : string,
|
||||||
|
body_obj : any)
|
||||||
|
: Promise<Response>
|
||||||
|
{
|
||||||
|
let body_str = pf(body_obj);
|
||||||
|
let req_opts = {method : 'POST',
|
||||||
|
body : body_str,
|
||||||
|
headers : {"Content-Type": "application/json"}};
|
||||||
|
let response = await fetch(url, req_opts);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
// EXPORTS
|
||||||
|
//-------------------------------------------------------------------
|
||||||
|
export {
|
||||||
|
get_json,
|
||||||
|
get_json_response,
|
||||||
|
post_json,
|
||||||
|
post_json_response
|
||||||
|
}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
@@ -0,0 +1,23 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="./style.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="/">Home</a>
|
||||||
|
<ul><li><b>Examples</b></li></ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h1>Sidekick Examples</h1>
|
||||||
|
<ol>
|
||||||
|
<li><a href="./examples_html/hello.html">Hello world</a></li>
|
||||||
|
<li><a href="./examples_html/do_a_transfer.html">Do a transfer</a></li>
|
||||||
|
<li><a href="./examples_html/ide.html">Sophia IDE</a></li>
|
||||||
|
<li><a href="./examples_html/maerket.html">(NYI) Maerket</a></li>
|
||||||
|
</ol>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
body
|
||||||
|
{
|
||||||
|
background-color: #ffd;
|
||||||
|
color: #222;
|
||||||
|
}
|
||||||
|
|
||||||
|
.disabled
|
||||||
|
{
|
||||||
|
background-color: #444;
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
|
||||||
|
.current
|
||||||
|
{
|
||||||
|
background-color: #fff;
|
||||||
|
color: #000;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.done
|
||||||
|
{
|
||||||
|
background-color: #9f9;
|
||||||
|
color: #222;
|
||||||
|
}
|
||||||
|
|
||||||
|
#step2-recip
|
||||||
|
{
|
||||||
|
width: 450px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#step2-amt
|
||||||
|
{
|
||||||
|
width: 50px;
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
{"compilerOptions" : {"target" : "es2022",
|
||||||
|
"strict" : true,
|
||||||
|
"esModuleInterop" : true,
|
||||||
|
"skipLibCheck" : true,
|
||||||
|
"forceConsistentCasingInFileNames" : true,
|
||||||
|
"noImplicitAny" : true,
|
||||||
|
"strictNullChecks" : true,
|
||||||
|
"strictPropertyInitialization" : true,
|
||||||
|
"sourceMap" : true,
|
||||||
|
"outDir" : "examples_dist_js"},
|
||||||
|
"$schema" : "https://json.schemastore.org/tsconfig",
|
||||||
|
"display" : "Recommended",
|
||||||
|
"include" : ["examples_src_ts/**/*"]}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Why?</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Because you touch yourself at night</h1>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,219 @@
|
|||||||
|
|
||||||
|
|
||||||
|
//------------------------------------------------------------------------------
|
||||||
|
// LOGGERS
|
||||||
|
//------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Standard logging interface
|
||||||
|
*/
|
||||||
|
interface Logger
|
||||||
|
{
|
||||||
|
debug : (message: string, misc: any) => Promise<void>;
|
||||||
|
info : (message: string, misc: any) => Promise<void>;
|
||||||
|
warning : (message: string, misc: any) => Promise<void>;
|
||||||
|
error : (message: string, misc: any) => Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logger that logs sequentially to a bunch of other loggers
|
||||||
|
*/
|
||||||
|
class Loggers implements Logger
|
||||||
|
{
|
||||||
|
loggers : Array<Logger> = [];
|
||||||
|
|
||||||
|
async debug
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let fun =
|
||||||
|
function (logger)
|
||||||
|
{
|
||||||
|
logger.debug(msg, misc);
|
||||||
|
};
|
||||||
|
this.loggers.foreach(fun);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async info
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let fun =
|
||||||
|
function (logger)
|
||||||
|
{
|
||||||
|
logger.info(msg, misc);
|
||||||
|
};
|
||||||
|
this.loggers.foreach(fun);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async warning
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let fun =
|
||||||
|
function (logger)
|
||||||
|
{
|
||||||
|
logger.warning(msg, misc);
|
||||||
|
};
|
||||||
|
this.loggers.foreach(fun);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async error
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let fun =
|
||||||
|
function (logger)
|
||||||
|
{
|
||||||
|
logger.error(msg, misc);
|
||||||
|
};
|
||||||
|
this.loggers.foreach(fun);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logs all window messages to the console
|
||||||
|
*/
|
||||||
|
class ConsoleLogger implements Logger
|
||||||
|
{
|
||||||
|
listener : ((e: Event) => void);
|
||||||
|
|
||||||
|
constructor
|
||||||
|
()
|
||||||
|
{
|
||||||
|
// js pointer hack
|
||||||
|
const this_ptr = this;
|
||||||
|
this.listener =
|
||||||
|
function (event : Event)
|
||||||
|
{
|
||||||
|
this_ptr.handle(event);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
listen
|
||||||
|
(tgt : EventTarget)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
tgt.addEventListener('message', this.listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
ignore
|
||||||
|
(tgt : EventTarget)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
tgt.removeEventListener('message', this.listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
handle
|
||||||
|
(evt : MessageEvent<any>)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
this.info("handling event", evt);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async debug
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
console.debug(msg, misc);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async info
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
console.info(msg, misc);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async warning
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
console.warn(msg, misc);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async error
|
||||||
|
(msg : string,
|
||||||
|
misc : any)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
console.error(msg, misc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* You provide a function that converts any `MessageEvent` to an HTTP request,
|
||||||
|
* and this fires the request each time any such event occurs
|
||||||
|
*/
|
||||||
|
class HttpLogger
|
||||||
|
{
|
||||||
|
listener : ((e : Event) => Promise<void>);
|
||||||
|
transformer : ((e : MessageEvent<any>) => Request)
|
||||||
|
|
||||||
|
constructor
|
||||||
|
(transformer : (e : MessageEvent<any>) => Request)
|
||||||
|
{
|
||||||
|
this.transformer = transformer;
|
||||||
|
|
||||||
|
// js pointer hack
|
||||||
|
const this_ptr = this;
|
||||||
|
this.listener =
|
||||||
|
async function (event : Event)
|
||||||
|
{
|
||||||
|
// @ts-ignore typescript can't figure out that this is guaranteed to be a MessageEvent
|
||||||
|
this_ptr.handle(event);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
listen
|
||||||
|
(tgt : EventTarget)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
// @ts-ignore beta type inference
|
||||||
|
tgt.addEventListener('message', this.listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
ignore
|
||||||
|
(tgt : EventTarget)
|
||||||
|
: void
|
||||||
|
{
|
||||||
|
// @ts-ignore beta type inference
|
||||||
|
tgt.removeEventListener('message', this.listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async handle
|
||||||
|
(evt : MessageEvent<any>)
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
let req = this.transformer(evt);
|
||||||
|
fetch(req);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
# fulldist is the kitchen sink:
|
||||||
|
# - builds (& typechecks) the library
|
||||||
|
# - makes a distribution tarball
|
||||||
|
# - builds (& typechecks) the examples
|
||||||
|
# - builds the documentation
|
||||||
|
# - puts it all in a nice tree
|
||||||
|
all: build_fulldist
|
||||||
|
|
||||||
|
build_sidekick:
|
||||||
|
tsc
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -r dist_js || return 0
|
||||||
|
rm -r sidekick_mindist || return 0
|
||||||
|
rm -r docs || return 0
|
||||||
|
rm -r examples/examples_dist_js || return 0
|
||||||
|
rm -r sidekick_fulldist || return 0
|
||||||
|
|
||||||
|
build_mindist: build_sidekick
|
||||||
|
mkdir -p sidekick_mindist
|
||||||
|
cp README.md sidekick_mindist
|
||||||
|
cp LICENSE.txt sidekick_mindist
|
||||||
|
cp -r src sidekick_mindist
|
||||||
|
cp -r dist sidekick_mindist
|
||||||
|
|
||||||
|
build_docs:
|
||||||
|
npx typedoc --out docs \
|
||||||
|
--entryPointStrategy expand \
|
||||||
|
--name Sidekick \
|
||||||
|
src
|
||||||
|
|
||||||
|
|
||||||
|
serve_docs:
|
||||||
|
cd docs && python3 -m http.server 8002
|
||||||
|
|
||||||
|
build_examples: build_mindist
|
||||||
|
rm examples/sidekick_mindist || return 0
|
||||||
|
cd examples && ln -s ../sidekick_mindist sidekick_mindist
|
||||||
|
cd examples && tsc
|
||||||
|
|
||||||
|
serve_examples:
|
||||||
|
cd examples && python3 -m http.server 8001
|
||||||
|
|
||||||
|
build_everything: build_sidekick build_mindist build_examples build_docs
|
||||||
|
|
||||||
|
build_fulldist: build_everything
|
||||||
|
mkdir sidekick_fulldist
|
||||||
|
cp -r sidekick_mindist sidekick_fulldist
|
||||||
|
cp -r docs sidekick_fulldist
|
||||||
|
cp -r examples sidekick_fulldist
|
||||||
@@ -0,0 +1,490 @@
|
|||||||
|
# Sidekick
|
||||||
|
|
||||||
|
Sidekick is a simple JavaScript library for talking to an Aeternity
|
||||||
|
browser wallet extension such as Superhero from the document context
|
||||||
|
of a webpage.
|
||||||
|
|
||||||
|
| **Thing** | **URL** |
|
||||||
|
| --- | --- |
|
||||||
|
| Bug Tracker | https://gitlab.com/DoctorAjayKumar/sidekick/-/issues |
|
||||||
|
| Documentation | http://orangepill.healthcare/projects/sidekick/current/docs |
|
||||||
|
| Examples | https://gitlab.com/DoctorAjayKumar/sidekick/-/tree/master/examples |
|
||||||
|
| Git repository | https://gitlab.com/DoctorAjayKumar/sidekick |
|
||||||
|
| Homepage | http://orangepill.healthcare/projects/sidekick |
|
||||||
|
| License | ./LICENSE.txt |
|
||||||
|
| Maintainer | Dr. Ajay Kumar PHD <DoctorAjayKumar@protonmail.com> |
|
||||||
|
| Releases | http://orangepill.healthcare/projects/sidekick/releases |
|
||||||
|
|
||||||
|
|
||||||
|
> One of the most important things for designing a computer, which I
|
||||||
|
> think most designers don't do, is you study the problem you want to
|
||||||
|
> solve. And then use what you learn from studying the problem you
|
||||||
|
> want to solve to put in the mechanisms needed to solve it in the
|
||||||
|
> computer you're building. No more, no less.
|
||||||
|
|
||||||
|
— Gerald Jay Sussman
|
||||||
|
|
||||||
|
### What sidekick is NOT
|
||||||
|
|
||||||
|
Sidekick is **not** ideal if you operate in the Node/NPM ecosystem. If you are
|
||||||
|
working in the Node/NPM ecosystem, you probably want the [Aeternity JavaScript
|
||||||
|
SDK](https://github.com/aeternity/aepp-sdk-js/). Every single
|
||||||
|
Aeternity-related thing you could ever possibly want to do is possible to
|
||||||
|
accomplish with the SDK.
|
||||||
|
|
||||||
|
All that Sidekick knows how to do is talk to a browser wallet extension. In an
|
||||||
|
application, there is a great deal of necessary functionality (e.g. forming
|
||||||
|
transactions for the wallet to sign) which sidekick assumes your server-side
|
||||||
|
code has already handled.
|
||||||
|
|
||||||
|
In all software there is a tradeoff between simplicity and number of features.
|
||||||
|
Sidekick is very simple: 2300 lines of TypeScript, including comments, with no
|
||||||
|
dependencies. Therefore Sidekick intentionally only has a very limited set of
|
||||||
|
features.
|
||||||
|
|
||||||
|
|
||||||
|
# How to use this library
|
||||||
|
|
||||||
|
To obtain this library, download and unpack a release tarball
|
||||||
|
|
||||||
|
wget http://zxq9.com/projects/vanillae/sidekick/releases/sidekick_dist_X-Y-Z.tar.gz
|
||||||
|
tar xzvf sidekick_dist_X-Y-Z.tar.gz
|
||||||
|
|
||||||
|
You *should* be able to get all of the functionality you need just
|
||||||
|
from the exposed functions in the `sidekick` module. (If this is not
|
||||||
|
the case, please report this as a bug.)
|
||||||
|
|
||||||
|
You probably want to read the documentation of:
|
||||||
|
|
||||||
|
sidekick.js : top-level function calls
|
||||||
|
awcp/awcp.js : explains the return types of top-level sidekick
|
||||||
|
functions, explains what sidekick actually does
|
||||||
|
for you, and explains how all the various
|
||||||
|
modules fit together
|
||||||
|
skylight.js : main data structure in sidekick
|
||||||
|
helpers.js : what it sounds like
|
||||||
|
|
||||||
|
There are examples explained in this document. Their source can be
|
||||||
|
found in full in the GitLab repository, link above. The examples
|
||||||
|
exhibit how to interact with the standard release tarball using
|
||||||
|
TypeScript.
|
||||||
|
|
||||||
|
|
||||||
|
## General flow of Sidekick usage
|
||||||
|
|
||||||
|
1. Import the sidekick.js file:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as sk from '/path/to/sidekick_dist_X-Y-Z/dist_js/sidekick.js'
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a `Skylight`. This is the main data structure of Sidekick.
|
||||||
|
|
||||||
|
There are two ways to do this
|
||||||
|
|
||||||
|
1. `start_dwim() : Promise<Skylight>`
|
||||||
|
|
||||||
|
This is probably the one you want. It starts up the Skylight
|
||||||
|
and does the handshake with the wallet (will pop up the
|
||||||
|
little window for your user). The effect of this is to
|
||||||
|
populate all the variables like the user's public key.
|
||||||
|
|
||||||
|
Note that this is an async function. It doesn't return until
|
||||||
|
the handshake is complete.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Needs to be wrapped in an async function in order to use
|
||||||
|
// await keyword
|
||||||
|
async function main() : Promise<void> {
|
||||||
|
let my_skylight = await sk.start_dwim();
|
||||||
|
...
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
|
```
|
||||||
|
|
||||||
|
2. `start : Skylight`
|
||||||
|
|
||||||
|
This is the vanilla option. All it does is create the
|
||||||
|
Skylight object.
|
||||||
|
|
||||||
|
Beware that this does start up a message queue that passively
|
||||||
|
listens for messages from the wallet.
|
||||||
|
|
||||||
|
|
||||||
|
3. Pass the skylight in to various functions along with additional
|
||||||
|
calldata generated by your server-side backend code.
|
||||||
|
|
||||||
|
|
||||||
|
## Example 1: Hello World
|
||||||
|
|
||||||
|
The effect of this example is to print "hello world" to the JS
|
||||||
|
console (Ctrl+Shift+C in most browsers). This example is included for
|
||||||
|
debugging/mental-quicksand-escape purposes.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Hello world: Sidekick</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Sidekick Example: Hello World</h1>
|
||||||
|
|
||||||
|
<h4>Check the console</h4>
|
||||||
|
<script type="module">
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
sk.hello();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
The important lines are
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script type="module">
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
sk.hello();
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
This shows
|
||||||
|
|
||||||
|
- you need to use `type="module"` in order for imports to work
|
||||||
|
- how to do an import
|
||||||
|
- how to call functions from an imported module
|
||||||
|
|
||||||
|
|
||||||
|
## Example 2: get the user to sign a transaction
|
||||||
|
|
||||||
|
Anything you will want the user to do (e.g. sign smart contracts) is
|
||||||
|
contained in "get the user to sign a transaction". This example
|
||||||
|
illustrates the basic things you need to do in order to accomplish
|
||||||
|
that.
|
||||||
|
|
||||||
|
Sidekick does not provide functionality for forming the transaction
|
||||||
|
string you want the user to sign. Your backend should be doing that.
|
||||||
|
|
||||||
|
The example here uses a shim library called `parasite`, which you can find in
|
||||||
|
the GitLab repository in the `examples` directory. Parasite is just a rewrite
|
||||||
|
layer in front of the `testnet.aeternity.io` JSON interface. It is not suitable
|
||||||
|
for usage in production.
|
||||||
|
|
||||||
|
This is adapted from
|
||||||
|
[`examples/examples_src_ts/do_a_transfer.ts`][dat_ts]. The
|
||||||
|
difference is that `do_a_transfer.ts` is written against
|
||||||
|
[`examples/examples_html/do_a_transfer.html`][dat_html]. It contains
|
||||||
|
a lot of unnecessary detail, like doing things in response to buttons
|
||||||
|
being clicked, and filling in DOM textboxes with the results of things.
|
||||||
|
|
||||||
|
The full example has logic that resembles a register machine, rather
|
||||||
|
than a functional program. This example is closer to a functional
|
||||||
|
program.
|
||||||
|
|
||||||
|
[dat_html]: https://gitlab.com/DoctorAjayKumar/sidekick/-/blob/master/examples/examples_html/do_a_transfer.html
|
||||||
|
[dat_ts]: https://gitlab.com/DoctorAjayKumar/sidekick/-/blob/master/examples/examples_src_ts/do_a_transfer.ts
|
||||||
|
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as ae_node from './parasite/ae_node.js';
|
||||||
|
import * as sk from '../sidekick_dist/dist_js/sidekick.js';
|
||||||
|
|
||||||
|
async function
|
||||||
|
main()
|
||||||
|
: Promise<void>
|
||||||
|
{
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 1: MAKE A SKYLIGHT
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
let skl : sk.Skylight =
|
||||||
|
await sk.start_dwim(sk.TIMEOUT_DEF_DETECT,
|
||||||
|
sk.TIMEOUT_DEF_CONNECT,
|
||||||
|
sk.TIMEOUT_DEF_ADDRESS);
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 2: GET THE USER'S ADDRESS
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
let user_addr : string =
|
||||||
|
await sk.address(skl, sk.TIMEOUT_DEF_ADDRESS);
|
||||||
|
|
||||||
|
// faster/non-async:
|
||||||
|
//
|
||||||
|
// let user_addr = skl.waellet_address
|
||||||
|
//
|
||||||
|
// the non-commented code
|
||||||
|
//
|
||||||
|
// - will crash if the wallet isn't connected
|
||||||
|
// - will query the wallet for the address if the wallet *is*
|
||||||
|
// connected but the skl.waellet_address field *is not*
|
||||||
|
// populated
|
||||||
|
// - will crash if that times out after the second argument
|
||||||
|
// number of milliseconds
|
||||||
|
//
|
||||||
|
// if you know with 100% certainty that the address field will be
|
||||||
|
// populated (which we do here, because we used connect_dwim),
|
||||||
|
// then it's safe to just grab the field from the skylight
|
||||||
|
//
|
||||||
|
// The problem is that if the address field isn't populated, the
|
||||||
|
// commented code defaults to `undefined`, rather than crashing
|
||||||
|
// with an error message and callstack trace
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 3: FORM THE TRANSACTION
|
||||||
|
//
|
||||||
|
// This will be different for your application, because you're
|
||||||
|
// not using parasite (right?)
|
||||||
|
//
|
||||||
|
// You need to figure out how to make something like `tx_obj` on
|
||||||
|
// your own.
|
||||||
|
//
|
||||||
|
// `tx_obj` is just `{tx: "some_base58_garbage"}`.
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
|
||||||
|
let target_addr : string =
|
||||||
|
'ak_dvNHMgVvdSgDchLsmcUpuFTbMBGfG3E5V9KZnNjLYPyEhcqnL';
|
||||||
|
|
||||||
|
// amount is in aettos
|
||||||
|
let amount : number = 1;
|
||||||
|
let endpoint : string = ae_node.URL_TESTNET;
|
||||||
|
let spendtx = {'recipient_id' : target_addr,
|
||||||
|
'amount' : amount,
|
||||||
|
'fee' : ae_node.MIN_FEE,
|
||||||
|
'sender_id' : user_addr,
|
||||||
|
'payload' : ""};
|
||||||
|
let tx_obj = await ae_node.PostSpend(endpoint, spendtx);
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
// STEP 4: HAVE THE USER SIGN THE TRANSACTION
|
||||||
|
//
|
||||||
|
// There are two options:
|
||||||
|
//
|
||||||
|
// 1. `tx_sign_no_propagate` simply has the wallet sign the
|
||||||
|
// transaction, and return the signed transaction back to you
|
||||||
|
//
|
||||||
|
// 2. `tx_sign_yes_propagate` has the wallet sign the transaction
|
||||||
|
// and also propagates it into the network. It returns a more
|
||||||
|
// elaborate data structure, which is documented in somewhere
|
||||||
|
// the AWCP module documentation.
|
||||||
|
//---------------------------------------------------------------
|
||||||
|
|
||||||
|
let result =
|
||||||
|
await sk.tx_sign_no_propagate(skl,
|
||||||
|
tx_obj,
|
||||||
|
sk.NETWORK_ID_TESTNET,
|
||||||
|
sk.TIMEOUT_DEF_SIGN);
|
||||||
|
|
||||||
|
console.log(result);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# Known pitfalls
|
||||||
|
|
||||||
|
- See notes in sidekick module about potential state crossups if your
|
||||||
|
document logic is multi-threaded.
|
||||||
|
|
||||||
|
- Has only been tested against Firefox-on-Linux
|
||||||
|
|
||||||
|
- Have not worked out good user idioms for handling errors
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# How the release is structured and why
|
||||||
|
|
||||||
|
The idea of the release is that it contains exactly what is needed in
|
||||||
|
order to drop Sidekick into your project and start using it. No more,
|
||||||
|
no less.
|
||||||
|
|
||||||
|
A release has the following structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
sidekick_dist_X-Y-Z/
|
||||||
|
dist_js/............tsc-generated human-readable JS tree
|
||||||
|
foo.js..............the actual code that is run
|
||||||
|
foo.d.ts............included so that your TypeScript code can
|
||||||
|
typecheck against sidekick
|
||||||
|
foo.js.map..........debug symbols that map foo.js to
|
||||||
|
locations in the TypeScript source
|
||||||
|
src_ts/.............included so that the browser's debugger works
|
||||||
|
foo.ts
|
||||||
|
README.txt
|
||||||
|
LICENSE.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
We use semantic versioning: `X.Y.Z`
|
||||||
|
|
||||||
|
- A change in `X` means an API-breaking change
|
||||||
|
- A change in `Y` means an non-breaking API change
|
||||||
|
- A change in `Z` means no change to the API
|
||||||
|
|
||||||
|
There is no documentation included in the release. There is
|
||||||
|
autogenerated API documentation linked above, which is generated from
|
||||||
|
this file and the sources that are included in the release.
|
||||||
|
|
||||||
|
|
||||||
|
## What each file does
|
||||||
|
|
||||||
|
```
|
||||||
|
src_ts/.....................TypeScript source for sidekick library
|
||||||
|
awcp/.......................Aepp-Waellet Communication Protocol
|
||||||
|
awcp.ts.....................Protocol definition
|
||||||
|
msgq.ts.....................Block-on-raseev implementation
|
||||||
|
msgr.ts.....................Protocol implementation
|
||||||
|
helpers.ts..................what it sounds like
|
||||||
|
sidekick.ts.................top-level module
|
||||||
|
skylight.ts.................primary data structure
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Where is the NPM package or the webpack bundle?
|
||||||
|
|
||||||
|
There isn't one.
|
||||||
|
|
||||||
|
|
||||||
|
### Why?
|
||||||
|
|
||||||
|
Sidekick is a library that deals with cryptocurrency. The security
|
||||||
|
model is based on transparency and trust. A user must be able to
|
||||||
|
inspect code that is running on his hardware handling his money.
|
||||||
|
|
||||||
|
We don't support NPM because of the security issues that NPM
|
||||||
|
introduces. Briefly, the code can change at any time under the
|
||||||
|
developer's nose without the developer knowing. The [leftpad
|
||||||
|
debacle][lpad] and the [RIAEvangelist debacle][ria] are good examples
|
||||||
|
of the types of vulnerabilities that package managers like NPM
|
||||||
|
enable.
|
||||||
|
|
||||||
|
[lpad]: https://archive.ph/Qsh7j
|
||||||
|
[ria]: https://archive.ph/OF5I9
|
||||||
|
|
||||||
|
We don't use something like webpack because that introduces an opaque
|
||||||
|
rewrite using an untrusted tool. Webpack could plausibly alter the
|
||||||
|
runtime behavior of the program, and we would have no way to detect
|
||||||
|
that. Even if we trusted webpack, how do we obtain webpack? NPM.
|
||||||
|
So.
|
||||||
|
|
||||||
|
It is debatable whether or not we should trust the TypeScript
|
||||||
|
compiler (TSC). On the whole, TSC probably makes Sidekick more
|
||||||
|
secure, simply by virtue of increasing overall code quality and
|
||||||
|
eliminating the largest categories of potential bugs. Moreover, the
|
||||||
|
output that TSC produces is human-readable, and has a very
|
||||||
|
straightforward mapping to the original source code. A human can
|
||||||
|
easily read the TSC-generated JavaScript tree, even without the aid
|
||||||
|
of the source map, and have a high degree of faith that the code is
|
||||||
|
trustworthy and that TSC is behaving as promised.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# How to obtain the source tree
|
||||||
|
|
||||||
|
The source tree is included in your release. You can clone the
|
||||||
|
git repository with
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://gitlab.com/DoctorAjayKumar/sidekick.git
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Repo file tree (non-exhaustive)
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
examples/...................Examples
|
||||||
|
contract-examples/..........Example Sophia smart contracts
|
||||||
|
examples_html/..............Low-budget example interfaces
|
||||||
|
do_a_transfer.html......Send money to an arbitrary address
|
||||||
|
hello.html..............Hello world
|
||||||
|
ide.html................Play around with smart contracts
|
||||||
|
examples_src_ts/............TypeScript source for each example
|
||||||
|
parasite/...................JavaScript shim that does what
|
||||||
|
your backend code ordinarily
|
||||||
|
would do
|
||||||
|
ae_compiler.ts..............Talk to a remote Sophia
|
||||||
|
compiler JSON HTTP interface
|
||||||
|
ae_node.ts..................Talk to a node (for forming
|
||||||
|
transactions, querying chain,
|
||||||
|
etc)
|
||||||
|
net.ts......................Network helper functions
|
||||||
|
do_a_transfer.ts........Send money to an arbitrary address
|
||||||
|
ide.ts..................Play around with smart contracts
|
||||||
|
tsconfig.json...............Examples-specific tsc configuration
|
||||||
|
src_ts/.....................TypeScript source for sidekick library
|
||||||
|
awcp/.......................Aepp-Waellet Communication Protocol
|
||||||
|
awcp.ts.....................Protocol definition
|
||||||
|
msgq.ts.....................Block-on-raseev implementation
|
||||||
|
msgr.ts.....................Protocol implementation
|
||||||
|
helpers.ts..................what it sounds like
|
||||||
|
sidekick.ts.................top-level module
|
||||||
|
skylight.ts.................primary data structure
|
||||||
|
LICENSE.txt.................MIT License
|
||||||
|
Makefile....................Makefile
|
||||||
|
make........................Equivalent to `make build`
|
||||||
|
make build..................Run tsc
|
||||||
|
make clean..................rm -r dist_js sidekick_dist docs \
|
||||||
|
examples/examples_dist_js
|
||||||
|
make dist...................Build a release tarball directory
|
||||||
|
make jsdoc..................Build the HTML documentation
|
||||||
|
make build_examples.........cd examples && tsc
|
||||||
|
make serve_examples.........cd examples && python3 -m \
|
||||||
|
http.server 8001
|
||||||
|
README.txt..................This file
|
||||||
|
STYLE_GUIDE.md..............Explains why the code looks so weird
|
||||||
|
TODO.md.....................what it sounds like
|
||||||
|
tsconfig.json...............Configuration file for tsc
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# How to build a release
|
||||||
|
|
||||||
|
You will need the TypeScript compiler installed. See prereqs section.
|
||||||
|
|
||||||
|
make dist
|
||||||
|
|
||||||
|
|
||||||
|
## Prereqs for building source files
|
||||||
|
|
||||||
|
If you want to edit and rebuild the source files, you need TypeScript
|
||||||
|
installed, and you should update npm.
|
||||||
|
|
||||||
|
npm install -g typescript
|
||||||
|
npm install -g npm
|
||||||
|
|
||||||
|
## Protip: avoid using `sudo npm install -g`
|
||||||
|
|
||||||
|
If you want to avoid using sudo
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir ~/.npm-packages
|
||||||
|
npm config set prefix "${HOME}/.npm-packages"
|
||||||
|
```
|
||||||
|
|
||||||
|
Edit `~/.bashrc` or `~/.zshrc` with
|
||||||
|
|
||||||
|
```
|
||||||
|
NPM_PACKAGES="${HOME}/.npm-packages"
|
||||||
|
export PATH=$NPM_PACKAGES/bin:$PATH
|
||||||
|
```
|
||||||
|
|
||||||
|
Source: https://github.com/sindresorhus/guides/blob/main/npm-global-without-sudo.md
|
||||||
|
|
||||||
|
|
||||||
|
# How to build and view documentation
|
||||||
|
|
||||||
|
```
|
||||||
|
make build_docs
|
||||||
|
make serve_docs
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,244 @@
|
|||||||
|
*
|
||||||
|
* As far as I can tell, AWCP isn't formally defined anywhere. I
|
||||||
|
* figured this out by fuzzing the messaging protocol. So I suppose
|
||||||
|
* this is a candidate for a formal definition.
|
||||||
|
*
|
||||||
|
* This currently does not implement the full kitchen sink
|
||||||
|
* functionality, only what is needed for the limited functionality that
|
||||||
|
* sidekick provides. That said, the framework and design pattern laid
|
||||||
|
* out here can easily be extended to implement the entire kitchen sink.
|
||||||
|
*
|
||||||
|
* The pattern here is to define all of the types involved. At the end,
|
||||||
|
* an interface called `AWCP_Aepp` is defined. This enumerates all of
|
||||||
|
* the functions that you an aepp needs to have defined in order to do
|
||||||
|
* stuff with a waellet.
|
||||||
|
*
|
||||||
|
* The functions are listed in the order that they are used in practice.
|
||||||
|
* So for instance,
|
||||||
|
*
|
||||||
|
* - before you can `connection.open` with the waellet, you must wait
|
||||||
|
* for the waellet to `connection.announcePresence`
|
||||||
|
* - before you can `address.subscribe` the waellet, you must wait
|
||||||
|
* for the waellet to `connection.open`
|
||||||
|
*
|
||||||
|
* An implementation of `AWCP_Aepp` is given in the `msgr.ts` file in
|
||||||
|
* this directory. In particular, msgr implements the "selective ignore"
|
||||||
|
* special behavior needed to deal with `connection.announcePresence`.
|
||||||
|
*
|
||||||
|
* `skylight.ts` (parent directory) includes some convenience functions
|
||||||
|
* wrapped on top of msgr. In particular, it black-boxes away things
|
||||||
|
* like "increment the message id each time you send a new message"
|
||||||
|
*
|
||||||
|
* Moreover, `skylight.ts` includes some subset of porcelain (dwim)
|
||||||
|
* functions like "just connect to the wallet, do what I mean", which
|
||||||
|
* does the "wait for `connection.announcePresence`, then do
|
||||||
|
* `connection.open`, then do `address.subscribe`" dance.
|
||||||
|
*
|
||||||
|
* Crucially, skylight only contains porcelain functions that are of the
|
||||||
|
* flavor of black-boxing away complexity related to talking to the
|
||||||
|
* waellet. For instance, Skylight will never directly communicate with
|
||||||
|
* a node.
|
||||||
|
*
|
||||||
|
* This "design pattern" of "define the types for a messaging protocol,
|
||||||
|
* and separately implement it, then black-box away the complexity in a
|
||||||
|
* porcelain module" will probably also be done for talking to a node
|
||||||
|
* and talking to a compiler.
|
||||||
|
*
|
||||||
|
* sidekick.ts (parent directory) includes programmer-facing porcelain
|
||||||
|
* functions such as "I just want to perform a transaction". In other
|
||||||
|
* words, sidekick.ts black-boxes away the complexity in coordinating
|
||||||
|
* between the compiler, the node, and the waellet.
|
||||||
|
* This is entirely types and type definitions
|
||||||
|
*
|
||||||
|
* See:
|
||||||
|
* - JSON RPC 2.0 definition: https://www.jsonrpc.org/specification
|
||||||
|
* - Typescript generics: https://www.typescriptlang.org/docs/handbook/2/generics.html
|
||||||
|
*
|
||||||
|
* @module
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
% Every operation, calculation, and concept, no matter how
|
||||||
|
% arbitrarily complex, reduces to adding integers together.
|
||||||
|
% There are no new concepts in QAnal. Everything is just
|
||||||
|
% putting lipstick on adding integers together.
|
||||||
|
%
|
||||||
|
% -- Dr. Ajay Kumar PHD, The Founder
|
||||||
|
%
|
||||||
|
% a word is the smallest unit in a reduced sum. In for instance
|
||||||
|
% 1 + a + ab, the words are 1, a, and ab, which are represented as
|
||||||
|
% the sets {}, {a}, and {a, b}, respectively.
|
||||||
|
%
|
||||||
|
% - a word is a tuple {w, SetOfWFChars}
|
||||||
|
% - the empty set means 1
|
||||||
|
%
|
||||||
|
% - a wfchar is a Binary
|
||||||
|
% - if you wish to use pf/1, the binary must be string-formattable
|
||||||
|
%
|
||||||
|
% in WF algebra, anything times itself equals itself, therefore we
|
||||||
|
% don't need to keep track of exponents. That is why the set
|
||||||
|
% representation makes sense.
|
||||||
|
%
|
||||||
|
% with a word, multiplication is implied
|
||||||
|
% with a sentence, summation is implied
|
||||||
|
-module(wfc_word).
|
||||||
|
-vsn("1.0.0").
|
||||||
|
|
||||||
|
-export_type([
|
||||||
|
wfchar/0,
|
||||||
|
word/0
|
||||||
|
]).
|
||||||
|
-export([
|
||||||
|
one/0,
|
||||||
|
is_one/1,
|
||||||
|
is_valid_word/1,
|
||||||
|
from_binary/1,
|
||||||
|
from_list/1,
|
||||||
|
to_list/1,
|
||||||
|
times/1,
|
||||||
|
times/2,
|
||||||
|
pf/1,
|
||||||
|
pp/1
|
||||||
|
]).
|
||||||
|
|
||||||
|
-type wfchar() :: binary().
|
||||||
|
-type word() :: {w, sets:set(wfchar())}.
|
||||||
|
|
||||||
|
|
||||||
|
%%% API
|
||||||
|
|
||||||
|
|
||||||
|
-spec one() -> word().
|
||||||
|
% @doc The word corresponding to the concept "1"; it is a tagged
|
||||||
|
% tuple of {w, EmptySet}.
|
||||||
|
|
||||||
|
one() ->
|
||||||
|
{w, sets:new()}.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec is_one(term()) -> boolean().
|
||||||
|
% @doc a word is one if it {w, EmptySet}.
|
||||||
|
|
||||||
|
is_one(Word) ->
|
||||||
|
Word =:= one().
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec is_valid_word(term()) -> boolean().
|
||||||
|
% @doc
|
||||||
|
% a word is valid if exactly one of these conditions are true:
|
||||||
|
%
|
||||||
|
% - is empty
|
||||||
|
% - contains only valid wfchars
|
||||||
|
%
|
||||||
|
% return false on anything failing to pattern match {w, Set}
|
||||||
|
|
||||||
|
is_valid_word({w, Set}) ->
|
||||||
|
Chars = sets:to_list(Set),
|
||||||
|
lists:all(fun is_valid_char/1, Chars);
|
||||||
|
is_valid_word(_) ->
|
||||||
|
false.
|
||||||
|
|
||||||
|
is_valid_char(X) ->
|
||||||
|
is_binary(X).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec from_binary(binary()) -> word().
|
||||||
|
% @doc
|
||||||
|
% Convert a binary into a word
|
||||||
|
|
||||||
|
from_binary(Bin) when is_binary(Bin) ->
|
||||||
|
Set = sets:from_list([Bin]),
|
||||||
|
Word = {w, Set},
|
||||||
|
true = is_valid_word(Word),
|
||||||
|
Word.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec from_list([binary()]) -> word().
|
||||||
|
% @doc
|
||||||
|
% Given a list of binaries, take their "product" and put it into a
|
||||||
|
% word.
|
||||||
|
|
||||||
|
from_list(Binaries) ->
|
||||||
|
Set = sets:from_list(Binaries),
|
||||||
|
ResultWord = {w, Set},
|
||||||
|
true = is_valid_word(ResultWord),
|
||||||
|
ResultWord.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec to_list(word()) -> [binary()].
|
||||||
|
% @doc
|
||||||
|
% pull out the set in the tagged tuple, convert it to a list, and
|
||||||
|
% return the SORTED list of BINARIES
|
||||||
|
% @end
|
||||||
|
|
||||||
|
to_list({w, Set}) ->
|
||||||
|
Chars = sets:to_list(Set),
|
||||||
|
lists:sort(Chars).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec times([word()]) -> word().
|
||||||
|
% @doc product of a list of words
|
||||||
|
|
||||||
|
times(Words) ->
|
||||||
|
Result = times_acc(Words, one()),
|
||||||
|
true = is_valid_word(Result),
|
||||||
|
Result.
|
||||||
|
|
||||||
|
|
||||||
|
times_acc([], FinalAcc) ->
|
||||||
|
FinalAcc;
|
||||||
|
times_acc([W | Ws], Acc) ->
|
||||||
|
NewAcc = times(W, Acc),
|
||||||
|
times_acc(Ws, NewAcc).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec times(word(), word()) -> word().
|
||||||
|
% @doc
|
||||||
|
% Multiply two words. This amounts to just taking the union of the
|
||||||
|
% characters contained in the words
|
||||||
|
% @end
|
||||||
|
|
||||||
|
times({w, L}, {w, R}) ->
|
||||||
|
% take the unions of the things it contains
|
||||||
|
LR = sets:union(L, R),
|
||||||
|
Word = {w, LR},
|
||||||
|
true = is_valid_word(Word),
|
||||||
|
Word.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec pp(word()) -> ok.
|
||||||
|
% @doc pretty print a word (wraps an io:format/2 call around pf/1).
|
||||||
|
|
||||||
|
pp(Word) ->
|
||||||
|
io:format("~ts~n", [pf(Word)]).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-spec pf(word()) -> iolist().
|
||||||
|
% @doc
|
||||||
|
% returns iolist
|
||||||
|
%
|
||||||
|
% "(*)" if word is 1
|
||||||
|
% "(* a b c)" if word is the set containing {a,b,c}
|
||||||
|
|
||||||
|
pf(Word) ->
|
||||||
|
true = is_valid_word(Word),
|
||||||
|
Chars = to_list(Word),
|
||||||
|
Strs = pf_wfchars(Chars, []),
|
||||||
|
["(*", Strs, ")"].
|
||||||
|
|
||||||
|
pf_wfchars([Binary | Rest], Accum) when is_binary(Binary) ->
|
||||||
|
BinStr = io_lib:format("~s", [Binary]),
|
||||||
|
NewAccum = [Accum, " ", BinStr],
|
||||||
|
pf_wfchars(Rest, NewAccum);
|
||||||
|
pf_wfchars([], Accum) ->
|
||||||
|
Accum.
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,16 @@
|
|||||||
|
{"compilerOptions" : {"target" : "es2022",
|
||||||
|
"strict" : true,
|
||||||
|
"esModuleInterop" : true,
|
||||||
|
"skipLibCheck" : true,
|
||||||
|
"forceConsistentCasingInFileNames" : true,
|
||||||
|
"noImplicitAny" : true,
|
||||||
|
"strictNullChecks" : true,
|
||||||
|
"strictPropertyInitialization" : true,
|
||||||
|
"sourceMap" : true,
|
||||||
|
"outDir" : "dist",
|
||||||
|
"declaration" : true},
|
||||||
|
"$schema" : "https://json.schemastore.org/tsconfig",
|
||||||
|
"display" : "Recommended",
|
||||||
|
"include" : ["src/**/*"],
|
||||||
|
"exclude" : ["src/jex_include"],
|
||||||
|
"composite" : true}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
.eunit
|
||||||
|
deps
|
||||||
|
*.o
|
||||||
|
*.beam
|
||||||
|
*.plt
|
||||||
|
*.swp
|
||||||
|
erl_crash.dump
|
||||||
|
ebin/*.beam
|
||||||
|
doc/*.html
|
||||||
|
doc/*.css
|
||||||
|
doc/edoc-info
|
||||||
|
doc/erlang.png
|
||||||
|
rel/example_project
|
||||||
|
.concrete/DEV_MODE
|
||||||
|
.rebar
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{"src/*", [debug_info, {i, "include/"}, {outdir, "ebin/"}]}.
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Peter Harpending
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||||
|
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||||
|
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||||
|
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||||
|
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||||
|
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||||
|
PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
{application,jex,
|
||||||
|
[{description,"jex"},
|
||||||
|
{registered,[]},
|
||||||
|
{included_applications,[]},
|
||||||
|
{applications,[stdlib,kernel]},
|
||||||
|
{vsn,"0.1.0"},
|
||||||
|
{modules,[jex]}]}.
|
||||||
@@ -0,0 +1,356 @@
|
|||||||
|
%%% @doc
|
||||||
|
%%% jex: jex
|
||||||
|
%%%
|
||||||
|
%%% This module is currently named `jex', but you may want to change that.
|
||||||
|
%%% Remember that changing the name in `-module()' below requires renaming
|
||||||
|
%%% this file, and it is recommended to run `zx update .app` in the main
|
||||||
|
%%% project directory to make sure the ebin/jex.app file stays in
|
||||||
|
%%% sync with the project whenever you add, remove or rename a module.
|
||||||
|
%%% @end
|
||||||
|
|
||||||
|
-module(jex).
|
||||||
|
-vsn("0.1.0").
|
||||||
|
-license("MIT").
|
||||||
|
-export([start/1]).
|
||||||
|
|
||||||
|
-include("$zx_include/zx_logger.hrl").
|
||||||
|
|
||||||
|
|
||||||
|
-spec start(ArgV) -> ok
|
||||||
|
when ArgV :: [string()].
|
||||||
|
|
||||||
|
start(ArgV) ->
|
||||||
|
ok = log(info, "ArgV: ~tp", [ArgV]),
|
||||||
|
ok = dispatch(ArgV),
|
||||||
|
zx:silent_stop().
|
||||||
|
|
||||||
|
help() ->
|
||||||
|
io:format("~ts~n", [help_screen()]).
|
||||||
|
|
||||||
|
|
||||||
|
% TODO: be smart about creating jex_include
|
||||||
|
% TODO: make mindist tarballs
|
||||||
|
% TODO: make fulldist tarballs
|
||||||
|
% TODO: make tsdocs
|
||||||
|
% TODO: jex pull
|
||||||
|
% TODO: hints about where to find packages
|
||||||
|
% TODO: tarball shas
|
||||||
|
% TODO: tarball signatures
|
||||||
|
% TODO: tarball signatures
|
||||||
|
|
||||||
|
help_screen() ->
|
||||||
|
["welcome to hell\n"
|
||||||
|
"\n"
|
||||||
|
"COMMANDS:\n"
|
||||||
|
" cfgbarf barf out the jex.eterms file (mostly to make sure it parses correctly)\n"
|
||||||
|
" echo home echo $HOME\n"
|
||||||
|
" echo jexdir echo $HOME/.jex\n"
|
||||||
|
" echo devdir echo $HOME/.jex/dev\n"
|
||||||
|
" echo pkgname name of current package\n"
|
||||||
|
" echo pkgdir echo $HOME/.jex/dev/realm-name-X.Y.Z\n"
|
||||||
|
" echo deps list dependencies of current package\n"
|
||||||
|
" echo pathof PKG list the path to PKG or \n"
|
||||||
|
" init mkdir -p $HOME/.jex/dev\n"
|
||||||
|
" build tsc && cp -r ./src/jex_include ./dist/\n"
|
||||||
|
" -w, --weak continue building even if tsc fails\n"
|
||||||
|
" -f, --force use cp -rf instead of cp -r\n"
|
||||||
|
" mindist mkdir jex_mindist && cp -r src jex_mindist && cp -r dist jex_mindist && rm -r jex_mindist/src/jex_include\n"
|
||||||
|
" -f, --force use cp -rf instead of cp -r\n"
|
||||||
|
" push rsync -a jex_mindist/ PKGDIR\n"
|
||||||
|
" ls ls $HOME/.jex/dev\n"
|
||||||
|
" jextree tree $HOME/.jex/\n"
|
||||||
|
" rmpkg PKG rm -r $HOME/.jex/dev/PKG\n"
|
||||||
|
" pull pull each dependency into src/jx_include\n"
|
||||||
|
].
|
||||||
|
|
||||||
|
|
||||||
|
dispatch(["cfgbarf"]) -> cfgbarf();
|
||||||
|
dispatch(["echo", "home"]) -> echo(home);
|
||||||
|
dispatch(["echo", "jexdir"]) -> echo(jexdir);
|
||||||
|
dispatch(["echo", "devdir"]) -> echo(devdir);
|
||||||
|
dispatch(["echo", "pkgname"]) -> echo(pkgname);
|
||||||
|
dispatch(["echo", "pkgdir"]) -> echo(pkgdir);
|
||||||
|
dispatch(["echo", "deps"]) -> echo(deps);
|
||||||
|
dispatch(["init"]) -> init();
|
||||||
|
dispatch(["build" | Opts]) -> build(Opts);
|
||||||
|
dispatch(["mindist" | Opts]) -> mindist(Opts);
|
||||||
|
dispatch(["push"]) -> push();
|
||||||
|
dispatch(["ls"]) -> ls();
|
||||||
|
dispatch(["tree"]) -> tree();
|
||||||
|
dispatch(["rmpkg", Pkg]) -> rmpkg(Pkg);
|
||||||
|
dispatch(["pull"]) -> pull();
|
||||||
|
dispatch(_) -> help().
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex cfgbarf
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
cfgbarf() ->
|
||||||
|
io:format("~tp~n", [file:consult("jex.eterms")]).
|
||||||
|
|
||||||
|
|
||||||
|
cfg() ->
|
||||||
|
file:consult("jex.eterms").
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex echo
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
echo(home) ->
|
||||||
|
tell(info, "~ts", [home()]);
|
||||||
|
echo(jexdir) ->
|
||||||
|
tell(info, "~ts", [jexdir()]);
|
||||||
|
echo(devdir) ->
|
||||||
|
tell(info, "~ts", [devdir()]);
|
||||||
|
echo(pkgname) ->
|
||||||
|
tell(info, "~ts", [pkgname()]);
|
||||||
|
echo(pkgdir) ->
|
||||||
|
tell(info, "~ts", [pkgdir()]);
|
||||||
|
echo(deps) ->
|
||||||
|
PrintDep =
|
||||||
|
fun(Dep) ->
|
||||||
|
tell(info, "~ts", [Dep])
|
||||||
|
end,
|
||||||
|
lists:foreach(PrintDep, deps());
|
||||||
|
echo({pathof, Pkg}) ->
|
||||||
|
tell(info, "~ts", [pathof(Pkg)]).
|
||||||
|
|
||||||
|
|
||||||
|
home() ->
|
||||||
|
case os:getenv("HOME") of
|
||||||
|
false -> error("You are running some retard system that doesn't have $HOME defined. Fuck off");
|
||||||
|
HomeD -> HomeD
|
||||||
|
end.
|
||||||
|
|
||||||
|
|
||||||
|
jexdir() ->
|
||||||
|
filename:join(home(), ".jex").
|
||||||
|
|
||||||
|
devdir() ->
|
||||||
|
filename:join(jexdir(), "dev").
|
||||||
|
|
||||||
|
|
||||||
|
pkgname() ->
|
||||||
|
{ok, Cfg} = cfg(),
|
||||||
|
Realm = proplists:get_value(realm, Cfg),
|
||||||
|
Name = proplists:get_value(name, Cfg),
|
||||||
|
Vsn = proplists:get_value(version, Cfg),
|
||||||
|
io_lib:format("~tp-~tp-~ts", [Realm, Name, Vsn]).
|
||||||
|
|
||||||
|
pkgdir() ->
|
||||||
|
filename:join(devdir(), pkgname()).
|
||||||
|
|
||||||
|
|
||||||
|
deps() ->
|
||||||
|
{ok, Cfg} = cfg(),
|
||||||
|
case proplists:get_value(deps, Cfg) of
|
||||||
|
undefined ->
|
||||||
|
error("jex.eterms is missing key `deps`");
|
||||||
|
Deps ->
|
||||||
|
Deps
|
||||||
|
end.
|
||||||
|
|
||||||
|
|
||||||
|
pathof(Pkg) ->
|
||||||
|
Filename = filename:join(devdir(), Pkg),
|
||||||
|
case file_exists(Filename) of
|
||||||
|
true -> Filename;
|
||||||
|
false -> error({unknown_package, Pkg})
|
||||||
|
end.
|
||||||
|
|
||||||
|
file_exists(Filename) ->
|
||||||
|
case file:read_file_info(Filename) of
|
||||||
|
{ok, _} -> true;
|
||||||
|
{error, _} -> false
|
||||||
|
end.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex init
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
init() ->
|
||||||
|
DevDir = devdir(),
|
||||||
|
Cmd = io_lib:format("mkdir -p ~ts", [DevDir]),
|
||||||
|
_ = cmd(Cmd),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex build
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
build(Opts) ->
|
||||||
|
% flags if flag default
|
||||||
|
OptsConfig = [{["-w", "--weak"], {weak, weak}, {weak, strict}},
|
||||||
|
{["-f", "--force"], {force, force}, {force, dont_force}}],
|
||||||
|
#{force := Force, weak := Weak} = parseopts(OptsConfig, Opts),
|
||||||
|
_ = cmd("mkdir -p src/jex_include"),
|
||||||
|
ok = tsc(Weak),
|
||||||
|
ok = cp_jex_include(Force),
|
||||||
|
ok.
|
||||||
|
%ok.
|
||||||
|
|
||||||
|
tsc(strict) ->
|
||||||
|
"" = cmd("tsc"),
|
||||||
|
ok;
|
||||||
|
tsc(weak) ->
|
||||||
|
_ = cmd("tsc"),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
cp_jex_include(dont_force) ->
|
||||||
|
_ = cmd("cp -rv src/jex_include dist"),
|
||||||
|
ok;
|
||||||
|
cp_jex_include(force) ->
|
||||||
|
_ = cmd("cp -rvf src/jex_include dist"),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex mindist
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
mindist(Opts) ->
|
||||||
|
% flags if flag default
|
||||||
|
OptsConfig = [{["-f", "--force"], {force, force}, {force, dont_force}}],
|
||||||
|
#{force := Force} = parseopts(OptsConfig, Opts),
|
||||||
|
_ = cmd("mkdir -p jex_mindist"),
|
||||||
|
_ = mindist_cp(Force),
|
||||||
|
_ = cmd("rm -r jex_mindist/src/jex_include"),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
mindist_cp(dont_force) ->
|
||||||
|
_ = cmd("cp -rv src jex_mindist"),
|
||||||
|
_ = cmd("cp -rv dist jex_mindist"),
|
||||||
|
ok;
|
||||||
|
mindist_cp(force) ->
|
||||||
|
_ = cmd("cp -rvf src jex_mindist"),
|
||||||
|
_ = cmd("cp -rvf dist jex_mindist"),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex push
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
push() ->
|
||||||
|
_ = cmd(io_lib:format("rsync -avv jex_mindist/ ~ts", [pkgdir()])),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex ls
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
ls() ->
|
||||||
|
_ = cmd(io_lib:format("ls ~ts", [devdir()])),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex tree
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
tree() ->
|
||||||
|
_ = cmd(io_lib:format("tree ~ts", [jexdir()])),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex rmpkg Pkg
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
rmpkg(Pkg) ->
|
||||||
|
Filename = pathof(Pkg),
|
||||||
|
_ = cmd(io_lib:format("rm -r ~ts", [Filename])),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% jex pull
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
pull() ->
|
||||||
|
pull(deps()).
|
||||||
|
|
||||||
|
pull([Dep | Deps]) ->
|
||||||
|
pull_dep(Dep),
|
||||||
|
pull(Deps);
|
||||||
|
pull([]) ->
|
||||||
|
tell(info, "no more dependencies to pull", []),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
pull_dep(Dep) ->
|
||||||
|
Src = pathof(Dep),
|
||||||
|
Dst = filename:join("./src/jex_include", Dep),
|
||||||
|
_ = cmd(io_lib:format("mkdir -p ~ts", [Dst])),
|
||||||
|
%tell(info, "path of ~s: ~s", [Dep, Src]),
|
||||||
|
_ = cmd(io_lib:format("rsync -avv ~ts/ ~ts", [Src, Dst])),
|
||||||
|
ok.
|
||||||
|
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
%% INTERNALS
|
||||||
|
%%-----------------------------------------------------------------------------
|
||||||
|
cmd(Command) ->
|
||||||
|
ok = tell("$ ~ts", [Command]),
|
||||||
|
S = os:cmd(Command),
|
||||||
|
ok = tell("~ts", [S]),
|
||||||
|
S.
|
||||||
|
|
||||||
|
parseopts(OptsConfig, Opts) ->
|
||||||
|
log(info, "OptsConfig: ~tp", [OptsConfig]),
|
||||||
|
log(info, "Opts: ~tp", [Opts]),
|
||||||
|
DefaultOpts = default_opts(OptsConfig, #{}),
|
||||||
|
log(info, "DefaultOpts: ~tp", [DefaultOpts]),
|
||||||
|
Updater = updater(OptsConfig, #{}),
|
||||||
|
log(info, "Updater: ~tp", [Updater]),
|
||||||
|
Flags = getflags(Opts, []),
|
||||||
|
UpdatedFlags = update_flags(Flags, Updater, DefaultOpts),
|
||||||
|
log(info, "UpdatedFlags: ~tp", [UpdatedFlags]),
|
||||||
|
UpdatedFlags.
|
||||||
|
|
||||||
|
update_flags([Flag | Rest], Updater, AccFlags) ->
|
||||||
|
NewAcc =
|
||||||
|
case maps:find(Flag, Updater) of
|
||||||
|
{ok, {NewFlag, NewValue}} ->
|
||||||
|
AccFlags#{NewFlag => NewValue};
|
||||||
|
error ->
|
||||||
|
error(["invalid flag", Flag])
|
||||||
|
end,
|
||||||
|
update_flags(Rest, Updater, NewAcc);
|
||||||
|
update_flags([], _Updater, FinalAcc) ->
|
||||||
|
FinalAcc.
|
||||||
|
|
||||||
|
updater([{DashedFlags, IfFlag, _Def} | Rest], Acc) ->
|
||||||
|
UndashedFlags = getflags(DashedFlags, []),
|
||||||
|
Flagger =
|
||||||
|
fun (UndashedFlag, UndashedFlagToOptionMap) ->
|
||||||
|
UndashedFlagToOptionMap#{UndashedFlag => IfFlag}
|
||||||
|
end,
|
||||||
|
NewAcc = lists:foldl(Flagger, Acc, UndashedFlags),
|
||||||
|
updater(Rest, NewAcc);
|
||||||
|
updater([], Acc) ->
|
||||||
|
Acc.
|
||||||
|
|
||||||
|
default_opts([{_X, _Y, {Z, W}} | Rest], Acc) ->
|
||||||
|
default_opts(Rest, Acc#{Z => W});
|
||||||
|
default_opts([], FinalAcc) ->
|
||||||
|
FinalAcc.
|
||||||
|
|
||||||
|
% --flag (long flag)
|
||||||
|
getflags(["--"++LongFlag | Flags], Acc) ->
|
||||||
|
NewAcc = [LongFlag | Acc],
|
||||||
|
getflags(Flags, NewAcc);
|
||||||
|
% -xyz (many short flags)
|
||||||
|
getflags(["-"++ShortFlags | Flags], Acc) ->
|
||||||
|
NewAcc = lists:map(fun(Char) -> [Char] end, ShortFlags) ++ Acc,
|
||||||
|
getflags(Flags, NewAcc);
|
||||||
|
% no more options
|
||||||
|
getflags([], FinalAcc) ->
|
||||||
|
FinalAcc.
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
{a_email,[]}.
|
||||||
|
{author,[]}.
|
||||||
|
{c_email,[]}.
|
||||||
|
{copyright,[]}.
|
||||||
|
{deps,[]}.
|
||||||
|
{desc,"jex"}.
|
||||||
|
{file_exts,[]}.
|
||||||
|
{key_name,none}.
|
||||||
|
{license,"MIT"}.
|
||||||
|
{mod,"jex"}.
|
||||||
|
{modules,[]}.
|
||||||
|
{name,"jex"}.
|
||||||
|
{package_id,{"otpr","jex",{0,1,0}}}.
|
||||||
|
{prefix,none}.
|
||||||
|
{repo_url,[]}.
|
||||||
|
{tags,[]}.
|
||||||
|
{type,cli}.
|
||||||
|
{ws_url,[]}.
|
||||||
Submodule
+1
Submodule utils/vlogd added at a0a63736b8
Reference in New Issue
Block a user