@xo-cash/engine 0.0.1-development.14109350676
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/LICENSE +21 -0
- package/README.md +49 -0
- package/dist/index.d.mts +1405 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +2724 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +73 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 GeneralProtocols / XO
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# @xo-cash/engine
|
|
2
|
+
|
|
3
|
+
XO Engine
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @xo-cash/engine
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### Basic Setup
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Engine } from '@xo-cash/engine';
|
|
15
|
+
import { createElectrumClient } from '@electrum-cash/network';
|
|
16
|
+
|
|
17
|
+
// Create an Electrum client for blockchain connectivity
|
|
18
|
+
const client = await createElectrumClient({
|
|
19
|
+
// client configuration
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
// Initialize the engine with wallet seed and storage options
|
|
23
|
+
const engine = await Engine.create('your-wallet-seed', client, {
|
|
24
|
+
databasePath: './',
|
|
25
|
+
databaseFilename: 'XO',
|
|
26
|
+
defaultTemplateHubUrl: 'https://template-hub.example.com',
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
// Import a template
|
|
30
|
+
const templateIdentifier = await engine.importTemplate(templateJson);
|
|
31
|
+
|
|
32
|
+
// List available starting actions for a template
|
|
33
|
+
const startingActions = await engine.listStartingActions(templateIdentifier);
|
|
34
|
+
|
|
35
|
+
// Create an invitation for a specific action
|
|
36
|
+
const invitation = await engine.createInvitation({
|
|
37
|
+
templateIdentifier,
|
|
38
|
+
actionIdentifier: 'action-id',
|
|
39
|
+
});
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Links
|
|
43
|
+
|
|
44
|
+
- [Repository](https://gitlab.com/GeneralProtocols/xo/engine)
|
|
45
|
+
- [Issues](https://gitlab.com/GeneralProtocols/xo/engine/issues)
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
MIT
|