shogun-core 1.3.0 → 1.3.2
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 +4 -40
- package/dist/browser/shogun-core.js +1 -1
- package/dist/browser/shogun-core.light.js +1 -1
- package/dist/browser/shogun-core.vendors.light.js +1 -1
- package/dist/core.js +9 -29
- package/dist/gundb/gunInstance.js +1 -1
- package/dist/types/core.d.ts +0 -21
- package/dist/types/gundb/index.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Shogun Core 📦
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/shogun-core)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
[](https://www.typescriptlang.org/)
|
|
6
6
|
|
|
@@ -15,7 +15,6 @@ Shogun Core is a comprehensive SDK for building decentralized applications (dApp
|
|
|
15
15
|
- **[Reactive Data Flows](wiki/gundb.md#reactive-programming-with-rxjs)**: RxJS integration for building responsive, real-time user interfaces
|
|
16
16
|
- **[Enterprise Security](wiki/core.md#security)**: End-to-end encryption, secure key management, and modern cryptographic standards
|
|
17
17
|
- **[Plugin Architecture](wiki/core.md#plugin-system)**: Extensible system for adding custom authentication methods and functionality
|
|
18
|
-
- **[Smart Contract Integration](wiki/contracts.md)**: Tools for interacting with Shogun Protocol contracts on Ethereum
|
|
19
18
|
|
|
20
19
|
## Core Components
|
|
21
20
|
|
|
@@ -24,14 +23,6 @@ Shogun Core is a comprehensive SDK for building decentralized applications (dApp
|
|
|
24
23
|
- **[WebAuthn Plugin](wiki/webauthn.md)**: Passwordless authentication with biometrics and security keys
|
|
25
24
|
- **[Web3 Plugin](wiki/web3.md)**: Ethereum wallet integration and blockchain authentication
|
|
26
25
|
- **[Nostr Plugin](wiki/nostr.md)**: Bitcoin and Nostr protocol integration for decentralized identity
|
|
27
|
-
- **[Contracts SDK](wiki/contracts.md)**: Tools for interacting with Shogun Protocol smart contracts
|
|
28
|
-
|
|
29
|
-
## External Plugins
|
|
30
|
-
|
|
31
|
-
For extended functionality, install these separate plugins:
|
|
32
|
-
|
|
33
|
-
- **[@shogun/bip44](https://github.com/scobru/shogun-BIP44)**: BIP-44 HD wallet management
|
|
34
|
-
- **[@shogun/stealth-address](https://github.com/scobru/shogun-stealth-address)**: Privacy-enhancing stealth addresses
|
|
35
26
|
|
|
36
27
|
## Installation
|
|
37
28
|
|
|
@@ -39,9 +30,6 @@ For extended functionality, install these separate plugins:
|
|
|
39
30
|
npm install shogun-core
|
|
40
31
|
# or
|
|
41
32
|
yarn add shogun-core
|
|
42
|
-
|
|
43
|
-
# Optional external plugins
|
|
44
|
-
npm install @shogun/bip44 @shogun/stealth-address
|
|
45
33
|
```
|
|
46
34
|
|
|
47
35
|
## Quick Start
|
|
@@ -54,11 +42,6 @@ const shogun = new ShogunCore({
|
|
|
54
42
|
peers: ["https://your-gun-peer.com/gun"],
|
|
55
43
|
scope: "my-app",
|
|
56
44
|
|
|
57
|
-
// Enable built-in authentication plugins
|
|
58
|
-
webauthn: { enabled: true },
|
|
59
|
-
web3: { enabled: true },
|
|
60
|
-
nostr: { enabled: true },
|
|
61
|
-
|
|
62
45
|
// Configure logging
|
|
63
46
|
logging: {
|
|
64
47
|
enabled: true,
|
|
@@ -83,27 +66,13 @@ await gundb.put("user/profile", { name: "John Doe", status: "online" });
|
|
|
83
66
|
const profile = await gundb.get("user/profile");
|
|
84
67
|
|
|
85
68
|
// Reactive data with RxJS
|
|
86
|
-
shogun.
|
|
69
|
+
shogun.observe("user/profile").subscribe(profile => {
|
|
87
70
|
console.log("Profile updated:", profile);
|
|
88
71
|
});
|
|
89
72
|
```
|
|
90
73
|
|
|
91
74
|
## Advanced Usage
|
|
92
75
|
|
|
93
|
-
### Custom Plugin Registration
|
|
94
|
-
|
|
95
|
-
```typescript
|
|
96
|
-
// Register external plugins
|
|
97
|
-
import { HDWalletPlugin } from "@shogun/bip44";
|
|
98
|
-
import { StealthPlugin } from "@shogun/stealth-address";
|
|
99
|
-
|
|
100
|
-
shogun.register(new HDWalletPlugin());
|
|
101
|
-
shogun.register(new StealthPlugin());
|
|
102
|
-
|
|
103
|
-
const bip44Plugin = shogun.getPlugin("bip44");
|
|
104
|
-
const stealthPlugin = shogun.getPlugin("stealth");
|
|
105
|
-
```
|
|
106
|
-
|
|
107
76
|
### Event Handling
|
|
108
77
|
|
|
109
78
|
```typescript
|
|
@@ -134,12 +103,8 @@ For detailed documentation on each component:
|
|
|
134
103
|
- **[Web3 Plugin](wiki/web3.md)** - Ethereum wallet integration
|
|
135
104
|
- **[Nostr Plugin](wiki/nostr.md)** - Bitcoin and Nostr protocol support
|
|
136
105
|
|
|
137
|
-
### External Plugins
|
|
138
|
-
- **[BIP44 HD Wallet Plugin](https://github.com/scobru/shogun-BIP44)** - Hierarchical deterministic wallet management
|
|
139
|
-
- **[Stealth Address Plugin](https://github.com/scobru/shogun-stealth-address)** - Privacy-enhancing address generation
|
|
140
|
-
|
|
141
106
|
### Technical Documentation
|
|
142
|
-
Full API documentation is available
|
|
107
|
+
Full API documentation is available in the `/docs` directory after building.
|
|
143
108
|
|
|
144
109
|
## Use Cases
|
|
145
110
|
|
|
@@ -149,9 +114,8 @@ Shogun Core is ideal for building:
|
|
|
149
114
|
- **Web3 Wallets**: Browser-based cryptocurrency wallets with multiple authentication options
|
|
150
115
|
- **Enterprise dApps**: Business applications requiring secure, decentralized data storage
|
|
151
116
|
- **Gaming Platforms**: Real-time multiplayer games with decentralized leaderboards and assets
|
|
152
|
-
- **Privacy-Focused Applications**: Apps requiring anonymous interactions and
|
|
117
|
+
- **Privacy-Focused Applications**: Apps requiring anonymous interactions and privacy features
|
|
153
118
|
- **Collaborative Tools**: Real-time document editing, project management, and team coordination
|
|
154
|
-
- **IoT and Edge Computing**: Decentralized device management and data collection
|
|
155
119
|
|
|
156
120
|
## Browser Compatibility
|
|
157
121
|
|