@tezos-x/octez.connect-sdk 0.9.0

package/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Papers AG
+
+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,80 @@
+# octez.connect SDK
+
+[![npm](https://img.shields.io/npm/v/@tezos-x/octez.connect-sdk.svg?colorB=brightgreen)](https://www.npmjs.com/package/@tezos-x/octez.connect-sdk)
+[![documentation](https://img.shields.io/badge/documentation-online-brightgreen.svg)](https://trilitech.github.io/octez.connect-sdk/)
+[![GitHub Action](https://github.com/trilitech/octez.connect-sdk/workflows/Build%2C%20Test%20and%20Analyze/badge.svg)](https://github.com/trilitech/octez.connect-sdk/actions?query=workflow%3A%22Build%2C+Test+and+Analyze%22+branch%3Amain)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+## Intro
+
+The `octez.connect-sdk` simplifies and abstracts the communication between dApps and wallets over different transport layers.
+
+Developers that plan to develop complex smart contract interactions can use [Taquito](https://github.com/ecadlabs/taquito) with the `BeaconWallet`, which uses this SDK under the hood, but provides helpful methods to interact with contracts.
+
+
+## Installation
+
+```
+npm i --save @tezos-x/octez.connect-sdk
+```
+
+## Example DApp integration
+
+```ts
+const client = new DAppClient({ name: 'My Sample DApp' })
+
+client
+  .requestPermissions() // Send a permission request and automatically show UI to the user to select his favorite wallet
+  .then((permissions) => {
+    // Account that has been shared by the wallet
+    console.log('got permissions', permissions)
+  })
+  .catch((error) => console.log(error))
+```
+
+For a more complete example, take a look at the `example-dapp.html` file.
+
+## Example Wallet integration
+
+```ts
+const client = new WalletClient({ name: 'My Wallet' })
+await client.init() // Establish P2P connection
+
+client
+  .connect(async (message) => {
+    // Example: Handle PermissionRequest. A wallet should handle all request types
+    if (message.type === BeaconMessageType.PermissionRequest) {
+      // Show a UI to the user where he can confirm sharing an account with the DApp
+
+      const response: PermissionResponseInput = {
+        type: BeaconMessageType.PermissionResponse,
+        network: message.network, // Use the same network that the user requested
+        scopes: [PermissionScope.OPERATION_REQUEST], // Ignore the scopes that have been requested and instead give only operation permissions
+        id: message.id,
+        publicKey: 'tezos public key'
+      }
+
+      // Send response back to DApp
+      await client.respond(response)
+    }
+  })
+  .catch((error) => console.error('connect error', error))
+```
+
+For a more complete example, take a look at the `example-wallet.html` file.
+
+## Adding a wallet to octez.connect-sdk
+
+Please create a PR and add your wallet [here](https://github.com/trilitech/octez.connect-sdk/blob/master/scripts/generate-wallet-list.ts).
+
+For iOS wallets, the wallet needs to define a custom url scheme to support the same-device functionality.
+
+## Development
+
+```
+$ npm i
+$ npm run build
+$ npm run test
+```
+
+Once the SDK is built, you can open the `example-dapp.html` file in your browser and try out the basic functionality. To support browser extensions as well, the file should be viewed over a webserver. You can easily start one with `python -m SimpleHTTPServer 8000` and then open the file with `http://localhost:8000/example-dapp.html`.

package/dist/cjs/index.d.ts

@@ -0,0 +1,10 @@
+export * from '@tezos-x/octez.connect-blockchain-substrate';
+export * from '@tezos-x/octez.connect-blockchain-tezos';
+export * from '@tezos-x/octez.connect-core';
+export * from '@tezos-x/octez.connect-dapp';
+export * from '@tezos-x/octez.connect-transport-matrix';
+export * from '@tezos-x/octez.connect-transport-postmessage';
+export * from '@tezos-x/octez.connect-transport-walletconnect';
+export * from '@tezos-x/octez.connect-types';
+export * from '@tezos-x/octez.connect-utils';
+export * from '@tezos-x/octez.connect-wallet';

package/dist/cjs/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@tezos-x/octez.connect-blockchain-substrate"), exports);
+__exportStar(require("@tezos-x/octez.connect-blockchain-tezos"), exports);
+__exportStar(require("@tezos-x/octez.connect-core"), exports);
+__exportStar(require("@tezos-x/octez.connect-dapp"), exports);
+__exportStar(require("@tezos-x/octez.connect-transport-matrix"), exports);
+__exportStar(require("@tezos-x/octez.connect-transport-postmessage"), exports);
+__exportStar(require("@tezos-x/octez.connect-transport-walletconnect"), exports);
+__exportStar(require("@tezos-x/octez.connect-types"), exports);
+// export * from '@tezos-x/octez.connect-ui'
+__exportStar(require("@tezos-x/octez.connect-utils"), exports);
+__exportStar(require("@tezos-x/octez.connect-wallet"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8EAA2D;AAC3D,0EAAuD;AACvD,8DAA2C;AAC3C,8DAA2C;AAC3C,0EAAuD;AACvD,+EAA4D;AAC5D,iFAA8D;AAC9D,+DAA4C;AAC5C,4CAA4C;AAC5C,+DAA4C;AAC5C,gEAA6C"}

package/dist/esm/index.d.ts

@@ -0,0 +1,10 @@
+export * from '@tezos-x/octez.connect-blockchain-substrate';
+export * from '@tezos-x/octez.connect-blockchain-tezos';
+export * from '@tezos-x/octez.connect-core';
+export * from '@tezos-x/octez.connect-dapp';
+export * from '@tezos-x/octez.connect-transport-matrix';
+export * from '@tezos-x/octez.connect-transport-postmessage';
+export * from '@tezos-x/octez.connect-transport-walletconnect';
+export * from '@tezos-x/octez.connect-types';
+export * from '@tezos-x/octez.connect-utils';
+export * from '@tezos-x/octez.connect-wallet';

package/dist/esm/index.js

@@ -0,0 +1,12 @@
+export * from '@tezos-x/octez.connect-blockchain-substrate';
+export * from '@tezos-x/octez.connect-blockchain-tezos';
+export * from '@tezos-x/octez.connect-core';
+export * from '@tezos-x/octez.connect-dapp';
+export * from '@tezos-x/octez.connect-transport-matrix';
+export * from '@tezos-x/octez.connect-transport-postmessage';
+export * from '@tezos-x/octez.connect-transport-walletconnect';
+export * from '@tezos-x/octez.connect-types';
+// export * from '@tezos-x/octez.connect-ui'
+export * from '@tezos-x/octez.connect-utils';
+export * from '@tezos-x/octez.connect-wallet';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,6CAA6C,CAAA;AAC3D,cAAc,yCAAyC,CAAA;AACvD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yCAAyC,CAAA;AACvD,cAAc,8CAA8C,CAAA;AAC5D,cAAc,gDAAgD,CAAA;AAC9D,cAAc,8BAA8B,CAAA;AAC5C,4CAA4C;AAC5C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA"}