@massalabs/wallet-provider 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Massa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,183 @@
+
+![check-code-coverage](https://img.shields.io/badge/coverage-NaN%25-red)
+
+
+
+
+  
+
+`Wallet-provider` is a TypeScript library that one could utilize to establish a connection between a frontend application and any browser wallet extensions that implement the [massa standard](https://github.com/massalabs/massa-standards/blob/main/wallet/dapps-communication.md). With this library one can access all massa-blockchain wallets and their standardized functionalities for ready use.
+
+  
+
+## Usage
+
+`Wallet-provider` could be used as a library for frameworks or as a stand-alone bundled js file which can be easily loaded into the browser.
+
+  
+
+### Library (Node.js/React/Vue.js) usage
+
+  
+
+> npm install @massalabs/wallet-provider
+
+  
+
+### Browser usage
+
+  
+
+Add the following script to your html file:
+
+  
+
+```ts
+
+<script
+
+type="text/javascript"
+
+src="https://cdn.jsdelivr.net/npm/@massalabs/wallet-provider@x.x.x/bundle.js"
+
+></script>
+
+```
+
+  
+
+whereby the x.x.x is one of the available released versions under [Wallet-provider's releases page](https://github.com/massalabs/wallet-provider/releases).
+
+  
+
+In your code, once the script is fully loaded, just use `window.wallet` to access all `wallet-provider`'s' exported functionalities.
+
+
+```ts
+
+<script>
+
+const  providers = window.massa.providers();
+
+console.log("Massa Providers ", providers);
+
+</script>
+
+```
+
+  
+
+## Documentation
+
+Wallet-provider provides complete documentation of all available functions and objects.
+
+To generate the documentation for a specific branch, run the following command:
+
+```sh
+npm run doc
+```
+
+The documentation will be generated in the `docs/documentation/html` directory.
+
+   
+
+## Web3 Wallet Provider Requirement and Initialization
+
+
+### Requirements
+
+- NodeJS 16+
+
+- npm / yarn (see package.json)
+
+
+### Initialization
+
+1. Run `npm install` to install all dependencies
+
+2. Run `npx playwright install --with-deps` to install playwright and its dependencies
+
+3. Run `npm run build` to build distribution content
+
+4. Run `npm run test` to run integration and unit tests
+
+<br>
+
+The library exports a function called `providers` which can be executed to return a vector of all massa-wallet providers currently initialized in the space. As shown below in the example code, each provider has its own callable methods for listing, importing and deleting accounts. Each account can return its name, address and has methods to retrieve its balance and sign a data array.
+
+```ts
+
+import { providers } from  "@massalabs/wallet-provider";
+
+
+// get all available massa-wallet providers
+
+const  providers = providers();
+  
+
+// get a provider
+
+const  myProvider = providers[0];
+
+console.log("Provider Name", myProvider.name());
+
+
+// import an account via the massa-wallet provider
+
+console.log("Importing an account ...");
+
+const  privateKey = "Sxxxxxxxxxxxxxx";
+
+const  publicKey = "Pxxxxxxxxxxxxxxx";
+
+
+await  myProvider.importAccount(publicKey, privateKey);
+
+
+// get accounts
+
+console.log("Retrieving the accounts ...");
+
+const  myAccounts = await  myProvider.accounts();
+
+console.log("Provider accounts ...", myAccounts);
+  
+
+// getting one account
+
+const  myAccount = myAccounts[0];
+
+console.log("Account address ", myAccount.address());
+ 
+
+// getting account balance
+
+console.log("Retrieving the account balance ...");
+
+const  accountBalance = await  myAccount.balance();
+
+console.log("Account Balance = ", accountBalance.balance);
+ 
+
+// signing a message
+
+console.log("Signing a message ...");
+
+const  signature = await  myAccount.sign([0, 1, 2]);
+
+console.log("Signature = ", signature);
+  
+
+// deleting an account
+
+console.log("Deleting an account ...");
+
+await  myProvider.importAccount(myAccount.address());
+
+```
+
+
+## Contributing
+We welcome contributions from the community!
+
+If you would like to contribute to Massa-as-sdk, please read the  [CONTRIBUTING file](https://github.com/massalabs/wallet-provider/blob/main/CONTRIBUTING.md).

package/package.json

@@ -0,0 +1,92 @@
+{
+    "name": "@massalabs/wallet-provider",
+    "version": "0.0.0",
+    "description": "massa's wallet provider",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "up": "npm update",
+        "check": "npm outdated",
+        "upgrade": "npm run up && npm run check && npm run build",
+        "build-package": "rimraf dist/* && tsc -d -p ./tsconfig.json",
+        "build-bundle": "npm run gen-bundle",
+        "gen-bundle": "browserify dist/index.js -p esmify --standalone wallet > bundle.js",
+        "uglify-bundle-optimize": "browserify dist/index.js -p esmify -i node-fetch -i http -i https -o bundle.min.js && browserify dist/index.js -p esmify -i node-fetch -g uglifyify --compress --mangle -o bundle.min.js",
+        "build": "npm run fmt && npm run build-package && npm run build-bundle",
+        "update-version-major": "npm version major",
+        "update-version-minor": "npm version minor",
+        "update-version-patch": "npm version patch",
+        "test:serve-dapp": "cp ./bundle.js ./test/dapp/bundle.js && http-server test/dapp --cors --port 9009", 
+        "test": "cd ./test && npx playwright test",
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix",
+        "prettier": "prettier --check .",
+        "prettier:fix": "prettier --write .",
+        "fmt": "npm run prettier:fix && npm run lint:fix",
+        "fmt:check": "npm run prettier && npm run lint",
+        "doc": "typedoc src/index.ts --name massa-wallet-provider --out docs/documentation/html --tsconfig tsconfig.json"
+    },
+    "author": "Massa Labs <info@massa.net>",
+    "contributors": [
+        "Evgeni Pirianov"
+    ],
+    "license": "(MIT AND Apache-2.0)",
+    "homepage": "https://github.com/massalabs/massa-wallet-provider",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/massalabs/massa-wallet-provider"
+    },
+    "private": false,
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "keywords": [
+        "web3",
+        "ts",
+        "sdk",
+        "massa"
+    ],
+    "files": [
+        "dist",
+        "bundle.js",
+        "bundle.min.js"
+    ],
+    "dependencies": {
+        "bignumber.js": "^9.1.1",
+        "buffer": "^6.0.3",
+        "esmify": "^2.1.1",
+        "uid": "^2.0.1"
+    },
+    "devDependencies": {
+        "@massalabs/eslint-config": "^0.0.9",
+        "@massalabs/prettier-config-as": "^0.0.2",
+        "@playwright/test": "^1.32.3",
+        "@types/bn.js": "^5.1.1",
+        "@types/chai": "^4.3.4",
+        "@types/mocha": "^10.0.1",
+        "@types/node": "^18.13.0",
+        "@types/secp256k1": "^4.0.3",
+        "browserify": "^17.0.0",
+        "chai": "^4.3.7",
+        "chalk": "^4.1.0",
+        "eslint-plugin-jsdoc": "^41.1.1",
+        "express": "^4.18.2",
+        "fs-extra": "^11.1.1",
+        "http-server": "^14.1.1",
+        "mocha": "^10.2.0",
+        "node-ts": "^5.1.2",
+        "ts-node": "^10.9.1",
+        "tslib": "^2.5.0",
+        "tslint": "^6.1.3",
+        "typedoc": "^0.23.25",
+        "typescript": "^4.9.5",
+        "uglify-js": "^3.17.4",
+        "uglifyify": "^5.0.2"
+    },
+    "optionalDependencies": {
+        "bufferutil": "^4.0.7",
+        "utf-8-validate": "^6.0.2"
+    },
+    "prettier": "@massalabs/prettier-config-as"
+}