vanillae project reorganization
This commit is contained in:
@@ -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,3 @@
|
||||
# Sidekick
|
||||
|
||||
Click "sidekick" in the sidebar or hamburger menu
|
||||
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.2.1"}.
|
||||
{deps, ["local-awcp-0.2.1"]}.
|
||||
@@ -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,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,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,80 @@
|
||||
|
||||
<!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 Base64: <code class="pv-spendtx-base64"></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 Base64</h5>
|
||||
<pre class="pv-spendtx-base64"></pre>
|
||||
<h2>4.3 Sign the transaction (sidekick)</h2>
|
||||
<ol>
|
||||
<li><pre class="pv-spendtx-base64"></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>
|
||||
|
||||
|
||||
<h1>5. Sign a message</h1>
|
||||
<textarea id="message-text" rows="5" cols="80">MESSSSSSSSSSAGGGGGGGGGGGGGGGGGGGGGGGGGGGE</textarea>
|
||||
<br>
|
||||
<button id="sign-message">Sign Message</button>
|
||||
|
||||
<!-- 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, sidekick_examples}.
|
||||
{version, "0.1.0"}.
|
||||
{deps, ["local-awcp-0.2.1",
|
||||
"local-parasite-0.2.0",
|
||||
"local-sidekick-0.2.1"]}.
|
||||
@@ -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,232 @@
|
||||
import * as ae_node from './jex_include/local-parasite-0.2.0/dist/ae_node.js';
|
||||
import * as awcp from './jex_include/local-awcp-0.2.0/dist/awcp.js';
|
||||
import * as sk from './jex_include/local-sidekick-0.2.0/dist/sidekick.js';
|
||||
|
||||
var pv_address: string;
|
||||
var pv_spendtx_base64: 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_base64
|
||||
(new_address: string)
|
||||
: void
|
||||
{
|
||||
pv_spendtx_base64 = new_address;
|
||||
for (let elt of document.getElementsByClassName('pv-spendtx-base64'))
|
||||
{
|
||||
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_base64(tx.tx);
|
||||
//document.getElementById('spendtx-base64')!.innerHTML =
|
||||
// JSON.stringify(tx, undefined, 4);
|
||||
//
|
||||
}
|
||||
|
||||
async function
|
||||
sign_tx
|
||||
(logger: sk.Logger)
|
||||
: Promise<void>
|
||||
{
|
||||
let sign_params = {
|
||||
tx: pv_spendtx_base64,
|
||||
// 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);
|
||||
}
|
||||
|
||||
async function
|
||||
sign_msg
|
||||
(logger: sk.Logger)
|
||||
: Promise<void>
|
||||
{
|
||||
let acc_pubkey : string = pv_address;
|
||||
// @ts-ignore value property exists because i say so
|
||||
let msg_text : string = document.getElementById('message-text').value;
|
||||
let signed_msg = await sk.msg_sign('sk-msg-sign-1', acc_pubkey, msg_text, sk.TIMEOUT_DEF_MSG_SIGN_MS, 'message signing took too long', logger);
|
||||
console.log('signed message:', signed_msg);
|
||||
}
|
||||
|
||||
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); };
|
||||
document.getElementById('sign-message')!.onclick = function() { sign_msg(logger); };
|
||||
|
||||
//set_pv_address("ak_2XhCkjzTwcq1coXSSzHJoMZkUzTwnjH88zmPGkkowUsFNTo9UE");
|
||||
}
|
||||
|
||||
main();
|
||||
@@ -0,0 +1,3 @@
|
||||
import * as sk from './jex_include/local-sidekick-0.2.0/dist/sidekick.js';
|
||||
|
||||
sk.hello();
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
{type, library}.
|
||||
{realm, local}.
|
||||
{name, vanillae}.
|
||||
{name, vdk}.
|
||||
{version, "0.1.0"}.
|
||||
{deps, []}.
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
{type, library}.
|
||||
{realm, local}.
|
||||
{name, vanillae_test_cases}.
|
||||
{version, "0.1.0"}.
|
||||
{deps, ["local-vanillae-0.1.0"]}.
|
||||
@@ -1,6 +0,0 @@
|
||||
{type, library}.
|
||||
{realm, local}.
|
||||
{name, vanillae_test}.
|
||||
{version, "0.1.0"}.
|
||||
{deps, ["local-vanillae-0.1.0",
|
||||
"local-vanillae_test_cases-0.1.0"]}.
|
||||
Vendored
+12
@@ -0,0 +1,12 @@
|
||||
export declare const rlp: {
|
||||
decoded: import("./jex_include/local-vdk-0.1.0/dist/rlp.js").decoded_data;
|
||||
encoded: Uint8Array;
|
||||
}[];
|
||||
export declare const base58: {
|
||||
encoded: string;
|
||||
decoded: Uint8Array;
|
||||
}[];
|
||||
export declare const base64: {
|
||||
decoded: Uint8Array;
|
||||
encoded: string;
|
||||
}[];
|
||||
Vendored
+3657
File diff suppressed because it is too large
Load Diff
Vendored
+1
File diff suppressed because one or more lines are too long
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Base58 encoding/decoding
|
||||
*/
|
||||
export { encode, decode };
|
||||
/**
|
||||
* Encode a Uint8Array into base58
|
||||
*/
|
||||
declare function encode(binary: Uint8Array): string;
|
||||
/**
|
||||
* Decode a Base58 string into a Uint8Array
|
||||
*/
|
||||
declare function decode(base58: string): Uint8Array;
|
||||
@@ -0,0 +1,308 @@
|
||||
/**
|
||||
* Base58 encoding/decoding
|
||||
*/
|
||||
export { encode, decode };
|
||||
//=============================================================================
|
||||
// ENCODING
|
||||
//=============================================================================
|
||||
/**
|
||||
* Encode a Uint8Array into base58
|
||||
*/
|
||||
function encode(binary) {
|
||||
let num_leading_zeros = nlz(binary);
|
||||
let rest = binary.slice(num_leading_zeros);
|
||||
let ones = encode_zeros(num_leading_zeros);
|
||||
let rest_b58 = encode_rest(rest);
|
||||
let result = ones + rest_b58;
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* count the number of leading zeros in a uint8array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function nlz(bytes) {
|
||||
let n = 0;
|
||||
for (let this_byte of bytes) {
|
||||
if (0 === this_byte) {
|
||||
n++;
|
||||
}
|
||||
else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return n;
|
||||
}
|
||||
/**
|
||||
* Generate a bunch of '1's for however many leading zeros there are
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_zeros(how_many) {
|
||||
let ones = '';
|
||||
for (let i = 1; i <= how_many; i++) {
|
||||
ones += '1';
|
||||
}
|
||||
return ones;
|
||||
}
|
||||
/**
|
||||
* Encode a Uint8Array that has no leading zeros
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_rest(bytes) {
|
||||
let bytes_bignum = bytes_to_bigint(bytes);
|
||||
let result = bignum_to_base58(bytes_bignum);
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Convert a bytestring to a bignum
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bytes_to_bigint(bytes) {
|
||||
let acc_bigint = 0n;
|
||||
for (let this_byte of bytes) {
|
||||
acc_bigint <<= 8n;
|
||||
acc_bigint += BigInt(this_byte);
|
||||
}
|
||||
return acc_bigint;
|
||||
}
|
||||
/**
|
||||
* Convert a BigInt to Base58
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bignum_to_base58(q) {
|
||||
let s = '';
|
||||
while (q !== 0n) {
|
||||
let this_n = q % 58n;
|
||||
q /= 58n;
|
||||
let this_b58_char = bigint_to_char(this_n);
|
||||
s = this_b58_char + s;
|
||||
}
|
||||
return s;
|
||||
}
|
||||
//=============================================================================
|
||||
// DECODING
|
||||
//=============================================================================
|
||||
/**
|
||||
* Decode a Base58 string into a Uint8Array
|
||||
*/
|
||||
function decode(base58) {
|
||||
let num_leading_ones = nlo(base58);
|
||||
let rest = base58.slice(num_leading_ones);
|
||||
let zeros = decode_ones(num_leading_ones);
|
||||
let rest_arr = decode_rest(rest);
|
||||
let pre_result = zeros.concat(rest_arr);
|
||||
return new Uint8Array(pre_result);
|
||||
}
|
||||
/**
|
||||
* count the number of leading 1 characters in a uint8array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function nlo(base58) {
|
||||
let n = 0;
|
||||
for (let this_char of base58) {
|
||||
if ('1' === this_char) {
|
||||
n++;
|
||||
}
|
||||
else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return n;
|
||||
}
|
||||
/**
|
||||
* Generate a bunch of '0's for however many leading ones there are
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_ones(how_many) {
|
||||
let zeros = [];
|
||||
for (let i = 1; i <= how_many; i++) {
|
||||
zeros.push(0);
|
||||
}
|
||||
return zeros;
|
||||
}
|
||||
/**
|
||||
* Decode a string that has no leading 1s
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_rest(base58) {
|
||||
let result_bignum = base58_to_bigint(base58);
|
||||
let result = bigint_to_base256(result_bignum);
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Convert a base58 string to a bignum
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function base58_to_bigint(base58) {
|
||||
let acc_bigint = 0n;
|
||||
for (let this_char of base58) {
|
||||
acc_bigint *= 58n;
|
||||
acc_bigint += char_to_bigint(this_char);
|
||||
}
|
||||
return acc_bigint;
|
||||
}
|
||||
/**
|
||||
* convert a bignum into a byte array
|
||||
*
|
||||
* @end
|
||||
*/
|
||||
function bigint_to_base256(q) {
|
||||
let arr_reverse = [];
|
||||
while (q !== 0n) {
|
||||
let r = Number(q % 256n);
|
||||
q /= 256n;
|
||||
arr_reverse.push(r);
|
||||
}
|
||||
arr_reverse.reverse();
|
||||
return arr_reverse;
|
||||
}
|
||||
//=============================================================================
|
||||
// TRANSLATION TABLES
|
||||
//=============================================================================
|
||||
/**
|
||||
* Base58 integer -> character conversion table
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bigint_to_char(n) {
|
||||
switch (n) {
|
||||
case 0n: return '1';
|
||||
case 1n: return '2';
|
||||
case 2n: return '3';
|
||||
case 3n: return '4';
|
||||
case 4n: return '5';
|
||||
case 5n: return '6';
|
||||
case 6n: return '7';
|
||||
case 7n: return '8';
|
||||
case 8n: return '9';
|
||||
case 9n: return 'A';
|
||||
case 10n: return 'B';
|
||||
case 11n: return 'C';
|
||||
case 12n: return 'D';
|
||||
case 13n: return 'E';
|
||||
case 14n: return 'F';
|
||||
case 15n: return 'G';
|
||||
case 16n: return 'H';
|
||||
case 17n: return 'J';
|
||||
case 18n: return 'K';
|
||||
case 19n: return 'L';
|
||||
case 20n: return 'M';
|
||||
case 21n: return 'N';
|
||||
case 22n: return 'P';
|
||||
case 23n: return 'Q';
|
||||
case 24n: return 'R';
|
||||
case 25n: return 'S';
|
||||
case 26n: return 'T';
|
||||
case 27n: return 'U';
|
||||
case 28n: return 'V';
|
||||
case 29n: return 'W';
|
||||
case 30n: return 'X';
|
||||
case 31n: return 'Y';
|
||||
case 32n: return 'Z';
|
||||
case 33n: return 'a';
|
||||
case 34n: return 'b';
|
||||
case 35n: return 'c';
|
||||
case 36n: return 'd';
|
||||
case 37n: return 'e';
|
||||
case 38n: return 'f';
|
||||
case 39n: return 'g';
|
||||
case 40n: return 'h';
|
||||
case 41n: return 'i';
|
||||
case 42n: return 'j';
|
||||
case 43n: return 'k';
|
||||
case 44n: return 'm';
|
||||
case 45n: return 'n';
|
||||
case 46n: return 'o';
|
||||
case 47n: return 'p';
|
||||
case 48n: return 'q';
|
||||
case 49n: return 'r';
|
||||
case 50n: return 's';
|
||||
case 51n: return 't';
|
||||
case 52n: return 'u';
|
||||
case 53n: return 'v';
|
||||
case 54n: return 'w';
|
||||
case 55n: return 'x';
|
||||
case 56n: return 'y';
|
||||
case 57n: return 'z';
|
||||
default:
|
||||
throw new Error('invalid base58 bigint: ' + n);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Base58 character -> integer conversion table
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function char_to_bigint(s) {
|
||||
switch (s) {
|
||||
case '1': return 0n;
|
||||
case '2': return 1n;
|
||||
case '3': return 2n;
|
||||
case '4': return 3n;
|
||||
case '5': return 4n;
|
||||
case '6': return 5n;
|
||||
case '7': return 6n;
|
||||
case '8': return 7n;
|
||||
case '9': return 8n;
|
||||
case 'A': return 9n;
|
||||
case 'B': return 10n;
|
||||
case 'C': return 11n;
|
||||
case 'D': return 12n;
|
||||
case 'E': return 13n;
|
||||
case 'F': return 14n;
|
||||
case 'G': return 15n;
|
||||
case 'H': return 16n;
|
||||
case 'J': return 17n;
|
||||
case 'K': return 18n;
|
||||
case 'L': return 19n;
|
||||
case 'M': return 20n;
|
||||
case 'N': return 21n;
|
||||
case 'P': return 22n;
|
||||
case 'Q': return 23n;
|
||||
case 'R': return 24n;
|
||||
case 'S': return 25n;
|
||||
case 'T': return 26n;
|
||||
case 'U': return 27n;
|
||||
case 'V': return 28n;
|
||||
case 'W': return 29n;
|
||||
case 'X': return 30n;
|
||||
case 'Y': return 31n;
|
||||
case 'Z': return 32n;
|
||||
case 'a': return 33n;
|
||||
case 'b': return 34n;
|
||||
case 'c': return 35n;
|
||||
case 'd': return 36n;
|
||||
case 'e': return 37n;
|
||||
case 'f': return 38n;
|
||||
case 'g': return 39n;
|
||||
case 'h': return 40n;
|
||||
case 'i': return 41n;
|
||||
case 'j': return 42n;
|
||||
case 'k': return 43n;
|
||||
case 'm': return 44n;
|
||||
case 'n': return 45n;
|
||||
case 'o': return 46n;
|
||||
case 'p': return 47n;
|
||||
case 'q': return 48n;
|
||||
case 'r': return 49n;
|
||||
case 's': return 50n;
|
||||
case 't': return 51n;
|
||||
case 'u': return 52n;
|
||||
case 'v': return 53n;
|
||||
case 'w': return 54n;
|
||||
case 'x': return 55n;
|
||||
case 'y': return 56n;
|
||||
case 'z': return 57n;
|
||||
default:
|
||||
throw new Error('invalid base58 char: ' + s);
|
||||
}
|
||||
}
|
||||
//# sourceMappingURL=b58.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Base64 Utility Functions in TypeScript
|
||||
*/
|
||||
export { encode, decode };
|
||||
/**
|
||||
* Encode an array of bytes as a Uint8Array in base64 notation.
|
||||
*/
|
||||
declare function encode(bytes: Uint8Array): string;
|
||||
/**
|
||||
* Decode a base64-encoded string
|
||||
*/
|
||||
declare function decode(base64_str: string): Uint8Array;
|
||||
@@ -0,0 +1,507 @@
|
||||
/**
|
||||
* Base64 Utility Functions in TypeScript
|
||||
*/
|
||||
export { encode, decode };
|
||||
/**
|
||||
* Encode an array of bytes as a Uint8Array in base64 notation.
|
||||
*/
|
||||
function encode(bytes) {
|
||||
// slice the array
|
||||
// length of head is a multiple of 3
|
||||
// treat the tail as a special case
|
||||
let { head, tail, tail_len } = slice3k(bytes);
|
||||
let head_str = encode_head(head);
|
||||
let tail_str = encode_tail(tail, tail_len);
|
||||
return head_str + tail_str;
|
||||
}
|
||||
/**
|
||||
* Take a Uint8Array, take the first 3k (k >= 0) bytes, put them in head, and
|
||||
* the remaining 0,1, or 2 bytes, put them in tail
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function slice3k(bytes) {
|
||||
let len = bytes.length;
|
||||
// too lazy to look up how to do integer division in js so this will do
|
||||
let tail_len = len % 3;
|
||||
let head_len = len - tail_len;
|
||||
// for slice:
|
||||
// first argument is the 0-index of the start
|
||||
// second - first is the length of the slice
|
||||
let head = bytes.slice(0, head_len);
|
||||
// empty second argument means go to the end
|
||||
let tail = bytes.slice(head_len);
|
||||
return { head: head,
|
||||
tail: tail,
|
||||
tail_len: tail_len };
|
||||
}
|
||||
/**
|
||||
* Encode a Uint8Array whose length is known to be a multiple of 3
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_head(head_bytes) {
|
||||
// can assume length of bytes is a multiple of 3
|
||||
// start index at 0
|
||||
// increment by 3
|
||||
let head_bytes_len = head_bytes.length;
|
||||
let max_idx0 = head_bytes_len - 1;
|
||||
let head_str_acc = '';
|
||||
for (let this_3slice_start_idx0 = 0; this_3slice_start_idx0 <= max_idx0; this_3slice_start_idx0 += 3) {
|
||||
let this_3slice_bytes = head_bytes.slice(this_3slice_start_idx0, this_3slice_start_idx0 + 3);
|
||||
let this_3slice_str = encode3(this_3slice_bytes);
|
||||
head_str_acc += this_3slice_str;
|
||||
}
|
||||
return head_str_acc;
|
||||
}
|
||||
/**
|
||||
* Encode a 3 bytes into base64 notation
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode3(bytes) {
|
||||
let b0 = bytes[0];
|
||||
let b1 = bytes[1];
|
||||
let b2 = bytes[2];
|
||||
// ABCDEFGH 12345678 abcdefgh
|
||||
// b0 b1 b2
|
||||
// ABCDEF GH1234 5678ab cdefgh
|
||||
// n0 n1 n2 n3
|
||||
let n0 = b0 >> 2;
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
// b1 = 12345678
|
||||
// b1 >> 4 = ____1234
|
||||
// n1 = __GH1234
|
||||
let n1 = ((b0 % 4) << 4) + (b1 >> 4);
|
||||
// b1 = 12345678
|
||||
// 16 = ___1____
|
||||
// b1 % 16 = ____5678
|
||||
// (b1 % 16) << 2 = __5678__
|
||||
// b2 = abcdefgh
|
||||
// b2 >> 6 = ______ab
|
||||
// n2 = __5678ab
|
||||
let n2 = ((b1 % 16) << 2) + (b2 >> 6);
|
||||
// b2 = abcdefgh
|
||||
// 64 = _1______
|
||||
// n3 = __cdefgh
|
||||
let n3 = b2 % 64;
|
||||
// convert to chars
|
||||
let s0 = int2char(n0);
|
||||
let s1 = int2char(n1);
|
||||
let s2 = int2char(n2);
|
||||
let s3 = int2char(n3);
|
||||
// retrvn
|
||||
return s0 + s1 + s2 + s3;
|
||||
}
|
||||
/**
|
||||
* Encode the final 0, 1, or 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_tail(tail_bytes, tail_len) {
|
||||
switch (tail_len) {
|
||||
case 0: return '';
|
||||
case 1: return encode1(tail_bytes);
|
||||
case 2: return encode2(tail_bytes);
|
||||
default:
|
||||
throw new Error('encode_tail with tail_len = ' + tail_len);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Encode a single byte
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode1(bytes) {
|
||||
let b0 = bytes[0];
|
||||
// n0 = __ABCDEF
|
||||
// b0 = ABCDEFGH
|
||||
// b0 >> 2 = __ABCDEF
|
||||
let n0 = b0 >> 2;
|
||||
// n1 = __GH____
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
let n1 = (b0 % 4) << 4;
|
||||
return int2char(n0) + int2char(n1) + '==';
|
||||
}
|
||||
/**
|
||||
* Encode two bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode2(bytes) {
|
||||
let b0 = bytes[0];
|
||||
let b1 = bytes[1];
|
||||
// ABCDEFGH 12345678
|
||||
// b0 b1
|
||||
// ABCDEF GH1234 5678__
|
||||
// n0 n1 n2
|
||||
let n0 = b0 >> 2;
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
// b1 = 12345678
|
||||
// b1 >> 4 = ____1234
|
||||
// n1 = __GH1234
|
||||
let n1 = ((b0 % 4) << 4) + (b1 >> 4);
|
||||
// b1 = 12345678
|
||||
// 16 = ___1____
|
||||
// b1 % 16 = ____5678
|
||||
// (b1 % 16) << 2 = __5678__
|
||||
// n2 = __5678__
|
||||
let n2 = (b1 % 16) << 2;
|
||||
// convert to chars
|
||||
let s0 = int2char(n0);
|
||||
let s1 = int2char(n1);
|
||||
let s2 = int2char(n2);
|
||||
// retrvn
|
||||
return s0 + s1 + s2 + '=';
|
||||
}
|
||||
/**
|
||||
* Decode a base64-encoded string
|
||||
*/
|
||||
function decode(base64_str) {
|
||||
// length of the string is guaranteed to be a multiple of 4
|
||||
// if the string is empty, return the empty array
|
||||
let len = base64_str.length;
|
||||
// this branching contains the implicit assertion that the length is a
|
||||
// multiple of 4. If this is not true, the bottom branch is triggered.
|
||||
// general case goes first because speeeeeed
|
||||
if ((4 < len)
|
||||
&& (0 === (len % 4))) {
|
||||
// split the head and tail
|
||||
let tail_start_idx0 = len - 4;
|
||||
let head_s = base64_str.slice(0, tail_start_idx0);
|
||||
let tail_s = base64_str.slice(tail_start_idx0);
|
||||
// Using arrays because Uint8Arrays don't have a concat operation
|
||||
let head_arr = decode_head(head_s);
|
||||
let tail_arr = decode_tail(tail_s);
|
||||
// silly to put these in variables but this is exactly the type of
|
||||
// situation where JS type insanity shows up
|
||||
//
|
||||
// see: i forgot
|
||||
// > [1,2,3] + [4,5,6]
|
||||
// '1,2,34,5,6'
|
||||
//
|
||||
// Originally, I used + like some sort of moron who codes in a sane
|
||||
// language
|
||||
//
|
||||
// seriously what is this language
|
||||
//
|
||||
// this is some clown behavior
|
||||
let total_arr = head_arr.concat(tail_arr);
|
||||
return new Uint8Array(total_arr);
|
||||
}
|
||||
// special case if the length is exactly 4
|
||||
else if (4 === len) {
|
||||
// it's just a tail
|
||||
return new Uint8Array(decode_tail(base64_str));
|
||||
}
|
||||
// empty string
|
||||
else if (0 === len) {
|
||||
return new Uint8Array([]);
|
||||
}
|
||||
else {
|
||||
throw new Error('base64 decode: invalid string length: ' + len);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Decode a string known to not have any padding
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_head(s) {
|
||||
// go 4 characters at a time
|
||||
let max_i0 = s.length - 1;
|
||||
let decoded_acc = [];
|
||||
for (let i0 = 0; i0 <= max_i0; i0 += 4) {
|
||||
let this_slice_s = s.slice(i0, i0 + 4);
|
||||
let this_slice_arr = decode3(this_slice_s);
|
||||
// update accumulator
|
||||
decoded_acc = decoded_acc.concat(this_slice_arr);
|
||||
}
|
||||
return decoded_acc;
|
||||
}
|
||||
/**
|
||||
* Decode 4 characters that correspond to either 3 bytes, 2, bytes, or 1 byte
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_tail(s) {
|
||||
// all that matters right now is the last 2 chars
|
||||
// s0, s1, s2, s3
|
||||
// 0 based indexing is so annoying
|
||||
let s2 = s[2];
|
||||
let s3 = s[3];
|
||||
// braaaaaaaaaaaaaaaaaench
|
||||
// two equals signs means 1 byte
|
||||
if (('=' === s3) && ('=' === s2)) {
|
||||
return decode1(s);
|
||||
}
|
||||
// one equals sign means 2 bytes
|
||||
else if (('=' === s3)) {
|
||||
return decode2(s);
|
||||
}
|
||||
// 0 equals signs means 3 bytes
|
||||
else {
|
||||
return decode3(s);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 3 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode3(s) {
|
||||
// pull out strings
|
||||
let s0 = s[0];
|
||||
let s1 = s[1];
|
||||
let s2 = s[2];
|
||||
let s3 = s[3];
|
||||
// convert to numbers
|
||||
let n0 = char2int(s0);
|
||||
let n1 = char2int(s1);
|
||||
let n2 = char2int(s2);
|
||||
let n3 = char2int(s3);
|
||||
// abcdef gh1234 5678ab cdefgh
|
||||
// n0 n1 n2 n3
|
||||
// abcdefgh 12345678 abcdefgh
|
||||
// b0 b1 b2
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh1234
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 = (n0 << 2) + (n1 >> 4);
|
||||
// n1 = __gh1234
|
||||
// 16 = ___1____
|
||||
// n1 % 16 = ____1234
|
||||
// (n1 % 16) << 4 = 1234____
|
||||
// n2 = __5678ab
|
||||
// n2 >> 2 = ____5678
|
||||
// b1 = 12345678
|
||||
let b1 = ((n1 % 16) << 4) + (n2 >> 2);
|
||||
// n2 = __5678ab
|
||||
// 4 = _____1__
|
||||
// n2 % 4 = ______ab
|
||||
// (n2 % 4) << 6 = ab______
|
||||
// n3 = __cdefgh
|
||||
let b2 = ((n2 % 4) << 6) + n3;
|
||||
return [b0, b1, b2];
|
||||
}
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode2(s) {
|
||||
// xyz=
|
||||
// pull out strings
|
||||
let s0 = s[0];
|
||||
let s1 = s[1];
|
||||
let s2 = s[2];
|
||||
// convert to numbers
|
||||
let n0 = char2int(s0);
|
||||
let n1 = char2int(s1);
|
||||
let n2 = char2int(s2);
|
||||
// abcdef gh1234 5678__
|
||||
// n0 n1 n2
|
||||
// abcdefgh 12345678
|
||||
// b0 b1
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh1234
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 = (n0 << 2) + (n1 >> 4);
|
||||
// n1 = __gh1234
|
||||
// 16 = ___1____
|
||||
// n1 % 16 = ____1234
|
||||
// (n1 % 16) << 4 = 1234____
|
||||
// n2 = __5678__
|
||||
// n2 >> 2 = ____5678
|
||||
// b1 = 12345678
|
||||
let b1 = ((n1 % 16) << 4) + (n2 >> 2);
|
||||
return [b0, b1];
|
||||
}
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode1(s) {
|
||||
// xy==
|
||||
// pull out strings
|
||||
let s0 = s[0];
|
||||
let s1 = s[1];
|
||||
// convert to numbers
|
||||
let n0 = char2int(s0);
|
||||
let n1 = char2int(s1);
|
||||
// abcdef gh____
|
||||
// n0 n1
|
||||
// abcdefgh
|
||||
// b0
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh____
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 = (n0 << 2) + (n1 >> 4);
|
||||
return [b0];
|
||||
}
|
||||
// FIXME: these tables would *probably* be faster if they were made into objects
|
||||
/**
|
||||
* Conversion table for base64 encode
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function int2char(n) {
|
||||
switch (n) {
|
||||
case 0: return 'A';
|
||||
case 1: return 'B';
|
||||
case 2: return 'C';
|
||||
case 3: return 'D';
|
||||
case 4: return 'E';
|
||||
case 5: return 'F';
|
||||
case 6: return 'G';
|
||||
case 7: return 'H';
|
||||
case 8: return 'I';
|
||||
case 9: return 'J';
|
||||
case 10: return 'K';
|
||||
case 11: return 'L';
|
||||
case 12: return 'M';
|
||||
case 13: return 'N';
|
||||
case 14: return 'O';
|
||||
case 15: return 'P';
|
||||
case 16: return 'Q';
|
||||
case 17: return 'R';
|
||||
case 18: return 'S';
|
||||
case 19: return 'T';
|
||||
case 20: return 'U';
|
||||
case 21: return 'V';
|
||||
case 22: return 'W';
|
||||
case 23: return 'X';
|
||||
case 24: return 'Y';
|
||||
case 25: return 'Z';
|
||||
case 26: return 'a';
|
||||
case 27: return 'b';
|
||||
case 28: return 'c';
|
||||
case 29: return 'd';
|
||||
case 30: return 'e';
|
||||
case 31: return 'f';
|
||||
case 32: return 'g';
|
||||
case 33: return 'h';
|
||||
case 34: return 'i';
|
||||
case 35: return 'j';
|
||||
case 36: return 'k';
|
||||
case 37: return 'l';
|
||||
case 38: return 'm';
|
||||
case 39: return 'n';
|
||||
case 40: return 'o';
|
||||
case 41: return 'p';
|
||||
case 42: return 'q';
|
||||
case 43: return 'r';
|
||||
case 44: return 's';
|
||||
case 45: return 't';
|
||||
case 46: return 'u';
|
||||
case 47: return 'v';
|
||||
case 48: return 'w';
|
||||
case 49: return 'x';
|
||||
case 50: return 'y';
|
||||
case 51: return 'z';
|
||||
case 52: return '0';
|
||||
case 53: return '1';
|
||||
case 54: return '2';
|
||||
case 55: return '3';
|
||||
case 56: return '4';
|
||||
case 57: return '5';
|
||||
case 58: return '6';
|
||||
case 59: return '7';
|
||||
case 60: return '8';
|
||||
case 61: return '9';
|
||||
case 62: return '+';
|
||||
case 63: return '/';
|
||||
default: throw new Error("invalid base64 encode byte: " + n);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Conversion table for base64 decode
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function char2int(s) {
|
||||
switch (s) {
|
||||
case 'A': return 0;
|
||||
case 'B': return 1;
|
||||
case 'C': return 2;
|
||||
case 'D': return 3;
|
||||
case 'E': return 4;
|
||||
case 'F': return 5;
|
||||
case 'G': return 6;
|
||||
case 'H': return 7;
|
||||
case 'I': return 8;
|
||||
case 'J': return 9;
|
||||
case 'K': return 10;
|
||||
case 'L': return 11;
|
||||
case 'M': return 12;
|
||||
case 'N': return 13;
|
||||
case 'O': return 14;
|
||||
case 'P': return 15;
|
||||
case 'Q': return 16;
|
||||
case 'R': return 17;
|
||||
case 'S': return 18;
|
||||
case 'T': return 19;
|
||||
case 'U': return 20;
|
||||
case 'V': return 21;
|
||||
case 'W': return 22;
|
||||
case 'X': return 23;
|
||||
case 'Y': return 24;
|
||||
case 'Z': return 25;
|
||||
case 'a': return 26;
|
||||
case 'b': return 27;
|
||||
case 'c': return 28;
|
||||
case 'd': return 29;
|
||||
case 'e': return 30;
|
||||
case 'f': return 31;
|
||||
case 'g': return 32;
|
||||
case 'h': return 33;
|
||||
case 'i': return 34;
|
||||
case 'j': return 35;
|
||||
case 'k': return 36;
|
||||
case 'l': return 37;
|
||||
case 'm': return 38;
|
||||
case 'n': return 39;
|
||||
case 'o': return 40;
|
||||
case 'p': return 41;
|
||||
case 'q': return 42;
|
||||
case 'r': return 43;
|
||||
case 's': return 44;
|
||||
case 't': return 45;
|
||||
case 'u': return 46;
|
||||
case 'v': return 47;
|
||||
case 'w': return 48;
|
||||
case 'x': return 49;
|
||||
case 'y': return 50;
|
||||
case 'z': return 51;
|
||||
case '0': return 52;
|
||||
case '1': return 53;
|
||||
case '2': return 54;
|
||||
case '3': return 55;
|
||||
case '4': return 56;
|
||||
case '5': return 57;
|
||||
case '6': return 58;
|
||||
case '7': return 59;
|
||||
case '8': return 60;
|
||||
case '9': return 61;
|
||||
case '+': return 62;
|
||||
case '/': return 63;
|
||||
default: throw new Error("invalid base64 character: " + s);
|
||||
}
|
||||
}
|
||||
//# sourceMappingURL=b64.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* Miscellaneous binary utility functions
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { bytes_to_bigint, bigint_to_bytes, concat, strong_rand_bytes };
|
||||
/**
|
||||
* Concatenate two arrays
|
||||
*/
|
||||
declare function concat(arr1: Uint8Array, arr2: Uint8Array): Uint8Array;
|
||||
/**
|
||||
* Cryptographically random bytes
|
||||
*/
|
||||
declare function strong_rand_bytes(how_many: number): Uint8Array;
|
||||
/**
|
||||
* Convert a byte array to a bigint
|
||||
*
|
||||
* Equivalent to `binary:decode_unsigned/1` from Erlang
|
||||
*/
|
||||
declare function bytes_to_bigint(bytes: Uint8Array): bigint;
|
||||
/**
|
||||
* Convert a bigint to a byte array
|
||||
*
|
||||
* Equivalent to `binary:encode_unsigned/1` from Erlang
|
||||
*
|
||||
* Requires input to be positive
|
||||
*/
|
||||
declare function bigint_to_bytes(q: bigint): Uint8Array;
|
||||
@@ -0,0 +1,266 @@
|
||||
/**
|
||||
* Miscellaneous binary utility functions
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { bytes_to_bigint, bigint_to_bytes, concat, strong_rand_bytes };
|
||||
/**
|
||||
* Concatenate two arrays
|
||||
*/
|
||||
function concat(arr1, arr2) {
|
||||
let len1 = arr1.length;
|
||||
let len2 = arr2.length;
|
||||
let arr1_idx0_offset = 0;
|
||||
let arr2_idx0_offset = len1;
|
||||
let result_len = len1 + len2;
|
||||
let result = new Uint8Array(result_len);
|
||||
// copy first array into result
|
||||
for (let arr1_idx0 = 0; arr1_idx0 < len1; arr1_idx0++) {
|
||||
// no offset here
|
||||
let result_idx0 = arr1_idx0 + arr1_idx0_offset;
|
||||
result[result_idx0] = arr1[arr1_idx0];
|
||||
}
|
||||
// copy second array into result
|
||||
for (let arr2_idx0 = 0; arr2_idx0 < len2; arr2_idx0++) {
|
||||
// offset by the length of the first array
|
||||
let result_idx0 = arr2_idx0 + arr2_idx0_offset;
|
||||
result[result_idx0] = arr2[arr2_idx0];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Cryptographically random bytes
|
||||
*/
|
||||
function strong_rand_bytes(how_many) {
|
||||
let arr = new Uint8Array(how_many);
|
||||
(new Crypto()).getRandomValues(arr);
|
||||
return arr;
|
||||
}
|
||||
/**
|
||||
* Convert a byte array to a bigint
|
||||
*
|
||||
* Equivalent to `binary:decode_unsigned/1` from Erlang
|
||||
*/
|
||||
function bytes_to_bigint(bytes) {
|
||||
let n = 0n;
|
||||
for (let b of bytes) {
|
||||
// move first, then add
|
||||
// otherwise it ends on a move
|
||||
// imperative languages are for losers
|
||||
n <<= 8n;
|
||||
n += BigInt(b);
|
||||
}
|
||||
return n;
|
||||
}
|
||||
/**
|
||||
* Convert a bigint to a byte array
|
||||
*
|
||||
* Equivalent to `binary:encode_unsigned/1` from Erlang
|
||||
*
|
||||
* Requires input to be positive
|
||||
*/
|
||||
function bigint_to_bytes(q) {
|
||||
if (q < 0n) {
|
||||
throw new Error('q < 0n: ' + q);
|
||||
}
|
||||
let arr_reverse = [];
|
||||
while (q > 0n) {
|
||||
let r = Number(q % 256n);
|
||||
q /= 256n;
|
||||
arr_reverse.push(r);
|
||||
}
|
||||
arr_reverse.reverse();
|
||||
return new Uint8Array(arr_reverse);
|
||||
}
|
||||
/**
|
||||
* Get an uninitialized bitstring
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bits_null(bit_length) {
|
||||
let byte_length = Math.ceil(bit_length / 8);
|
||||
let result = new Uint8Array(byte_length);
|
||||
return { bit_length: bit_length,
|
||||
bytes: result };
|
||||
}
|
||||
/**
|
||||
* Get a bitstring of a given length where every value is 0.
|
||||
*/
|
||||
function bits_zeros(bit_length) {
|
||||
let byte_length = Math.ceil(bit_length / 8);
|
||||
let result = new Uint8Array(byte_length);
|
||||
for (let i0 = 0; i0 < byte_length; i0++) {
|
||||
result[i0] = 0;
|
||||
}
|
||||
return { bit_length: bit_length,
|
||||
bytes: result };
|
||||
}
|
||||
/**
|
||||
* Get a bitstring of a given length where every value is 1.
|
||||
*/
|
||||
function bits_ones(bit_length) {
|
||||
let byte_length = Math.ceil(bit_length / 8);
|
||||
let result = new Uint8Array(byte_length);
|
||||
// fill everything except the last byte with 255s
|
||||
for (let i0 = 0; i0 < (byte_length - 1); i0++) {
|
||||
result[i0] = 255;
|
||||
}
|
||||
// alright so the last byte
|
||||
// ok so the number of leading 0s is
|
||||
// 8 - (bit_length % 8)
|
||||
let num_trailing_zero_bits = 8 - (bit_length % 8);
|
||||
// the trailing byte is 255 << that
|
||||
// e.g. 3 trailing 0s
|
||||
// 1111_1111 -> 1111_1000
|
||||
let last_byte = 255 << num_trailing_zero_bits;
|
||||
let last_byte_idx0 = byte_length - 1;
|
||||
result[last_byte_idx0] = last_byte;
|
||||
return { bit_length: bit_length,
|
||||
bytes: result };
|
||||
}
|
||||
/**
|
||||
* Get the bit at a given 0-index
|
||||
*/
|
||||
function bits_i0th(bit_idx0, bits) {
|
||||
// first task is figuring out what byte we're at
|
||||
// for instance if we want bit 27
|
||||
// 3*8 = 24 =< 27 < 4*8
|
||||
// so it's Math.floor(bit_idx0 / 8)
|
||||
let byte_idx0 = Math.floor(bit_idx0 / 8);
|
||||
// let's fetch the byte and work with that
|
||||
let the_byte = bits.bytes[byte_idx0];
|
||||
// ok so let's go with 27 again
|
||||
// 27 = 3 mod 8
|
||||
// so we bitshift right by (8 - 3)
|
||||
// and then take the remainder dividing by 2
|
||||
// --B-_---- -> ----_---B -> 0000_000B
|
||||
let bsr = 8 - (bit_idx0 % 8);
|
||||
return (the_byte >> bsr) % 2;
|
||||
}
|
||||
/**
|
||||
* Concatenate two bitstrings
|
||||
*/
|
||||
function bits_concat(bits1, bits2) {
|
||||
let result_bit_length = bits1.bit_length + bits2.bit_length;
|
||||
let bytes1 = bits1.bytes;
|
||||
let bytes2 = bits2.bytes;
|
||||
// using zeros here because of our xor trick in a minute
|
||||
let result_bits = bits_null(result_bit_length);
|
||||
let result_bytes = result_bits.bytes;
|
||||
// go along each byte in result, and compute the byte boundary
|
||||
for (let i = 0; i < result_bytes.length; i++) {
|
||||
// ABCD_EFGH _
|
||||
// 0123_4567 8
|
||||
// this is the bit index of the leftmost bit in this byte
|
||||
let start_bit_bi0 = i * 8;
|
||||
let next_start_bit_bi0 = start_bit_bi0 + 8;
|
||||
// does the bit at the beginning of this byte correspond to the first array?
|
||||
// strict comparison:
|
||||
// suppose i = 0,
|
||||
// suppose bit_length1 is 0
|
||||
// then this says no, go to second array
|
||||
// suppose bl1 = 1,
|
||||
// this says start at first array
|
||||
let start_bit_is_of_first_array = start_bit_bi0 < bits1.bit_length;
|
||||
// weak comparison:
|
||||
// suppose bit_length1 = 8
|
||||
// ABCD_EFGH _
|
||||
// 0123_4567 8
|
||||
// ^
|
||||
// start_bit_bi0 ^ next_start_bit_bi0
|
||||
let stop_bit_is_of_first_array = next_start_bit_bi0 <= bits1.bit_length;
|
||||
// is this a bytes1 byte
|
||||
let is_bytes1_byte = start_bit_is_of_first_array && stop_bit_is_of_first_array;
|
||||
let is_boundary_byte = start_bit_is_of_first_array && !stop_bit_is_of_first_array;
|
||||
// need to work out the ping_pong bs up here because js is dumb and I
|
||||
// can't put lets between elseifs
|
||||
// alright, now we're in the case of only copying from the second array
|
||||
// we have two cases:
|
||||
// ping-pong:
|
||||
// ABCD_EFGH 1234_5678
|
||||
// - ---- ---
|
||||
// copying these bits
|
||||
// ping:
|
||||
// ABCD_EFGH <end>
|
||||
// - ---- 000
|
||||
//
|
||||
// how to distinguish between these two??
|
||||
//
|
||||
// we're in the ping case when the start_bit_bi0 corresponds to the
|
||||
// final byte of the second array
|
||||
//
|
||||
// ok
|
||||
//
|
||||
// we need to compute the bit address in the second array that
|
||||
// corresponds to the bit address at the beginning of this byte in the
|
||||
// result array
|
||||
let bits2_addr_bi0 = start_bit_bi0 - bits1.bit_length;
|
||||
// I think the variable is
|
||||
// bits_left_to_copy = bits2.bit_length - bit_addr2_bi0
|
||||
// no + 1 because the current bit is uncopied,
|
||||
// so if bit_addr2_bi0 = 7 and bits2.bit_length is 8, it means we
|
||||
// have the last bit to copy
|
||||
// cases:
|
||||
// bits_left_to_copy <= 0 ->
|
||||
// this would mean we have more bits to copy, but are out of
|
||||
// source bits. should be impossible if bits_null is correct
|
||||
// bits_left_to_copy <= 8 ->
|
||||
// this would mean we are going to fill this last byte in the
|
||||
// result array with the correct bits from array2, but how we
|
||||
// do this will depend on how those are arranged in bytes2
|
||||
// (whether we grab one or two bytes)
|
||||
//
|
||||
// this is the tricky case
|
||||
//
|
||||
// I think what matters here is the byte address in the second array
|
||||
// if we're on the last byte
|
||||
// 8 < bits_left_to_copy ->
|
||||
// this means we can safely grab two bytes from bytes2, and do
|
||||
// our bitshifting to make it correct
|
||||
//
|
||||
// FIXME
|
||||
let bits_left_to_copy = bits2.bit_length - bits2_addr_bi0;
|
||||
// no the variable that matters is which byte we're on in the result
|
||||
let this_bytes2_addr_i0 = Math.floor(bits2_addr_bi0 / 8);
|
||||
let next_bytes2_addr_i0 = this_bytes2_addr_i0 + 1;
|
||||
let bitshift_amt = bits1.bit_length % 8;
|
||||
let ping = next_bytes2_addr_i0 === bytes2.length;
|
||||
// simple case: this is a byte from the first array
|
||||
// just copy it
|
||||
if (is_bytes1_byte)
|
||||
result_bytes[i] = bytes1[i];
|
||||
// this is a boundary byte
|
||||
// further cases:
|
||||
// second bit length is 0 ->
|
||||
// ABCD_EF-- <empty>
|
||||
// ^ starting here
|
||||
// just copy first byte and move along
|
||||
else if (is_boundary_byte && (bits2.bit_length === 0))
|
||||
result_bytes[i] = bytes1[i];
|
||||
// boundary byte, and there is at least one byte in the second array
|
||||
else if (is_boundary_byte) {
|
||||
// copy over the first byte
|
||||
result_bytes[i] = bytes1[i];
|
||||
// take the first byte from the second array
|
||||
let first_byte_of_second_array = bytes2[0];
|
||||
// bytes1:
|
||||
// ABCD_EF00
|
||||
// 6
|
||||
// bytes2:
|
||||
// 1234_5678
|
||||
// 0000_0012
|
||||
// and bitshift it right by that amount
|
||||
let bitshift_amt = bits1.bit_length % 8;
|
||||
result_bytes[i] ^= first_byte_of_second_array >> bitshift_amt;
|
||||
}
|
||||
// last byte of second array
|
||||
else if (ping)
|
||||
result_bytes[i] = (bytes2[this_bytes2_addr_i0] << bitshift_amt);
|
||||
// ping-pong: not last byte of second array
|
||||
else
|
||||
result_bytes[i] = (bytes2[this_bytes2_addr_i0] << bitshift_amt) ^ (bytes2[next_bytes2_addr_i0] << bitshift_amt);
|
||||
}
|
||||
return { bit_length: result_bit_length,
|
||||
bytes: result_bytes };
|
||||
}
|
||||
//# sourceMappingURL=bin.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* FÆRT: Fast Æternity Recovery Text
|
||||
*
|
||||
* Reference: https://gitlab.com/zxq9/passgas/-/blob/83607fedb08be5dfd03210e331f9c76125bb3467/fullofbeans
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { encode, decode, byte_of_word, check_word, check_byte, words };
|
||||
import * as safe from './safe.js';
|
||||
/**
|
||||
* Encode a bytestring into FÆRT
|
||||
*/
|
||||
declare function encode(bytes: Uint8Array): string;
|
||||
/**
|
||||
* Decode a FAERT string into bytes
|
||||
*/
|
||||
declare function decode(faert: string): safe.Safe<Uint8Array, string>;
|
||||
/**
|
||||
* given a word, find its index
|
||||
*/
|
||||
declare function byte_of_word(word: string): safe.Safe<number, string>;
|
||||
/**
|
||||
* compute the check word of an array
|
||||
*/
|
||||
declare function check_word(bytes: Uint8Array): string;
|
||||
/**
|
||||
* given an array, compute the xor of all the bytes in the array
|
||||
*/
|
||||
declare function check_byte(bytes: Uint8Array): number;
|
||||
declare let words: string[];
|
||||
@@ -0,0 +1,344 @@
|
||||
/**
|
||||
* FÆRT: Fast Æternity Recovery Text
|
||||
*
|
||||
* Reference: https://gitlab.com/zxq9/passgas/-/blob/83607fedb08be5dfd03210e331f9c76125bb3467/fullofbeans
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { encode, decode, byte_of_word, check_word, check_byte, words };
|
||||
import * as safe from './safe.js';
|
||||
/**
|
||||
* Encode a bytestring into FÆRT
|
||||
*/
|
||||
function encode(bytes) {
|
||||
// initial accumulator
|
||||
let words_acc = [];
|
||||
// go along each byte and look up the word
|
||||
// add it to the accumulator
|
||||
for (let this_byte of bytes) {
|
||||
let this_word = words[this_byte];
|
||||
words_acc.push(this_word);
|
||||
}
|
||||
// prepend check word to phrase
|
||||
// yes craig it would be faster to do the check byte inline
|
||||
// the usage case here is 64 byte strings
|
||||
// double pass is not a big deal
|
||||
return check_word(bytes) + ' ' + words_acc.join(' ');
|
||||
}
|
||||
/**
|
||||
* Decode a FAERT string into bytes
|
||||
*/
|
||||
function decode(faert) {
|
||||
let all_words = faert.split(' ');
|
||||
let input_check_word = all_words[0];
|
||||
let input_words = all_words.slice(1);
|
||||
// accumulator
|
||||
let computed_bytes = [];
|
||||
// loop over words and figure out accumulator
|
||||
for (let this_input_word of input_words) {
|
||||
let maybe_this_byte = byte_of_word(this_input_word);
|
||||
// if the word is an allowable word, add it to the accumulator
|
||||
if (maybe_this_byte.ok) {
|
||||
let this_byte = maybe_this_byte.result;
|
||||
computed_bytes.push(this_byte);
|
||||
}
|
||||
// error case, propagate the error up the call chain
|
||||
else
|
||||
return maybe_this_byte;
|
||||
}
|
||||
// at this point, we can assume we correctly decoded all words
|
||||
// compute the check byte
|
||||
let computed_bytes_u8s = new Uint8Array(computed_bytes);
|
||||
let computed_check_word = check_word(computed_bytes_u8s);
|
||||
// check if it is correct
|
||||
// if so, return the computed bytes
|
||||
if (computed_check_word === input_check_word)
|
||||
return safe.ok(computed_bytes_u8s);
|
||||
// otherwise, return an error
|
||||
else
|
||||
return safe.error('checksum failure! computed check word: ' + computed_check_word + '; input check word: ' + input_check_word);
|
||||
}
|
||||
/**
|
||||
* given a word, find its index
|
||||
*/
|
||||
function byte_of_word(word) {
|
||||
for (let i = 0; i <= 255; i++) {
|
||||
if (word === words[i])
|
||||
return safe.ok(i);
|
||||
}
|
||||
return safe.error('invalid word: ' + word);
|
||||
}
|
||||
/**
|
||||
* compute the check word of an array
|
||||
*/
|
||||
function check_word(bytes) {
|
||||
return words[check_byte(bytes)];
|
||||
}
|
||||
/**
|
||||
* given an array, compute the xor of all the bytes in the array
|
||||
*/
|
||||
function check_byte(bytes) {
|
||||
let check_byte = 0;
|
||||
for (let this_byte of bytes)
|
||||
check_byte ^= this_byte;
|
||||
return check_byte;
|
||||
}
|
||||
let words = [
|
||||
"able",
|
||||
"abuse",
|
||||
"acquire",
|
||||
"adjust",
|
||||
"agent",
|
||||
"air",
|
||||
"alert",
|
||||
"alpha",
|
||||
"anger",
|
||||
"answer",
|
||||
"any",
|
||||
"argue",
|
||||
"around",
|
||||
"assume",
|
||||
"asthma",
|
||||
"aunt",
|
||||
"awkward",
|
||||
"balcony",
|
||||
"barrel",
|
||||
"because",
|
||||
"behave",
|
||||
"bicycle",
|
||||
"bike",
|
||||
"blind",
|
||||
"blouse",
|
||||
"bonus",
|
||||
"bottom",
|
||||
"breeze",
|
||||
"brother",
|
||||
"bubble",
|
||||
"burger",
|
||||
"butter",
|
||||
"can",
|
||||
"cannon",
|
||||
"cargo",
|
||||
"catalog",
|
||||
"caught",
|
||||
"century",
|
||||
"chaos",
|
||||
"chicken",
|
||||
"churn",
|
||||
"cinnamon",
|
||||
"clever",
|
||||
"clock",
|
||||
"clown",
|
||||
"collect",
|
||||
"conduct",
|
||||
"convince",
|
||||
"correct",
|
||||
"cradle",
|
||||
"crane",
|
||||
"crime",
|
||||
"cross",
|
||||
"crystal",
|
||||
"curve",
|
||||
"daughter",
|
||||
"debris",
|
||||
"decrease",
|
||||
"deny",
|
||||
"deputy",
|
||||
"despair",
|
||||
"diesel",
|
||||
"dinner",
|
||||
"distance",
|
||||
"document",
|
||||
"donate",
|
||||
"drama",
|
||||
"drink",
|
||||
"dutch",
|
||||
"earth",
|
||||
"educate",
|
||||
"elbow",
|
||||
"employ",
|
||||
"endless",
|
||||
"enlist",
|
||||
"enter",
|
||||
"equal",
|
||||
"eternal",
|
||||
"example",
|
||||
"exhibit",
|
||||
"exotic",
|
||||
"faculty",
|
||||
"famous",
|
||||
"fault",
|
||||
"feature",
|
||||
"fiber",
|
||||
"filter",
|
||||
"firm",
|
||||
"flame",
|
||||
"flush",
|
||||
"follow",
|
||||
"forward",
|
||||
"frame",
|
||||
"fringe",
|
||||
"future",
|
||||
"game",
|
||||
"gate",
|
||||
"gift",
|
||||
"glare",
|
||||
"glow",
|
||||
"goat",
|
||||
"grab",
|
||||
"grief",
|
||||
"guilt",
|
||||
"hand",
|
||||
"hawk",
|
||||
"health",
|
||||
"hen",
|
||||
"hire",
|
||||
"honey",
|
||||
"hover",
|
||||
"hurry",
|
||||
"hybrid",
|
||||
"impose",
|
||||
"inch",
|
||||
"inherit",
|
||||
"injury",
|
||||
"install",
|
||||
"iron",
|
||||
"jazz",
|
||||
"joke",
|
||||
"just",
|
||||
"kit",
|
||||
"kitchen",
|
||||
"language",
|
||||
"laundry",
|
||||
"leader",
|
||||
"lend",
|
||||
"leopard",
|
||||
"license",
|
||||
"live",
|
||||
"lobster",
|
||||
"lounge",
|
||||
"magnet",
|
||||
"mail",
|
||||
"mansion",
|
||||
"mass",
|
||||
"math",
|
||||
"media",
|
||||
"message",
|
||||
"metal",
|
||||
"misery",
|
||||
"mix",
|
||||
"more",
|
||||
"mountain",
|
||||
"museum",
|
||||
"mutual",
|
||||
"narrow",
|
||||
"nerve",
|
||||
"next",
|
||||
"note",
|
||||
"obey",
|
||||
"obtain",
|
||||
"offer",
|
||||
"once",
|
||||
"orange",
|
||||
"ostrich",
|
||||
"over",
|
||||
"owner",
|
||||
"palace",
|
||||
"patch",
|
||||
"pave",
|
||||
"pen",
|
||||
"phrase",
|
||||
"piece",
|
||||
"pizza",
|
||||
"plunge",
|
||||
"polar",
|
||||
"pool",
|
||||
"power",
|
||||
"pretty",
|
||||
"private",
|
||||
"protect",
|
||||
"pulp",
|
||||
"purity",
|
||||
"quit",
|
||||
"quote",
|
||||
"raise",
|
||||
"razor",
|
||||
"recall",
|
||||
"region",
|
||||
"relief",
|
||||
"rent",
|
||||
"rescue",
|
||||
"review",
|
||||
"ride",
|
||||
"risk",
|
||||
"roof",
|
||||
"rough",
|
||||
"saddle",
|
||||
"salmon",
|
||||
"sand",
|
||||
"scene",
|
||||
"scrub",
|
||||
"season",
|
||||
"seek",
|
||||
"series",
|
||||
"shed",
|
||||
"shoe",
|
||||
"sick",
|
||||
"silent",
|
||||
"situate",
|
||||
"skill",
|
||||
"slide",
|
||||
"slush",
|
||||
"snack",
|
||||
"solar",
|
||||
"soul",
|
||||
"special",
|
||||
"sphere",
|
||||
"spot",
|
||||
"spy",
|
||||
"stairs",
|
||||
"stereo",
|
||||
"strategy",
|
||||
"stuff",
|
||||
"success",
|
||||
"sunny",
|
||||
"surge",
|
||||
"swear",
|
||||
"symptom",
|
||||
"tail",
|
||||
"ten",
|
||||
"tent",
|
||||
"theme",
|
||||
"thumb",
|
||||
"tiny",
|
||||
"toe",
|
||||
"tooth",
|
||||
"topic",
|
||||
"trade",
|
||||
"trash",
|
||||
"trophy",
|
||||
"truly",
|
||||
"tumble",
|
||||
"typical",
|
||||
"uncle",
|
||||
"unfair",
|
||||
"until",
|
||||
"upper",
|
||||
"useless",
|
||||
"van",
|
||||
"venue",
|
||||
"video",
|
||||
"visa",
|
||||
"vocal",
|
||||
"walk",
|
||||
"waste",
|
||||
"wedding",
|
||||
"weekend",
|
||||
"wide",
|
||||
"winner",
|
||||
"wise",
|
||||
"wood",
|
||||
"wrist",
|
||||
"zero"
|
||||
];
|
||||
//# sourceMappingURL=faert.js.map
|
||||
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"faert.js","sourceRoot":"","sources":["../src/faert.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACH,MAAM,EACN,MAAM,EACN,YAAY,EACZ,UAAU,EACV,UAAU,EACV,KAAK,EACR,CAAA;AAED,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAIlC;;GAEG;AACH,SACA,MAAM,CACD,KAAkB;IAGnB,sBAAsB;IACtB,IAAI,SAAS,GAAoB,EAAE,CAAC;IAEpC,0CAA0C;IAC1C,4BAA4B;IAC5B,KAAK,IAAI,SAAS,IAAI,KAAK,EAC3B;QACI,IAAI,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QACjC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC7B;IAED,+BAA+B;IAC/B,2DAA2D;IAC3D,yCAAyC;IACzC,gCAAgC;IAChC,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzD,CAAC;AAID;;GAEG;AACH,SACA,MAAM,CACD,KAAc;IAGf,IAAI,SAAS,GAA0B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxD,IAAI,gBAAgB,GAAmB,SAAS,CAAC,CAAC,CAAC,CAAC;IACpD,IAAI,WAAW,GAAwB,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAEzD,cAAc;IACd,IAAI,cAAc,GAAmB,EAAE,CAAC;IAExC,6CAA6C;IAC7C,KAAK,IAAI,eAAe,IAAI,WAAW,EACvC;QACI,IAAI,eAAe,GAA+B,YAAY,CAAC,eAAe,CAAC,CAAC;QAChF,8DAA8D;QAC9D,IAAI,eAAe,CAAC,EAAE,EACtB;YACI,IAAI,SAAS,GAAY,eAAe,CAAC,MAAM,CAAC;YAChD,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAClC;QACD,oDAAoD;;YAEhD,OAAO,eAAe,CAAC;KAC9B;IAED,8DAA8D;IAC9D,yBAAyB;IACzB,IAAI,kBAAkB,GAAiB,IAAI,UAAU,CAAC,cAAc,CAAC,CAAC;IACtE,IAAI,mBAAmB,GAAY,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAElE,yBAAyB;IACzB,mCAAmC;IACnC,IAAI,mBAAmB,KAAK,gBAAgB;QACxC,OAAO,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;IACvC,6BAA6B;;QAEzB,OAAO,IAAI,CAAC,KAAK,CAAC,yCAAyC,GAAG,mBAAmB,GAAG,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;AACvI,CAAC;AAID;;GAEG;AACH,SACA,YAAY,CACP,IAAY;IAGb,KAAK,IAAI,CAAC,GAAC,CAAC,EAAE,CAAC,IAAE,GAAG,EAAE,CAAC,EAAE,EACzB;QACI,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC;YACjB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KACzB;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;AAC/C,CAAC;AAID;;GAEG;AACH,SACA,UAAU,CACL,KAAiB;IAGlB,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AACpC,CAAC;AAGD;;GAEG;AACH,SACA,UAAU,CACL,KAAiB;IAGlB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,IAAI,SAAS,IAAI,KAAK;QACvB,UAAU,IAAI,SAAS,CAAC;IAC5B,OAAO,UAAU,CAAC;AACtB,CAAC;AAID,IAAI,KAAK,GAAG;IACR,MAAM;IACN,OAAO;IACP,SAAS;IACT,QAAQ;IACR,OAAO;IACP,KAAK;IACL,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,KAAK;IACL,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,SAAS;IACT,SAAS;IACT,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,OAAO;IACP,SAAS;IACT,QAAQ;IACR,SAAS;IACT,OAAO;IACP,SAAS;IACT,OAAO;IACP,UAAU;IACV,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,SAAS;IACT,UAAU;IACV,SAAS;IACT,QAAQ;IACR,OAAO;IACP,OAAO;IACP,OAAO;IACP,SAAS;IACT,OAAO;IACP,UAAU;IACV,QAAQ;IACR,UAAU;IACV,MAAM;IACN,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,UAAU;IACV,QAAQ;IACR,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,SAAS;IACT,OAAO;IACP,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,SAAS;IACT,SAAS;IACT,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,OAAO;IACP,SAAS;IACT,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;IACR,SAAS;IACT,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,QAAQ;IACR,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,SAAS;IACT,QAAQ;IACR,SAAS;IACT,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,SAAS;IACT,UAAU;IACV,SAAS;IACT,QAAQ;IACR,MAAM;IACN,SAAS;IACT,SAAS;IACT,MAAM;IACN,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,SAAS;IACT,MAAM;IACN,MAAM;IACN,OAAO;IACP,SAAS;IACT,OAAO;IACP,QAAQ;IACR,KAAK;IACL,MAAM;IACN,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,QAAQ;IACR,OAAO;IACP,MAAM;IACN,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,QAAQ;IACR,OAAO;IACP,MAAM;IACN,KAAK;IACL,QAAQ;IACR,OAAO;IACP,OAAO;IACP,QAAQ;IACR,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,SAAS;IACT,SAAS;IACT,MAAM;IACN,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,QAAQ;IACR,SAAS;IACT,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,MAAM;IACN,SAAS;IACT,QAAQ;IACR,MAAM;IACN,KAAK;IACL,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,OAAO;IACP,SAAS;IACT,OAAO;IACP,OAAO;IACP,OAAO;IACP,SAAS;IACT,MAAM;IACN,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,KAAK;IACL,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,SAAS;IACT,OAAO;IACP,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,KAAK;IACL,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,SAAS;IACT,SAAS;IACT,MAAM;IACN,QAAQ;IACR,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;CACT,CAAA"}
|
||||
@@ -0,0 +1,37 @@
|
||||
/**
|
||||
* Ethereum Recursive-Length Prefix Encoding implementation
|
||||
*
|
||||
* Two reference implementations:
|
||||
*
|
||||
* 1. Ethereum Python implementation
|
||||
* 2. My Erlang implementation (agrees with Ethereum Python in randomized
|
||||
* tests)
|
||||
*
|
||||
* This work can be found in ../test/testgen/
|
||||
*
|
||||
* FIXME: need to have Safe assertions for "i am decoding a list", "i am
|
||||
* decoding a binary", "I am decoding something with no remainder", etc
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { decoded_data, decode_result, decode, encode };
|
||||
/**
|
||||
* Data that RLP can encode. Also the result of decoding.
|
||||
*/
|
||||
declare type decoded_data = Uint8Array | Array<decoded_data>;
|
||||
/**
|
||||
* Decoding can have a remainder
|
||||
*/
|
||||
declare type decode_result = {
|
||||
decoded_data: decoded_data;
|
||||
remainder: Uint8Array;
|
||||
};
|
||||
/**
|
||||
* Decode an RLP-encoded bytestring into a `decode_result` (decoded data +
|
||||
* whatever wasn't consumed)
|
||||
*/
|
||||
declare function decode(bytes: Uint8Array): decode_result;
|
||||
/**
|
||||
* Encode some decoded data
|
||||
*/
|
||||
declare function encode(data: decoded_data): Uint8Array;
|
||||
@@ -0,0 +1,382 @@
|
||||
/**
|
||||
* Ethereum Recursive-Length Prefix Encoding implementation
|
||||
*
|
||||
* Two reference implementations:
|
||||
*
|
||||
* 1. Ethereum Python implementation
|
||||
* 2. My Erlang implementation (agrees with Ethereum Python in randomized
|
||||
* tests)
|
||||
*
|
||||
* This work can be found in ../test/testgen/
|
||||
*
|
||||
* FIXME: need to have Safe assertions for "i am decoding a list", "i am
|
||||
* decoding a binary", "I am decoding something with no remainder", etc
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { decode, encode };
|
||||
/**
|
||||
* Decode an RLP-encoded bytestring into a `decode_result` (decoded data +
|
||||
* whatever wasn't consumed)
|
||||
*/
|
||||
function decode(bytes) {
|
||||
// check the first byte
|
||||
let first_byte = bytes[0];
|
||||
let rest = bytes.slice(1);
|
||||
// if the first byte is between 0 and 127, that is the data
|
||||
if (first_byte <= 127) {
|
||||
return dr(new Uint8Array([first_byte]), rest);
|
||||
}
|
||||
// if the first byte is between 128 and 183 = 128 + 55, it is a bytestring
|
||||
// and the length is Byte - 128
|
||||
else if (first_byte <= 183) {
|
||||
let payload_byte_length = first_byte - 128;
|
||||
let payload = rest.slice(0, payload_byte_length);
|
||||
let rest2 = rest.slice(payload_byte_length);
|
||||
return dr(payload, rest2);
|
||||
}
|
||||
// if the first byte is between 184 = 183 + 1 and 191 = 183 + 8, it is a
|
||||
// bytestring. the byte length of bytestring is FirstByte - 183. Then pull
|
||||
// out the actual data
|
||||
else if (first_byte <= 191) {
|
||||
let byte_length_of_byte_length = first_byte - 183;
|
||||
let bytes_of_byte_length = rest.slice(0, byte_length_of_byte_length);
|
||||
let byte_length = bytes_to_number(bytes_of_byte_length);
|
||||
let bytes = rest.slice(byte_length_of_byte_length, byte_length + byte_length_of_byte_length);
|
||||
let rest2 = rest.slice(byte_length + byte_length_of_byte_length);
|
||||
return dr(bytes, rest2);
|
||||
}
|
||||
// If the first byte is between 192 and 247 = 192 + 55, it is a list. The
|
||||
// byte length of the list-payload is FirstByte - 192. Then the list
|
||||
// payload, which needs to be decoded on its own.
|
||||
else if (first_byte <= 247) {
|
||||
let byte_length_of_list = first_byte - 192;
|
||||
let list_payload = rest.slice(0, byte_length_of_list);
|
||||
let list = decode_list(list_payload);
|
||||
let rest2 = rest.slice(byte_length_of_list);
|
||||
return dr(list, rest2);
|
||||
}
|
||||
// If the first byte is between 248 = 247 + 1 and 255 = 247 + 8, it is a
|
||||
// list. The byte length of the byte length of the list-payload is
|
||||
// FirstByte - 247. Then the byte length of the list. Then the list
|
||||
// payload, which needs to be decoded on its own.
|
||||
else {
|
||||
let byte_length_of_byte_length = first_byte - 247;
|
||||
let bytes_of_byte_length = rest.slice(0, byte_length_of_byte_length);
|
||||
let byte_length = bytes_to_number(bytes_of_byte_length);
|
||||
let list_bytes = rest.slice(byte_length_of_byte_length, byte_length + byte_length_of_byte_length);
|
||||
let list = decode_list(list_bytes);
|
||||
let rest2 = rest.slice(byte_length + byte_length_of_byte_length);
|
||||
return dr(list, rest2);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Decode a list payload (non-prefixed) into an `Array<decoded_data>`.
|
||||
*
|
||||
* Repeatedly decodes an element off the list until remainder is empty.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_list(bytes) {
|
||||
let arr = [];
|
||||
while (bytes.length > 0) {
|
||||
// grab an item off the bytes
|
||||
let { decoded_data, remainder } = decode(bytes);
|
||||
// push it
|
||||
arr.push(decoded_data);
|
||||
// update bytes
|
||||
bytes = remainder;
|
||||
}
|
||||
return arr;
|
||||
}
|
||||
/**
|
||||
* Convert bytestring to number
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bytes_to_number(bytes) {
|
||||
let n = 0;
|
||||
for (let b of bytes) {
|
||||
n <<= 8;
|
||||
n += b;
|
||||
}
|
||||
return n;
|
||||
}
|
||||
/**
|
||||
* Make a `decode_result` containing the two arguments
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function dr(x, y) {
|
||||
return { decoded_data: x,
|
||||
remainder: y };
|
||||
}
|
||||
//=============================================================================
|
||||
//=============================================================================
|
||||
// ENCODING
|
||||
//=============================================================================
|
||||
//=============================================================================
|
||||
/**
|
||||
* Encode some decoded data
|
||||
*/
|
||||
function encode(data) {
|
||||
// is it an array or data
|
||||
if (is_binary(data)) {
|
||||
return encode_binary(data);
|
||||
}
|
||||
else if (is_list(data)) {
|
||||
return encode_list(data);
|
||||
}
|
||||
else {
|
||||
throw new Error('encode told to encode something that is not an array or a binary: ' + data);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Encode a binary into RLP
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_binary(bytes) {
|
||||
let len = bytes.length;
|
||||
// single byte case when the byte is between 0..127
|
||||
// result is the bytestring containing the byte itself
|
||||
if ((len === 1) &&
|
||||
(bytes[0] <= 127)) {
|
||||
return bytes;
|
||||
}
|
||||
// if the bytestring is 0..55 bytes long, the first byte in the result is
|
||||
// 128 + Length, the rest of the result bytestring is the input string
|
||||
else if (len <= 55) {
|
||||
// construct the result
|
||||
// <<128 + Len, Bytes/binary>>
|
||||
let result = new Uint8Array(len + 1);
|
||||
// first byte is 128 + length
|
||||
result[0] = 128 + len;
|
||||
// copy input bytes into result
|
||||
for (let input_idx0 = 0; input_idx0 < len; input_idx0++) {
|
||||
let result_idx0 = input_idx0 + 1;
|
||||
result[result_idx0] = bytes[input_idx0];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
// if the bytestring is more than 55 bytes long, the first byte is 183 +
|
||||
// ByteLengthOfByteLength, followed by the byte length, followed by the
|
||||
// bytes
|
||||
else {
|
||||
let len_bytes = encode_unsigned(len);
|
||||
let len_bytes_length = len_bytes.length;
|
||||
// total array is
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
let result = new Uint8Array(1 + len_bytes_length + len);
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
result[0] = 183 + len_bytes_length;
|
||||
// copy len_bytes into result
|
||||
for (let len_bytes_idx0 = 0; len_bytes_idx0 < len_bytes_length; len_bytes_idx0++) {
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
let result_idx0 = len_bytes_idx0 + 1;
|
||||
result[result_idx0] = len_bytes[len_bytes_idx0];
|
||||
}
|
||||
// copy original byte array into result
|
||||
for (let input_idx0 = 0; input_idx0 < len; input_idx0++) {
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
let result_idx0 = input_idx0 + (1 + len_bytes_length);
|
||||
result[result_idx0] = bytes[input_idx0];
|
||||
}
|
||||
// finally, return the result
|
||||
return result;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Encode a list
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_list(list) {
|
||||
// first encode every element in the list, then branch
|
||||
let payloads = list.map(encode);
|
||||
let payload = uint8arr_concat(payloads);
|
||||
let payload_size = payload.length;
|
||||
// if the payload size is in 0..55, then the first byte is 192 + payload
|
||||
// size, followed by the payload
|
||||
if (payload_size <= 55) {
|
||||
// result: <<(192 + Payload_Size), Payload/binary >>;
|
||||
// 1 byte payload_size bytes
|
||||
let result = new Uint8Array(1 + payload_size);
|
||||
// result: <<(192 + Payload_Size), Payload/binary >>;
|
||||
// 1 byte payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
result[0] = 192 + payload_size;
|
||||
// copy the rest of the payload into result
|
||||
for (let payload_idx0 = 0; payload_idx0 < payload_size; payload_idx0++) {
|
||||
// result: <<(192 + Payload_Size), Payload/binary >>;
|
||||
// 1 byte payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
let result_idx0 = payload_idx0 + 1;
|
||||
result[result_idx0] = payload[payload_idx0];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
// if the payload size is greater than 55, the first byte is 247 +
|
||||
// size_of_payload_size, followed by the payload size, followed by the
|
||||
// payload
|
||||
else {
|
||||
// compute the payload size size
|
||||
let payload_size_bytes = encode_unsigned(payload_size);
|
||||
let payload_size_size = payload_size_bytes.length;
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
let result = new Uint8Array(1 + payload_size_size + payload_size);
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
// first byte is 247 + payload_size_size
|
||||
result[0] = 247 + payload_size_size;
|
||||
// copy the payload_size_bytes into result
|
||||
for (let psb_idx0 = 0; psb_idx0 < payload_size_size; psb_idx0++) {
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
// offset is 1 byte for this
|
||||
let result_idx0 = psb_idx0 + 1;
|
||||
result[result_idx0] = payload_size_bytes[psb_idx0];
|
||||
}
|
||||
// copy the payload into result
|
||||
for (let pb_idx0 = 0; pb_idx0 < payload_size; pb_idx0++) {
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
// offset is 1 + payload_size_size bytes for this
|
||||
let result_idx0 = pb_idx0 + (1 + payload_size_size);
|
||||
result[result_idx0] = payload[pb_idx0];
|
||||
}
|
||||
// finally, return result
|
||||
return result;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Encode a number as a bytestring
|
||||
*
|
||||
* Not for general use, this assumes the input number is greater than 55
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_unsigned(n) {
|
||||
// can assume that n initially is greater than 55
|
||||
// have to encode it in reverse order
|
||||
let arr = [];
|
||||
// repeated division by 256 with remainder
|
||||
//
|
||||
// example: suppose bign was 1234 and we were dividing by 10
|
||||
//
|
||||
// iteration 0:
|
||||
// bign = 1234
|
||||
// arr = []
|
||||
// ---
|
||||
// bign / 10 = 123
|
||||
// bign % 10 = 4
|
||||
// ---
|
||||
// bign = 123
|
||||
// arr = [4]
|
||||
//
|
||||
// iteration 1:
|
||||
// bign = 123
|
||||
// arr = [4]
|
||||
// ---
|
||||
// bign / 10 = 12
|
||||
// bign % 10 = 3
|
||||
// ---
|
||||
// bign = 12
|
||||
// arr = [4, 3]
|
||||
//
|
||||
// iteration 2:
|
||||
// bign = 12
|
||||
// arr = [4, 3]
|
||||
// ---
|
||||
// bign / 10 = 1
|
||||
// bign % 10 = 2
|
||||
// ---
|
||||
// bign = 1
|
||||
// arr = [4, 3, 2]
|
||||
//
|
||||
// iteration 3:
|
||||
// bign = 1
|
||||
// arr = [4, 3, 2]
|
||||
// ---
|
||||
// bign / 10 = 0
|
||||
// bign % 10 = 1
|
||||
// ---
|
||||
// bign = 0
|
||||
// arr = [4, 3, 2, 1]
|
||||
//
|
||||
// iteration 4:
|
||||
// bign = 0
|
||||
// arr = [4, 3, 2, 1]
|
||||
// ---
|
||||
// DONE
|
||||
while (n > 0) {
|
||||
arr.push(n % 256);
|
||||
n >>= 8;
|
||||
}
|
||||
// reverse and make into Uint8Array
|
||||
arr.reverse();
|
||||
return new Uint8Array(arr);
|
||||
}
|
||||
/**
|
||||
* concatenate an array of `Uint8Array`s into a single Uint8Array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function uint8arr_concat(arrs) {
|
||||
// total length
|
||||
let total_len = arrs.reduce(// fold
|
||||
function (acc_len, this_uint8array) {
|
||||
return acc_len + this_uint8array.length;
|
||||
},
|
||||
// initial accumulator
|
||||
0);
|
||||
// start up result
|
||||
let result = new Uint8Array(total_len);
|
||||
let result_idx0 = 0;
|
||||
// concatenate
|
||||
for (let this_uint8arr of arrs) {
|
||||
// bytewise copy of this uint8array
|
||||
for (let this_uint8arr_idx0 = 0; this_uint8arr_idx0 < this_uint8arr.length; this_uint8arr_idx0++) {
|
||||
// copy byte and increment result idx0
|
||||
result[result_idx0] = this_uint8arr[this_uint8arr_idx0];
|
||||
result_idx0++;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* returns true if input is `instanceof Uint8Array`
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function is_binary(x) {
|
||||
return (x instanceof Uint8Array);
|
||||
}
|
||||
/**
|
||||
* returns true if input is `instanceof Array`
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function is_list(x) {
|
||||
return (x instanceof Array);
|
||||
}
|
||||
//# sourceMappingURL=rlp.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,66 @@
|
||||
/**
|
||||
* "Safe" error handling
|
||||
*
|
||||
* The idea here is that there are situations where it is known
|
||||
*
|
||||
* ```typescript
|
||||
* type Safe<ok_t, err_t>
|
||||
* = Ok<ok_t>
|
||||
* | Error<err_t>;
|
||||
*
|
||||
* type Ok<ok_t>
|
||||
* = {ok : true,
|
||||
* result : ok_t};
|
||||
*
|
||||
* type Error<err_t>
|
||||
* = {ok : false,
|
||||
* error : err_t};
|
||||
* ```
|
||||
*
|
||||
* 1. a given function call is likely to fail
|
||||
* 2. the likely errors can be enumerated
|
||||
*
|
||||
* These are called "positive errors". An example would be a page script
|
||||
* asking a browser wallet extension to sign a transaction. The following
|
||||
* errors, among others, are likely:
|
||||
*
|
||||
* - the user does not have a wallet installed
|
||||
* - the user has a wallet but does not have the correct signing key
|
||||
* - the user rejects the transaction
|
||||
* - the sign request timed out
|
||||
*
|
||||
* These errors should not generate exceptions, as these behaviors are to some
|
||||
* degree "expected".
|
||||
*/
|
||||
export { Safe, Ok, Error, ok, error, unsafe };
|
||||
/**
|
||||
* Type that catches positive errors
|
||||
*/
|
||||
declare type Safe<ok_t, err_t> = Ok<ok_t> | Error<err_t>;
|
||||
/**
|
||||
* Ok type
|
||||
*/
|
||||
declare type Ok<ok_t> = {
|
||||
ok: true;
|
||||
result: ok_t;
|
||||
};
|
||||
/**
|
||||
* Error type
|
||||
*/
|
||||
declare type Error<err_t> = {
|
||||
ok: false;
|
||||
error: err_t;
|
||||
};
|
||||
/**
|
||||
* Constructs an `Ok` value from a pure value
|
||||
*/
|
||||
declare function ok<ok_t>(x: ok_t): Ok<ok_t>;
|
||||
/**
|
||||
* Constructs an `Error` value from a pure value
|
||||
*/
|
||||
declare function error<err_t>(x: err_t): Error<err_t>;
|
||||
/**
|
||||
* Takes a `Safe` value, if `ok`, returns the `ok_t`, or if an error throws the
|
||||
* `err_t`
|
||||
*/
|
||||
declare function unsafe<ok_t, err_t>(x: Safe<ok_t, err_t>): ok_t;
|
||||
@@ -0,0 +1,58 @@
|
||||
/**
|
||||
* "Safe" error handling
|
||||
*
|
||||
* The idea here is that there are situations where it is known
|
||||
*
|
||||
* ```typescript
|
||||
* type Safe<ok_t, err_t>
|
||||
* = Ok<ok_t>
|
||||
* | Error<err_t>;
|
||||
*
|
||||
* type Ok<ok_t>
|
||||
* = {ok : true,
|
||||
* result : ok_t};
|
||||
*
|
||||
* type Error<err_t>
|
||||
* = {ok : false,
|
||||
* error : err_t};
|
||||
* ```
|
||||
*
|
||||
* 1. a given function call is likely to fail
|
||||
* 2. the likely errors can be enumerated
|
||||
*
|
||||
* These are called "positive errors". An example would be a page script
|
||||
* asking a browser wallet extension to sign a transaction. The following
|
||||
* errors, among others, are likely:
|
||||
*
|
||||
* - the user does not have a wallet installed
|
||||
* - the user has a wallet but does not have the correct signing key
|
||||
* - the user rejects the transaction
|
||||
* - the sign request timed out
|
||||
*
|
||||
* These errors should not generate exceptions, as these behaviors are to some
|
||||
* degree "expected".
|
||||
*/
|
||||
export { ok, error, unsafe };
|
||||
/**
|
||||
* Constructs an `Ok` value from a pure value
|
||||
*/
|
||||
function ok(x) {
|
||||
return { ok: true, result: x };
|
||||
}
|
||||
/**
|
||||
* Constructs an `Error` value from a pure value
|
||||
*/
|
||||
function error(x) {
|
||||
return { ok: false, error: x };
|
||||
}
|
||||
/**
|
||||
* Takes a `Safe` value, if `ok`, returns the `ok_t`, or if an error throws the
|
||||
* `err_t`
|
||||
*/
|
||||
function unsafe(x) {
|
||||
if (x.ok)
|
||||
return x.result;
|
||||
else
|
||||
throw x.error;
|
||||
}
|
||||
//# sourceMappingURL=safe.js.map
|
||||
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"safe.js","sourceRoot":"","sources":["../src/safe.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,OAAO,EAIH,EAAE,EACF,KAAK,EACL,MAAM,EACT,CAAA;AA2BD;;GAEG;AACH,SACA,EAAE,CAEG,CAAQ;IAGT,OAAO,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAC,CAAC;AACjC,CAAC;AAID;;GAEG;AACH,SACA,KAAK,CAEA,CAAQ;IAGT,OAAO,EAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAC,CAAC;AACjC,CAAC;AAID;;;GAGG;AACH,SACA,MAAM,CAED,CAAoB;IAGrB,IAAI,CAAC,CAAC,EAAE;QACJ,OAAO,CAAC,CAAC,MAAM,CAAC;;QAEhB,MAAM,CAAC,CAAC,KAAK,CAAC;AACtB,CAAC"}
|
||||
@@ -0,0 +1,418 @@
|
||||
/**
|
||||
* Base58 encoding/decoding
|
||||
*/
|
||||
|
||||
export {
|
||||
encode,
|
||||
decode
|
||||
}
|
||||
|
||||
|
||||
|
||||
//=============================================================================
|
||||
// ENCODING
|
||||
//=============================================================================
|
||||
|
||||
/**
|
||||
* Encode a Uint8Array into base58
|
||||
*/
|
||||
function
|
||||
encode
|
||||
(binary : Uint8Array)
|
||||
: string
|
||||
{
|
||||
let num_leading_zeros : number = nlz(binary);
|
||||
let rest : Uint8Array = binary.slice(num_leading_zeros);
|
||||
let ones : string = encode_zeros(num_leading_zeros);
|
||||
let rest_b58 : string = encode_rest(rest);
|
||||
let result : string = ones + rest_b58;
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* count the number of leading zeros in a uint8array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
nlz
|
||||
(bytes: Uint8Array)
|
||||
: number
|
||||
{
|
||||
let n = 0;
|
||||
for (let this_byte of bytes)
|
||||
{
|
||||
if (0 === this_byte) { n++; }
|
||||
else { break; }
|
||||
}
|
||||
return n;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Generate a bunch of '1's for however many leading zeros there are
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode_zeros
|
||||
(how_many : number)
|
||||
: string
|
||||
{
|
||||
let ones : string = '';
|
||||
for (let i = 1;
|
||||
i <= how_many;
|
||||
i++)
|
||||
{
|
||||
ones += '1';
|
||||
}
|
||||
|
||||
return ones;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a Uint8Array that has no leading zeros
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode_rest
|
||||
(bytes : Uint8Array)
|
||||
: string
|
||||
{
|
||||
let bytes_bignum : bigint = bytes_to_bigint(bytes);
|
||||
let result : string = bignum_to_base58(bytes_bignum);
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Convert a bytestring to a bignum
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
bytes_to_bigint
|
||||
(bytes: Uint8Array)
|
||||
: bigint
|
||||
{
|
||||
let acc_bigint : bigint = 0n;
|
||||
for(let this_byte of bytes)
|
||||
{
|
||||
acc_bigint <<= 8n;
|
||||
acc_bigint += BigInt(this_byte);
|
||||
}
|
||||
return acc_bigint;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Convert a BigInt to Base58
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
bignum_to_base58
|
||||
(q: bigint)
|
||||
: string
|
||||
{
|
||||
let s = '';
|
||||
while (q !== 0n)
|
||||
{
|
||||
let this_n : bigint = q % 58n;
|
||||
q /= 58n;
|
||||
|
||||
let this_b58_char : string = bigint_to_char(this_n);
|
||||
s = this_b58_char + s;
|
||||
}
|
||||
return s;
|
||||
}
|
||||
|
||||
|
||||
|
||||
//=============================================================================
|
||||
// DECODING
|
||||
//=============================================================================
|
||||
|
||||
/**
|
||||
* Decode a Base58 string into a Uint8Array
|
||||
*/
|
||||
function
|
||||
decode
|
||||
(base58: string)
|
||||
: Uint8Array
|
||||
{
|
||||
let num_leading_ones : number = nlo(base58);
|
||||
let rest : string = base58.slice(num_leading_ones);
|
||||
let zeros : Array<number> = decode_ones(num_leading_ones);
|
||||
let rest_arr : Array<number> = decode_rest(rest);
|
||||
let pre_result : Array<number> = zeros.concat(rest_arr);
|
||||
return new Uint8Array(pre_result);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* count the number of leading 1 characters in a uint8array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
nlo
|
||||
(base58: string)
|
||||
: number
|
||||
{
|
||||
let n = 0;
|
||||
for (let this_char of base58)
|
||||
{
|
||||
if ('1' === this_char) { n++; }
|
||||
else { break; }
|
||||
}
|
||||
return n;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Generate a bunch of '0's for however many leading ones there are
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode_ones
|
||||
(how_many : number)
|
||||
: Array<number>
|
||||
{
|
||||
let zeros : Array<number> = [];
|
||||
for (let i = 1;
|
||||
i <= how_many;
|
||||
i++)
|
||||
{
|
||||
zeros.push(0);
|
||||
}
|
||||
|
||||
return zeros;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a string that has no leading 1s
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode_rest
|
||||
(base58: string)
|
||||
: Array<number>
|
||||
{
|
||||
let result_bignum : bigint = base58_to_bigint(base58);
|
||||
let result : Array<number> = bigint_to_base256(result_bignum);
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Convert a base58 string to a bignum
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
base58_to_bigint
|
||||
(base58: string)
|
||||
: bigint
|
||||
{
|
||||
let acc_bigint : bigint = 0n;
|
||||
for(let this_char of base58)
|
||||
{
|
||||
acc_bigint *= 58n;
|
||||
acc_bigint += char_to_bigint(this_char);
|
||||
}
|
||||
return acc_bigint;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* convert a bignum into a byte array
|
||||
*
|
||||
* @end
|
||||
*/
|
||||
function
|
||||
bigint_to_base256
|
||||
(q: bigint)
|
||||
: Array<number>
|
||||
{
|
||||
let arr_reverse = [];
|
||||
while(q !== 0n)
|
||||
{
|
||||
let r: number = Number(q % 256n);
|
||||
q /= 256n;
|
||||
arr_reverse.push(r);
|
||||
}
|
||||
arr_reverse.reverse();
|
||||
return arr_reverse;
|
||||
}
|
||||
|
||||
|
||||
//=============================================================================
|
||||
// TRANSLATION TABLES
|
||||
//=============================================================================
|
||||
|
||||
|
||||
/**
|
||||
* Base58 integer -> character conversion table
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
bigint_to_char
|
||||
(n: bigint)
|
||||
: string
|
||||
{
|
||||
switch(n) {
|
||||
case 0n: return '1';
|
||||
case 1n: return '2';
|
||||
case 2n: return '3';
|
||||
case 3n: return '4';
|
||||
case 4n: return '5';
|
||||
case 5n: return '6';
|
||||
case 6n: return '7';
|
||||
case 7n: return '8';
|
||||
case 8n: return '9';
|
||||
case 9n: return 'A';
|
||||
case 10n: return 'B';
|
||||
case 11n: return 'C';
|
||||
case 12n: return 'D';
|
||||
case 13n: return 'E';
|
||||
case 14n: return 'F';
|
||||
case 15n: return 'G';
|
||||
case 16n: return 'H';
|
||||
case 17n: return 'J';
|
||||
case 18n: return 'K';
|
||||
case 19n: return 'L';
|
||||
case 20n: return 'M';
|
||||
case 21n: return 'N';
|
||||
case 22n: return 'P';
|
||||
case 23n: return 'Q';
|
||||
case 24n: return 'R';
|
||||
case 25n: return 'S';
|
||||
case 26n: return 'T';
|
||||
case 27n: return 'U';
|
||||
case 28n: return 'V';
|
||||
case 29n: return 'W';
|
||||
case 30n: return 'X';
|
||||
case 31n: return 'Y';
|
||||
case 32n: return 'Z';
|
||||
case 33n: return 'a';
|
||||
case 34n: return 'b';
|
||||
case 35n: return 'c';
|
||||
case 36n: return 'd';
|
||||
case 37n: return 'e';
|
||||
case 38n: return 'f';
|
||||
case 39n: return 'g';
|
||||
case 40n: return 'h';
|
||||
case 41n: return 'i';
|
||||
case 42n: return 'j';
|
||||
case 43n: return 'k';
|
||||
case 44n: return 'm';
|
||||
case 45n: return 'n';
|
||||
case 46n: return 'o';
|
||||
case 47n: return 'p';
|
||||
case 48n: return 'q';
|
||||
case 49n: return 'r';
|
||||
case 50n: return 's';
|
||||
case 51n: return 't';
|
||||
case 52n: return 'u';
|
||||
case 53n: return 'v';
|
||||
case 54n: return 'w';
|
||||
case 55n: return 'x';
|
||||
case 56n: return 'y';
|
||||
case 57n: return 'z';
|
||||
default:
|
||||
throw new Error('invalid base58 bigint: ' + n);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Base58 character -> integer conversion table
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
char_to_bigint
|
||||
(s: string)
|
||||
: bigint
|
||||
{
|
||||
switch(s) {
|
||||
case '1': return 0n;
|
||||
case '2': return 1n;
|
||||
case '3': return 2n;
|
||||
case '4': return 3n;
|
||||
case '5': return 4n;
|
||||
case '6': return 5n;
|
||||
case '7': return 6n;
|
||||
case '8': return 7n;
|
||||
case '9': return 8n;
|
||||
case 'A': return 9n;
|
||||
case 'B': return 10n;
|
||||
case 'C': return 11n;
|
||||
case 'D': return 12n;
|
||||
case 'E': return 13n;
|
||||
case 'F': return 14n;
|
||||
case 'G': return 15n;
|
||||
case 'H': return 16n;
|
||||
case 'J': return 17n;
|
||||
case 'K': return 18n;
|
||||
case 'L': return 19n;
|
||||
case 'M': return 20n;
|
||||
case 'N': return 21n;
|
||||
case 'P': return 22n;
|
||||
case 'Q': return 23n;
|
||||
case 'R': return 24n;
|
||||
case 'S': return 25n;
|
||||
case 'T': return 26n;
|
||||
case 'U': return 27n;
|
||||
case 'V': return 28n;
|
||||
case 'W': return 29n;
|
||||
case 'X': return 30n;
|
||||
case 'Y': return 31n;
|
||||
case 'Z': return 32n;
|
||||
case 'a': return 33n;
|
||||
case 'b': return 34n;
|
||||
case 'c': return 35n;
|
||||
case 'd': return 36n;
|
||||
case 'e': return 37n;
|
||||
case 'f': return 38n;
|
||||
case 'g': return 39n;
|
||||
case 'h': return 40n;
|
||||
case 'i': return 41n;
|
||||
case 'j': return 42n;
|
||||
case 'k': return 43n;
|
||||
case 'm': return 44n;
|
||||
case 'n': return 45n;
|
||||
case 'o': return 46n;
|
||||
case 'p': return 47n;
|
||||
case 'q': return 48n;
|
||||
case 'r': return 49n;
|
||||
case 's': return 50n;
|
||||
case 't': return 51n;
|
||||
case 'u': return 52n;
|
||||
case 'v': return 53n;
|
||||
case 'w': return 54n;
|
||||
case 'x': return 55n;
|
||||
case 'y': return 56n;
|
||||
case 'z': return 57n;
|
||||
default:
|
||||
throw new Error('invalid base58 char: ' + s);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,655 @@
|
||||
/**
|
||||
* Base64 Utility Functions in TypeScript
|
||||
*/
|
||||
|
||||
export {
|
||||
encode,
|
||||
decode
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode an array of bytes as a Uint8Array in base64 notation.
|
||||
*/
|
||||
function
|
||||
encode
|
||||
(bytes: Uint8Array)
|
||||
: string
|
||||
{
|
||||
// slice the array
|
||||
// length of head is a multiple of 3
|
||||
// treat the tail as a special case
|
||||
let {head, tail, tail_len} = slice3k(bytes);
|
||||
let head_str : string = encode_head(head);
|
||||
let tail_str : string = encode_tail(tail, tail_len);
|
||||
return head_str + tail_str;
|
||||
}
|
||||
|
||||
|
||||
|
||||
type slice3k
|
||||
= {head : Uint8Array,
|
||||
tail : Uint8Array,
|
||||
tail_len : number};
|
||||
|
||||
/**
|
||||
* Take a Uint8Array, take the first 3k (k >= 0) bytes, put them in head, and
|
||||
* the remaining 0,1, or 2 bytes, put them in tail
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
slice3k
|
||||
(bytes: Uint8Array)
|
||||
: slice3k
|
||||
{
|
||||
let len : number = bytes.length;
|
||||
// too lazy to look up how to do integer division in js so this will do
|
||||
let tail_len : number = len % 3;
|
||||
let head_len : number = len - tail_len;
|
||||
// for slice:
|
||||
// first argument is the 0-index of the start
|
||||
// second - first is the length of the slice
|
||||
let head : Uint8Array = bytes.slice(0, head_len);
|
||||
// empty second argument means go to the end
|
||||
let tail : Uint8Array = bytes.slice(head_len);
|
||||
return {head : head,
|
||||
tail : tail,
|
||||
tail_len : tail_len};
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a Uint8Array whose length is known to be a multiple of 3
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode_head
|
||||
(head_bytes: Uint8Array)
|
||||
: string
|
||||
{
|
||||
// can assume length of bytes is a multiple of 3
|
||||
// start index at 0
|
||||
// increment by 3
|
||||
let head_bytes_len : number = head_bytes.length;
|
||||
let max_idx0 : number = head_bytes_len - 1;
|
||||
|
||||
let head_str_acc : string = '';
|
||||
for(let this_3slice_start_idx0 = 0;
|
||||
this_3slice_start_idx0 <= max_idx0;
|
||||
this_3slice_start_idx0 += 3)
|
||||
{
|
||||
let this_3slice_bytes : Uint8Array = head_bytes.slice(this_3slice_start_idx0, this_3slice_start_idx0 + 3);
|
||||
let this_3slice_str : string = encode3(this_3slice_bytes);
|
||||
head_str_acc += this_3slice_str;
|
||||
}
|
||||
|
||||
return head_str_acc;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a 3 bytes into base64 notation
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode3
|
||||
(bytes: Uint8Array)
|
||||
: string
|
||||
{
|
||||
let b0 : number = bytes[0];
|
||||
let b1 : number = bytes[1];
|
||||
let b2 : number = bytes[2];
|
||||
|
||||
// ABCDEFGH 12345678 abcdefgh
|
||||
// b0 b1 b2
|
||||
// ABCDEF GH1234 5678ab cdefgh
|
||||
// n0 n1 n2 n3
|
||||
let n0 : number = b0 >> 2;
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
// b1 = 12345678
|
||||
// b1 >> 4 = ____1234
|
||||
// n1 = __GH1234
|
||||
let n1 : number = ((b0 % 4) << 4) + (b1 >> 4);
|
||||
// b1 = 12345678
|
||||
// 16 = ___1____
|
||||
// b1 % 16 = ____5678
|
||||
// (b1 % 16) << 2 = __5678__
|
||||
// b2 = abcdefgh
|
||||
// b2 >> 6 = ______ab
|
||||
// n2 = __5678ab
|
||||
let n2 : number = ((b1 % 16) << 2) + (b2 >> 6);
|
||||
// b2 = abcdefgh
|
||||
// 64 = _1______
|
||||
// n3 = __cdefgh
|
||||
let n3 : number = b2 % 64;
|
||||
|
||||
// convert to chars
|
||||
let s0 : string = int2char(n0);
|
||||
let s1 : string = int2char(n1);
|
||||
let s2 : string = int2char(n2);
|
||||
let s3 : string = int2char(n3);
|
||||
|
||||
// retrvn
|
||||
return s0 + s1 + s2 + s3;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode the final 0, 1, or 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode_tail
|
||||
(tail_bytes : Uint8Array,
|
||||
tail_len : number)
|
||||
: string
|
||||
{
|
||||
switch(tail_len) {
|
||||
case 0: return '';
|
||||
case 1: return encode1(tail_bytes);
|
||||
case 2: return encode2(tail_bytes);
|
||||
default:
|
||||
throw new Error('encode_tail with tail_len = ' + tail_len);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a single byte
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode1
|
||||
(bytes: Uint8Array)
|
||||
: string
|
||||
{
|
||||
let b0 : number = bytes[0];
|
||||
// n0 = __ABCDEF
|
||||
// b0 = ABCDEFGH
|
||||
// b0 >> 2 = __ABCDEF
|
||||
let n0 : number = b0 >> 2;
|
||||
// n1 = __GH____
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
let n1 : number = (b0 % 4) << 4;
|
||||
|
||||
return int2char(n0) + int2char(n1) + '==';
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode two bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode2
|
||||
(bytes: Uint8Array)
|
||||
: string
|
||||
{
|
||||
let b0 : number = bytes[0];
|
||||
let b1 : number = bytes[1];
|
||||
|
||||
// ABCDEFGH 12345678
|
||||
// b0 b1
|
||||
// ABCDEF GH1234 5678__
|
||||
// n0 n1 n2
|
||||
let n0 : number = b0 >> 2;
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
// b1 = 12345678
|
||||
// b1 >> 4 = ____1234
|
||||
// n1 = __GH1234
|
||||
let n1 : number = ((b0 % 4) << 4) + (b1 >> 4);
|
||||
// b1 = 12345678
|
||||
// 16 = ___1____
|
||||
// b1 % 16 = ____5678
|
||||
// (b1 % 16) << 2 = __5678__
|
||||
// n2 = __5678__
|
||||
let n2 : number = (b1 % 16) << 2;
|
||||
|
||||
// convert to chars
|
||||
let s0 : string = int2char(n0);
|
||||
let s1 : string = int2char(n1);
|
||||
let s2 : string = int2char(n2);
|
||||
|
||||
// retrvn
|
||||
return s0 + s1 + s2 + '=';
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a base64-encoded string
|
||||
*/
|
||||
function
|
||||
decode
|
||||
(base64_str : string)
|
||||
: Uint8Array
|
||||
{
|
||||
// length of the string is guaranteed to be a multiple of 4
|
||||
// if the string is empty, return the empty array
|
||||
let len = base64_str.length;
|
||||
// this branching contains the implicit assertion that the length is a
|
||||
// multiple of 4. If this is not true, the bottom branch is triggered.
|
||||
// general case goes first because speeeeeed
|
||||
if ( (4 < len)
|
||||
&& (0 === (len % 4)))
|
||||
{
|
||||
// split the head and tail
|
||||
let tail_start_idx0 : number = len - 4;
|
||||
let head_s : string = base64_str.slice(0, tail_start_idx0);
|
||||
let tail_s : string = base64_str.slice(tail_start_idx0);
|
||||
// Using arrays because Uint8Arrays don't have a concat operation
|
||||
let head_arr : Array<number> = decode_head(head_s);
|
||||
let tail_arr : Array<number> = decode_tail(tail_s);
|
||||
// silly to put these in variables but this is exactly the type of
|
||||
// situation where JS type insanity shows up
|
||||
//
|
||||
// see: i forgot
|
||||
// > [1,2,3] + [4,5,6]
|
||||
// '1,2,34,5,6'
|
||||
//
|
||||
// Originally, I used + like some sort of moron who codes in a sane
|
||||
// language
|
||||
//
|
||||
// seriously what is this language
|
||||
//
|
||||
// this is some clown behavior
|
||||
let total_arr : Array<number> = head_arr.concat(tail_arr);
|
||||
return new Uint8Array(total_arr);
|
||||
}
|
||||
// special case if the length is exactly 4
|
||||
else if (4 === len)
|
||||
{
|
||||
// it's just a tail
|
||||
return new Uint8Array(decode_tail(base64_str));
|
||||
}
|
||||
// empty string
|
||||
else if (0 === len)
|
||||
{
|
||||
return new Uint8Array([]);
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new Error('base64 decode: invalid string length: ' + len);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a string known to not have any padding
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode_head
|
||||
(s: string)
|
||||
: Array<number>
|
||||
{
|
||||
// go 4 characters at a time
|
||||
let max_i0 : number = s.length - 1;
|
||||
let decoded_acc : Array<number> = [];
|
||||
for(let i0 = 0;
|
||||
i0 <= max_i0;
|
||||
i0 += 4)
|
||||
{
|
||||
let this_slice_s : string = s.slice(i0, i0 + 4);
|
||||
let this_slice_arr : Array<number> = decode3(this_slice_s);
|
||||
// update accumulator
|
||||
decoded_acc = decoded_acc.concat(this_slice_arr);
|
||||
}
|
||||
return decoded_acc;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode 4 characters that correspond to either 3 bytes, 2, bytes, or 1 byte
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode_tail
|
||||
(s: string)
|
||||
: Array<number>
|
||||
{
|
||||
// all that matters right now is the last 2 chars
|
||||
// s0, s1, s2, s3
|
||||
// 0 based indexing is so annoying
|
||||
let s2 = s[2];
|
||||
let s3 = s[3];
|
||||
|
||||
// braaaaaaaaaaaaaaaaaench
|
||||
// two equals signs means 1 byte
|
||||
if (('=' === s3) && ('=' === s2)) {
|
||||
return decode1(s);
|
||||
}
|
||||
// one equals sign means 2 bytes
|
||||
else if (('=' === s3)) {
|
||||
return decode2(s);
|
||||
}
|
||||
// 0 equals signs means 3 bytes
|
||||
else {
|
||||
return decode3(s);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 3 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode3
|
||||
(s: string)
|
||||
: Array<number>
|
||||
{
|
||||
// pull out strings
|
||||
let s0 : string = s[0];
|
||||
let s1 : string = s[1];
|
||||
let s2 : string = s[2];
|
||||
let s3 : string = s[3];
|
||||
|
||||
// convert to numbers
|
||||
let n0 : number = char2int(s0);
|
||||
let n1 : number = char2int(s1);
|
||||
let n2 : number = char2int(s2);
|
||||
let n3 : number = char2int(s3);
|
||||
|
||||
// abcdef gh1234 5678ab cdefgh
|
||||
// n0 n1 n2 n3
|
||||
// abcdefgh 12345678 abcdefgh
|
||||
// b0 b1 b2
|
||||
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh1234
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 : number = (n0 << 2) + (n1 >> 4);
|
||||
// n1 = __gh1234
|
||||
// 16 = ___1____
|
||||
// n1 % 16 = ____1234
|
||||
// (n1 % 16) << 4 = 1234____
|
||||
// n2 = __5678ab
|
||||
// n2 >> 2 = ____5678
|
||||
// b1 = 12345678
|
||||
let b1 : number = ((n1 % 16) << 4) + (n2 >> 2);
|
||||
// n2 = __5678ab
|
||||
// 4 = _____1__
|
||||
// n2 % 4 = ______ab
|
||||
// (n2 % 4) << 6 = ab______
|
||||
// n3 = __cdefgh
|
||||
let b2 : number = ((n2 % 4) << 6) + n3;
|
||||
|
||||
return [b0, b1, b2];
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode2
|
||||
(s: string)
|
||||
: Array<number>
|
||||
{
|
||||
// xyz=
|
||||
// pull out strings
|
||||
let s0 : string = s[0];
|
||||
let s1 : string = s[1];
|
||||
let s2 : string = s[2];
|
||||
|
||||
// convert to numbers
|
||||
let n0 : number = char2int(s0);
|
||||
let n1 : number = char2int(s1);
|
||||
let n2 : number = char2int(s2);
|
||||
|
||||
// abcdef gh1234 5678__
|
||||
// n0 n1 n2
|
||||
// abcdefgh 12345678
|
||||
// b0 b1
|
||||
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh1234
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 : number = (n0 << 2) + (n1 >> 4);
|
||||
// n1 = __gh1234
|
||||
// 16 = ___1____
|
||||
// n1 % 16 = ____1234
|
||||
// (n1 % 16) << 4 = 1234____
|
||||
// n2 = __5678__
|
||||
// n2 >> 2 = ____5678
|
||||
// b1 = 12345678
|
||||
let b1 : number = ((n1 % 16) << 4) + (n2 >> 2);
|
||||
|
||||
return [b0, b1];
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode1
|
||||
(s: string)
|
||||
: Array<number>
|
||||
{
|
||||
// xy==
|
||||
// pull out strings
|
||||
let s0 : string = s[0];
|
||||
let s1 : string = s[1];
|
||||
|
||||
// convert to numbers
|
||||
let n0 : number = char2int(s0);
|
||||
let n1 : number = char2int(s1);
|
||||
|
||||
// abcdef gh____
|
||||
// n0 n1
|
||||
// abcdefgh
|
||||
// b0
|
||||
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh____
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 : number = (n0 << 2) + (n1 >> 4);
|
||||
|
||||
return [b0];
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
// FIXME: these tables would *probably* be faster if they were made into objects
|
||||
|
||||
/**
|
||||
* Conversion table for base64 encode
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
int2char
|
||||
(n: number)
|
||||
: string
|
||||
{
|
||||
switch(n) {
|
||||
case 0: return 'A';
|
||||
case 1: return 'B';
|
||||
case 2: return 'C';
|
||||
case 3: return 'D';
|
||||
case 4: return 'E';
|
||||
case 5: return 'F';
|
||||
case 6: return 'G';
|
||||
case 7: return 'H';
|
||||
case 8: return 'I';
|
||||
case 9: return 'J';
|
||||
case 10: return 'K';
|
||||
case 11: return 'L';
|
||||
case 12: return 'M';
|
||||
case 13: return 'N';
|
||||
case 14: return 'O';
|
||||
case 15: return 'P';
|
||||
case 16: return 'Q';
|
||||
case 17: return 'R';
|
||||
case 18: return 'S';
|
||||
case 19: return 'T';
|
||||
case 20: return 'U';
|
||||
case 21: return 'V';
|
||||
case 22: return 'W';
|
||||
case 23: return 'X';
|
||||
case 24: return 'Y';
|
||||
case 25: return 'Z';
|
||||
case 26: return 'a';
|
||||
case 27: return 'b';
|
||||
case 28: return 'c';
|
||||
case 29: return 'd';
|
||||
case 30: return 'e';
|
||||
case 31: return 'f';
|
||||
case 32: return 'g';
|
||||
case 33: return 'h';
|
||||
case 34: return 'i';
|
||||
case 35: return 'j';
|
||||
case 36: return 'k';
|
||||
case 37: return 'l';
|
||||
case 38: return 'm';
|
||||
case 39: return 'n';
|
||||
case 40: return 'o';
|
||||
case 41: return 'p';
|
||||
case 42: return 'q';
|
||||
case 43: return 'r';
|
||||
case 44: return 's';
|
||||
case 45: return 't';
|
||||
case 46: return 'u';
|
||||
case 47: return 'v';
|
||||
case 48: return 'w';
|
||||
case 49: return 'x';
|
||||
case 50: return 'y';
|
||||
case 51: return 'z';
|
||||
case 52: return '0';
|
||||
case 53: return '1';
|
||||
case 54: return '2';
|
||||
case 55: return '3';
|
||||
case 56: return '4';
|
||||
case 57: return '5';
|
||||
case 58: return '6';
|
||||
case 59: return '7';
|
||||
case 60: return '8';
|
||||
case 61: return '9';
|
||||
case 62: return '+';
|
||||
case 63: return '/';
|
||||
default: throw new Error("invalid base64 encode byte: " + n);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Conversion table for base64 decode
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
char2int
|
||||
(s: string)
|
||||
: number
|
||||
{
|
||||
switch(s) {
|
||||
case 'A': return 0;
|
||||
case 'B': return 1;
|
||||
case 'C': return 2;
|
||||
case 'D': return 3;
|
||||
case 'E': return 4;
|
||||
case 'F': return 5;
|
||||
case 'G': return 6;
|
||||
case 'H': return 7;
|
||||
case 'I': return 8;
|
||||
case 'J': return 9;
|
||||
case 'K': return 10;
|
||||
case 'L': return 11;
|
||||
case 'M': return 12;
|
||||
case 'N': return 13;
|
||||
case 'O': return 14;
|
||||
case 'P': return 15;
|
||||
case 'Q': return 16;
|
||||
case 'R': return 17;
|
||||
case 'S': return 18;
|
||||
case 'T': return 19;
|
||||
case 'U': return 20;
|
||||
case 'V': return 21;
|
||||
case 'W': return 22;
|
||||
case 'X': return 23;
|
||||
case 'Y': return 24;
|
||||
case 'Z': return 25;
|
||||
case 'a': return 26;
|
||||
case 'b': return 27;
|
||||
case 'c': return 28;
|
||||
case 'd': return 29;
|
||||
case 'e': return 30;
|
||||
case 'f': return 31;
|
||||
case 'g': return 32;
|
||||
case 'h': return 33;
|
||||
case 'i': return 34;
|
||||
case 'j': return 35;
|
||||
case 'k': return 36;
|
||||
case 'l': return 37;
|
||||
case 'm': return 38;
|
||||
case 'n': return 39;
|
||||
case 'o': return 40;
|
||||
case 'p': return 41;
|
||||
case 'q': return 42;
|
||||
case 'r': return 43;
|
||||
case 's': return 44;
|
||||
case 't': return 45;
|
||||
case 'u': return 46;
|
||||
case 'v': return 47;
|
||||
case 'w': return 48;
|
||||
case 'x': return 49;
|
||||
case 'y': return 50;
|
||||
case 'z': return 51;
|
||||
case '0': return 52;
|
||||
case '1': return 53;
|
||||
case '2': return 54;
|
||||
case '3': return 55;
|
||||
case '4': return 56;
|
||||
case '5': return 57;
|
||||
case '6': return 58;
|
||||
case '7': return 59;
|
||||
case '8': return 60;
|
||||
case '9': return 61;
|
||||
case '+': return 62;
|
||||
case '/': return 63;
|
||||
default: throw new Error("invalid base64 character: " + s);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,377 @@
|
||||
/**
|
||||
* Miscellaneous binary utility functions
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
export {
|
||||
bytes_to_bigint,
|
||||
bigint_to_bytes,
|
||||
concat,
|
||||
strong_rand_bytes
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Concatenate two arrays
|
||||
*/
|
||||
function
|
||||
concat
|
||||
(arr1 : Uint8Array,
|
||||
arr2 : Uint8Array)
|
||||
: Uint8Array
|
||||
{
|
||||
let len1 : number = arr1.length;
|
||||
let len2 : number = arr2.length;
|
||||
let arr1_idx0_offset : number = 0;
|
||||
let arr2_idx0_offset : number = len1;
|
||||
let result_len : number = len1 + len2;
|
||||
let result : Uint8Array = new Uint8Array(result_len);
|
||||
// copy first array into result
|
||||
for (let arr1_idx0 = 0;
|
||||
arr1_idx0 < len1;
|
||||
arr1_idx0++)
|
||||
{
|
||||
// no offset here
|
||||
let result_idx0 : number = arr1_idx0 + arr1_idx0_offset;
|
||||
result[result_idx0] = arr1[arr1_idx0];
|
||||
}
|
||||
// copy second array into result
|
||||
for (let arr2_idx0 = 0;
|
||||
arr2_idx0 < len2;
|
||||
arr2_idx0++)
|
||||
{
|
||||
// offset by the length of the first array
|
||||
let result_idx0 : number = arr2_idx0 + arr2_idx0_offset;
|
||||
result[result_idx0] = arr2[arr2_idx0];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Cryptographically random bytes
|
||||
*/
|
||||
function
|
||||
strong_rand_bytes
|
||||
(how_many : number)
|
||||
: Uint8Array
|
||||
{
|
||||
let arr = new Uint8Array(how_many);
|
||||
(new Crypto()).getRandomValues(arr);
|
||||
return arr;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Convert a byte array to a bigint
|
||||
*
|
||||
* Equivalent to `binary:decode_unsigned/1` from Erlang
|
||||
*/
|
||||
function
|
||||
bytes_to_bigint
|
||||
(bytes: Uint8Array)
|
||||
: bigint
|
||||
{
|
||||
let n : bigint = 0n;
|
||||
for (let b of bytes) {
|
||||
// move first, then add
|
||||
// otherwise it ends on a move
|
||||
// imperative languages are for losers
|
||||
n <<= 8n;
|
||||
n += BigInt(b);
|
||||
}
|
||||
return n;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Convert a bigint to a byte array
|
||||
*
|
||||
* Equivalent to `binary:encode_unsigned/1` from Erlang
|
||||
*
|
||||
* Requires input to be positive
|
||||
*/
|
||||
function
|
||||
bigint_to_bytes
|
||||
(q: bigint)
|
||||
: Uint8Array
|
||||
{
|
||||
if (q < 0n) {
|
||||
throw new Error('q < 0n: ' + q);
|
||||
}
|
||||
|
||||
let arr_reverse = [];
|
||||
while (q > 0n) {
|
||||
let r = Number(q % 256n);
|
||||
q /= 256n;
|
||||
arr_reverse.push(r);
|
||||
}
|
||||
arr_reverse.reverse();
|
||||
return new Uint8Array(arr_reverse);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Oh no, bitstrings in a language that only has bytestrings
|
||||
*
|
||||
* By convention these are `Uint8Array`s with byte length `ceil(bit_length /
|
||||
* 8)`, and all trailing bits are zero.
|
||||
*/
|
||||
type bits =
|
||||
{bit_length : number,
|
||||
bytes : Uint8Array};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Get an uninitialized bitstring
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
bits_null
|
||||
(bit_length : number)
|
||||
: bits
|
||||
{
|
||||
let byte_length : number = Math.ceil(bit_length / 8);
|
||||
let result : Uint8Array = new Uint8Array(byte_length);
|
||||
return {bit_length : bit_length,
|
||||
bytes : result};
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Get a bitstring of a given length where every value is 0.
|
||||
*/
|
||||
function
|
||||
bits_zeros
|
||||
(bit_length : number)
|
||||
: bits
|
||||
{
|
||||
let byte_length : number = Math.ceil(bit_length / 8);
|
||||
let result : Uint8Array = new Uint8Array(byte_length);
|
||||
for (let i0 = 0;
|
||||
i0 < byte_length;
|
||||
i0++)
|
||||
{
|
||||
result[i0] = 0;
|
||||
}
|
||||
return {bit_length : bit_length,
|
||||
bytes : result};
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Get a bitstring of a given length where every value is 1.
|
||||
*/
|
||||
function
|
||||
bits_ones
|
||||
(bit_length : number)
|
||||
: bits
|
||||
{
|
||||
let byte_length : number = Math.ceil(bit_length / 8);
|
||||
let result : Uint8Array = new Uint8Array(byte_length);
|
||||
|
||||
// fill everything except the last byte with 255s
|
||||
for (let i0 = 0;
|
||||
i0 < (byte_length - 1);
|
||||
i0++)
|
||||
{
|
||||
result[i0] = 255;
|
||||
}
|
||||
|
||||
// alright so the last byte
|
||||
// ok so the number of leading 0s is
|
||||
// 8 - (bit_length % 8)
|
||||
let num_trailing_zero_bits : number = 8 - (bit_length % 8);
|
||||
// the trailing byte is 255 << that
|
||||
// e.g. 3 trailing 0s
|
||||
// 1111_1111 -> 1111_1000
|
||||
let last_byte : number = 255 << num_trailing_zero_bits;
|
||||
let last_byte_idx0 : number = byte_length - 1;
|
||||
result[last_byte_idx0] = last_byte;
|
||||
|
||||
return {bit_length : bit_length,
|
||||
bytes : result};
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Get the bit at a given 0-index
|
||||
*/
|
||||
function
|
||||
bits_i0th
|
||||
(bit_idx0 : number,
|
||||
bits : bits)
|
||||
: number
|
||||
{
|
||||
// first task is figuring out what byte we're at
|
||||
// for instance if we want bit 27
|
||||
// 3*8 = 24 =< 27 < 4*8
|
||||
// so it's Math.floor(bit_idx0 / 8)
|
||||
let byte_idx0 : number = Math.floor(bit_idx0 / 8);
|
||||
// let's fetch the byte and work with that
|
||||
let the_byte : number = bits.bytes[byte_idx0];
|
||||
|
||||
// ok so let's go with 27 again
|
||||
// 27 = 3 mod 8
|
||||
// so we bitshift right by (8 - 3)
|
||||
// and then take the remainder dividing by 2
|
||||
// --B-_---- -> ----_---B -> 0000_000B
|
||||
let bsr : number = 8 - (bit_idx0 % 8);
|
||||
return (the_byte >> bsr) % 2;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Concatenate two bitstrings
|
||||
*/
|
||||
function
|
||||
bits_concat
|
||||
(bits1 : bits,
|
||||
bits2 : bits)
|
||||
: bits
|
||||
{
|
||||
let result_bit_length : number = bits1.bit_length + bits2.bit_length;
|
||||
let bytes1 : Uint8Array = bits1.bytes;
|
||||
let bytes2 : Uint8Array = bits2.bytes;
|
||||
// using zeros here because of our xor trick in a minute
|
||||
let result_bits : bits = bits_null(result_bit_length);
|
||||
let result_bytes : Uint8Array = result_bits.bytes;
|
||||
|
||||
// go along each byte in result, and compute the byte boundary
|
||||
for (let i = 0;
|
||||
i < result_bytes.length;
|
||||
i++)
|
||||
{
|
||||
// ABCD_EFGH _
|
||||
// 0123_4567 8
|
||||
// this is the bit index of the leftmost bit in this byte
|
||||
let start_bit_bi0 : number = i * 8;
|
||||
let next_start_bit_bi0 : number = start_bit_bi0 + 8;
|
||||
// does the bit at the beginning of this byte correspond to the first array?
|
||||
// strict comparison:
|
||||
// suppose i = 0,
|
||||
// suppose bit_length1 is 0
|
||||
// then this says no, go to second array
|
||||
// suppose bl1 = 1,
|
||||
// this says start at first array
|
||||
let start_bit_is_of_first_array : boolean = start_bit_bi0 < bits1.bit_length;
|
||||
// weak comparison:
|
||||
// suppose bit_length1 = 8
|
||||
// ABCD_EFGH _
|
||||
// 0123_4567 8
|
||||
// ^
|
||||
// start_bit_bi0 ^ next_start_bit_bi0
|
||||
let stop_bit_is_of_first_array : boolean = next_start_bit_bi0 <= bits1.bit_length;
|
||||
// is this a bytes1 byte
|
||||
let is_bytes1_byte : boolean = start_bit_is_of_first_array && stop_bit_is_of_first_array;
|
||||
let is_boundary_byte : boolean = start_bit_is_of_first_array && !stop_bit_is_of_first_array;
|
||||
|
||||
// need to work out the ping_pong bs up here because js is dumb and I
|
||||
// can't put lets between elseifs
|
||||
// alright, now we're in the case of only copying from the second array
|
||||
// we have two cases:
|
||||
// ping-pong:
|
||||
// ABCD_EFGH 1234_5678
|
||||
// - ---- ---
|
||||
// copying these bits
|
||||
// ping:
|
||||
// ABCD_EFGH <end>
|
||||
// - ---- 000
|
||||
//
|
||||
// how to distinguish between these two??
|
||||
//
|
||||
// we're in the ping case when the start_bit_bi0 corresponds to the
|
||||
// final byte of the second array
|
||||
//
|
||||
// ok
|
||||
//
|
||||
// we need to compute the bit address in the second array that
|
||||
// corresponds to the bit address at the beginning of this byte in the
|
||||
// result array
|
||||
let bits2_addr_bi0 : number = start_bit_bi0 - bits1.bit_length;
|
||||
// I think the variable is
|
||||
// bits_left_to_copy = bits2.bit_length - bit_addr2_bi0
|
||||
// no + 1 because the current bit is uncopied,
|
||||
// so if bit_addr2_bi0 = 7 and bits2.bit_length is 8, it means we
|
||||
// have the last bit to copy
|
||||
// cases:
|
||||
// bits_left_to_copy <= 0 ->
|
||||
// this would mean we have more bits to copy, but are out of
|
||||
// source bits. should be impossible if bits_null is correct
|
||||
// bits_left_to_copy <= 8 ->
|
||||
// this would mean we are going to fill this last byte in the
|
||||
// result array with the correct bits from array2, but how we
|
||||
// do this will depend on how those are arranged in bytes2
|
||||
// (whether we grab one or two bytes)
|
||||
//
|
||||
// this is the tricky case
|
||||
//
|
||||
// I think what matters here is the byte address in the second array
|
||||
// if we're on the last byte
|
||||
// 8 < bits_left_to_copy ->
|
||||
// this means we can safely grab two bytes from bytes2, and do
|
||||
// our bitshifting to make it correct
|
||||
//
|
||||
// FIXME
|
||||
let bits_left_to_copy : number = bits2.bit_length - bits2_addr_bi0;
|
||||
// no the variable that matters is which byte we're on in the result
|
||||
let this_bytes2_addr_i0 : number = Math.floor(bits2_addr_bi0 / 8);
|
||||
let next_bytes2_addr_i0 : number = this_bytes2_addr_i0 + 1;
|
||||
let bitshift_amt : number = bits1.bit_length % 8;
|
||||
|
||||
let ping : boolean = next_bytes2_addr_i0 === bytes2.length;
|
||||
|
||||
|
||||
// simple case: this is a byte from the first array
|
||||
// just copy it
|
||||
if (is_bytes1_byte)
|
||||
result_bytes[i] = bytes1[i];
|
||||
// this is a boundary byte
|
||||
// further cases:
|
||||
// second bit length is 0 ->
|
||||
// ABCD_EF-- <empty>
|
||||
// ^ starting here
|
||||
// just copy first byte and move along
|
||||
else if (is_boundary_byte && (bits2.bit_length === 0))
|
||||
result_bytes[i] = bytes1[i];
|
||||
// boundary byte, and there is at least one byte in the second array
|
||||
else if (is_boundary_byte)
|
||||
{
|
||||
// copy over the first byte
|
||||
result_bytes[i] = bytes1[i];
|
||||
// take the first byte from the second array
|
||||
let first_byte_of_second_array : number = bytes2[0];
|
||||
// bytes1:
|
||||
// ABCD_EF00
|
||||
// 6
|
||||
// bytes2:
|
||||
// 1234_5678
|
||||
// 0000_0012
|
||||
// and bitshift it right by that amount
|
||||
let bitshift_amt : number = bits1.bit_length % 8;
|
||||
result_bytes[i] ^= first_byte_of_second_array >> bitshift_amt;
|
||||
}
|
||||
// last byte of second array
|
||||
else if (ping)
|
||||
result_bytes[i] = (bytes2[this_bytes2_addr_i0] << bitshift_amt);
|
||||
// ping-pong: not last byte of second array
|
||||
else
|
||||
result_bytes[i] = (bytes2[this_bytes2_addr_i0] << bitshift_amt) ^ (bytes2[next_bytes2_addr_i0] << bitshift_amt);
|
||||
}
|
||||
|
||||
return {bit_length : result_bit_length,
|
||||
bytes : result_bytes};
|
||||
|
||||
}
|
||||
@@ -0,0 +1,399 @@
|
||||
/**
|
||||
* FÆRT: Fast Æternity Recovery Text
|
||||
*
|
||||
* Reference: https://gitlab.com/zxq9/passgas/-/blob/83607fedb08be5dfd03210e331f9c76125bb3467/fullofbeans
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
export {
|
||||
encode,
|
||||
decode,
|
||||
byte_of_word,
|
||||
check_word,
|
||||
check_byte,
|
||||
words
|
||||
}
|
||||
|
||||
import * as safe from './safe.js';
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a bytestring into FÆRT
|
||||
*/
|
||||
function
|
||||
encode
|
||||
(bytes : Uint8Array)
|
||||
: string
|
||||
{
|
||||
// initial accumulator
|
||||
let words_acc : Array<string> = [];
|
||||
|
||||
// go along each byte and look up the word
|
||||
// add it to the accumulator
|
||||
for (let this_byte of bytes)
|
||||
{
|
||||
let this_word = words[this_byte];
|
||||
words_acc.push(this_word);
|
||||
}
|
||||
|
||||
// prepend check word to phrase
|
||||
// yes craig it would be faster to do the check byte inline
|
||||
// the usage case here is 64 byte strings
|
||||
// double pass is not a big deal
|
||||
return check_word(bytes) + ' ' + words_acc.join(' ');
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a FAERT string into bytes
|
||||
*/
|
||||
function
|
||||
decode
|
||||
(faert : string)
|
||||
: safe.Safe<Uint8Array, string>
|
||||
{
|
||||
let all_words : Array<string> = faert.split(' ');
|
||||
let input_check_word : string = all_words[0];
|
||||
let input_words : Array<string> = all_words.slice(1)
|
||||
|
||||
// accumulator
|
||||
let computed_bytes : Array<number> = [];
|
||||
|
||||
// loop over words and figure out accumulator
|
||||
for (let this_input_word of input_words)
|
||||
{
|
||||
let maybe_this_byte : safe.Safe<number, string> = byte_of_word(this_input_word);
|
||||
// if the word is an allowable word, add it to the accumulator
|
||||
if (maybe_this_byte.ok)
|
||||
{
|
||||
let this_byte : number = maybe_this_byte.result;
|
||||
computed_bytes.push(this_byte);
|
||||
}
|
||||
// error case, propagate the error up the call chain
|
||||
else
|
||||
return maybe_this_byte;
|
||||
}
|
||||
|
||||
// at this point, we can assume we correctly decoded all words
|
||||
// compute the check byte
|
||||
let computed_bytes_u8s : Uint8Array = new Uint8Array(computed_bytes);
|
||||
let computed_check_word : string = check_word(computed_bytes_u8s);
|
||||
|
||||
// check if it is correct
|
||||
// if so, return the computed bytes
|
||||
if (computed_check_word === input_check_word)
|
||||
return safe.ok(computed_bytes_u8s);
|
||||
// otherwise, return an error
|
||||
else
|
||||
return safe.error('checksum failure! computed check word: ' + computed_check_word + '; input check word: ' + input_check_word);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* given a word, find its index
|
||||
*/
|
||||
function
|
||||
byte_of_word
|
||||
(word: string)
|
||||
: safe.Safe<number, string>
|
||||
{
|
||||
for (let i=0; i<=255; i++)
|
||||
{
|
||||
if (word === words[i])
|
||||
return safe.ok(i);
|
||||
}
|
||||
return safe.error('invalid word: ' + word);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* compute the check word of an array
|
||||
*/
|
||||
function
|
||||
check_word
|
||||
(bytes: Uint8Array)
|
||||
: string
|
||||
{
|
||||
return words[check_byte(bytes)];
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* given an array, compute the xor of all the bytes in the array
|
||||
*/
|
||||
function
|
||||
check_byte
|
||||
(bytes: Uint8Array)
|
||||
: number
|
||||
{
|
||||
let check_byte = 0;
|
||||
for (let this_byte of bytes)
|
||||
check_byte ^= this_byte;
|
||||
return check_byte;
|
||||
}
|
||||
|
||||
|
||||
|
||||
let words = [
|
||||
"able",
|
||||
"abuse",
|
||||
"acquire",
|
||||
"adjust",
|
||||
"agent",
|
||||
"air",
|
||||
"alert",
|
||||
"alpha",
|
||||
"anger",
|
||||
"answer",
|
||||
"any",
|
||||
"argue",
|
||||
"around",
|
||||
"assume",
|
||||
"asthma",
|
||||
"aunt",
|
||||
"awkward",
|
||||
"balcony",
|
||||
"barrel",
|
||||
"because",
|
||||
"behave",
|
||||
"bicycle",
|
||||
"bike",
|
||||
"blind",
|
||||
"blouse",
|
||||
"bonus",
|
||||
"bottom",
|
||||
"breeze",
|
||||
"brother",
|
||||
"bubble",
|
||||
"burger",
|
||||
"butter",
|
||||
"can",
|
||||
"cannon",
|
||||
"cargo",
|
||||
"catalog",
|
||||
"caught",
|
||||
"century",
|
||||
"chaos",
|
||||
"chicken",
|
||||
"churn",
|
||||
"cinnamon",
|
||||
"clever",
|
||||
"clock",
|
||||
"clown",
|
||||
"collect",
|
||||
"conduct",
|
||||
"convince",
|
||||
"correct",
|
||||
"cradle",
|
||||
"crane",
|
||||
"crime",
|
||||
"cross",
|
||||
"crystal",
|
||||
"curve",
|
||||
"daughter",
|
||||
"debris",
|
||||
"decrease",
|
||||
"deny",
|
||||
"deputy",
|
||||
"despair",
|
||||
"diesel",
|
||||
"dinner",
|
||||
"distance",
|
||||
"document",
|
||||
"donate",
|
||||
"drama",
|
||||
"drink",
|
||||
"dutch",
|
||||
"earth",
|
||||
"educate",
|
||||
"elbow",
|
||||
"employ",
|
||||
"endless",
|
||||
"enlist",
|
||||
"enter",
|
||||
"equal",
|
||||
"eternal",
|
||||
"example",
|
||||
"exhibit",
|
||||
"exotic",
|
||||
"faculty",
|
||||
"famous",
|
||||
"fault",
|
||||
"feature",
|
||||
"fiber",
|
||||
"filter",
|
||||
"firm",
|
||||
"flame",
|
||||
"flush",
|
||||
"follow",
|
||||
"forward",
|
||||
"frame",
|
||||
"fringe",
|
||||
"future",
|
||||
"game",
|
||||
"gate",
|
||||
"gift",
|
||||
"glare",
|
||||
"glow",
|
||||
"goat",
|
||||
"grab",
|
||||
"grief",
|
||||
"guilt",
|
||||
"hand",
|
||||
"hawk",
|
||||
"health",
|
||||
"hen",
|
||||
"hire",
|
||||
"honey",
|
||||
"hover",
|
||||
"hurry",
|
||||
"hybrid",
|
||||
"impose",
|
||||
"inch",
|
||||
"inherit",
|
||||
"injury",
|
||||
"install",
|
||||
"iron",
|
||||
"jazz",
|
||||
"joke",
|
||||
"just",
|
||||
"kit",
|
||||
"kitchen",
|
||||
"language",
|
||||
"laundry",
|
||||
"leader",
|
||||
"lend",
|
||||
"leopard",
|
||||
"license",
|
||||
"live",
|
||||
"lobster",
|
||||
"lounge",
|
||||
"magnet",
|
||||
"mail",
|
||||
"mansion",
|
||||
"mass",
|
||||
"math",
|
||||
"media",
|
||||
"message",
|
||||
"metal",
|
||||
"misery",
|
||||
"mix",
|
||||
"more",
|
||||
"mountain",
|
||||
"museum",
|
||||
"mutual",
|
||||
"narrow",
|
||||
"nerve",
|
||||
"next",
|
||||
"note",
|
||||
"obey",
|
||||
"obtain",
|
||||
"offer",
|
||||
"once",
|
||||
"orange",
|
||||
"ostrich",
|
||||
"over",
|
||||
"owner",
|
||||
"palace",
|
||||
"patch",
|
||||
"pave",
|
||||
"pen",
|
||||
"phrase",
|
||||
"piece",
|
||||
"pizza",
|
||||
"plunge",
|
||||
"polar",
|
||||
"pool",
|
||||
"power",
|
||||
"pretty",
|
||||
"private",
|
||||
"protect",
|
||||
"pulp",
|
||||
"purity",
|
||||
"quit",
|
||||
"quote",
|
||||
"raise",
|
||||
"razor",
|
||||
"recall",
|
||||
"region",
|
||||
"relief",
|
||||
"rent",
|
||||
"rescue",
|
||||
"review",
|
||||
"ride",
|
||||
"risk",
|
||||
"roof",
|
||||
"rough",
|
||||
"saddle",
|
||||
"salmon",
|
||||
"sand",
|
||||
"scene",
|
||||
"scrub",
|
||||
"season",
|
||||
"seek",
|
||||
"series",
|
||||
"shed",
|
||||
"shoe",
|
||||
"sick",
|
||||
"silent",
|
||||
"situate",
|
||||
"skill",
|
||||
"slide",
|
||||
"slush",
|
||||
"snack",
|
||||
"solar",
|
||||
"soul",
|
||||
"special",
|
||||
"sphere",
|
||||
"spot",
|
||||
"spy",
|
||||
"stairs",
|
||||
"stereo",
|
||||
"strategy",
|
||||
"stuff",
|
||||
"success",
|
||||
"sunny",
|
||||
"surge",
|
||||
"swear",
|
||||
"symptom",
|
||||
"tail",
|
||||
"ten",
|
||||
"tent",
|
||||
"theme",
|
||||
"thumb",
|
||||
"tiny",
|
||||
"toe",
|
||||
"tooth",
|
||||
"topic",
|
||||
"trade",
|
||||
"trash",
|
||||
"trophy",
|
||||
"truly",
|
||||
"tumble",
|
||||
"typical",
|
||||
"uncle",
|
||||
"unfair",
|
||||
"until",
|
||||
"upper",
|
||||
"useless",
|
||||
"van",
|
||||
"venue",
|
||||
"video",
|
||||
"visa",
|
||||
"vocal",
|
||||
"walk",
|
||||
"waste",
|
||||
"wedding",
|
||||
"weekend",
|
||||
"wide",
|
||||
"winner",
|
||||
"wise",
|
||||
"wood",
|
||||
"wrist",
|
||||
"zero"
|
||||
]
|
||||
@@ -0,0 +1,521 @@
|
||||
/**
|
||||
* Ethereum Recursive-Length Prefix Encoding implementation
|
||||
*
|
||||
* Two reference implementations:
|
||||
*
|
||||
* 1. Ethereum Python implementation
|
||||
* 2. My Erlang implementation (agrees with Ethereum Python in randomized
|
||||
* tests)
|
||||
*
|
||||
* This work can be found in ../test/testgen/
|
||||
*
|
||||
* FIXME: need to have Safe assertions for "i am decoding a list", "i am
|
||||
* decoding a binary", "I am decoding something with no remainder", etc
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
export {
|
||||
decoded_data,
|
||||
decode_result,
|
||||
decode,
|
||||
encode
|
||||
}
|
||||
|
||||
|
||||
//=============================================================================
|
||||
//=============================================================================
|
||||
// DECODING
|
||||
//=============================================================================
|
||||
//=============================================================================
|
||||
|
||||
|
||||
/**
|
||||
* Data that RLP can encode. Also the result of decoding.
|
||||
*/
|
||||
type decoded_data
|
||||
= Uint8Array
|
||||
| Array<decoded_data>;
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decoding can have a remainder
|
||||
*/
|
||||
type decode_result
|
||||
= {decoded_data : decoded_data,
|
||||
remainder : Uint8Array};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode an RLP-encoded bytestring into a `decode_result` (decoded data +
|
||||
* whatever wasn't consumed)
|
||||
*/
|
||||
function
|
||||
decode
|
||||
(bytes: Uint8Array)
|
||||
: decode_result
|
||||
{
|
||||
// check the first byte
|
||||
let first_byte: number = bytes[0];
|
||||
let rest : Uint8Array = bytes.slice(1);
|
||||
// if the first byte is between 0 and 127, that is the data
|
||||
if
|
||||
(first_byte <= 127) {
|
||||
return dr(new Uint8Array([first_byte]), rest);
|
||||
}
|
||||
// if the first byte is between 128 and 183 = 128 + 55, it is a bytestring
|
||||
// and the length is Byte - 128
|
||||
else if
|
||||
(first_byte <= 183) {
|
||||
let payload_byte_length : number = first_byte - 128;
|
||||
let payload : Uint8Array = rest.slice(0, payload_byte_length);
|
||||
let rest2 : Uint8Array = rest.slice(payload_byte_length);
|
||||
return dr(payload, rest2);
|
||||
}
|
||||
// if the first byte is between 184 = 183 + 1 and 191 = 183 + 8, it is a
|
||||
// bytestring. the byte length of bytestring is FirstByte - 183. Then pull
|
||||
// out the actual data
|
||||
else if
|
||||
(first_byte <= 191) {
|
||||
let byte_length_of_byte_length : number = first_byte - 183;
|
||||
let bytes_of_byte_length : Uint8Array = rest.slice(0, byte_length_of_byte_length);
|
||||
let byte_length : number = bytes_to_number(bytes_of_byte_length);
|
||||
let bytes : Uint8Array = rest.slice(byte_length_of_byte_length,
|
||||
byte_length + byte_length_of_byte_length);
|
||||
let rest2 : Uint8Array = rest.slice(byte_length + byte_length_of_byte_length);
|
||||
return dr(bytes, rest2);
|
||||
}
|
||||
// If the first byte is between 192 and 247 = 192 + 55, it is a list. The
|
||||
// byte length of the list-payload is FirstByte - 192. Then the list
|
||||
// payload, which needs to be decoded on its own.
|
||||
else if
|
||||
(first_byte <= 247) {
|
||||
let byte_length_of_list : number = first_byte - 192;
|
||||
let list_payload : Uint8Array = rest.slice(0, byte_length_of_list);
|
||||
let list : Array<decoded_data> = decode_list(list_payload);
|
||||
let rest2 : Uint8Array = rest.slice(byte_length_of_list);
|
||||
return dr(list, rest2);
|
||||
}
|
||||
// If the first byte is between 248 = 247 + 1 and 255 = 247 + 8, it is a
|
||||
// list. The byte length of the byte length of the list-payload is
|
||||
// FirstByte - 247. Then the byte length of the list. Then the list
|
||||
// payload, which needs to be decoded on its own.
|
||||
else {
|
||||
let byte_length_of_byte_length : number = first_byte - 247;
|
||||
let bytes_of_byte_length : Uint8Array = rest.slice(0, byte_length_of_byte_length);
|
||||
let byte_length : number = bytes_to_number(bytes_of_byte_length);
|
||||
let list_bytes : Uint8Array = rest.slice(byte_length_of_byte_length,
|
||||
byte_length + byte_length_of_byte_length);
|
||||
let list : Array<decoded_data> = decode_list(list_bytes);
|
||||
let rest2 : Uint8Array = rest.slice(byte_length + byte_length_of_byte_length);
|
||||
return dr(list, rest2);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Decode a list payload (non-prefixed) into an `Array<decoded_data>`.
|
||||
*
|
||||
* Repeatedly decodes an element off the list until remainder is empty.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
decode_list
|
||||
(bytes: Uint8Array)
|
||||
: Array<decoded_data>
|
||||
{
|
||||
let arr : Array<decoded_data> = [];
|
||||
while (bytes.length > 0) {
|
||||
// grab an item off the bytes
|
||||
let {decoded_data, remainder} = decode(bytes);
|
||||
// push it
|
||||
arr.push(decoded_data);
|
||||
// update bytes
|
||||
bytes = remainder;
|
||||
}
|
||||
return arr;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Convert bytestring to number
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
bytes_to_number
|
||||
(bytes: Uint8Array)
|
||||
: number
|
||||
{
|
||||
let n : number = 0;
|
||||
for (let b of bytes)
|
||||
{
|
||||
n <<= 8;
|
||||
n += b;
|
||||
}
|
||||
return n;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Make a `decode_result` containing the two arguments
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
dr
|
||||
(x : decoded_data,
|
||||
y : Uint8Array)
|
||||
: decode_result
|
||||
{
|
||||
return {decoded_data : x,
|
||||
remainder : y};
|
||||
}
|
||||
|
||||
|
||||
|
||||
//=============================================================================
|
||||
//=============================================================================
|
||||
// ENCODING
|
||||
//=============================================================================
|
||||
//=============================================================================
|
||||
|
||||
/**
|
||||
* Encode some decoded data
|
||||
*/
|
||||
function
|
||||
encode
|
||||
(data: decoded_data)
|
||||
: Uint8Array
|
||||
{
|
||||
// is it an array or data
|
||||
if
|
||||
(is_binary(data)) {
|
||||
return encode_binary(data as Uint8Array);
|
||||
}
|
||||
else if
|
||||
(is_list(data)) {
|
||||
return encode_list(data as Array<decoded_data>);
|
||||
}
|
||||
else {
|
||||
throw new Error('encode told to encode something that is not an array or a binary: ' + data);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a binary into RLP
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode_binary
|
||||
(bytes: Uint8Array)
|
||||
: Uint8Array
|
||||
{
|
||||
let len: number = bytes.length;
|
||||
// single byte case when the byte is between 0..127
|
||||
// result is the bytestring containing the byte itself
|
||||
if
|
||||
((len === 1) &&
|
||||
(bytes[0] <= 127)){
|
||||
return bytes;
|
||||
}
|
||||
// if the bytestring is 0..55 bytes long, the first byte in the result is
|
||||
// 128 + Length, the rest of the result bytestring is the input string
|
||||
else if
|
||||
(len <= 55) {
|
||||
// construct the result
|
||||
// <<128 + Len, Bytes/binary>>
|
||||
let result : Uint8Array = new Uint8Array(len + 1);
|
||||
// first byte is 128 + length
|
||||
result[0] = 128 + len;
|
||||
// copy input bytes into result
|
||||
for (let input_idx0 = 0;
|
||||
input_idx0 < len;
|
||||
input_idx0++)
|
||||
{
|
||||
let result_idx0 : number = input_idx0 + 1;
|
||||
result[result_idx0] = bytes[input_idx0];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
// if the bytestring is more than 55 bytes long, the first byte is 183 +
|
||||
// ByteLengthOfByteLength, followed by the byte length, followed by the
|
||||
// bytes
|
||||
else {
|
||||
let len_bytes : Uint8Array = encode_unsigned(len);
|
||||
let len_bytes_length : number = len_bytes.length;
|
||||
// total array is
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
let result : Uint8Array = new Uint8Array(1 + len_bytes_length + len);
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
result[0] = 183 + len_bytes_length;
|
||||
// copy len_bytes into result
|
||||
for (let len_bytes_idx0 = 0;
|
||||
len_bytes_idx0 < len_bytes_length;
|
||||
len_bytes_idx0++)
|
||||
{
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
let result_idx0: number = len_bytes_idx0 + 1;
|
||||
result[result_idx0] = len_bytes[len_bytes_idx0];
|
||||
}
|
||||
// copy original byte array into result
|
||||
for (let input_idx0 = 0;
|
||||
input_idx0 < len;
|
||||
input_idx0++)
|
||||
{
|
||||
// <<183 + len_bytes_length, len_bytes, Bytes>>
|
||||
// 1 byte len_bytes_length bytes len bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
let result_idx0: number = input_idx0 + (1 + len_bytes_length);
|
||||
result[result_idx0] = bytes[input_idx0];
|
||||
}
|
||||
// finally, return the result
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a list
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode_list
|
||||
(list: Array<decoded_data>)
|
||||
: Uint8Array
|
||||
{
|
||||
// first encode every element in the list, then branch
|
||||
let payloads : Array<Uint8Array> = list.map(encode);
|
||||
let payload : Uint8Array = uint8arr_concat(payloads);
|
||||
let payload_size : number = payload.length;
|
||||
// if the payload size is in 0..55, then the first byte is 192 + payload
|
||||
// size, followed by the payload
|
||||
if
|
||||
(payload_size <= 55) {
|
||||
// result: <<(192 + Payload_Size), Payload/binary >>;
|
||||
// 1 byte payload_size bytes
|
||||
let result : Uint8Array = new Uint8Array(1 + payload_size);
|
||||
// result: <<(192 + Payload_Size), Payload/binary >>;
|
||||
// 1 byte payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
result[0] = 192 + payload_size;
|
||||
// copy the rest of the payload into result
|
||||
for (let payload_idx0 = 0;
|
||||
payload_idx0 < payload_size;
|
||||
payload_idx0++)
|
||||
{
|
||||
// result: <<(192 + Payload_Size), Payload/binary >>;
|
||||
// 1 byte payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
let result_idx0: number = payload_idx0 + 1;
|
||||
result[result_idx0] = payload[payload_idx0];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
// if the payload size is greater than 55, the first byte is 247 +
|
||||
// size_of_payload_size, followed by the payload size, followed by the
|
||||
// payload
|
||||
else {
|
||||
// compute the payload size size
|
||||
let payload_size_bytes : Uint8Array = encode_unsigned(payload_size);
|
||||
let payload_size_size : number = payload_size_bytes.length;
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
let result: Uint8Array = new Uint8Array(1 + payload_size_size + payload_size);
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
// first byte is 247 + payload_size_size
|
||||
result[0] = 247 + payload_size_size;
|
||||
// copy the payload_size_bytes into result
|
||||
for (let psb_idx0 = 0;
|
||||
psb_idx0 < payload_size_size;
|
||||
psb_idx0++)
|
||||
{
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
// offset is 1 byte for this
|
||||
let result_idx0 : number = psb_idx0 + 1;
|
||||
result[result_idx0] = payload_size_bytes[psb_idx0];
|
||||
}
|
||||
// copy the payload into result
|
||||
for (let pb_idx0 = 0;
|
||||
pb_idx0 < payload_size;
|
||||
pb_idx0++)
|
||||
{
|
||||
// result = <<(247 + payload_size_size), payload_size_bytes/binary, payload/binary >>
|
||||
// 1 byte payload_size_size bytes payload_size bytes
|
||||
//
|
||||
// ^ YOU ARE HERE
|
||||
// offset is 1 + payload_size_size bytes for this
|
||||
let result_idx0 : number = pb_idx0 + (1 + payload_size_size);
|
||||
result[result_idx0] = payload[pb_idx0];
|
||||
}
|
||||
// finally, return result
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Encode a number as a bytestring
|
||||
*
|
||||
* Not for general use, this assumes the input number is greater than 55
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
encode_unsigned
|
||||
(n: number)
|
||||
: Uint8Array
|
||||
{
|
||||
// can assume that n initially is greater than 55
|
||||
// have to encode it in reverse order
|
||||
let arr : Array<number> = [];
|
||||
// repeated division by 256 with remainder
|
||||
//
|
||||
// example: suppose bign was 1234 and we were dividing by 10
|
||||
//
|
||||
// iteration 0:
|
||||
// bign = 1234
|
||||
// arr = []
|
||||
// ---
|
||||
// bign / 10 = 123
|
||||
// bign % 10 = 4
|
||||
// ---
|
||||
// bign = 123
|
||||
// arr = [4]
|
||||
//
|
||||
// iteration 1:
|
||||
// bign = 123
|
||||
// arr = [4]
|
||||
// ---
|
||||
// bign / 10 = 12
|
||||
// bign % 10 = 3
|
||||
// ---
|
||||
// bign = 12
|
||||
// arr = [4, 3]
|
||||
//
|
||||
// iteration 2:
|
||||
// bign = 12
|
||||
// arr = [4, 3]
|
||||
// ---
|
||||
// bign / 10 = 1
|
||||
// bign % 10 = 2
|
||||
// ---
|
||||
// bign = 1
|
||||
// arr = [4, 3, 2]
|
||||
//
|
||||
// iteration 3:
|
||||
// bign = 1
|
||||
// arr = [4, 3, 2]
|
||||
// ---
|
||||
// bign / 10 = 0
|
||||
// bign % 10 = 1
|
||||
// ---
|
||||
// bign = 0
|
||||
// arr = [4, 3, 2, 1]
|
||||
//
|
||||
// iteration 4:
|
||||
// bign = 0
|
||||
// arr = [4, 3, 2, 1]
|
||||
// ---
|
||||
// DONE
|
||||
while (n > 0) {
|
||||
arr.push(n % 256);
|
||||
n >>= 8;
|
||||
}
|
||||
// reverse and make into Uint8Array
|
||||
arr.reverse();
|
||||
return new Uint8Array(arr);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* concatenate an array of `Uint8Array`s into a single Uint8Array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
uint8arr_concat
|
||||
(arrs: Array<Uint8Array>)
|
||||
: Uint8Array
|
||||
{
|
||||
// total length
|
||||
let total_len = arrs.reduce(// fold
|
||||
function (acc_len: number, this_uint8array: Uint8Array): number {
|
||||
return acc_len + this_uint8array.length;
|
||||
},
|
||||
// initial accumulator
|
||||
0);
|
||||
// start up result
|
||||
let result : Uint8Array = new Uint8Array(total_len);
|
||||
let result_idx0 : number = 0;
|
||||
// concatenate
|
||||
for (let this_uint8arr of arrs) {
|
||||
// bytewise copy of this uint8array
|
||||
for (let this_uint8arr_idx0 = 0;
|
||||
this_uint8arr_idx0 < this_uint8arr.length;
|
||||
this_uint8arr_idx0++)
|
||||
{
|
||||
// copy byte and increment result idx0
|
||||
result[result_idx0] = this_uint8arr[this_uint8arr_idx0];
|
||||
result_idx0++;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* returns true if input is `instanceof Uint8Array`
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
is_binary
|
||||
(x: any)
|
||||
: boolean
|
||||
{
|
||||
return (x instanceof Uint8Array);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* returns true if input is `instanceof Array`
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function
|
||||
is_list
|
||||
(x: any)
|
||||
: boolean
|
||||
{
|
||||
return (x instanceof Array);
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
/**
|
||||
* "Safe" error handling
|
||||
*
|
||||
* The idea here is that there are situations where it is known
|
||||
*
|
||||
* ```typescript
|
||||
* type Safe<ok_t, err_t>
|
||||
* = Ok<ok_t>
|
||||
* | Error<err_t>;
|
||||
*
|
||||
* type Ok<ok_t>
|
||||
* = {ok : true,
|
||||
* result : ok_t};
|
||||
*
|
||||
* type Error<err_t>
|
||||
* = {ok : false,
|
||||
* error : err_t};
|
||||
* ```
|
||||
*
|
||||
* 1. a given function call is likely to fail
|
||||
* 2. the likely errors can be enumerated
|
||||
*
|
||||
* These are called "positive errors". An example would be a page script
|
||||
* asking a browser wallet extension to sign a transaction. The following
|
||||
* errors, among others, are likely:
|
||||
*
|
||||
* - the user does not have a wallet installed
|
||||
* - the user has a wallet but does not have the correct signing key
|
||||
* - the user rejects the transaction
|
||||
* - the sign request timed out
|
||||
*
|
||||
* These errors should not generate exceptions, as these behaviors are to some
|
||||
* degree "expected".
|
||||
*/
|
||||
|
||||
export {
|
||||
Safe,
|
||||
Ok,
|
||||
Error,
|
||||
ok,
|
||||
error,
|
||||
unsafe
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Type that catches positive errors
|
||||
*/
|
||||
type Safe<ok_t, err_t>
|
||||
= Ok<ok_t>
|
||||
| Error<err_t>;
|
||||
|
||||
|
||||
/**
|
||||
* Ok type
|
||||
*/
|
||||
type Ok<ok_t>
|
||||
= {ok : true,
|
||||
result : ok_t};
|
||||
|
||||
|
||||
/**
|
||||
* Error type
|
||||
*/
|
||||
type Error<err_t>
|
||||
= {ok : false,
|
||||
error : err_t};
|
||||
|
||||
|
||||
/**
|
||||
* Constructs an `Ok` value from a pure value
|
||||
*/
|
||||
function
|
||||
ok
|
||||
<ok_t>
|
||||
(x : ok_t)
|
||||
: Ok<ok_t>
|
||||
{
|
||||
return {ok: true, result: x};
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Constructs an `Error` value from a pure value
|
||||
*/
|
||||
function
|
||||
error
|
||||
<err_t>
|
||||
(x: err_t)
|
||||
: Error<err_t>
|
||||
{
|
||||
return {ok: false, error: x};
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Takes a `Safe` value, if `ok`, returns the `ok_t`, or if an error throws the
|
||||
* `err_t`
|
||||
*/
|
||||
function
|
||||
unsafe
|
||||
<ok_t, err_t>
|
||||
(x: Safe<ok_t, err_t>)
|
||||
: ok_t
|
||||
{
|
||||
if (x.ok)
|
||||
return x.result;
|
||||
else
|
||||
throw x.error;
|
||||
}
|
||||
Vendored
+7
@@ -0,0 +1,7 @@
|
||||
import * as rlp from './jex_include/local-vdk-0.1.0/dist/rlp.js';
|
||||
declare type rlpcases = {
|
||||
decoded: rlp.decoded_data;
|
||||
encoded: Uint8Array;
|
||||
};
|
||||
export declare const cases: Array<rlpcases>;
|
||||
export {};
|
||||
Vendored
+12568
File diff suppressed because it is too large
Load Diff
Vendored
+1
File diff suppressed because one or more lines are too long
@@ -0,0 +1,5 @@
|
||||
{type, library}.
|
||||
{realm, local}.
|
||||
{name, vdk_cases}.
|
||||
{version, "0.1.0"}.
|
||||
{deps, ["local-vdk-0.1.0"]}.
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
export declare const rlp: {
|
||||
decoded: import("./jex_include/local-vdk-0.1.0/dist/rlp.js").decoded_data;
|
||||
encoded: Uint8Array;
|
||||
}[];
|
||||
export declare const base58: {
|
||||
encoded: string;
|
||||
decoded: Uint8Array;
|
||||
}[];
|
||||
export declare const base64: {
|
||||
decoded: Uint8Array;
|
||||
encoded: string;
|
||||
}[];
|
||||
+3657
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Base58 encoding/decoding
|
||||
*/
|
||||
export { encode, decode };
|
||||
/**
|
||||
* Encode a Uint8Array into base58
|
||||
*/
|
||||
declare function encode(binary: Uint8Array): string;
|
||||
/**
|
||||
* Decode a Base58 string into a Uint8Array
|
||||
*/
|
||||
declare function decode(base58: string): Uint8Array;
|
||||
@@ -0,0 +1,308 @@
|
||||
/**
|
||||
* Base58 encoding/decoding
|
||||
*/
|
||||
export { encode, decode };
|
||||
//=============================================================================
|
||||
// ENCODING
|
||||
//=============================================================================
|
||||
/**
|
||||
* Encode a Uint8Array into base58
|
||||
*/
|
||||
function encode(binary) {
|
||||
let num_leading_zeros = nlz(binary);
|
||||
let rest = binary.slice(num_leading_zeros);
|
||||
let ones = encode_zeros(num_leading_zeros);
|
||||
let rest_b58 = encode_rest(rest);
|
||||
let result = ones + rest_b58;
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* count the number of leading zeros in a uint8array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function nlz(bytes) {
|
||||
let n = 0;
|
||||
for (let this_byte of bytes) {
|
||||
if (0 === this_byte) {
|
||||
n++;
|
||||
}
|
||||
else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return n;
|
||||
}
|
||||
/**
|
||||
* Generate a bunch of '1's for however many leading zeros there are
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_zeros(how_many) {
|
||||
let ones = '';
|
||||
for (let i = 1; i <= how_many; i++) {
|
||||
ones += '1';
|
||||
}
|
||||
return ones;
|
||||
}
|
||||
/**
|
||||
* Encode a Uint8Array that has no leading zeros
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_rest(bytes) {
|
||||
let bytes_bignum = bytes_to_bigint(bytes);
|
||||
let result = bignum_to_base58(bytes_bignum);
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Convert a bytestring to a bignum
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bytes_to_bigint(bytes) {
|
||||
let acc_bigint = 0n;
|
||||
for (let this_byte of bytes) {
|
||||
acc_bigint <<= 8n;
|
||||
acc_bigint += BigInt(this_byte);
|
||||
}
|
||||
return acc_bigint;
|
||||
}
|
||||
/**
|
||||
* Convert a BigInt to Base58
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bignum_to_base58(q) {
|
||||
let s = '';
|
||||
while (q !== 0n) {
|
||||
let this_n = q % 58n;
|
||||
q /= 58n;
|
||||
let this_b58_char = bigint_to_char(this_n);
|
||||
s = this_b58_char + s;
|
||||
}
|
||||
return s;
|
||||
}
|
||||
//=============================================================================
|
||||
// DECODING
|
||||
//=============================================================================
|
||||
/**
|
||||
* Decode a Base58 string into a Uint8Array
|
||||
*/
|
||||
function decode(base58) {
|
||||
let num_leading_ones = nlo(base58);
|
||||
let rest = base58.slice(num_leading_ones);
|
||||
let zeros = decode_ones(num_leading_ones);
|
||||
let rest_arr = decode_rest(rest);
|
||||
let pre_result = zeros.concat(rest_arr);
|
||||
return new Uint8Array(pre_result);
|
||||
}
|
||||
/**
|
||||
* count the number of leading 1 characters in a uint8array
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function nlo(base58) {
|
||||
let n = 0;
|
||||
for (let this_char of base58) {
|
||||
if ('1' === this_char) {
|
||||
n++;
|
||||
}
|
||||
else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return n;
|
||||
}
|
||||
/**
|
||||
* Generate a bunch of '0's for however many leading ones there are
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_ones(how_many) {
|
||||
let zeros = [];
|
||||
for (let i = 1; i <= how_many; i++) {
|
||||
zeros.push(0);
|
||||
}
|
||||
return zeros;
|
||||
}
|
||||
/**
|
||||
* Decode a string that has no leading 1s
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_rest(base58) {
|
||||
let result_bignum = base58_to_bigint(base58);
|
||||
let result = bigint_to_base256(result_bignum);
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Convert a base58 string to a bignum
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function base58_to_bigint(base58) {
|
||||
let acc_bigint = 0n;
|
||||
for (let this_char of base58) {
|
||||
acc_bigint *= 58n;
|
||||
acc_bigint += char_to_bigint(this_char);
|
||||
}
|
||||
return acc_bigint;
|
||||
}
|
||||
/**
|
||||
* convert a bignum into a byte array
|
||||
*
|
||||
* @end
|
||||
*/
|
||||
function bigint_to_base256(q) {
|
||||
let arr_reverse = [];
|
||||
while (q !== 0n) {
|
||||
let r = Number(q % 256n);
|
||||
q /= 256n;
|
||||
arr_reverse.push(r);
|
||||
}
|
||||
arr_reverse.reverse();
|
||||
return arr_reverse;
|
||||
}
|
||||
//=============================================================================
|
||||
// TRANSLATION TABLES
|
||||
//=============================================================================
|
||||
/**
|
||||
* Base58 integer -> character conversion table
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bigint_to_char(n) {
|
||||
switch (n) {
|
||||
case 0n: return '1';
|
||||
case 1n: return '2';
|
||||
case 2n: return '3';
|
||||
case 3n: return '4';
|
||||
case 4n: return '5';
|
||||
case 5n: return '6';
|
||||
case 6n: return '7';
|
||||
case 7n: return '8';
|
||||
case 8n: return '9';
|
||||
case 9n: return 'A';
|
||||
case 10n: return 'B';
|
||||
case 11n: return 'C';
|
||||
case 12n: return 'D';
|
||||
case 13n: return 'E';
|
||||
case 14n: return 'F';
|
||||
case 15n: return 'G';
|
||||
case 16n: return 'H';
|
||||
case 17n: return 'J';
|
||||
case 18n: return 'K';
|
||||
case 19n: return 'L';
|
||||
case 20n: return 'M';
|
||||
case 21n: return 'N';
|
||||
case 22n: return 'P';
|
||||
case 23n: return 'Q';
|
||||
case 24n: return 'R';
|
||||
case 25n: return 'S';
|
||||
case 26n: return 'T';
|
||||
case 27n: return 'U';
|
||||
case 28n: return 'V';
|
||||
case 29n: return 'W';
|
||||
case 30n: return 'X';
|
||||
case 31n: return 'Y';
|
||||
case 32n: return 'Z';
|
||||
case 33n: return 'a';
|
||||
case 34n: return 'b';
|
||||
case 35n: return 'c';
|
||||
case 36n: return 'd';
|
||||
case 37n: return 'e';
|
||||
case 38n: return 'f';
|
||||
case 39n: return 'g';
|
||||
case 40n: return 'h';
|
||||
case 41n: return 'i';
|
||||
case 42n: return 'j';
|
||||
case 43n: return 'k';
|
||||
case 44n: return 'm';
|
||||
case 45n: return 'n';
|
||||
case 46n: return 'o';
|
||||
case 47n: return 'p';
|
||||
case 48n: return 'q';
|
||||
case 49n: return 'r';
|
||||
case 50n: return 's';
|
||||
case 51n: return 't';
|
||||
case 52n: return 'u';
|
||||
case 53n: return 'v';
|
||||
case 54n: return 'w';
|
||||
case 55n: return 'x';
|
||||
case 56n: return 'y';
|
||||
case 57n: return 'z';
|
||||
default:
|
||||
throw new Error('invalid base58 bigint: ' + n);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Base58 character -> integer conversion table
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function char_to_bigint(s) {
|
||||
switch (s) {
|
||||
case '1': return 0n;
|
||||
case '2': return 1n;
|
||||
case '3': return 2n;
|
||||
case '4': return 3n;
|
||||
case '5': return 4n;
|
||||
case '6': return 5n;
|
||||
case '7': return 6n;
|
||||
case '8': return 7n;
|
||||
case '9': return 8n;
|
||||
case 'A': return 9n;
|
||||
case 'B': return 10n;
|
||||
case 'C': return 11n;
|
||||
case 'D': return 12n;
|
||||
case 'E': return 13n;
|
||||
case 'F': return 14n;
|
||||
case 'G': return 15n;
|
||||
case 'H': return 16n;
|
||||
case 'J': return 17n;
|
||||
case 'K': return 18n;
|
||||
case 'L': return 19n;
|
||||
case 'M': return 20n;
|
||||
case 'N': return 21n;
|
||||
case 'P': return 22n;
|
||||
case 'Q': return 23n;
|
||||
case 'R': return 24n;
|
||||
case 'S': return 25n;
|
||||
case 'T': return 26n;
|
||||
case 'U': return 27n;
|
||||
case 'V': return 28n;
|
||||
case 'W': return 29n;
|
||||
case 'X': return 30n;
|
||||
case 'Y': return 31n;
|
||||
case 'Z': return 32n;
|
||||
case 'a': return 33n;
|
||||
case 'b': return 34n;
|
||||
case 'c': return 35n;
|
||||
case 'd': return 36n;
|
||||
case 'e': return 37n;
|
||||
case 'f': return 38n;
|
||||
case 'g': return 39n;
|
||||
case 'h': return 40n;
|
||||
case 'i': return 41n;
|
||||
case 'j': return 42n;
|
||||
case 'k': return 43n;
|
||||
case 'm': return 44n;
|
||||
case 'n': return 45n;
|
||||
case 'o': return 46n;
|
||||
case 'p': return 47n;
|
||||
case 'q': return 48n;
|
||||
case 'r': return 49n;
|
||||
case 's': return 50n;
|
||||
case 't': return 51n;
|
||||
case 'u': return 52n;
|
||||
case 'v': return 53n;
|
||||
case 'w': return 54n;
|
||||
case 'x': return 55n;
|
||||
case 'y': return 56n;
|
||||
case 'z': return 57n;
|
||||
default:
|
||||
throw new Error('invalid base58 char: ' + s);
|
||||
}
|
||||
}
|
||||
//# sourceMappingURL=b58.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Base64 Utility Functions in TypeScript
|
||||
*/
|
||||
export { encode, decode };
|
||||
/**
|
||||
* Encode an array of bytes as a Uint8Array in base64 notation.
|
||||
*/
|
||||
declare function encode(bytes: Uint8Array): string;
|
||||
/**
|
||||
* Decode a base64-encoded string
|
||||
*/
|
||||
declare function decode(base64_str: string): Uint8Array;
|
||||
@@ -0,0 +1,507 @@
|
||||
/**
|
||||
* Base64 Utility Functions in TypeScript
|
||||
*/
|
||||
export { encode, decode };
|
||||
/**
|
||||
* Encode an array of bytes as a Uint8Array in base64 notation.
|
||||
*/
|
||||
function encode(bytes) {
|
||||
// slice the array
|
||||
// length of head is a multiple of 3
|
||||
// treat the tail as a special case
|
||||
let { head, tail, tail_len } = slice3k(bytes);
|
||||
let head_str = encode_head(head);
|
||||
let tail_str = encode_tail(tail, tail_len);
|
||||
return head_str + tail_str;
|
||||
}
|
||||
/**
|
||||
* Take a Uint8Array, take the first 3k (k >= 0) bytes, put them in head, and
|
||||
* the remaining 0,1, or 2 bytes, put them in tail
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function slice3k(bytes) {
|
||||
let len = bytes.length;
|
||||
// too lazy to look up how to do integer division in js so this will do
|
||||
let tail_len = len % 3;
|
||||
let head_len = len - tail_len;
|
||||
// for slice:
|
||||
// first argument is the 0-index of the start
|
||||
// second - first is the length of the slice
|
||||
let head = bytes.slice(0, head_len);
|
||||
// empty second argument means go to the end
|
||||
let tail = bytes.slice(head_len);
|
||||
return { head: head,
|
||||
tail: tail,
|
||||
tail_len: tail_len };
|
||||
}
|
||||
/**
|
||||
* Encode a Uint8Array whose length is known to be a multiple of 3
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_head(head_bytes) {
|
||||
// can assume length of bytes is a multiple of 3
|
||||
// start index at 0
|
||||
// increment by 3
|
||||
let head_bytes_len = head_bytes.length;
|
||||
let max_idx0 = head_bytes_len - 1;
|
||||
let head_str_acc = '';
|
||||
for (let this_3slice_start_idx0 = 0; this_3slice_start_idx0 <= max_idx0; this_3slice_start_idx0 += 3) {
|
||||
let this_3slice_bytes = head_bytes.slice(this_3slice_start_idx0, this_3slice_start_idx0 + 3);
|
||||
let this_3slice_str = encode3(this_3slice_bytes);
|
||||
head_str_acc += this_3slice_str;
|
||||
}
|
||||
return head_str_acc;
|
||||
}
|
||||
/**
|
||||
* Encode a 3 bytes into base64 notation
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode3(bytes) {
|
||||
let b0 = bytes[0];
|
||||
let b1 = bytes[1];
|
||||
let b2 = bytes[2];
|
||||
// ABCDEFGH 12345678 abcdefgh
|
||||
// b0 b1 b2
|
||||
// ABCDEF GH1234 5678ab cdefgh
|
||||
// n0 n1 n2 n3
|
||||
let n0 = b0 >> 2;
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
// b1 = 12345678
|
||||
// b1 >> 4 = ____1234
|
||||
// n1 = __GH1234
|
||||
let n1 = ((b0 % 4) << 4) + (b1 >> 4);
|
||||
// b1 = 12345678
|
||||
// 16 = ___1____
|
||||
// b1 % 16 = ____5678
|
||||
// (b1 % 16) << 2 = __5678__
|
||||
// b2 = abcdefgh
|
||||
// b2 >> 6 = ______ab
|
||||
// n2 = __5678ab
|
||||
let n2 = ((b1 % 16) << 2) + (b2 >> 6);
|
||||
// b2 = abcdefgh
|
||||
// 64 = _1______
|
||||
// n3 = __cdefgh
|
||||
let n3 = b2 % 64;
|
||||
// convert to chars
|
||||
let s0 = int2char(n0);
|
||||
let s1 = int2char(n1);
|
||||
let s2 = int2char(n2);
|
||||
let s3 = int2char(n3);
|
||||
// retrvn
|
||||
return s0 + s1 + s2 + s3;
|
||||
}
|
||||
/**
|
||||
* Encode the final 0, 1, or 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode_tail(tail_bytes, tail_len) {
|
||||
switch (tail_len) {
|
||||
case 0: return '';
|
||||
case 1: return encode1(tail_bytes);
|
||||
case 2: return encode2(tail_bytes);
|
||||
default:
|
||||
throw new Error('encode_tail with tail_len = ' + tail_len);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Encode a single byte
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode1(bytes) {
|
||||
let b0 = bytes[0];
|
||||
// n0 = __ABCDEF
|
||||
// b0 = ABCDEFGH
|
||||
// b0 >> 2 = __ABCDEF
|
||||
let n0 = b0 >> 2;
|
||||
// n1 = __GH____
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
let n1 = (b0 % 4) << 4;
|
||||
return int2char(n0) + int2char(n1) + '==';
|
||||
}
|
||||
/**
|
||||
* Encode two bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function encode2(bytes) {
|
||||
let b0 = bytes[0];
|
||||
let b1 = bytes[1];
|
||||
// ABCDEFGH 12345678
|
||||
// b0 b1
|
||||
// ABCDEF GH1234 5678__
|
||||
// n0 n1 n2
|
||||
let n0 = b0 >> 2;
|
||||
// b0 = ABCDEFGH
|
||||
// 4 = _____1__
|
||||
// b0 % 4 = ______GH
|
||||
// (b0 % 4) << 4 = __GH____
|
||||
// b1 = 12345678
|
||||
// b1 >> 4 = ____1234
|
||||
// n1 = __GH1234
|
||||
let n1 = ((b0 % 4) << 4) + (b1 >> 4);
|
||||
// b1 = 12345678
|
||||
// 16 = ___1____
|
||||
// b1 % 16 = ____5678
|
||||
// (b1 % 16) << 2 = __5678__
|
||||
// n2 = __5678__
|
||||
let n2 = (b1 % 16) << 2;
|
||||
// convert to chars
|
||||
let s0 = int2char(n0);
|
||||
let s1 = int2char(n1);
|
||||
let s2 = int2char(n2);
|
||||
// retrvn
|
||||
return s0 + s1 + s2 + '=';
|
||||
}
|
||||
/**
|
||||
* Decode a base64-encoded string
|
||||
*/
|
||||
function decode(base64_str) {
|
||||
// length of the string is guaranteed to be a multiple of 4
|
||||
// if the string is empty, return the empty array
|
||||
let len = base64_str.length;
|
||||
// this branching contains the implicit assertion that the length is a
|
||||
// multiple of 4. If this is not true, the bottom branch is triggered.
|
||||
// general case goes first because speeeeeed
|
||||
if ((4 < len)
|
||||
&& (0 === (len % 4))) {
|
||||
// split the head and tail
|
||||
let tail_start_idx0 = len - 4;
|
||||
let head_s = base64_str.slice(0, tail_start_idx0);
|
||||
let tail_s = base64_str.slice(tail_start_idx0);
|
||||
// Using arrays because Uint8Arrays don't have a concat operation
|
||||
let head_arr = decode_head(head_s);
|
||||
let tail_arr = decode_tail(tail_s);
|
||||
// silly to put these in variables but this is exactly the type of
|
||||
// situation where JS type insanity shows up
|
||||
//
|
||||
// see: i forgot
|
||||
// > [1,2,3] + [4,5,6]
|
||||
// '1,2,34,5,6'
|
||||
//
|
||||
// Originally, I used + like some sort of moron who codes in a sane
|
||||
// language
|
||||
//
|
||||
// seriously what is this language
|
||||
//
|
||||
// this is some clown behavior
|
||||
let total_arr = head_arr.concat(tail_arr);
|
||||
return new Uint8Array(total_arr);
|
||||
}
|
||||
// special case if the length is exactly 4
|
||||
else if (4 === len) {
|
||||
// it's just a tail
|
||||
return new Uint8Array(decode_tail(base64_str));
|
||||
}
|
||||
// empty string
|
||||
else if (0 === len) {
|
||||
return new Uint8Array([]);
|
||||
}
|
||||
else {
|
||||
throw new Error('base64 decode: invalid string length: ' + len);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Decode a string known to not have any padding
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_head(s) {
|
||||
// go 4 characters at a time
|
||||
let max_i0 = s.length - 1;
|
||||
let decoded_acc = [];
|
||||
for (let i0 = 0; i0 <= max_i0; i0 += 4) {
|
||||
let this_slice_s = s.slice(i0, i0 + 4);
|
||||
let this_slice_arr = decode3(this_slice_s);
|
||||
// update accumulator
|
||||
decoded_acc = decoded_acc.concat(this_slice_arr);
|
||||
}
|
||||
return decoded_acc;
|
||||
}
|
||||
/**
|
||||
* Decode 4 characters that correspond to either 3 bytes, 2, bytes, or 1 byte
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode_tail(s) {
|
||||
// all that matters right now is the last 2 chars
|
||||
// s0, s1, s2, s3
|
||||
// 0 based indexing is so annoying
|
||||
let s2 = s[2];
|
||||
let s3 = s[3];
|
||||
// braaaaaaaaaaaaaaaaaench
|
||||
// two equals signs means 1 byte
|
||||
if (('=' === s3) && ('=' === s2)) {
|
||||
return decode1(s);
|
||||
}
|
||||
// one equals sign means 2 bytes
|
||||
else if (('=' === s3)) {
|
||||
return decode2(s);
|
||||
}
|
||||
// 0 equals signs means 3 bytes
|
||||
else {
|
||||
return decode3(s);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 3 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode3(s) {
|
||||
// pull out strings
|
||||
let s0 = s[0];
|
||||
let s1 = s[1];
|
||||
let s2 = s[2];
|
||||
let s3 = s[3];
|
||||
// convert to numbers
|
||||
let n0 = char2int(s0);
|
||||
let n1 = char2int(s1);
|
||||
let n2 = char2int(s2);
|
||||
let n3 = char2int(s3);
|
||||
// abcdef gh1234 5678ab cdefgh
|
||||
// n0 n1 n2 n3
|
||||
// abcdefgh 12345678 abcdefgh
|
||||
// b0 b1 b2
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh1234
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 = (n0 << 2) + (n1 >> 4);
|
||||
// n1 = __gh1234
|
||||
// 16 = ___1____
|
||||
// n1 % 16 = ____1234
|
||||
// (n1 % 16) << 4 = 1234____
|
||||
// n2 = __5678ab
|
||||
// n2 >> 2 = ____5678
|
||||
// b1 = 12345678
|
||||
let b1 = ((n1 % 16) << 4) + (n2 >> 2);
|
||||
// n2 = __5678ab
|
||||
// 4 = _____1__
|
||||
// n2 % 4 = ______ab
|
||||
// (n2 % 4) << 6 = ab______
|
||||
// n3 = __cdefgh
|
||||
let b2 = ((n2 % 4) << 6) + n3;
|
||||
return [b0, b1, b2];
|
||||
}
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode2(s) {
|
||||
// xyz=
|
||||
// pull out strings
|
||||
let s0 = s[0];
|
||||
let s1 = s[1];
|
||||
let s2 = s[2];
|
||||
// convert to numbers
|
||||
let n0 = char2int(s0);
|
||||
let n1 = char2int(s1);
|
||||
let n2 = char2int(s2);
|
||||
// abcdef gh1234 5678__
|
||||
// n0 n1 n2
|
||||
// abcdefgh 12345678
|
||||
// b0 b1
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh1234
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 = (n0 << 2) + (n1 >> 4);
|
||||
// n1 = __gh1234
|
||||
// 16 = ___1____
|
||||
// n1 % 16 = ____1234
|
||||
// (n1 % 16) << 4 = 1234____
|
||||
// n2 = __5678__
|
||||
// n2 >> 2 = ____5678
|
||||
// b1 = 12345678
|
||||
let b1 = ((n1 % 16) << 4) + (n2 >> 2);
|
||||
return [b0, b1];
|
||||
}
|
||||
/**
|
||||
* Decode a 4-character long base64 string corresponding to 2 bytes
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function decode1(s) {
|
||||
// xy==
|
||||
// pull out strings
|
||||
let s0 = s[0];
|
||||
let s1 = s[1];
|
||||
// convert to numbers
|
||||
let n0 = char2int(s0);
|
||||
let n1 = char2int(s1);
|
||||
// abcdef gh____
|
||||
// n0 n1
|
||||
// abcdefgh
|
||||
// b0
|
||||
// n0 = __abcdef
|
||||
// n1 = __gh____
|
||||
// n0 << 2 = abcdef__
|
||||
// n1 >> 4 = ______gh
|
||||
// b0 = abcdefgh
|
||||
let b0 = (n0 << 2) + (n1 >> 4);
|
||||
return [b0];
|
||||
}
|
||||
// FIXME: these tables would *probably* be faster if they were made into objects
|
||||
/**
|
||||
* Conversion table for base64 encode
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function int2char(n) {
|
||||
switch (n) {
|
||||
case 0: return 'A';
|
||||
case 1: return 'B';
|
||||
case 2: return 'C';
|
||||
case 3: return 'D';
|
||||
case 4: return 'E';
|
||||
case 5: return 'F';
|
||||
case 6: return 'G';
|
||||
case 7: return 'H';
|
||||
case 8: return 'I';
|
||||
case 9: return 'J';
|
||||
case 10: return 'K';
|
||||
case 11: return 'L';
|
||||
case 12: return 'M';
|
||||
case 13: return 'N';
|
||||
case 14: return 'O';
|
||||
case 15: return 'P';
|
||||
case 16: return 'Q';
|
||||
case 17: return 'R';
|
||||
case 18: return 'S';
|
||||
case 19: return 'T';
|
||||
case 20: return 'U';
|
||||
case 21: return 'V';
|
||||
case 22: return 'W';
|
||||
case 23: return 'X';
|
||||
case 24: return 'Y';
|
||||
case 25: return 'Z';
|
||||
case 26: return 'a';
|
||||
case 27: return 'b';
|
||||
case 28: return 'c';
|
||||
case 29: return 'd';
|
||||
case 30: return 'e';
|
||||
case 31: return 'f';
|
||||
case 32: return 'g';
|
||||
case 33: return 'h';
|
||||
case 34: return 'i';
|
||||
case 35: return 'j';
|
||||
case 36: return 'k';
|
||||
case 37: return 'l';
|
||||
case 38: return 'm';
|
||||
case 39: return 'n';
|
||||
case 40: return 'o';
|
||||
case 41: return 'p';
|
||||
case 42: return 'q';
|
||||
case 43: return 'r';
|
||||
case 44: return 's';
|
||||
case 45: return 't';
|
||||
case 46: return 'u';
|
||||
case 47: return 'v';
|
||||
case 48: return 'w';
|
||||
case 49: return 'x';
|
||||
case 50: return 'y';
|
||||
case 51: return 'z';
|
||||
case 52: return '0';
|
||||
case 53: return '1';
|
||||
case 54: return '2';
|
||||
case 55: return '3';
|
||||
case 56: return '4';
|
||||
case 57: return '5';
|
||||
case 58: return '6';
|
||||
case 59: return '7';
|
||||
case 60: return '8';
|
||||
case 61: return '9';
|
||||
case 62: return '+';
|
||||
case 63: return '/';
|
||||
default: throw new Error("invalid base64 encode byte: " + n);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Conversion table for base64 decode
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function char2int(s) {
|
||||
switch (s) {
|
||||
case 'A': return 0;
|
||||
case 'B': return 1;
|
||||
case 'C': return 2;
|
||||
case 'D': return 3;
|
||||
case 'E': return 4;
|
||||
case 'F': return 5;
|
||||
case 'G': return 6;
|
||||
case 'H': return 7;
|
||||
case 'I': return 8;
|
||||
case 'J': return 9;
|
||||
case 'K': return 10;
|
||||
case 'L': return 11;
|
||||
case 'M': return 12;
|
||||
case 'N': return 13;
|
||||
case 'O': return 14;
|
||||
case 'P': return 15;
|
||||
case 'Q': return 16;
|
||||
case 'R': return 17;
|
||||
case 'S': return 18;
|
||||
case 'T': return 19;
|
||||
case 'U': return 20;
|
||||
case 'V': return 21;
|
||||
case 'W': return 22;
|
||||
case 'X': return 23;
|
||||
case 'Y': return 24;
|
||||
case 'Z': return 25;
|
||||
case 'a': return 26;
|
||||
case 'b': return 27;
|
||||
case 'c': return 28;
|
||||
case 'd': return 29;
|
||||
case 'e': return 30;
|
||||
case 'f': return 31;
|
||||
case 'g': return 32;
|
||||
case 'h': return 33;
|
||||
case 'i': return 34;
|
||||
case 'j': return 35;
|
||||
case 'k': return 36;
|
||||
case 'l': return 37;
|
||||
case 'm': return 38;
|
||||
case 'n': return 39;
|
||||
case 'o': return 40;
|
||||
case 'p': return 41;
|
||||
case 'q': return 42;
|
||||
case 'r': return 43;
|
||||
case 's': return 44;
|
||||
case 't': return 45;
|
||||
case 'u': return 46;
|
||||
case 'v': return 47;
|
||||
case 'w': return 48;
|
||||
case 'x': return 49;
|
||||
case 'y': return 50;
|
||||
case 'z': return 51;
|
||||
case '0': return 52;
|
||||
case '1': return 53;
|
||||
case '2': return 54;
|
||||
case '3': return 55;
|
||||
case '4': return 56;
|
||||
case '5': return 57;
|
||||
case '6': return 58;
|
||||
case '7': return 59;
|
||||
case '8': return 60;
|
||||
case '9': return 61;
|
||||
case '+': return 62;
|
||||
case '/': return 63;
|
||||
default: throw new Error("invalid base64 character: " + s);
|
||||
}
|
||||
}
|
||||
//# sourceMappingURL=b64.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* Miscellaneous binary utility functions
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { bytes_to_bigint, bigint_to_bytes, concat, strong_rand_bytes };
|
||||
/**
|
||||
* Concatenate two arrays
|
||||
*/
|
||||
declare function concat(arr1: Uint8Array, arr2: Uint8Array): Uint8Array;
|
||||
/**
|
||||
* Cryptographically random bytes
|
||||
*/
|
||||
declare function strong_rand_bytes(how_many: number): Uint8Array;
|
||||
/**
|
||||
* Convert a byte array to a bigint
|
||||
*
|
||||
* Equivalent to `binary:decode_unsigned/1` from Erlang
|
||||
*/
|
||||
declare function bytes_to_bigint(bytes: Uint8Array): bigint;
|
||||
/**
|
||||
* Convert a bigint to a byte array
|
||||
*
|
||||
* Equivalent to `binary:encode_unsigned/1` from Erlang
|
||||
*
|
||||
* Requires input to be positive
|
||||
*/
|
||||
declare function bigint_to_bytes(q: bigint): Uint8Array;
|
||||
@@ -0,0 +1,266 @@
|
||||
/**
|
||||
* Miscellaneous binary utility functions
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { bytes_to_bigint, bigint_to_bytes, concat, strong_rand_bytes };
|
||||
/**
|
||||
* Concatenate two arrays
|
||||
*/
|
||||
function concat(arr1, arr2) {
|
||||
let len1 = arr1.length;
|
||||
let len2 = arr2.length;
|
||||
let arr1_idx0_offset = 0;
|
||||
let arr2_idx0_offset = len1;
|
||||
let result_len = len1 + len2;
|
||||
let result = new Uint8Array(result_len);
|
||||
// copy first array into result
|
||||
for (let arr1_idx0 = 0; arr1_idx0 < len1; arr1_idx0++) {
|
||||
// no offset here
|
||||
let result_idx0 = arr1_idx0 + arr1_idx0_offset;
|
||||
result[result_idx0] = arr1[arr1_idx0];
|
||||
}
|
||||
// copy second array into result
|
||||
for (let arr2_idx0 = 0; arr2_idx0 < len2; arr2_idx0++) {
|
||||
// offset by the length of the first array
|
||||
let result_idx0 = arr2_idx0 + arr2_idx0_offset;
|
||||
result[result_idx0] = arr2[arr2_idx0];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Cryptographically random bytes
|
||||
*/
|
||||
function strong_rand_bytes(how_many) {
|
||||
let arr = new Uint8Array(how_many);
|
||||
(new Crypto()).getRandomValues(arr);
|
||||
return arr;
|
||||
}
|
||||
/**
|
||||
* Convert a byte array to a bigint
|
||||
*
|
||||
* Equivalent to `binary:decode_unsigned/1` from Erlang
|
||||
*/
|
||||
function bytes_to_bigint(bytes) {
|
||||
let n = 0n;
|
||||
for (let b of bytes) {
|
||||
// move first, then add
|
||||
// otherwise it ends on a move
|
||||
// imperative languages are for losers
|
||||
n <<= 8n;
|
||||
n += BigInt(b);
|
||||
}
|
||||
return n;
|
||||
}
|
||||
/**
|
||||
* Convert a bigint to a byte array
|
||||
*
|
||||
* Equivalent to `binary:encode_unsigned/1` from Erlang
|
||||
*
|
||||
* Requires input to be positive
|
||||
*/
|
||||
function bigint_to_bytes(q) {
|
||||
if (q < 0n) {
|
||||
throw new Error('q < 0n: ' + q);
|
||||
}
|
||||
let arr_reverse = [];
|
||||
while (q > 0n) {
|
||||
let r = Number(q % 256n);
|
||||
q /= 256n;
|
||||
arr_reverse.push(r);
|
||||
}
|
||||
arr_reverse.reverse();
|
||||
return new Uint8Array(arr_reverse);
|
||||
}
|
||||
/**
|
||||
* Get an uninitialized bitstring
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
function bits_null(bit_length) {
|
||||
let byte_length = Math.ceil(bit_length / 8);
|
||||
let result = new Uint8Array(byte_length);
|
||||
return { bit_length: bit_length,
|
||||
bytes: result };
|
||||
}
|
||||
/**
|
||||
* Get a bitstring of a given length where every value is 0.
|
||||
*/
|
||||
function bits_zeros(bit_length) {
|
||||
let byte_length = Math.ceil(bit_length / 8);
|
||||
let result = new Uint8Array(byte_length);
|
||||
for (let i0 = 0; i0 < byte_length; i0++) {
|
||||
result[i0] = 0;
|
||||
}
|
||||
return { bit_length: bit_length,
|
||||
bytes: result };
|
||||
}
|
||||
/**
|
||||
* Get a bitstring of a given length where every value is 1.
|
||||
*/
|
||||
function bits_ones(bit_length) {
|
||||
let byte_length = Math.ceil(bit_length / 8);
|
||||
let result = new Uint8Array(byte_length);
|
||||
// fill everything except the last byte with 255s
|
||||
for (let i0 = 0; i0 < (byte_length - 1); i0++) {
|
||||
result[i0] = 255;
|
||||
}
|
||||
// alright so the last byte
|
||||
// ok so the number of leading 0s is
|
||||
// 8 - (bit_length % 8)
|
||||
let num_trailing_zero_bits = 8 - (bit_length % 8);
|
||||
// the trailing byte is 255 << that
|
||||
// e.g. 3 trailing 0s
|
||||
// 1111_1111 -> 1111_1000
|
||||
let last_byte = 255 << num_trailing_zero_bits;
|
||||
let last_byte_idx0 = byte_length - 1;
|
||||
result[last_byte_idx0] = last_byte;
|
||||
return { bit_length: bit_length,
|
||||
bytes: result };
|
||||
}
|
||||
/**
|
||||
* Get the bit at a given 0-index
|
||||
*/
|
||||
function bits_i0th(bit_idx0, bits) {
|
||||
// first task is figuring out what byte we're at
|
||||
// for instance if we want bit 27
|
||||
// 3*8 = 24 =< 27 < 4*8
|
||||
// so it's Math.floor(bit_idx0 / 8)
|
||||
let byte_idx0 = Math.floor(bit_idx0 / 8);
|
||||
// let's fetch the byte and work with that
|
||||
let the_byte = bits.bytes[byte_idx0];
|
||||
// ok so let's go with 27 again
|
||||
// 27 = 3 mod 8
|
||||
// so we bitshift right by (8 - 3)
|
||||
// and then take the remainder dividing by 2
|
||||
// --B-_---- -> ----_---B -> 0000_000B
|
||||
let bsr = 8 - (bit_idx0 % 8);
|
||||
return (the_byte >> bsr) % 2;
|
||||
}
|
||||
/**
|
||||
* Concatenate two bitstrings
|
||||
*/
|
||||
function bits_concat(bits1, bits2) {
|
||||
let result_bit_length = bits1.bit_length + bits2.bit_length;
|
||||
let bytes1 = bits1.bytes;
|
||||
let bytes2 = bits2.bytes;
|
||||
// using zeros here because of our xor trick in a minute
|
||||
let result_bits = bits_null(result_bit_length);
|
||||
let result_bytes = result_bits.bytes;
|
||||
// go along each byte in result, and compute the byte boundary
|
||||
for (let i = 0; i < result_bytes.length; i++) {
|
||||
// ABCD_EFGH _
|
||||
// 0123_4567 8
|
||||
// this is the bit index of the leftmost bit in this byte
|
||||
let start_bit_bi0 = i * 8;
|
||||
let next_start_bit_bi0 = start_bit_bi0 + 8;
|
||||
// does the bit at the beginning of this byte correspond to the first array?
|
||||
// strict comparison:
|
||||
// suppose i = 0,
|
||||
// suppose bit_length1 is 0
|
||||
// then this says no, go to second array
|
||||
// suppose bl1 = 1,
|
||||
// this says start at first array
|
||||
let start_bit_is_of_first_array = start_bit_bi0 < bits1.bit_length;
|
||||
// weak comparison:
|
||||
// suppose bit_length1 = 8
|
||||
// ABCD_EFGH _
|
||||
// 0123_4567 8
|
||||
// ^
|
||||
// start_bit_bi0 ^ next_start_bit_bi0
|
||||
let stop_bit_is_of_first_array = next_start_bit_bi0 <= bits1.bit_length;
|
||||
// is this a bytes1 byte
|
||||
let is_bytes1_byte = start_bit_is_of_first_array && stop_bit_is_of_first_array;
|
||||
let is_boundary_byte = start_bit_is_of_first_array && !stop_bit_is_of_first_array;
|
||||
// need to work out the ping_pong bs up here because js is dumb and I
|
||||
// can't put lets between elseifs
|
||||
// alright, now we're in the case of only copying from the second array
|
||||
// we have two cases:
|
||||
// ping-pong:
|
||||
// ABCD_EFGH 1234_5678
|
||||
// - ---- ---
|
||||
// copying these bits
|
||||
// ping:
|
||||
// ABCD_EFGH <end>
|
||||
// - ---- 000
|
||||
//
|
||||
// how to distinguish between these two??
|
||||
//
|
||||
// we're in the ping case when the start_bit_bi0 corresponds to the
|
||||
// final byte of the second array
|
||||
//
|
||||
// ok
|
||||
//
|
||||
// we need to compute the bit address in the second array that
|
||||
// corresponds to the bit address at the beginning of this byte in the
|
||||
// result array
|
||||
let bits2_addr_bi0 = start_bit_bi0 - bits1.bit_length;
|
||||
// I think the variable is
|
||||
// bits_left_to_copy = bits2.bit_length - bit_addr2_bi0
|
||||
// no + 1 because the current bit is uncopied,
|
||||
// so if bit_addr2_bi0 = 7 and bits2.bit_length is 8, it means we
|
||||
// have the last bit to copy
|
||||
// cases:
|
||||
// bits_left_to_copy <= 0 ->
|
||||
// this would mean we have more bits to copy, but are out of
|
||||
// source bits. should be impossible if bits_null is correct
|
||||
// bits_left_to_copy <= 8 ->
|
||||
// this would mean we are going to fill this last byte in the
|
||||
// result array with the correct bits from array2, but how we
|
||||
// do this will depend on how those are arranged in bytes2
|
||||
// (whether we grab one or two bytes)
|
||||
//
|
||||
// this is the tricky case
|
||||
//
|
||||
// I think what matters here is the byte address in the second array
|
||||
// if we're on the last byte
|
||||
// 8 < bits_left_to_copy ->
|
||||
// this means we can safely grab two bytes from bytes2, and do
|
||||
// our bitshifting to make it correct
|
||||
//
|
||||
// FIXME
|
||||
let bits_left_to_copy = bits2.bit_length - bits2_addr_bi0;
|
||||
// no the variable that matters is which byte we're on in the result
|
||||
let this_bytes2_addr_i0 = Math.floor(bits2_addr_bi0 / 8);
|
||||
let next_bytes2_addr_i0 = this_bytes2_addr_i0 + 1;
|
||||
let bitshift_amt = bits1.bit_length % 8;
|
||||
let ping = next_bytes2_addr_i0 === bytes2.length;
|
||||
// simple case: this is a byte from the first array
|
||||
// just copy it
|
||||
if (is_bytes1_byte)
|
||||
result_bytes[i] = bytes1[i];
|
||||
// this is a boundary byte
|
||||
// further cases:
|
||||
// second bit length is 0 ->
|
||||
// ABCD_EF-- <empty>
|
||||
// ^ starting here
|
||||
// just copy first byte and move along
|
||||
else if (is_boundary_byte && (bits2.bit_length === 0))
|
||||
result_bytes[i] = bytes1[i];
|
||||
// boundary byte, and there is at least one byte in the second array
|
||||
else if (is_boundary_byte) {
|
||||
// copy over the first byte
|
||||
result_bytes[i] = bytes1[i];
|
||||
// take the first byte from the second array
|
||||
let first_byte_of_second_array = bytes2[0];
|
||||
// bytes1:
|
||||
// ABCD_EF00
|
||||
// 6
|
||||
// bytes2:
|
||||
// 1234_5678
|
||||
// 0000_0012
|
||||
// and bitshift it right by that amount
|
||||
let bitshift_amt = bits1.bit_length % 8;
|
||||
result_bytes[i] ^= first_byte_of_second_array >> bitshift_amt;
|
||||
}
|
||||
// last byte of second array
|
||||
else if (ping)
|
||||
result_bytes[i] = (bytes2[this_bytes2_addr_i0] << bitshift_amt);
|
||||
// ping-pong: not last byte of second array
|
||||
else
|
||||
result_bytes[i] = (bytes2[this_bytes2_addr_i0] << bitshift_amt) ^ (bytes2[next_bytes2_addr_i0] << bitshift_amt);
|
||||
}
|
||||
return { bit_length: result_bit_length,
|
||||
bytes: result_bytes };
|
||||
}
|
||||
//# sourceMappingURL=bin.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* FÆRT: Fast Æternity Recovery Text
|
||||
*
|
||||
* Reference: https://gitlab.com/zxq9/passgas/-/blob/83607fedb08be5dfd03210e331f9c76125bb3467/fullofbeans
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { encode, decode, byte_of_word, check_word, check_byte, words };
|
||||
import * as safe from './safe.js';
|
||||
/**
|
||||
* Encode a bytestring into FÆRT
|
||||
*/
|
||||
declare function encode(bytes: Uint8Array): string;
|
||||
/**
|
||||
* Decode a FAERT string into bytes
|
||||
*/
|
||||
declare function decode(faert: string): safe.Safe<Uint8Array, string>;
|
||||
/**
|
||||
* given a word, find its index
|
||||
*/
|
||||
declare function byte_of_word(word: string): safe.Safe<number, string>;
|
||||
/**
|
||||
* compute the check word of an array
|
||||
*/
|
||||
declare function check_word(bytes: Uint8Array): string;
|
||||
/**
|
||||
* given an array, compute the xor of all the bytes in the array
|
||||
*/
|
||||
declare function check_byte(bytes: Uint8Array): number;
|
||||
declare let words: string[];
|
||||
@@ -0,0 +1,344 @@
|
||||
/**
|
||||
* FÆRT: Fast Æternity Recovery Text
|
||||
*
|
||||
* Reference: https://gitlab.com/zxq9/passgas/-/blob/83607fedb08be5dfd03210e331f9c76125bb3467/fullofbeans
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { encode, decode, byte_of_word, check_word, check_byte, words };
|
||||
import * as safe from './safe.js';
|
||||
/**
|
||||
* Encode a bytestring into FÆRT
|
||||
*/
|
||||
function encode(bytes) {
|
||||
// initial accumulator
|
||||
let words_acc = [];
|
||||
// go along each byte and look up the word
|
||||
// add it to the accumulator
|
||||
for (let this_byte of bytes) {
|
||||
let this_word = words[this_byte];
|
||||
words_acc.push(this_word);
|
||||
}
|
||||
// prepend check word to phrase
|
||||
// yes craig it would be faster to do the check byte inline
|
||||
// the usage case here is 64 byte strings
|
||||
// double pass is not a big deal
|
||||
return check_word(bytes) + ' ' + words_acc.join(' ');
|
||||
}
|
||||
/**
|
||||
* Decode a FAERT string into bytes
|
||||
*/
|
||||
function decode(faert) {
|
||||
let all_words = faert.split(' ');
|
||||
let input_check_word = all_words[0];
|
||||
let input_words = all_words.slice(1);
|
||||
// accumulator
|
||||
let computed_bytes = [];
|
||||
// loop over words and figure out accumulator
|
||||
for (let this_input_word of input_words) {
|
||||
let maybe_this_byte = byte_of_word(this_input_word);
|
||||
// if the word is an allowable word, add it to the accumulator
|
||||
if (maybe_this_byte.ok) {
|
||||
let this_byte = maybe_this_byte.result;
|
||||
computed_bytes.push(this_byte);
|
||||
}
|
||||
// error case, propagate the error up the call chain
|
||||
else
|
||||
return maybe_this_byte;
|
||||
}
|
||||
// at this point, we can assume we correctly decoded all words
|
||||
// compute the check byte
|
||||
let computed_bytes_u8s = new Uint8Array(computed_bytes);
|
||||
let computed_check_word = check_word(computed_bytes_u8s);
|
||||
// check if it is correct
|
||||
// if so, return the computed bytes
|
||||
if (computed_check_word === input_check_word)
|
||||
return safe.ok(computed_bytes_u8s);
|
||||
// otherwise, return an error
|
||||
else
|
||||
return safe.error('checksum failure! computed check word: ' + computed_check_word + '; input check word: ' + input_check_word);
|
||||
}
|
||||
/**
|
||||
* given a word, find its index
|
||||
*/
|
||||
function byte_of_word(word) {
|
||||
for (let i = 0; i <= 255; i++) {
|
||||
if (word === words[i])
|
||||
return safe.ok(i);
|
||||
}
|
||||
return safe.error('invalid word: ' + word);
|
||||
}
|
||||
/**
|
||||
* compute the check word of an array
|
||||
*/
|
||||
function check_word(bytes) {
|
||||
return words[check_byte(bytes)];
|
||||
}
|
||||
/**
|
||||
* given an array, compute the xor of all the bytes in the array
|
||||
*/
|
||||
function check_byte(bytes) {
|
||||
let check_byte = 0;
|
||||
for (let this_byte of bytes)
|
||||
check_byte ^= this_byte;
|
||||
return check_byte;
|
||||
}
|
||||
let words = [
|
||||
"able",
|
||||
"abuse",
|
||||
"acquire",
|
||||
"adjust",
|
||||
"agent",
|
||||
"air",
|
||||
"alert",
|
||||
"alpha",
|
||||
"anger",
|
||||
"answer",
|
||||
"any",
|
||||
"argue",
|
||||
"around",
|
||||
"assume",
|
||||
"asthma",
|
||||
"aunt",
|
||||
"awkward",
|
||||
"balcony",
|
||||
"barrel",
|
||||
"because",
|
||||
"behave",
|
||||
"bicycle",
|
||||
"bike",
|
||||
"blind",
|
||||
"blouse",
|
||||
"bonus",
|
||||
"bottom",
|
||||
"breeze",
|
||||
"brother",
|
||||
"bubble",
|
||||
"burger",
|
||||
"butter",
|
||||
"can",
|
||||
"cannon",
|
||||
"cargo",
|
||||
"catalog",
|
||||
"caught",
|
||||
"century",
|
||||
"chaos",
|
||||
"chicken",
|
||||
"churn",
|
||||
"cinnamon",
|
||||
"clever",
|
||||
"clock",
|
||||
"clown",
|
||||
"collect",
|
||||
"conduct",
|
||||
"convince",
|
||||
"correct",
|
||||
"cradle",
|
||||
"crane",
|
||||
"crime",
|
||||
"cross",
|
||||
"crystal",
|
||||
"curve",
|
||||
"daughter",
|
||||
"debris",
|
||||
"decrease",
|
||||
"deny",
|
||||
"deputy",
|
||||
"despair",
|
||||
"diesel",
|
||||
"dinner",
|
||||
"distance",
|
||||
"document",
|
||||
"donate",
|
||||
"drama",
|
||||
"drink",
|
||||
"dutch",
|
||||
"earth",
|
||||
"educate",
|
||||
"elbow",
|
||||
"employ",
|
||||
"endless",
|
||||
"enlist",
|
||||
"enter",
|
||||
"equal",
|
||||
"eternal",
|
||||
"example",
|
||||
"exhibit",
|
||||
"exotic",
|
||||
"faculty",
|
||||
"famous",
|
||||
"fault",
|
||||
"feature",
|
||||
"fiber",
|
||||
"filter",
|
||||
"firm",
|
||||
"flame",
|
||||
"flush",
|
||||
"follow",
|
||||
"forward",
|
||||
"frame",
|
||||
"fringe",
|
||||
"future",
|
||||
"game",
|
||||
"gate",
|
||||
"gift",
|
||||
"glare",
|
||||
"glow",
|
||||
"goat",
|
||||
"grab",
|
||||
"grief",
|
||||
"guilt",
|
||||
"hand",
|
||||
"hawk",
|
||||
"health",
|
||||
"hen",
|
||||
"hire",
|
||||
"honey",
|
||||
"hover",
|
||||
"hurry",
|
||||
"hybrid",
|
||||
"impose",
|
||||
"inch",
|
||||
"inherit",
|
||||
"injury",
|
||||
"install",
|
||||
"iron",
|
||||
"jazz",
|
||||
"joke",
|
||||
"just",
|
||||
"kit",
|
||||
"kitchen",
|
||||
"language",
|
||||
"laundry",
|
||||
"leader",
|
||||
"lend",
|
||||
"leopard",
|
||||
"license",
|
||||
"live",
|
||||
"lobster",
|
||||
"lounge",
|
||||
"magnet",
|
||||
"mail",
|
||||
"mansion",
|
||||
"mass",
|
||||
"math",
|
||||
"media",
|
||||
"message",
|
||||
"metal",
|
||||
"misery",
|
||||
"mix",
|
||||
"more",
|
||||
"mountain",
|
||||
"museum",
|
||||
"mutual",
|
||||
"narrow",
|
||||
"nerve",
|
||||
"next",
|
||||
"note",
|
||||
"obey",
|
||||
"obtain",
|
||||
"offer",
|
||||
"once",
|
||||
"orange",
|
||||
"ostrich",
|
||||
"over",
|
||||
"owner",
|
||||
"palace",
|
||||
"patch",
|
||||
"pave",
|
||||
"pen",
|
||||
"phrase",
|
||||
"piece",
|
||||
"pizza",
|
||||
"plunge",
|
||||
"polar",
|
||||
"pool",
|
||||
"power",
|
||||
"pretty",
|
||||
"private",
|
||||
"protect",
|
||||
"pulp",
|
||||
"purity",
|
||||
"quit",
|
||||
"quote",
|
||||
"raise",
|
||||
"razor",
|
||||
"recall",
|
||||
"region",
|
||||
"relief",
|
||||
"rent",
|
||||
"rescue",
|
||||
"review",
|
||||
"ride",
|
||||
"risk",
|
||||
"roof",
|
||||
"rough",
|
||||
"saddle",
|
||||
"salmon",
|
||||
"sand",
|
||||
"scene",
|
||||
"scrub",
|
||||
"season",
|
||||
"seek",
|
||||
"series",
|
||||
"shed",
|
||||
"shoe",
|
||||
"sick",
|
||||
"silent",
|
||||
"situate",
|
||||
"skill",
|
||||
"slide",
|
||||
"slush",
|
||||
"snack",
|
||||
"solar",
|
||||
"soul",
|
||||
"special",
|
||||
"sphere",
|
||||
"spot",
|
||||
"spy",
|
||||
"stairs",
|
||||
"stereo",
|
||||
"strategy",
|
||||
"stuff",
|
||||
"success",
|
||||
"sunny",
|
||||
"surge",
|
||||
"swear",
|
||||
"symptom",
|
||||
"tail",
|
||||
"ten",
|
||||
"tent",
|
||||
"theme",
|
||||
"thumb",
|
||||
"tiny",
|
||||
"toe",
|
||||
"tooth",
|
||||
"topic",
|
||||
"trade",
|
||||
"trash",
|
||||
"trophy",
|
||||
"truly",
|
||||
"tumble",
|
||||
"typical",
|
||||
"uncle",
|
||||
"unfair",
|
||||
"until",
|
||||
"upper",
|
||||
"useless",
|
||||
"van",
|
||||
"venue",
|
||||
"video",
|
||||
"visa",
|
||||
"vocal",
|
||||
"walk",
|
||||
"waste",
|
||||
"wedding",
|
||||
"weekend",
|
||||
"wide",
|
||||
"winner",
|
||||
"wise",
|
||||
"wood",
|
||||
"wrist",
|
||||
"zero"
|
||||
];
|
||||
//# sourceMappingURL=faert.js.map
|
||||
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"faert.js","sourceRoot":"","sources":["../src/faert.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACH,MAAM,EACN,MAAM,EACN,YAAY,EACZ,UAAU,EACV,UAAU,EACV,KAAK,EACR,CAAA;AAED,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAIlC;;GAEG;AACH,SACA,MAAM,CACD,KAAkB;IAGnB,sBAAsB;IACtB,IAAI,SAAS,GAAoB,EAAE,CAAC;IAEpC,0CAA0C;IAC1C,4BAA4B;IAC5B,KAAK,IAAI,SAAS,IAAI,KAAK,EAC3B;QACI,IAAI,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QACjC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC7B;IAED,+BAA+B;IAC/B,2DAA2D;IAC3D,yCAAyC;IACzC,gCAAgC;IAChC,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzD,CAAC;AAID;;GAEG;AACH,SACA,MAAM,CACD,KAAc;IAGf,IAAI,SAAS,GAA0B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxD,IAAI,gBAAgB,GAAmB,SAAS,CAAC,CAAC,CAAC,CAAC;IACpD,IAAI,WAAW,GAAwB,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAEzD,cAAc;IACd,IAAI,cAAc,GAAmB,EAAE,CAAC;IAExC,6CAA6C;IAC7C,KAAK,IAAI,eAAe,IAAI,WAAW,EACvC;QACI,IAAI,eAAe,GAA+B,YAAY,CAAC,eAAe,CAAC,CAAC;QAChF,8DAA8D;QAC9D,IAAI,eAAe,CAAC,EAAE,EACtB;YACI,IAAI,SAAS,GAAY,eAAe,CAAC,MAAM,CAAC;YAChD,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAClC;QACD,oDAAoD;;YAEhD,OAAO,eAAe,CAAC;KAC9B;IAED,8DAA8D;IAC9D,yBAAyB;IACzB,IAAI,kBAAkB,GAAiB,IAAI,UAAU,CAAC,cAAc,CAAC,CAAC;IACtE,IAAI,mBAAmB,GAAY,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAElE,yBAAyB;IACzB,mCAAmC;IACnC,IAAI,mBAAmB,KAAK,gBAAgB;QACxC,OAAO,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;IACvC,6BAA6B;;QAEzB,OAAO,IAAI,CAAC,KAAK,CAAC,yCAAyC,GAAG,mBAAmB,GAAG,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;AACvI,CAAC;AAID;;GAEG;AACH,SACA,YAAY,CACP,IAAY;IAGb,KAAK,IAAI,CAAC,GAAC,CAAC,EAAE,CAAC,IAAE,GAAG,EAAE,CAAC,EAAE,EACzB;QACI,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC;YACjB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KACzB;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;AAC/C,CAAC;AAID;;GAEG;AACH,SACA,UAAU,CACL,KAAiB;IAGlB,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AACpC,CAAC;AAGD;;GAEG;AACH,SACA,UAAU,CACL,KAAiB;IAGlB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,IAAI,SAAS,IAAI,KAAK;QACvB,UAAU,IAAI,SAAS,CAAC;IAC5B,OAAO,UAAU,CAAC;AACtB,CAAC;AAID,IAAI,KAAK,GAAG;IACR,MAAM;IACN,OAAO;IACP,SAAS;IACT,QAAQ;IACR,OAAO;IACP,KAAK;IACL,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,KAAK;IACL,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,SAAS;IACT,SAAS;IACT,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,OAAO;IACP,SAAS;IACT,QAAQ;IACR,SAAS;IACT,OAAO;IACP,SAAS;IACT,OAAO;IACP,UAAU;IACV,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,SAAS;IACT,UAAU;IACV,SAAS;IACT,QAAQ;IACR,OAAO;IACP,OAAO;IACP,OAAO;IACP,SAAS;IACT,OAAO;IACP,UAAU;IACV,QAAQ;IACR,UAAU;IACV,MAAM;IACN,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,UAAU;IACV,QAAQ;IACR,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,SAAS;IACT,OAAO;IACP,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,SAAS;IACT,SAAS;IACT,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,OAAO;IACP,SAAS;IACT,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;IACR,SAAS;IACT,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,QAAQ;IACR,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,SAAS;IACT,QAAQ;IACR,SAAS;IACT,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,SAAS;IACT,UAAU;IACV,SAAS;IACT,QAAQ;IACR,MAAM;IACN,SAAS;IACT,SAAS;IACT,MAAM;IACN,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,SAAS;IACT,MAAM;IACN,MAAM;IACN,OAAO;IACP,SAAS;IACT,OAAO;IACP,QAAQ;IACR,KAAK;IACL,MAAM;IACN,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,QAAQ;IACR,OAAO;IACP,MAAM;IACN,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,QAAQ;IACR,OAAO;IACP,MAAM;IACN,KAAK;IACL,QAAQ;IACR,OAAO;IACP,OAAO;IACP,QAAQ;IACR,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,SAAS;IACT,SAAS;IACT,MAAM;IACN,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,QAAQ;IACR,SAAS;IACT,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,MAAM;IACN,SAAS;IACT,QAAQ;IACR,MAAM;IACN,KAAK;IACL,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,OAAO;IACP,SAAS;IACT,OAAO;IACP,OAAO;IACP,OAAO;IACP,SAAS;IACT,MAAM;IACN,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,KAAK;IACL,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,SAAS;IACT,OAAO;IACP,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,KAAK;IACL,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,SAAS;IACT,SAAS;IACT,MAAM;IACN,QAAQ;IACR,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;CACT,CAAA"}
|
||||
@@ -0,0 +1,37 @@
|
||||
/**
|
||||
* Ethereum Recursive-Length Prefix Encoding implementation
|
||||
*
|
||||
* Two reference implementations:
|
||||
*
|
||||
* 1. Ethereum Python implementation
|
||||
* 2. My Erlang implementation (agrees with Ethereum Python in randomized
|
||||
* tests)
|
||||
*
|
||||
* This work can be found in ../test/testgen/
|
||||
*
|
||||
* FIXME: need to have Safe assertions for "i am decoding a list", "i am
|
||||
* decoding a binary", "I am decoding something with no remainder", etc
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
export { decoded_data, decode_result, decode, encode };
|
||||
/**
|
||||
* Data that RLP can encode. Also the result of decoding.
|
||||
*/
|
||||
declare type decoded_data = Uint8Array | Array<decoded_data>;
|
||||
/**
|
||||
* Decoding can have a remainder
|
||||
*/
|
||||
declare type decode_result = {
|
||||
decoded_data: decoded_data;
|
||||
remainder: Uint8Array;
|
||||
};
|
||||
/**
|
||||
* Decode an RLP-encoded bytestring into a `decode_result` (decoded data +
|
||||
* whatever wasn't consumed)
|
||||
*/
|
||||
declare function decode(bytes: Uint8Array): decode_result;
|
||||
/**
|
||||
* Encode some decoded data
|
||||
*/
|
||||
declare function encode(data: decoded_data): Uint8Array;
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user