Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/dapi-grpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Available methods :

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/dapi-grpc/issues/new) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
10 changes: 5 additions & 5 deletions packages/dapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ DAPI targets the latest LTS release of Node.js. Currently, this is Node v10.13.
DAPI requires the latest version of [dashcore](https://github.com/dashevo/dash-evo-branches/tree/evo) with Evolution features (special branch repo).

1. **Install core.** You can use the docker image (`dashcore:evo`) or clone code from [the repository](https://github.com/dashevo/dash-evo-branches/tree/evo), switch to the `evo` branch, and build it by yourself. Note: you need to build image with ZMQ and wallet support. You can follow the build instructions located [here](https://github.com/dashevo/dash-evo-branches/tree/evo/doc)
2. **Configure core.** DAPI needs dashcore's ZMQ interface to be exposed and all indexes enabled. You can find the example config for dashcore [here](/doc/dependencies_configs/dash.conf). To start dashcore process with this config, copy it somewhere to your system, and then run `./src/dashd -conf=/path/to/your/config`.
2. **Configure core.** DAPI needs dashcore's ZMQ interface to be exposed and all indexes enabled. You can find the example config for dashcore [here](doc/dependencies_configs/dash.conf). To start dashcore process with this config, copy it somewhere to your system, and then run `./src/dashd -conf=/path/to/your/config`.

## Usage

Expand All @@ -40,7 +40,7 @@ npm start

## Configuration

DAPI is configured via environment variables either explicitly passed or present in the `.env` dotfile. For example, to change the DAPI port, execute DAPI with the following arguments: `RPC_SERVER_PORT=3010 npm start`. Consult the sample environment [file](/.env.example). You can see the full list of available options [here](/doc/CONFIGURATION.md).
DAPI is configured via environment variables either explicitly passed or present in the `.env` dotfile. For example, to change the DAPI port, execute DAPI with the following arguments: `RPC_SERVER_PORT=3010 npm start`. Consult the sample environment [file](.env.example). You can see the full list of available options [here](doc/CONFIGURATION.md).

## Making basic requests

Expand All @@ -56,13 +56,13 @@ Note that you always need to specify an id, otherwise the server will respond wi

## API Reference

A list of all available RPC commands, along with their various arguments and expected responses can be found [here](/doc/REFERENCE.md)
A list of all available RPC commands, along with their various arguments and expected responses can be found [here](doc/REFERENCE.md)

Implementation of these commands can be viewed [here](/lib/rpcServer/commands).
Implementation of these commands can be viewed [here](lib/rpcServer/commands).

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/dapi/issues/new) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
2 changes: 1 addition & 1 deletion packages/dashmate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ $ docker-compose --env-file=.env.testnet up -d

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/dashmate/issues/new) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
6 changes: 3 additions & 3 deletions packages/dashpay-contract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ npm test

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/dashpay-contract/issues/new/choose) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## Licence
## License

[MIT](LICENCE) © Dash Core Group, Inc.
[MIT](LICENSE) © Dash Core Group, Inc.
2 changes: 1 addition & 1 deletion packages/dpns-contract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ npm install @dashevo/dpns-contract

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/dpns-contract/issues/new) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
2 changes: 1 addition & 1 deletion packages/feature-flags-contract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ npm install @dashevo/dpns-contract

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/feature-flags-contract/issues/new) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
6 changes: 3 additions & 3 deletions packages/js-dapi-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Platform via the decentralized API ([DAPI](https://github.com/dashevo/dapi))
hosted on Dash masternodes.

- `DAPI-Client` provides automatic server (masternode) discovery using either a default seed node or a user-supplied one
- `DAPI-Client` maps to DAPI's [RPC](https://github.com/dashevo/dapi/tree/master/lib/rpcServer/commands) and [gRPC](https://github.com/dashevo/dapi/tree/master/lib/grpcServer/handlers) endpoints
- `DAPI-Client` maps to DAPI's [RPC](https://github.com/dashevo/platform/tree/master/packages/dapi/lib/rpcServer/commands) and [gRPC](https://github.com/dashevo/platform/tree/master/packages/dapi/lib/grpcServer/handlers) endpoints

## Table of Contents
- [Install](#install)
Expand Down Expand Up @@ -101,12 +101,12 @@ client.core.getBestBlockHash(options).then((r) => {

## Documentation

More extensive documentation available at https://dashevo.github.io/js-dapi-client/.
More extensive documentation available at https://dashevo.github.io/platform/DAPI-Client/.


## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/js-dapi-client/issues/new/choose) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
10 changes: 5 additions & 5 deletions packages/js-dash-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,20 @@ client.getWalletAccount().then(async (account) => {
## Dependencies

The Dash SDK works using multiple dependencies that might interest you:
- [Wallet-Lib](https://github.com/dashevo/wallet-lib) - Wallet management for handling, signing and broadcasting transactions (BIP-44 HD).
- [Wallet-Lib](https://github.com/dashevo/platform/tree/master/packages/wallet-lib) - Wallet management for handling, signing and broadcasting transactions (BIP-44 HD).
- [Dashcore-Lib](https://github.com/dashevo/dashcore-lib) - Provides the main L1 blockchain primitives (Block, Transaction,...).
- [DAPI-Client](https://github.com/dashevo/dapi-client) - Client library for accessing DAPI endpoints.
- [DPP](https://github.com/dashevo/js-dpp) - Implementation (JS) of Dash Platform Protocol.
- [DAPI-Client](https://github.com/dashevo/platform/tree/master/packages/js-dapi-client) - Client library for accessing DAPI endpoints.
- [DPP](https://github.com/dashevo/platform/tree/master/packages/js-dpp) - Implementation (JS) of Dash Platform Protocol.

Some features might be more extensive in those libs, as Dash SDK only wraps around them to provide a single interface that is easy to use (and thus has less features).

## Documentation

More extensive documentation available at https://dashevo.github.io/js-dash-sdk/.
More extensive documentation available at https://dashevo.github.io/platform/SDK/.

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/js-dash-sdk/issues/new/choose) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ const signed = account.sign(message, pk);
const verify = message.verify(pk.toAddress().toString(), signed.toString());
```

See [code snippet](https://github.com/dashevo/DashJS/blob/master/examples/node/sign-and-verify-messages.js).
See [code snippet](https://github.com/dashevo/platform/blob/master/packages/js-dash-sdk/examples/node/sign-and-verify-messages.js).
2 changes: 1 addition & 1 deletion packages/js-dash-sdk/docs/wallet/about-wallet-lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ When Dash.Client is initiated with a `mnemonic` property, a wallet instance is a

In order to ensure the sync-up with the network has happened, you will need to wait for the method `client.isReady()` to resolve.

You will find else where the [complete documentation of Wallet-lib](https://github.com/dashevo/wallet-lib), as we only cover the most basic pieces in this documentation.
You will find else where the [complete documentation of Wallet-lib](https://github.com/dashevo/platform/tree/master/packages/wallet-lib), as we only cover the most basic pieces in this documentation.
4 changes: 2 additions & 2 deletions packages/js-dpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ npm install @dashevo/dpp

## Usage

See [documentation](https://dashevo.github.io/js-dpp/#/usage/DashPlatformProtocol)
See [documentation](https://dashevo.github.io/platform/Dash-Platform-Protocol/usage/DashPlatformProtocol/)

## Maintainer

[@shumkov](https://github.com/shumkov)

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/js-dpp/issues/new) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
2 changes: 1 addition & 1 deletion packages/js-drive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ See all available settings in [.env.example](.env.example).

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/js-drive-abci/issues/new/choose) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
4 changes: 2 additions & 2 deletions packages/platform-test-suite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The test suite for end-to-end and functional testing the Dash Platform by runnin

## Pre-requisites

You may run test-suite against any platform compatible network, or even [local node](https://github.com/dashevo/dashmate).
You may run test-suite against any platform compatible network, or even [local node](https://github.com/dashevo/platform/tree/master/packages/dashmate).
To run locally make sure you have [Node.js](https://nodejs.org/) installed.
To run using [Docker](https://www.docker.com/), make sure you have it installed.

Expand Down Expand Up @@ -97,7 +97,7 @@ Usage: test <seed> [options]

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/platform-test-suite/issues/new/choose) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
8 changes: 4 additions & 4 deletions packages/wallet-lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Account will by default be on expected BIP44 path (...0/0).

Insight-Client has been removed from MVP and is not working since Wallet-lib v3.0.

- [DAPI-Client](https://github.com/dashevo/dapi-client)
- [DAPI-Client](https://github.com/dashevo/platform/tree/master/packages/js-dapi-client)

### Adapters :

Expand All @@ -80,9 +80,9 @@ Insight-Client has been removed from MVP and is not working since Wallet-lib v3.

## Documentation

You can see some [examples here](/docs/usage/examples.md).
You can see some [examples here](docs/usage/examples.md).

More extensive documentation is available at https://dashevo.github.io/wallet-lib along with additional [examples & snippets](https://dashevo.github.io/wallet-lib/#/usage/examples).
More extensive documentation is available at https://dashevo.github.io/platform/Wallet-library/ along with additional [examples & snippets](https://dashevo.github.io/platform/Wallet-library/usage/examples/).

## Maintainers

Expand All @@ -91,7 +91,7 @@ We want to thank all members of the community that have submitted suggestions, i

## Contributing

Feel free to dive in! [Open an issue](https://github.com/dashevo/wallet-lib/issues/new/choose) or submit PRs.
Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.

## License

Expand Down
2 changes: 1 addition & 1 deletion packages/wallet-lib/docs/account/createTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Parameters:
| **txOpts.change** | string | no | Defaults: `account.getUnusedAddress(internal)`. When set, will use that address as a change address on remaining fund |


Returns : [Transaction](https://dashevo.github.io/DashJS/#/usage/dashcorelib-primitives?id=transaction)
Returns : [Transaction](https://dashevo.github.io/platform/SDK/usage/dashcorelib-primitives/#transaction)
Notes: This transaction will be need to be signed [`account.sign(transaction)`](../account/sign.md) and then, if wanted, broadcasted to the network for execution `account.broadcastTransaction()`.

Example :
Expand Down
2 changes: 1 addition & 1 deletion packages/wallet-lib/docs/plugins/writing-a-new-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ const wallet = new Wallet({
Due to the risk from running a plugin that have access to your keychain, these are, by default, not accessible.
One would need to initialize a Wallet with the option `allowSensitiveOperations` set to `true`.

You can see the list of thoses [sensitive functions and properties](https://github.com/dashevo/wallet-lib/blob/master/src/CONSTANTS.js#L67), anything under `UNSAFE_*` will require this option to be set to true in order to be use from within a plugin.
You can see the list of thoses [sensitive functions and properties](https://github.com/dashevo/platform/blob/master/packages/wallet-lib/src/CONSTANTS.js#L67), anything under `UNSAFE_*` will require this option to be set to true in order to be use from within a plugin.

## Injection order

Expand Down
2 changes: 1 addition & 1 deletion packages/wallet-lib/docs/usage/coinSelection.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const selectedUTXO = coinSelection(utxosList, outputsList);

By creating a simple function algorithm that you pass to the createTransaction parameter, you can provide your own algorithm that will be used to the coinSelection.

To implements your own algorithm, you might want to take example on the [already existing one](https://github.com/dashevo/wallet-lib/tree/master/src/utils/coinSelections/strategies).
To implements your own algorithm, you might want to take example on the [already existing one](https://github.com/dashevo/platform/tree/master/packages/wallet-lib/src/utils/coinSelections/strategies).
You will need your algorithm to handle multiples parameter :

- `utxosList` - An array consisting of multiple [unspent output](https://github.com/dashevo/dashcore-lib/blob/master/docs/unspentoutput.md).
Expand Down
2 changes: 1 addition & 1 deletion packages/wallet-lib/docs/usage/dapi.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## About DAPI

DAPI (Decentralized API) is a distributed and decentralized endpoints provided by the Masternode Network.
You can learn more about DAPI on the [DAPI-Client documentation](https://dashevo.github.io/dapi-client/#/).
You can learn more about DAPI on the [DAPI-Client documentation](https://dashevo.github.io/platform/DAPI-Client/).

## Get the DAPI-Client instance

Expand Down
8 changes: 4 additions & 4 deletions packages/wallet-lib/docs/usage/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Such uses case would be to generate a bunch of addresses that you could manually
You also have ways to import a known address, transaction, account or any type of data that you could wish to have via the network,
thus allowing you to use the wallet-library without connectivity.

See here [sample code](https://github.com/dashevo/wallet-lib/blob/master/examples/offline-wallet.js)
See here [sample code](https://github.com/dashevo/platform/blob/master/packages/wallet-lib/examples/offline-wallet.js)

## Offline message signing :

See here [sample code](https://github.com/dashevo/wallet-lib/blob/master/examples/offline-wallet-signing-message.js)
See here [sample code](https://github.com/dashevo/platform/blob/master/packages/wallet-lib/examples/offline-wallet-signing-message.js)

## Client usage

- From Mnemonic: [sample code](https://github.com/dashevo/wallet-lib/blob/master/examples/client-usage.js)
- From PrivateKey: [sample code](https://github.com/dashevo/wallet-lib/blob/master/examples/client-usage-single-privateKey.js)
- From Mnemonic: [sample code](https://github.com/dashevo/platform/blob/master/packages/wallet-lib/examples/client-usage.js)
- From PrivateKey: [sample code](https://github.com/dashevo/platform/blob/master/packages/wallet-lib/examples/client-usage-single-privateKey.js)