Skip to content

Commit 2e366c6

Browse files
authored
Merge pull request #154 from BitGo/WP-6811-advanced-wallets-beta-open
docs: add BETA open source release notice
2 parents 8ed07e3 + 0b58cdd commit 2e366c6

File tree

4 files changed

+164
-480
lines changed

4 files changed

+164
-480
lines changed

LICENSE

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
1-
Apache License
1+
===============================================================================
2+
BETA SOFTWARE NOTICE
3+
===============================================================================
4+
5+
THIS SOFTWARE IS PROVIDED IN BETA FORM AND HAS NOT BEEN OFFICIALLY RELEASED
6+
FOR PRODUCTION USE.
7+
8+
The software is provided "AS-IS" without any warranties or guarantees of any
9+
kind, express or implied. Features, APIs, and functionality may change without
10+
notice. This beta version is intended for testing, evaluation, and development
11+
purposes only.
12+
13+
BY USING THIS BETA SOFTWARE, YOU ACKNOWLEDGE AND AGREE THAT:
14+
15+
- The software may contain bugs, errors, or other issues
16+
- No production support or service level agreements are provided
17+
- BitGo assumes no liability for any losses, damages, or issues arising from
18+
use of this beta software
19+
- You use this software entirely at your own risk
20+
21+
For production use cases, please wait for the official release or contact
22+
BitGo for enterprise support options.
23+
24+
===============================================================================
25+
26+
Apache License
227
Version 2.0, January 2004
328
http://www.apache.org/licenses/
429

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Advanced Wallets
22

3+
> **⚠️ BETA SOFTWARE - NOT OFFICIALLY RELEASED**
4+
>
5+
> This project is currently in beta and has not been officially released for production use. APIs, features, and documentation may change without notice. Use at your own risk in production environments.
6+
7+
![Beta](https://img.shields.io/badge/status-beta-yellow) ![Version](https://img.shields.io/badge/version-2.0.0--beta-blue) ![License](https://img.shields.io/badge/license-Apache%202.0-green)
8+
39
Advanced wallets are a type of self-custody cryptocurrency wallet that securely enable mutual TLS (mTLS) signing servers with two operational modes:
410

511
- **Advanced Wallet Manager Mode** - A lightweight, dedicated keygen/signing server that you can use for secure key operations. This mode includes support for wallet recoveries.
@@ -304,7 +310,7 @@ curl -k --cert certs/test-ssl-cert.pem --key certs/test-ssl-key.pem -X POST http
304310
curl -k -X POST https://localhost:3081/ping/advancedWalletManager
305311
```
306312

307-
>**Note:**
313+
> **Note:**
308314
>
309315
> - `host.containers.internal` is a special DNS name that resolves to the host machine from inside containers.
310316
> - The `:Z` option in volume mounts is specific to SELinux-enabled systems and ensures proper volume labeling.
@@ -448,7 +454,7 @@ npm start
448454

449455
#### 3. Test Connection
450456

451-
For testing, you can use the IP address of the server or `localhost` if you're running it locally. In production deployments, configure your DNS or load balancer to point to the appropriate servers.
457+
For testing, you can use the IP address of the server or `localhost` if you're running it locally. In production deployments, configure your DNS or load balancer to point to the appropriate servers.
452458

453459
```bash
454460
# Test Advanced Wallet Manager (replace localhost with your server IP/hostname)

0 commit comments

Comments
 (0)