From 4883d60a5d9c994a82814c5f5c5f00df4441cd25 Mon Sep 17 00:00:00 2001 From: mhh Date: Mon, 25 Mar 2024 20:21:32 +0100 Subject: [PATCH] Update and add README.md where needed for v1.0.0 release --- README.md | 25 ++++++++++++++----------- packages/account/README.md | 10 ++++++++++ packages/account/package.json | 9 ++++----- packages/account/src/account.ts | 4 ++-- packages/avalanche/README.md | 13 +++++++++++++ packages/avalanche/package.json | 11 ++++------- packages/client/README.md | 6 +++++- packages/client/package.json | 9 +++------ packages/core/README.md | 6 ++++++ packages/core/package.json | 6 ++++-- packages/cosmos/README.md | 10 ++++++++++ packages/cosmos/package.json | 10 ++++------ packages/ethereum-ledger/README.md | 10 ++++++++++ packages/ethereum-ledger/package.json | 10 ++++------ packages/ethereum/README.md | 18 ++++++++++++++++++ packages/ethereum/package.json | 11 ++++------- packages/evm/README.md | 10 ++++++++++ packages/evm/package.json | 10 ++++------ packages/message/README.md | 13 +++++++++++++ packages/message/package.json | 10 ++++------ packages/nuls2/README.md | 10 ++++++++++ packages/nuls2/package.json | 10 ++++------ packages/solana/README.md | 11 +++++++++++ packages/solana/package.json | 10 ++++------ packages/substrate/README.md | 10 ++++++++++ packages/substrate/package.json | 10 ++++------ packages/superfluid/README.md | 10 ++++++++++ packages/superfluid/package.json | 12 ++++-------- packages/tezos/README.md | 11 +++++++++++ packages/tezos/package.json | 10 ++++------ 30 files changed, 218 insertions(+), 97 deletions(-) create mode 100644 packages/account/README.md create mode 100644 packages/avalanche/README.md create mode 100644 packages/core/README.md create mode 100644 packages/cosmos/README.md create mode 100644 packages/ethereum-ledger/README.md create mode 100644 packages/ethereum/README.md create mode 100644 packages/evm/README.md create mode 100644 packages/message/README.md create mode 100644 packages/nuls2/README.md create mode 100644 packages/solana/README.md create mode 100644 packages/substrate/README.md create mode 100644 packages/superfluid/README.md create mode 100644 packages/tezos/README.md diff --git a/README.md b/README.md index 88664ae4..e27b54a0 100644 --- a/README.md +++ b/README.md @@ -22,18 +22,20 @@ This is the list of currently supported Account types. For each of them you can: - Retrieve an account from a private key or mnemonic (or generate one on the fly). - Sign and send messages on the Aleph Network +- Some allow you to retrieve an account from a **browser based** wallet (ex: Metamask), or from a **Ledger** wallet. -On top of that some accounts allow you to **encrypt** messages, retrieve an account from a **browser based** wallet (ex: Metamask), or from a **Ledger** wallet. +[Previous versions](https://npmjs.com/package/aleph-sdk-ts) of the Typescript SDK allowed you to **encrypt** messages. +This has been -| Chain | Encryption | Wallet | Ledger | -| --------- | ------------------ | ------------------ | ------------------ | -| Avalanche | :heavy_check_mark: | :heavy_check_mark: | :x: | -| Cosmos | :x: | :x: | :x: | -| Ethereum | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| NULS2 | :heavy_check_mark: | :x: | :x: | -| Solana | :x: | :heavy_check_mark: | :x: | -| Substrate | :heavy_check_mark: | :x: | :x: | -| Tezos | :x: | :heavy_check_mark: | :x: | +| Chain | Encryption | Browser Wallet | Ledger | +|----------------------|------------|--------------------| ------------------ | +| Avalanche | :x: | :heavy_check_mark: | :x: | +| Cosmos | :x: | :heavy_check_mark: | :x: | +| Ethereum | :x: | :heavy_check_mark: | :heavy_check_mark: | +| NULS2 | :x: | :x: | :x: | +| Solana | :x: | :heavy_check_mark: | :x: | +| Substrate (Polkadot) | :x: | :heavy_check_mark: | :x: | +| Tezos | :x: | :heavy_check_mark: | :x: | ## Running from source @@ -60,7 +62,8 @@ This SDK is tested and works, with the following Node.js versions: | -- | -- | | v14.x | :heavy_check_mark: **Full working support** | | v16.x | :heavy_check_mark: **Full working support** | -| v18.x (**LTS**) | :heavy_multiplication_x: Some feature may not work (see notes) | +| v18.x | :heavy_multiplication_x: Some feature may not work (see notes) | +| v20.x (**LTS**) \* Due to changes in OpenSSL in Node v18, some chains helper may not work. If you encounter bugs using Node v18, you might want to consider using the `--openssl-legacy-provider` feature flag while running your project. diff --git a/packages/account/README.md b/packages/account/README.md new file mode 100644 index 00000000..3b2bec4f --- /dev/null +++ b/packages/account/README.md @@ -0,0 +1,10 @@ +# @aleph-sdk/account +This package provides common interface definitions for blockchain accounts compatible with aleph.im, including abstract classes for standard and ECIES accounts, and a base provider wallet abstraction. +It is designed to be extended for specific blockchain protocols such as Ethereum and Solana. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Abstract Account class for implementing protocol-related accounts. +- Abstract ECIESAccount class for accounts using secp256k1's curve, with encryption capabilities. +- Abstract BaseProviderWallet for interaction with browser-based providers & wallets. diff --git a/packages/account/package.json b/packages/account/package.json index 437785b3..244b9ac7 100644 --- a/packages/account/package.json +++ b/packages/account/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/account", "version": "1.0.0-rc2", - "description": "", + "description": "Common interfaces for accounts compatible with aleph.im.", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -14,14 +14,13 @@ "dependencies": { "@aleph-sdk/core": "^1.0.0-rc2" }, - "peerDependencies": { - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/account/src/account.ts b/packages/account/src/account.ts index 6004218f..a5286001 100644 --- a/packages/account/src/account.ts +++ b/packages/account/src/account.ts @@ -20,9 +20,9 @@ export abstract class Account { /** * The ECIESAccount class is used to implement protocols using secp256k1's curve. - * It extends the Account class by exposing an encryption publicKey and method + * It extends the Account class by exposing an encryption publicKey. * - * All inherited classes of ECIESAccount must implement the encrypt methods and expose a publicKey. + * Encryption has been removed as of the v1.0.0 release but will find its way back into the SDK. */ export abstract class ECIESAccount extends Account { public publicKey: string | undefined diff --git a/packages/avalanche/README.md b/packages/avalanche/README.md new file mode 100644 index 00000000..d1cf38c1 --- /dev/null +++ b/packages/avalanche/README.md @@ -0,0 +1,13 @@ +# @aleph-sdk/avalanche +This package provides an implementation for Avalanche blockchain accounts within the Aleph.im ecosystem, enabling Avalanche account management and message signing functionalities. +It is designed to work with both X-Chain and C-Chain on the Avalanche network, providing utilities for account creation, message signing, and account importation from private keys or mnemonics. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Support for Avalanche X-Chain and C-Chain. +- Account creation and importation using private keys and mnemonics. +- Integration with Web3 providers (e.g., Metamask) for account management. +- Message signing with Avalanche account keys. +- Utility to retrieve EVM-compatible addresses for accounts on the C-Chain. +- Verify X-Chain signatures. diff --git a/packages/avalanche/package.json b/packages/avalanche/package.json index 10f75144..b6c18f39 100644 --- a/packages/avalanche/package.json +++ b/packages/avalanche/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/avalanche", "version": "1.0.0-rc2", - "description": "", + "description": "Avalanche accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -23,16 +23,13 @@ "ethers": "^5.7.2", "sha.js": "^2.4.11" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1", - "@aleph-sdk/evm": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/client/README.md b/packages/client/README.md index 892f3266..2c26f283 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -16,7 +16,11 @@ Each chain has its own package: so that you can only install the packages and dependencies you need. -This particular client package is a wrapper arount [@aleph-sdk/message](https://npmjs.com/package/@aleph-sdk/message) and delivers a similar interface to the more developed [Python SDK](https://pypi.org/project/aleph-sdk-python/). +This particular client package is a wrapper arount [@aleph-sdk/message](https://npmjs.com/package/@aleph-sdk/message) and delivers a similar interface to the exemplary [Python SDK](https://pypi.org/project/aleph-sdk-python/). + +Additional domain and DNS-related functions can be found in [@aleph-sdk/dns](https://npmjs.com/package/@aleph-sdk/dns) or in the [official docs](https://docs.aleph.im/computing/custom_domain/setup/). + +Establishing [ALEPH streams to create VPS instances](https://docs.aleph.im/libraries/typescript-sdk/instances/) using Superfluid on Avalanche can be done with [@aleph-sdk/superfluid](https://npmjs.com/package/@aleph-sdk/superfluid). ## Installation diff --git a/packages/client/package.json b/packages/client/package.json index e1218889..63407ceb 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -19,16 +19,13 @@ "@aleph-sdk/core": "^1.0.0-rc2", "@aleph-sdk/message": "^1.0.0-rc2" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1", - "@aleph-sdk/message": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/core/README.md b/packages/core/README.md new file mode 100644 index 00000000..22f06ad6 --- /dev/null +++ b/packages/core/README.md @@ -0,0 +1,6 @@ +# @aleph-sdk/core +The @aleph-sdk/core package provides essential utilities and shared constants necessary for development with the @aleph-sdk. +It features a collection of functions to aid in URL management, environment detection, and timing, alongside an enumeration of supported blockchain networks. +Designed for both Node.js and browser environments, this package is a foundational component for building blockchain applications with Aleph. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. diff --git a/packages/core/package.json b/packages/core/package.json index 4ced8448..c15506f3 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/core", "version": "1.0.0-rc2", - "description": "", + "description": "Shared utilities and constants for @aleph-sdk", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -17,5 +17,7 @@ "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/cosmos/README.md b/packages/cosmos/README.md new file mode 100644 index 00000000..058d5411 --- /dev/null +++ b/packages/cosmos/README.md @@ -0,0 +1,10 @@ +# @aleph-sdk/cosmos +This package facilitates Cosmos account management and message signing within the Aleph.im network, leveraging the Cosmos protocol. It includes functionalities for account creation, message signing, and account import using both mnemonics and private keys. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Supports creating new Cosmos accounts with random mnemonic generation. +- Allows importing Cosmos accounts using a mnemonic or a private key. +- Integrates account signing functionality for Aleph.im messages with support for account numbers. +- Provides utilities to verify the authenticity of a signature. diff --git a/packages/cosmos/package.json b/packages/cosmos/package.json index 9372600b..55d4bfcb 100644 --- a/packages/cosmos/package.json +++ b/packages/cosmos/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/cosmos", "version": "1.0.0-rc2", - "description": "", + "description": "Cosmos accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -17,15 +17,13 @@ "@cosmjs/amino": "^0.32.2", "elliptic": "^6.5.4" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/ethereum-ledger/README.md b/packages/ethereum-ledger/README.md new file mode 100644 index 00000000..a72d5f0c --- /dev/null +++ b/packages/ethereum-ledger/README.md @@ -0,0 +1,10 @@ +# @aleph-sdk/ethereum-ledger +This module enables Ethereum accounts management and message signing using a Ledger device with the Ethereum app. It's part of the @aleph-sdk, designed to work seamlessly with Ethereum blockchain for operations requiring high security like transactions signing. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Retrieve Ethereum account details from a connected Ledger device. +- Sign messages using the Ledger device's private keys. +- Support for specific Ethereum derivation paths. +- Compatibility checks for Ledger device firmware. diff --git a/packages/ethereum-ledger/package.json b/packages/ethereum-ledger/package.json index a93aa9c7..02482aed 100644 --- a/packages/ethereum-ledger/package.json +++ b/packages/ethereum-ledger/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/ethereum-ledger", "version": "1.0.0-rc2", - "description": "", + "description": "Ledger-based Ethereum accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -21,15 +21,13 @@ "@ledgerhq/hw-transport-webusb": "^6.28.3", "semver": "^7.3.8" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/ethereum/README.md b/packages/ethereum/README.md new file mode 100644 index 00000000..78fb0cf8 --- /dev/null +++ b/packages/ethereum/README.md @@ -0,0 +1,18 @@ +# @aleph-sdk/ethereum +The `@aleph-sdk/ethereum` module offers functionalities to interact with Ethereum accounts within the Aleph.im ecosystem. +It allows for the creation, import, and management of Ethereum accounts and facilitates the signing of messages in compliance with Aleph.im protocols. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Creation and import of Ethereum accounts using mnemonics or private keys. +- Integration with Ethereum wallets and providers, such as MetaMask. +- Support for signing Aleph.im messages using Ethereum accounts. +- Compatibility with BIP39 for mnemonic generation and management. + +Further features are included in the [@aleph-sdk/evm](https://npmjs.com/package/@aleph-sdk/evm) dependency, such as: + +- EVM signature verification +- Get ChainID +- Switch network +- A standardized wrapper for browser-based and private-key wallets diff --git a/packages/ethereum/package.json b/packages/ethereum/package.json index faed35f4..6e5cd631 100644 --- a/packages/ethereum/package.json +++ b/packages/ethereum/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/ethereum", "version": "1.0.0-rc2", - "description": "", + "description": "Ethereum accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -19,16 +19,13 @@ "eciesjs": "^0.4.6", "ethers": "^5.7.2" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1", - "@aleph-sdk/evm": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/evm/README.md b/packages/evm/README.md new file mode 100644 index 00000000..de582173 --- /dev/null +++ b/packages/evm/README.md @@ -0,0 +1,10 @@ +# @aleph-sdk/evm +This package provides essential functionalities for Ethereum Virtual Machine (EVM)-based accounts to interact with the Aleph.im network. It includes utilities for managing blockchain network connections, signing messages, and verifying signatures using EVM-compatible wallets, such as MetaMask or custom JSON-RPC providers. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Supports changing network RPCs dynamically, including popular networks like Ethereum Mainnet, Binance Smart Chain, Polygon, and Avalanche. +- Facilitates the signing of messages and verification of their signatures with EVM accounts. +- Provides utility functions for hexadecimal and decimal conversions, alongside network configuration data for easy RPC management. +- Warns about potential deprecation of encryption/decryption features according to the ongoing discussions in the developer community. \ No newline at end of file diff --git a/packages/evm/package.json b/packages/evm/package.json index 1c6c65e9..49e76d47 100644 --- a/packages/evm/package.json +++ b/packages/evm/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/evm", "version": "1.0.0-rc2", - "description": "", + "description": "Common functions for EVM-based accounts interacting with aleph.im.", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -18,15 +18,13 @@ "ethereumjs-util": "^7.1.5", "ethers": "^5.7.2" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/message/README.md b/packages/message/README.md new file mode 100644 index 00000000..dbca603a --- /dev/null +++ b/packages/message/README.md @@ -0,0 +1,13 @@ +# @aleph-sdk/message +This package, part of the [aleph.im](https://aleph.im) SDK, provides a comprehensive API for creating, retrieving, updating (amending), and deleting (forgetting) messages on the aleph.im network. +It encapsulates the functionality necessary to interact with the aleph.im message protocol, streamlining blockchain and decentralized storage operations such as posting content, storing data, as well as handling instance creation. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Query messages: Retrieve and parse all messages available on the network. +- Message posting: Create and publish messages directly to the aleph.im network. +- Message management: Amend or forget messages, providing flexibility in content management. +- Content storage: Store content in a decentralized manner, with support for both temporary and permanent data storage. +- Create programs and instances: Request compute resources on the network by posting according messages. +- Utility functions: A suite of utility functions to support message creation and signing. \ No newline at end of file diff --git a/packages/message/package.json b/packages/message/package.json index cbfad2f9..1d625de7 100644 --- a/packages/message/package.json +++ b/packages/message/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/message", "version": "1.0.0-rc2", - "description": "", + "description": "Aleph.im message CRUD API", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -21,15 +21,13 @@ "form-data": "^4.0.0", "sha.js": "^2.4.11" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/nuls2/README.md b/packages/nuls2/README.md new file mode 100644 index 00000000..f1338845 --- /dev/null +++ b/packages/nuls2/README.md @@ -0,0 +1,10 @@ +# @aleph-sdk/nuls2 +The @aleph-sdk/nuls2 package facilitates interaction with the NULS2 blockchain for account management and message signing within the Aleph.im ecosystem. It leverages cryptographic standards and blockchain utilities to create, import, encrypt, decrypt, and sign messages using NULS2 protocol accounts. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Account Creation & Import: Generate new accounts or import existing ones using a mnemonic or private key. +- Message Signing: Sign messages in a format compatible with the Aleph.im network, utilizing the NULS2 blockchain's signature algorithms. +- Data Encryption & Decryption: Encrypt and decrypt content using public and private keys of a NULS2 account, ensuring secure data handling. +- Blockchain Compatibility: Designed explicitly for NULS2 protocol integration, supporting custom chain IDs and address prefixes. \ No newline at end of file diff --git a/packages/nuls2/package.json b/packages/nuls2/package.json index bf9f6660..cceabe5a 100644 --- a/packages/nuls2/package.json +++ b/packages/nuls2/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/nuls2", "version": "1.0.0-rc2", - "description": "", + "description": "Nuls2 accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -28,15 +28,13 @@ "secp256k1": "^5.0.0", "sha.js": "^2.4.11" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/solana/README.md b/packages/solana/README.md new file mode 100644 index 00000000..5d8e8001 --- /dev/null +++ b/packages/solana/README.md @@ -0,0 +1,11 @@ +# @aleph-sdk/solana +The @aleph-sdk/solana package enables the creation, signing, and verification of messages on the Aleph.im network using Solana accounts. It provides crucial functionalities to interact seamlessly with the Solana blockchain, including support for both keypair and wallet-based interactions. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +# Features +- Sign messages with Solana accounts either via a Keypair or a connected wallet provider. +- Verify the authenticity of signed messages. +- Create new Solana accounts with randomly generated keypairs. +- Import Solana accounts using private keys. +- Connect to in-browser wallet providers to retrieve public keys and sign messages. \ No newline at end of file diff --git a/packages/solana/package.json b/packages/solana/package.json index 3d4a53d3..08f559a9 100644 --- a/packages/solana/package.json +++ b/packages/solana/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/solana", "version": "1.0.0-rc2", - "description": "", + "description": "Solana accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -21,15 +21,13 @@ "bs58": "^5.0.0", "tweetnacl": "^1.0.3" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/substrate/README.md b/packages/substrate/README.md new file mode 100644 index 00000000..d933c141 --- /dev/null +++ b/packages/substrate/README.md @@ -0,0 +1,10 @@ +# @aleph-sdk/substrate +The @aleph-sdk/substrate package is designed to facilitate interactions with Polkadot/Substrate-based accounts on the Aleph.im network. It encompasses functionalities to manage account creation, importation, and to sign messages using the Substrate protocol, thus enabling seamless integrations for applications built on or transacting with Polkadot or other Substrate-based blockchains. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Account Management: Generate new Substrate accounts or import existing ones using a mnemonic or private key. +- Message Signing: Sign messages using Substrate keypairs or through connected wallet providers while ensuring integrity and non-repudiation. +- Signature Verification: Verify the authenticity of signatures against the original messages and signer's addresses. +- Provider Integration: Interface with Polkadot.js browser extension providers to fetch account details and perform signing operations. diff --git a/packages/substrate/package.json b/packages/substrate/package.json index 5c3595c3..35c5a870 100644 --- a/packages/substrate/package.json +++ b/packages/substrate/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/substrate", "version": "1.0.0-rc2", - "description": "", + "description": "Polkadot/Substrate-based accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -20,15 +20,13 @@ "@polkadot/util": "^12.6.2", "@polkadot/util-crypto": "^12.6.2" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/superfluid/README.md b/packages/superfluid/README.md new file mode 100644 index 00000000..f3ad0ce6 --- /dev/null +++ b/packages/superfluid/README.md @@ -0,0 +1,10 @@ +# @aleph-sdk/superfluid +The @aleph-sdk/superfluid package integrates Aleph.im's account management capabilities with the Superfluid protocol on the Avalanche network. It is designed to facilitate seamless interactions with the Superfluid protocol, enabling users to manage real-time finance streams with ALEPH tokens in a decentralized manner. + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Easily manage ALEPH token streams on the Superfluid protocol directly from Aleph.im accounts. +- Utilize functions to increase or decrease ALEPH flow rates to other addresses, providing greater control over streaming finance applications. +- Query for ALEPH balance, flow rate to a receiver, net flow rate of the account, and detailed inflow and outflow records, integrating financial streaming logic into your decentralized applications. +- Leverage compatibility with Avalanche and multiple network IDs for broader access and functionality. \ No newline at end of file diff --git a/packages/superfluid/package.json b/packages/superfluid/package.json index 6747077c..bfeae4b8 100644 --- a/packages/superfluid/package.json +++ b/packages/superfluid/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/superfluid", "version": "1.0.0-rc2", - "description": "", + "description": "Aleph.im account wrapper for interacting with the Superfluid Avalanche Contract", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -23,17 +23,13 @@ "avalanche": "1.0.3", "decimal.js": "^10.4.3" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/avalanche": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1", - "@aleph-sdk/evm": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" } diff --git a/packages/tezos/README.md b/packages/tezos/README.md new file mode 100644 index 00000000..5b8887b6 --- /dev/null +++ b/packages/tezos/README.md @@ -0,0 +1,11 @@ +# @aleph-sdk/tezos +The @aleph-sdk/tezos package bridges Tezos blockchain interactions for Aleph.im applications, enabling Tezos account management, message signing, and signature verification. +It provides effortless integration for developers looking to connect Tezos wallets or accounts with the Aleph.im data network, facilitating a seamless user experience in decentralized applications (DApps). + +See [@aleph-sdk/client](https://npmjs.com/package/@aleph-sdk/client) or the [offical docs](https://docs.aleph.im) as the entrypoint for developing with aleph.im. + +## Features +- Compatibility with both BeaconWallet and InMemorySigner for flexible account management. +- Direct message signing capability employing Tezos cryptographic standards. +- Signature verification based on input message and digital signature. +- Support for Tezos account creation and import via mnemonic, private keys, or fundraiser identity. diff --git a/packages/tezos/package.json b/packages/tezos/package.json index c343ae0a..69569da3 100644 --- a/packages/tezos/package.json +++ b/packages/tezos/package.json @@ -1,7 +1,7 @@ { "name": "@aleph-sdk/tezos", "version": "1.0.0-rc2", - "description": "", + "description": "Tezos accounts for signing messages on aleph.im", "main": "dist/cjs/index.min.cjs", "module": "dist/esm/index.min.mjs", "types": "dist/index.d.ts", @@ -22,15 +22,13 @@ "@taquito/utils": "^17.5.2", "tweetnacl": "^1.0.3" }, - "peerDependencies": { - "@aleph-sdk/account": "1.0.0-rc.1", - "@aleph-sdk/core": "1.0.0-rc.1" - }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "rollup": "rollup -c ../../rollup.config.js", "build": "npm run rollup" }, "author": "", - "license": "ISC" + "homepage": "https://aleph.im", + "bugs": "https://github.com/aleph-im/aleph-sdk-ts/issues", + "license": "MIT" }