dash-platform-sdk 1.6.0-dev.1 → 1.6.0-dev.3
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 +33 -15
- package/bundle.min.js +1 -1
- package/index.d.ts +3 -1
- package/index.js +2 -1
- package/package.json +2 -2
- package/proto/generated/platform.d.ts +128 -2
- package/proto/generated/platform.js +266 -8
- package/src/DashPlatformSDK.d.ts +19 -1
- package/src/DashPlatformSDK.js +28 -10
- package/src/QueryExecutor.d.ts +122 -0
- package/src/QueryExecutor.js +205 -0
- package/src/constants.d.ts +6 -0
- package/src/constants.js +6 -0
- package/src/contestedResources/getContestedResourceVoteState.d.ts +2 -1
- package/src/contestedResources/getContestedResourceVoteState.js +69 -49
- package/src/contestedResources/index.d.ts +4 -1
- package/src/contestedResources/index.js +5 -2
- package/src/dataContracts/getDataContractByIdentifier.d.ts +2 -1
- package/src/dataContracts/getDataContractByIdentifier.js +15 -27
- package/src/dataContracts/index.d.ts +4 -1
- package/src/dataContracts/index.js +5 -2
- package/src/documents/create.d.ts +1 -1
- package/src/documents/create.js +2 -2
- package/src/documents/getActionFeeAgreement.d.ts +2 -1
- package/src/documents/getActionFeeAgreement.js +3 -3
- package/src/documents/index.d.ts +14 -9
- package/src/documents/index.js +19 -15
- package/src/documents/query.d.ts +2 -1
- package/src/documents/query.js +16 -8
- package/src/documents/queryAggregate.d.ts +8 -1
- package/src/documents/queryAggregate.js +49 -15
- package/src/documents/queryJoined.d.ts +3 -2
- package/src/documents/queryJoined.js +54 -13
- package/src/documents/queryRanked.d.ts +3 -2
- package/src/documents/queryRanked.js +49 -15
- package/src/documents/v1.d.ts +25 -8
- package/src/documents/v1.js +50 -14
- package/src/grpcConnectionPool.d.ts +24 -4
- package/src/grpcConnectionPool.js +153 -37
- package/src/identities/getIdentityBalance.d.ts +2 -1
- package/src/identities/getIdentityBalance.js +13 -27
- package/src/identities/getIdentityByIdentifier.d.ts +2 -1
- package/src/identities/getIdentityByIdentifier.js +14 -28
- package/src/identities/getIdentityByNonUniquePublicKeyHash.d.ts +2 -1
- package/src/identities/getIdentityByNonUniquePublicKeyHash.js +49 -28
- package/src/identities/getIdentityByPublicKeyHash.d.ts +2 -1
- package/src/identities/getIdentityByPublicKeyHash.js +14 -28
- package/src/identities/getIdentityContractNonce.d.ts +2 -1
- package/src/identities/getIdentityContractNonce.js +10 -27
- package/src/identities/getIdentityNonce.d.ts +2 -1
- package/src/identities/getIdentityNonce.js +10 -27
- package/src/identities/getIdentityPublicKeys.d.ts +2 -1
- package/src/identities/getIdentityPublicKeys.js +16 -29
- package/src/identities/index.d.ts +4 -1
- package/src/identities/index.js +11 -8
- package/src/names/index.d.ts +8 -2
- package/src/names/index.js +12 -6
- package/src/names/registerName.d.ts +2 -1
- package/src/names/registerName.js +56 -36
- package/src/names/searchByIdentity.d.ts +2 -1
- package/src/names/searchByIdentity.js +2 -2
- package/src/names/searchByName.d.ts +2 -1
- package/src/names/searchByName.js +2 -2
- package/src/node/epochInfos.d.ts +2 -1
- package/src/node/epochInfos.js +27 -31
- package/src/node/finalizedEpochInfos.d.ts +4 -3
- package/src/node/finalizedEpochInfos.js +45 -39
- package/src/node/index.d.ts +4 -1
- package/src/node/index.js +7 -4
- package/src/node/totalCredits.d.ts +2 -1
- package/src/node/totalCredits.js +10 -25
- package/src/platformAddresses/getAddressInfo.d.ts +2 -1
- package/src/platformAddresses/getAddressInfo.js +17 -31
- package/src/platformAddresses/getAddressesBranchState.d.ts +2 -1
- package/src/platformAddresses/getAddressesBranchState.js +22 -8
- package/src/platformAddresses/getAddressesInfos.d.ts +2 -1
- package/src/platformAddresses/getAddressesInfos.js +18 -29
- package/src/platformAddresses/getAddressesTrunkState.d.ts +2 -1
- package/src/platformAddresses/getAddressesTrunkState.js +25 -23
- package/src/platformAddresses/getRecentAddressBalanceChanges.d.ts +2 -1
- package/src/platformAddresses/getRecentAddressBalanceChanges.js +26 -26
- package/src/platformAddresses/getRecentCompactedAddressBalanceChanges.d.ts +2 -1
- package/src/platformAddresses/getRecentCompactedAddressBalanceChanges.js +30 -26
- package/src/platformAddresses/index.d.ts +4 -1
- package/src/platformAddresses/index.js +10 -7
- package/src/quorumKeyProvider.d.ts +23 -0
- package/src/quorumKeyProvider.js +28 -0
- package/src/shielded/getMostRecentShieldedAnchor.d.ts +2 -1
- package/src/shielded/getMostRecentShieldedAnchor.js +8 -25
- package/src/shielded/getShieldedAnchors.d.ts +2 -1
- package/src/shielded/getShieldedAnchors.js +8 -25
- package/src/shielded/getShieldedEncryptedNotes.d.ts +2 -1
- package/src/shielded/getShieldedEncryptedNotes.js +16 -30
- package/src/shielded/getShieldedNotesCount.d.ts +2 -1
- package/src/shielded/getShieldedNotesCount.js +8 -25
- package/src/shielded/getShieldedNullifiers.d.ts +2 -1
- package/src/shielded/getShieldedNullifiers.js +14 -28
- package/src/shielded/getShieldedPoolState.d.ts +2 -1
- package/src/shielded/getShieldedPoolState.js +8 -25
- package/src/shielded/index.d.ts +4 -1
- package/src/shielded/index.js +10 -7
- package/src/stateTransitions/index.d.ts +4 -1
- package/src/stateTransitions/index.js +5 -2
- package/src/stateTransitions/waitForStateTransitionResult.d.ts +2 -1
- package/src/stateTransitions/waitForStateTransitionResult.js +42 -44
- package/src/tokens/getIdentitiesTokenBalances.d.ts +2 -1
- package/src/tokens/getIdentitiesTokenBalances.js +17 -28
- package/src/tokens/getIdentityTokensBalances.d.ts +2 -1
- package/src/tokens/getIdentityTokensBalances.js +17 -28
- package/src/tokens/getTokenContractInfo.d.ts +2 -1
- package/src/tokens/getTokenContractInfo.js +16 -30
- package/src/tokens/getTokenDirectPurchasePrices.d.ts +2 -1
- package/src/tokens/getTokenDirectPurchasePrices.js +26 -28
- package/src/tokens/getTokenTotalSupply.d.ts +2 -1
- package/src/tokens/getTokenTotalSupply.js +16 -28
- package/src/tokens/index.d.ts +4 -1
- package/src/tokens/index.js +11 -8
- package/src/utils/ProofError.d.ts +9 -0
- package/src/utils/ProofError.js +10 -0
- package/src/utils/verifyTenderdashProof.js +2 -1
- package/test/unit/Document.spec.js +9 -9
- package/test/unit/DocumentActionFees.spec.js +2 -2
- package/test/unit/Names.spec.js +30 -0
- package/test/unit/Node.spec.js +11 -8
- package/test/unit/SDK.spec.js +42 -0
- package/src/utils/getQuorumPublicKey.d.ts +0 -1
- package/src/utils/getQuorumPublicKey.js +0 -19
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# dash-platform-sdk v1.6.0-dev.
|
|
1
|
+
# dash-platform-sdk v1.6.0-dev.3
|
|
2
2
|
[](https://github.com/pshenmic/dash-platform-sdk/blob/master/LICENSE)  
|
|
3
3
|
|
|
4
4
|
|
|
@@ -85,12 +85,30 @@ Or load it straight from the web page:
|
|
|
85
85
|
|
|
86
86
|
Now you're ready to make queries in the network and push your data!
|
|
87
87
|
|
|
88
|
-
See [docs/Quickstart.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
88
|
+
See [docs/Quickstart.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/Quickstart.md) for basic usage examples (register data contract, push/update/delete documents).
|
|
89
89
|
|
|
90
90
|
## API Documentation
|
|
91
91
|
|
|
92
92
|
The full autogenerated typedoc reference is available at https://pshenmic.github.io/dash-platform-sdk/index.html
|
|
93
93
|
|
|
94
|
+
## Quorum Key Provider
|
|
95
|
+
|
|
96
|
+
Proof signatures are verified with quorum public keys. By default, they are fetched from Platform Explorer.
|
|
97
|
+
To use your own source (SPV client, local Dash Core node), implement `QuorumKeyProvider`:
|
|
98
|
+
|
|
99
|
+
```javascript
|
|
100
|
+
const quorumKeyProvider = {
|
|
101
|
+
// quorumHash is hex of proof.quorumHash bytes, same as in Dash Core RPC (`quorum info`)
|
|
102
|
+
// must return BLS public key of the quorum in hex
|
|
103
|
+
getQuorumPublicKey: async (quorumType, quorumHash) => await myWallet.getQuorumPublicKey(quorumType, quorumHash)
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
const sdk = new DashPlatformSDK({ network: 'testnet', quorumKeyProvider })
|
|
107
|
+
|
|
108
|
+
// or switch it later, pass nothing to switch back to Platform Explorer
|
|
109
|
+
sdk.setQuorumKeyProvider(quorumKeyProvider)
|
|
110
|
+
```
|
|
111
|
+
|
|
94
112
|
## Error Handling
|
|
95
113
|
|
|
96
114
|
The SDK currently relies on a happy path and doesn't include comprehensive error handling. This will be improved in future versions. For now, wrap SDK calls in try-catch blocks:
|
|
@@ -108,18 +126,18 @@ The folder `docs/examples` in this repo contains useful example code snippets.
|
|
|
108
126
|
|
|
109
127
|
| | |
|
|
110
128
|
|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
111
|
-
| [Quickstart.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
112
|
-
| [DataContracts.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
113
|
-
| [Documents.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
114
|
-
| [Tokens.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
115
|
-
| [Identities.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
116
|
-
| [Voting.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
117
|
-
| [StateTransitions.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
118
|
-
| [Names.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
119
|
-
| [Node.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
120
|
-
| [Utils.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
121
|
-
| [KeyPair.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
122
|
-
| [ContestedResources.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
123
|
-
| [PlatformAddresses.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.
|
|
129
|
+
| [Quickstart.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/Quickstart.md) | Install, Import, Register Data Contract, Push / Update / Delete Document |
|
|
130
|
+
| [DataContracts.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/DataContracts.md) | Get Data Contract By Identifier, Create Data Contract, Create State Transition |
|
|
131
|
+
| [Documents.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/Documents.md) | Create Document, Query Documents, Create State Transition (Create / Replace/ Delete / Transfer / Purchase / UpdatePrice) |
|
|
132
|
+
| [Tokens.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/Tokens.md) | Get Balance, Get Contract Info, Get Supply, Get prices, Create State Transition |
|
|
133
|
+
| [Identities.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/Identities.md) | Get Identity, Get Identity Balance, Get Identity Nonce, Get Identity Public Keys, Create Identity (from AssetLockProof), Top Up Identity (from AssetLockProof), Update Identity, Credit Transfer, Credit Withdrawal |
|
|
134
|
+
| [Voting.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/Voting.md) | Casting Masternode Vote against Contested Resource |
|
|
135
|
+
| [StateTransitions.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/StateTransitions.md) | Broadcast Transaction, Wait for State Transition Result (wait for finalization) |
|
|
136
|
+
| [Names.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/Names.md) | Search By Dash Username (DPNS Name), Search by Identity's Identifier, Register Dash Username (DPNS Name), Test Name Contested (validation), Validate Name (validation) |
|
|
137
|
+
| [Node.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/Node.md) | Node Status, Total Credits (locked in Platform), Epochs Info |
|
|
138
|
+
| [Utils.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/Utils.md) | useful utility functions, like hex/base58 encoding, createVoterIdentifier, createMasternodeIdentifier, validateIdentifier |
|
|
139
|
+
| [KeyPair.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/KeyPair.md) | Mnemonic to Seed, Seed to HD Key, Derive Identity Private Key, Derive Child, Derive Path, P2PKH Address conversion |
|
|
140
|
+
| [ContestedResources.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/ContestedResources.md) | Contested Resource Vote State Info |
|
|
141
|
+
| [PlatformAddresses.md](https://github.com/pshenmic/dash-platform-sdk/blob/v1.6.0-dev.3/docs/examples/PlatformAddresses.md) | Get Address Info, Create State Transition, Convenience builders (Transfer To Address, Create / Top Up Identity From Addresses, Transfer Between Addresses, Fund From Asset Lock, Withdrawal To Core) |
|
|
124
142
|
|
|
125
143
|
|