@portal-hq/web 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -0
- package/lib/commonjs/mpc/index.js +1 -1
- package/lib/esm/mpc/index.js +1 -1
- package/package.json +1 -1
- package/src/mpc/index.ts +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Portal Web SDK
|
|
2
|
+
|
|
3
|
+
Welcome to the `@portal-hq/web` SDK, the official TypeScript library for integrating Portal's features into your web applications. This package enables you to seamlessly incorporate embedded MPC wallets.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Portal Class Constructor**: Initialize the Portal instance in your application.
|
|
8
|
+
- **PortalContext Provider**: Expose the Portal instance to your React component tree.
|
|
9
|
+
- **usePortal Hook**: Consume the Portal instance within your child components for easy access and interaction.
|
|
10
|
+
- **Types and Enums**: Utilize helper types and enums for efficient development with the Portal SDK.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
For a comprehensive guide and API reference, please visit our [documentation portal](https://docs.portalhq.io/sdk/web).
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
### Prerequisites
|
|
19
|
+
|
|
20
|
+
- Node.js and npm or yarn installed.
|
|
21
|
+
- Basic knowledge of TypeScript and React.
|
|
22
|
+
- Access to a Portal Account.
|
|
23
|
+
|
|
24
|
+
### Installation
|
|
25
|
+
|
|
26
|
+
Install the SDK package using npm or yarn:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm install @portal-hq/web
|
|
30
|
+
# or
|
|
31
|
+
yarn add @portal-hq/web
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Support
|
|
35
|
+
|
|
36
|
+
For issues or questions please reach out to our support team at support@portalhq.io.
|
|
@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
12
12
|
exports.MpcErrorCodes = exports.MpcError = void 0;
|
|
13
13
|
const errors_1 = require("./errors");
|
|
14
14
|
const index_1 = require("../index");
|
|
15
|
-
const WEB_SDK_VERSION = '1.0.
|
|
15
|
+
const WEB_SDK_VERSION = '1.0.4';
|
|
16
16
|
class Mpc {
|
|
17
17
|
constructor({ portal }) {
|
|
18
18
|
this.configureIframe = () => {
|
package/lib/esm/mpc/index.js
CHANGED
|
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
9
9
|
};
|
|
10
10
|
import { PortalMpcError } from './errors';
|
|
11
11
|
import { BackupMethods } from '../index';
|
|
12
|
-
const WEB_SDK_VERSION = '1.0.
|
|
12
|
+
const WEB_SDK_VERSION = '1.0.4';
|
|
13
13
|
class Mpc {
|
|
14
14
|
constructor({ portal }) {
|
|
15
15
|
this.configureIframe = () => {
|
package/package.json
CHANGED