Added new RPC endpoint (speculative_exec, query_balance, info_get_cha…

…inspec)

Signed-off-by: Roman Bylbas <romka.bulbas@gmail.com>

.github/workflows/ci.yml

@@ -47,4 +47,4 @@ jobs:
       - name: Run test suite
         run: composer run-script test
         env:
-          CASPER_PHP_SDK_TEST_NODE_URL: "136.243.187.84:7777"
+          CASPER_PHP_SDK_TEST_NODE_URL: "65.21.237.160:7777"

docs/API/RpcClientAPI.md

@@ -118,6 +118,23 @@ Returns purse's balance from the network
 | `$stateRootHash` | `string` | Hex-encoded hash of the state root | Yes |
 | `$balanceUref` | `CLURef` | Balance URef object | Yes |
 
+---
+## Query balance
+```php
+queryBalance(
+    string $purseIdentifierType, 
+    string $purseIdentifier, 
+    string $stateRootHash = null
+): \GMP
+```
+Returns a purse’s balance from global state at a given [Block](../Entity/Block.md) or state root hash.
+### Parameters
+| Name | Type     | Description                                                                                                           | Required |
+|---|----------|-----------------------------------------------------------------------------------------------------------------------|----------|
+| `$purseIdentifierType` | `string` | Purse identifier type. Available values: `purse_uref`, `main_purse_under_public_key`, `main_purse_under_account_hash` | Yes      |
+| `$purseIdentifier` | `string` | Purse identifier                                                                                                      | Yes      |
+| `$stateRootHash` | `string` | Hex-encoded hash of the state root                                                                                                        | No       |
+
 ---
 ## Get account balance URef by account hash
 ```php
@@ -238,3 +255,22 @@ Returns an [GlobalState](../Entity/GlobalState.md) object by the given state roo
 | `$stateRootHash` | `string` | Hex-encoded hash of the state root | Yes |
 | `$key` | `string` | `casper_types::Key` as formatted string | Yes |
 | `$path` | `array` | The path components starting from the key as base | No |
+
+---
+## Get chainspec info
+```php
+getChainspecInfo(): ChainspecRegistryBytes
+```
+Returns a [ChainspecRegistryBytes](../Entity/ChainspecRegistryBytes.md) object
+
+---
+## Speculative deploy
+```php
+speculativeDeploy(Deploy $signedDeploy, string $blockHash)
+```
+Puts a [Deploy](../Entity/Deploy.md) to a single node for speculative execution on that node only.
+### Parameters
+| Name | Type | Description | Required |
+|---|------|-------------|----|
+| `$signedDeploy` | `Deploy` | Signed [Deploy](../Entity/Deploy.md) object | Yes |
+| `$blockHash` | `string` | Hex-encoded hash of the block | Yes |

docs/Entity/BlockRange.md

@@ -0,0 +1,10 @@
+# BlockRange
+
+```php
+getLow(): int
+```
+
+---
+```php
+getHigh(): int
+```

docs/Entity/ChainspecRegistryBytes.md

@@ -0,0 +1,18 @@
+# ChainspecRegistryBytes
+
+```php
+getChainspecBytes(): string
+```
+Returns Chainspec.toml bytes
+
+---
+```php
+getGenesisAccountsBytes(): ?string
+```
+Returns Accounts.toml bytes or `null`
+
+---
+```php
+getGlobalStateBytes(): ?string
+```
+Returns GlobalState.toml bytes or `null`

docs/Entity/Status.md

@@ -1,5 +1,10 @@
 # Status
 
+```php
+getApiVersion(): string
+```
+Returns node's RPC API version
+
 ```php
 getChainspecName(): string
 ```
@@ -46,3 +51,27 @@ Returns [NextUpgrade](NextUpgrade.md) object or `null`
 getPeers(): array
 ```
 Returns a list of [Peer](Peer.md) objects that connected to the network
+
+---
+```php
+getUptime(): string
+```
+Returns time that passed since the node has started.
+
+---
+```php
+getReactorState(): string
+```
+Returns node's reactor state
+
+---
+```php
+getLastProgress(): \DateTime
+```
+Returns node's last progress
+
+---
+```php
+getLastProgress(): BlockRange
+```
+Returns [BlockRange](BlockRange.md) object

src/Entity/BlockRange.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Casper\Entity;
+
+class BlockRange
+{
+    private int $low;
+
+    private int $high;
+
+    public function __construct(int $low, int $high)
+    {
+        $this->low = $low;
+        $this->high = $high;
+    }
+
+    public function getLow(): int
+    {
+        return $this->low;
+    }
+
+    public function getHigh(): int
+    {
+        return $this->high;
+    }
+}

src/Entity/ChainspecRegistryBytes.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Casper\Entity;
+
+class ChainspecRegistryBytes
+{
+    private string $chainspecBytes;
+
+    private ?string $genesisAccountsBytes;
+
+    private ?string $globalStateBytes;
+
+    public function __construct(
+        string  $chainspecBytes,
+        ?string $genesisAccountsBytes,
+        ?string $globalStateBytes
+    )
+    {
+        $this->chainspecBytes = $chainspecBytes;
+        $this->genesisAccountsBytes = $genesisAccountsBytes;
+        $this->globalStateBytes = $globalStateBytes;
+    }
+
+    public function getChainspecBytes(): string
+    {
+        return $this->chainspecBytes;
+    }
+
+    public function getGenesisAccountsBytes(): ?string
+    {
+        return $this->genesisAccountsBytes;
+    }
+
+    public function getGlobalStateBytes(): ?string
+    {
+        return $this->globalStateBytes;
+    }
+}

src/Entity/DeployExecutionResult.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Casper\Entity;
+
+class DeployExecutionResult
+{
+    private string $blockHash;
+
+    private DeployExecutionResultData $data;
+
+    public function __construct(string $blockHash, DeployExecutionResultData $data)
+    {
+        $this->blockHash = $blockHash;
+        $this->data = $data;
+    }
+
+    public function getBlockHash(): string
+    {
+        return $this->blockHash;
+    }
+
+    public function getData(): DeployExecutionResultData
+    {
+        return $this->data;
+    }
+}

src/Entity/DeployExecutionResultData.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Casper\Entity;
+
+class DeployExecutionResultData
+{
+    private string $status;
+
+    private Effect $effect;
+
+    private array $transfers;
+
+    private \GMP $cost;
+
+    private ?string $errorMessage = null;
+
+    public function __construct(string $status, Effect $effect, array $transfers, \GMP $cost, ?string $errorMessage)
+    {
+        $this->status = $status;
+        $this->effect = $effect;
+        $this->transfers = $transfers;
+        $this->cost = $cost;
+        $this->errorMessage = $errorMessage;
+    }
+
+    public function getStatus(): string
+    {
+        return $this->status;
+    }
+
+    public function getEffect(): Effect
+    {
+        return $this->effect;
+    }
+
+    public function getTransfers(): array
+    {
+        return $this->transfers;
+    }
+
+    public function getCost(): \GMP
+    {
+        return $this->cost;
+    }
+
+    public function getErrorMessage(): ?string
+    {
+        return $this->errorMessage;
+    }
+}

src/Entity/Effect.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Casper\Entity;
+
+class Effect
+{
+    /**
+     * @var Operation[]
+     */
+    private array $operations;
+
+    /**
+     * @var Transform[]
+     */
+    private array $transforms;
+
+    public function __construct(array $operations, array $transforms)
+    {
+        $this->operations = $operations;
+        $this->transforms = $transforms;
+    }
+
+    public function getOperations(): array
+    {
+        return $this->operations;
+    }
+
+    public function getTransforms(): array
+    {
+        return $this->transforms;
+    }
+}

src/Entity/Operation.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Casper\Entity;
+
+class Operation
+{
+    private string $key;
+
+    private string $kind;
+
+    public function __construct(string $key, string $kind)
+    {
+        $this->key = $key;
+        $this->kind = $kind;
+    }
+
+    public function getKey(): string
+    {
+        return $this->key;
+    }
+
+    public function getKind(): string
+    {
+        return $this->kind;
+    }
+}