@bluxcc/core 0.1.4 → 0.1.5

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.
Files changed (12) hide show
  1. package/README.md +30 -75
  2. package/dist/assets/Icons.d.ts +3 -0
  3. package/dist/exports/core/getBalances.d.ts +2 -2
  4. package/dist/exports/core/getPayments.d.ts +1 -1
  5. package/dist/index.cjs.js +11 -19
  6. package/dist/index.esm.js +11 -19
  7. package/dist/index.iife.js +14 -22
  8. package/dist/types.d.ts +1 -1
  9. package/package.json +3 -3
  10. package/dist/index.cjs.js.map +0 -1
  11. package/dist/index.esm.js.map +0 -1
  12. package/dist/index.iife.js.map +0 -1
package/README.md CHANGED
@@ -1,93 +1,57 @@
1
1
  # Blux Wallet Kit - The Missing Piece for Stellar dApps
2
2
 
3
- Blux is a **comprehensive authentication and wallet connect kit** designed for Stellar dApps. It simplifies onboarding by integrating multiple authentication methods, including **wallets, email, phone, and OAuth**. With Blux, developers can create seamless multi-auth experiences without the complexity of building custom authentication solutions from scratch.
3
+ ![image](https://blux.cc/bluxProduct.svg)
4
+
5
+ Blux is a **comprehensive authentication and wallet connect kit** designed for Stellar dApps.
6
+ It simplifies onboarding by integrating multiple authentication methods, including **wallets, email, passkey, and socials**.
4
7
 
5
8
  ## Features
6
9
 
7
- - **Multi-Wallet Support**: Easily integrate Stellar wallets such as **Rabet, xBull, Lobstr, Freighter, and Albedo**.
8
- - **OAuth & Social Login** _(Coming Soon)_: Support for **Apple, Meta, Google, and more**.
9
- - **Email & Phone Authentication** _(Coming Soon)_: Securely onboard users with non-crypto credentials.
10
+ - **Multi-Wallet Support**: Easily integrate Stellar wallets such as **Rabet, xBull, Lobstr, Freighter, Albedo, Hot Wallet, Hana Wallet, and more**.
11
+ - **Social Login** _(Coming Soon)_: Support for **Apple, Meta, Google, and more**.
12
+ - **Email & Passkey** _(Coming Soon)_: Securely onboard users with non-crypto credentials.
10
13
  - **Customizable UI**: Adjust themes, fonts, backgrounds, logos, border radius, and text colors.
11
14
  - **Configurable Networks**: Set up and modify network preferences via API keys.
12
15
  - **Future-Proof**: More wallets and authentication methods will be added based on community feedback.
13
16
 
14
17
  ## Installation
15
18
 
16
- Blux can be installed via npm:
17
-
18
19
  ```sh
19
20
  npm i @bluxcc/core
20
21
  ```
21
22
 
22
- or using yarn:
23
-
24
- ```sh
25
- yarn add @bluxcc/core
26
- ```
27
-
28
23
  ## Usage
29
24
 
30
- Include Blux and set up the authentication flow:
31
-
32
25
  ```html
33
26
  <!DOCTYPE html>
34
- <html>
35
- <head>
36
- <title>Blux Example</title>
37
- <script src="https://unpkg.com/@bluxcc/core/dist/index.iife.js"></script>
38
- </head>
39
- <body>
40
- <button id="loginBtn">Login with Blux</button>
41
-
42
- <script>
43
- Blux.createConfig({
44
- appName: 'your-app-name',
45
- appId: 'get-id-from-dashboard',
46
- networks: ['Public Global Stellar Network ; September 2015'],
47
- });
48
-
49
- document.getElementById('loginBtn').onclick = async () => {
50
- const user = await Blux.Blux.login();
51
-
52
- console.log('Logged in:', user);
53
- };
54
- </script>
55
- </body>
56
- </html>
57
- ```
27
+ <script src="https://unpkg.com/@bluxcc/core/dist/index.iife.js"></script>
58
28
 
59
- ## Customization
29
+ <button id="loginBtn">Login with Blux</button>
60
30
 
61
- Developers can customize various UI elements:
31
+ <script>
32
+ Blux.createConfig({
33
+ appName: 'My App',
34
+ networks: [Blux.core.networks.mainnet],
35
+ });
62
36
 
63
- - **Themes & Fonts**
64
- - **Backgrounds, Logos**
65
- - **Border Radius & Text Colors**
66
- - **Authentication Limits** (Free tier supports 500-1000 accounts per auth method)
67
-
68
- Configuration options can be passed in the `config` object when initializing Blux, or set via environment variables.
69
-
70
- ## Supported Wallets
71
-
72
- Currently supported connection methods:
37
+ document.getElementById('loginBtn').onclick = async () => {
38
+ await Blux.blux.login();
39
+ };
40
+ </script>
41
+ ```
73
42
 
74
- - [x] **Rabet**
75
- - [x] **xBull**
76
- - [x] **Lobstr**
77
- - [x] **Freighter**
78
- - [x] **Albedo**
79
- - [x] **Hana**
80
- - [ ] **Ledger**
81
- - [ ] **Trezor**
82
- - [ ] **WalletConnect**
83
- - [ ] **OAuth**
84
- - [ ] **Email**
43
+ ```tsx
44
+ import { blux, core, createConfig } from '@bluxcc/core';
85
45
 
86
- ## License & Usage Restrictions
46
+ createConfig({
47
+ appName: 'My App',
48
+ networks: [core.networks.mainnet],
49
+ });
87
50
 
88
- - **No Production Use**: This software is provided under the **Blux Team License** with restrictions on production use.
89
- - **No Forking or Unauthorized Modifications**: Removing references to **Blux Team** or forking without attribution is strictly prohibited.
90
- - **Custom Licensing Available**: Contact us at [support@blux.cc](mailto:support@blux.cc) to discuss licensing options.
51
+ document.getElementById('loginBtn').onclick = async () => {
52
+ await blux.login();
53
+ };
54
+ ```
91
55
 
92
56
  ## Support & Contact
93
57
 
@@ -96,13 +60,4 @@ For support, licensing, or inquiries, reach out via:
96
60
  - **Email**: [support@blux.cc](mailto:support@blux.cc)
97
61
  - **X (Twitter)**: [@BluxOfficial](https://twitter.com/BluxOfficial)
98
62
 
99
- ## Roadmap & Future Plans
100
-
101
- Blux is evolving. Follow our updates on [X (Twitter)](https://twitter.com/BluxOfficial) for:
102
-
103
- - **OAuth Authentication (Apple, Meta, Google, etc.)**
104
- - **Email & Phone-Based Authentication**
105
- - **More Wallet Integrations**
106
- - **Enhanced Customization & Security Features**
107
-
108
- Stay tuned. We have many exciting developments ahead!
63
+ Follow for more updates at [X (Twitter)](https://twitter.com/BluxOfficial).
package/dist/assets/Icons.d.ts CHANGED
@@ -56,6 +56,9 @@ export declare const WrongNetworkIcon: () => import("react/jsx-runtime").JSX.Ele
56
56
  export declare const SwapIcon: ({ fill }: {
57
57
  fill?: string;
58
58
  }) => import("react/jsx-runtime").JSX.Element;
59
+ export declare const SmallSwapIcon: ({ fill }: {
60
+ fill?: string;
61
+ }) => import("react/jsx-runtime").JSX.Element;
59
62
  export declare const ReceiveIcon: ({ fill }: {
60
63
  fill?: string;
61
64
  }) => import("react/jsx-runtime").JSX.Element;
package/dist/exports/core/getBalances.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { Horizon } from '@stellar/stellar-sdk';
2
- type GetBalanceOptions = {
2
+ type GetBalancesOptions = {
3
3
  address?: string;
4
4
  network?: string;
5
5
  includeZeroBalances?: boolean;
6
6
  };
7
- declare const getBalances: (options: GetBalanceOptions) => Promise<Horizon.HorizonApi.BalanceLine[]>;
7
+ declare const getBalances: (options: GetBalancesOptions) => Promise<Horizon.HorizonApi.BalanceLine[]>;
8
8
  export default getBalances;
package/dist/exports/core/getPayments.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { CallBuilderOptions } from "../utils";
1
+ import { CallBuilderOptions } from '../utils';
2
2
  type GetPaymentsOptions = CallBuilderOptions & {
3
3
  forAccount?: string;
4
4
  forLedger?: string | number;