Merge pull request #9 from iExecBlockchainComputing/release/0.0.1-alpha

Release/0.0.1 alpha

Author: abbesBenayache

.drone.yml

@@ -0,0 +1,6 @@
+**/coverage/
+**/dapp/
+**/deployment-dapp/
+**/examples/
+**/dist/
+**/node_modules/

.eslintignore

@@ -0,0 +1,36 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint", "import", "sonarjs", "jest"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "project": "./tsconfig.eslint.json",
+    "sourceType": "module"
+  },
+  "extends": [
+    "airbnb-typescript/base",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "plugin:sonarjs/recommended",
+    "plugin:jest/recommended"
+  ],
+  "rules": {
+    "sonarjs/cognitive-complexity": "warn",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-use-before-define": ["error", { "functions": false }]
+  },
+  "overrides": [
+    {
+      "files": ["./tests/**/*.ts"],
+      "rules": {
+        "import/no-extraneous-dependencies": [
+          "error",
+          {
+            "devDependencies": true
+          }
+        ],
+        "@typescript-eslint/no-explicit-any": "off",
+        "sonarjs/no-duplicate-string": "off"
+      }
+    }
+  ]
+}

.eslintrc.json

@@ -0,0 +1,30 @@
+# Compiled output
+/dist
+
+# Dependency directories
+**/node_modules/
+
+# IDE files
+/.vscode
+/.idea
+
+# Miscellaneous
+/.DS_Store
+/.env
+/*.log
+/*.env
+
+# TypeScript specific
+*.tsbuildinfo
+
+# tests output
+/coverage
+# CI
+# .drone.yml
+
+
+# sonar output
+.scannerwork
+
+#dist
+**/dist/

.gitignore

@@ -0,0 +1 @@
+18

.nvmrc

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

.prettierrc

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.1-alpha] Initial release

CHANGELOG.md

@@ -0,0 +1,70 @@
+<p align="center">
+  <a href="https://iex.ec/" rel="noopener" target="_blank"><img width="150" src="./logo-iexec.png" alt="iExec logo"/></a>
+</p>
+
+<h1 align="center">Web3Telegram</h1>
+
+**Web3Telegram** offers developers methods to create apps that:
+
+- enable an entity (such as a (d)app provider or an end-user) to message an Ethereum account holder without knowing her/his chatId or telegram username.
+- eliminate the need for end-users to share their chatId or telegram username with multiple third-parties, reducing the risk of data breaches and spam.
+
+Web3Telegram is composed of 2 methods:
+
+- **fetchMyContacts** — that enables an entity to retrieve a list of Ethereum accounts whose owners have authorized the entity to message them
+- **fetchUserContacts** — that enables an entity to retrieve a list of Ethereum accounts whose owners have authorized the provided user to message them
+- **sendTelegram** — that allows an entity to message a user on telegram (previously fetched via the fetchMyContacts method) knowing only her/his Ethereum account.
+
+<div align="center">
+
+[![npm](https://img.shields.io/npm/v/@iexec/web3telegram)](https://www.npmjs.com/package/@iexec/web3telegram)[![license](https://img.shields.io/badge/license-Apache%202-blue)](/LICENSE)
+
+</div>
+
+## Installation
+
+Web3Telegram will be available as an [npm package](https://www.npmjs.com/package/@iexec/web3telegram).
+
+**npm:**
+
+```sh
+npm install @iexec/web3telegram
+```
+
+**yarn:**
+
+```sh
+yarn add @iexec/web3telegram
+```
+
+## Get started
+
+### Browser
+
+```ts
+import { IExecWeb3telegram } from '@iexec/web3telegram';
+
+const web3Provider = window.ethereum;
+const web3telegram = new IExecWeb3telegram(web3Provider);
+```
+
+### NodeJS
+
+```ts
+import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';
+
+const { PRIVATE_KEY } = process.env;
+
+const web3Provider = getWeb3Provider(PRIVATE_KEY);
+const web3telegram = new IExecWeb3telegram(web3Provider);
+```
+
+## Documentation
+
+- [Web3telegram documentation](https://tools.docs.iex.ec/tools/web3telegram)
+- [Web3telegram technical design](./technical-design/index.md)
+- [iExec Protocol documentation](https://protocol.docs.iex.ec)
+
+## License
+
+This project is licensed under the terms of the [Apache 2.0](/LICENSE).

README.md

@@ -0,0 +1,2 @@
+.env
+.env.schema

dapp/.dockerignore

@@ -0,0 +1,5 @@
+IEXEC_IN=/path/to/input/directory
+IEXEC_OUT=/path/to/output/directory
+IEXEC_DATASET_FILENAME="protectedData.zip"
+IEXEC_APP_DEVELOPER_SECRET='{"TELEGRAM_BOT_TOKEN":"7045386731:AAGSmPQQ_t2Po5eDob7rUEWEZ25W-s2t9fg"}'
+IEXEC_REQUESTER_SECRET_1='{"chatId":"chatId","message":"message","telegramContentEncryptionKey":"telegramContentEncryptionKey"}'