This repository has been archived by the owner on Mar 13, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change-Id: I4aa464b65f1ce12a38d82b6a32aa0e9f3d63f809
- Loading branch information
Showing
8 changed files
with
430 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
Copyright 2022 Google LLC | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are | ||
met: | ||
|
||
* Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
* Redistributions in binary form must reproduce the above | ||
copyright notice, this list of conditions and the following disclaimer | ||
in the documentation and/or other materials provided with the | ||
distribution. | ||
* Neither the name of Google LLC nor the names of its | ||
contributors may be used to endorse or promote products derived from | ||
this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Ibis - a knowledge engine for type checking asynchronously communicating modules | ||
|
||
[![Ibis](https://github.com/project-oak/arcsjs-provable/actions/workflows/ibis.yml/badge.svg)](https://github.com/project-oak/arcsjs-provable/actions/workflows/ibis.yml) | ||
[![Ibis docs](https://img.shields.io/badge/rustdoc-docs-green)](https://project-oak.github.io/arcsjs-provable/ibis/docs/ibis/) | ||
|
||
#### This is not an officially supported Google product | ||
|
||
# Getting started | ||
|
||
Try out the [Ibis playground](https://project-oak.github.io/arcsjs-provable/ibis/playground). | ||
|
||
(Early) documentation can be found [here](https://project-oak.github.io/arcsjs-provable/ibis/docs/ibis/) thanks to `Rustdoc`. | ||
|
||
## Building and running Ibis locally | ||
|
||
For the following you'll need [git]() and [cargo](https://rustup.rs). | ||
```bash | ||
# Assuming git and cargo are already installed | ||
git clone https://github.com/project-oak/arcsjs-provable.git | ||
cd arcsjs-provable/ibis | ||
cat demo.json | cargo run --bin dot > out.dot | ||
``` | ||
|
||
Ibis also has a test suite that can be run with | ||
|
||
```bash | ||
cargo test | ||
``` | ||
|
||
### Optional tools & dependencies | ||
- [wasm-pack](https://github.com/rustwasm/wasm-pack) (for packaging WASM with JS) | ||
- [cargo-wasi](https://bytecodealliance.github.io/cargo-wasi/install.html) (for compilation to WASM) | ||
- [graphviz](https://graphviz.org/download/) (dot command is used to render debugging information) | ||
- A web server: | ||
- Recommended: [the http.server package](https://www.npmjs.com/package/http-server) from npm. | ||
- Alternatively: [python3's http.server](https://docs.python.org/3/using/unix.html#getting-and-installing-the-latest-version-of-python). | ||
- or just your favourite web server. | ||
|
||
# Contributing | ||
|
||
Please see the project's [contributing guide](../contributing.md). | ||
|
||
# License | ||
|
||
Please see the project's [license](../LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
/* tslint:disable */ | ||
/* eslint-disable */ | ||
/** | ||
* @returns {string} | ||
*/ | ||
export function version_info(): string; | ||
/** | ||
* @param {string} data | ||
* @returns {string} | ||
*/ | ||
export function best_solutions_to_json(data: string): string; | ||
/** | ||
* @param {string} data | ||
* @returns {string} | ||
*/ | ||
export function all_solutions_to_json(data: string): string; | ||
/** | ||
* @param {string} data | ||
* @returns {string} | ||
*/ | ||
export function best_solutions_to_dot(data: string): string; | ||
/** | ||
* @param {string} data | ||
* @returns {string} | ||
*/ | ||
export function all_solutions_to_dot(data: string): string; | ||
|
||
export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module; | ||
|
||
export interface InitOutput { | ||
readonly memory: WebAssembly.Memory; | ||
readonly version_info: (a: number) => void; | ||
readonly best_solutions_to_json: (a: number, b: number, c: number) => void; | ||
readonly all_solutions_to_json: (a: number, b: number, c: number) => void; | ||
readonly best_solutions_to_dot: (a: number, b: number, c: number) => void; | ||
readonly all_solutions_to_dot: (a: number, b: number, c: number) => void; | ||
readonly __wbindgen_add_to_stack_pointer: (a: number) => number; | ||
readonly __wbindgen_free: (a: number, b: number) => void; | ||
readonly __wbindgen_malloc: (a: number) => number; | ||
readonly __wbindgen_realloc: (a: number, b: number, c: number) => number; | ||
} | ||
|
||
/** | ||
* If `module_or_path` is {RequestInfo} or {URL}, makes a request and | ||
* for everything else, calls `WebAssembly.instantiate` directly. | ||
* | ||
* @param {InitInput | Promise<InitInput>} module_or_path | ||
* | ||
* @returns {Promise<InitOutput>} | ||
*/ | ||
export default function init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>; |
Oops, something went wrong.