feat: tokens endpoint

Author: alexbarnsley

src/API/Tokens.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ArkEcosystem\Client\API;
+
+class Tokens extends AbstractAPI
+{
+    /**
+     * Get all tokens.
+     *
+     * @param array $parameters
+     *
+     * @return array
+     */
+    public function all(array $parameters = []): ?array
+    {
+        return $this->requestGet('tokens', $parameters);
+    }
+
+    /**
+     * Get all tokens using whitelist filtering.
+     *
+     * This method sends a POST request with whitelist parameters.
+     *
+     * @param array $parameters
+     *
+     * @return array
+     */
+    public function allWithWhitelist(array $parameters = []): ?array
+    {
+        return $this->requestPost('tokens', $parameters);
+    }
+
+    /**
+     * Get a token by contract address.
+     *
+     * @param string $address
+     *
+     * @return array
+     */
+    public function get(string $address): ?array
+    {
+        return $this->requestGet("tokens/{$address}");
+    }
+
+    /**
+     * Get token holders for a given token.
+     *
+     * @param string $address
+     * @param array  $query
+     *
+     * @return array
+     */
+    public function holders(string $address, array $query = []): ?array
+    {
+        return $this->requestGet("tokens/{$address}/holders", $query);
+    }
+
+    /**
+     * Get token transfers for a given token.
+     *
+     * @param string $address
+     * @param array  $query
+     *
+     * @return array
+     */
+    public function transfersByToken(string $address, array $query = []): ?array
+    {
+        return $this->requestGet("tokens/{$address}/transfers", $query);
+    }
+
+    /**
+     * Get all token transfers.
+     *
+     * @param array $query
+     *
+     * @return array
+     */
+    public function transfers(array $query = []): ?array
+    {
+        return $this->requestGet('tokens/transfers', $query);
+    }
+
+    /**
+     * Get the token whitelist.
+     *
+     * @param array $query
+     *
+     * @return array
+     */
+    public function whitelist(array $query = []): ?array
+    {
+        return $this->requestGet('tokens/whitelist', $query);
+    }
+}

src/ArkClient.php

@@ -14,6 +14,7 @@
 use ArkEcosystem\Client\API\Peers;
 use ArkEcosystem\Client\API\Receipts;
 use ArkEcosystem\Client\API\Rounds;
+use ArkEcosystem\Client\API\Tokens;
 use ArkEcosystem\Client\API\Transactions;
 use ArkEcosystem\Client\API\Validators;
 use ArkEcosystem\Client\API\Votes;
@@ -79,6 +80,11 @@ public function rounds(): Rounds
         return new Rounds($this->connection);
     }
 
+    public function tokens(): Tokens
+    {
+        return new Tokens($this->connection);
+    }
+
     public function transactions(): Transactions
     {
         return new Transactions($this->connection);

tests/API/TokensTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ArkEcosystem\Tests\Client\API;
+
+use ArkEcosystem\Client\ArkClient;
+
+it('calls correct url for all', function () {
+    $this->assertResponse('GET', 'tokens', function (ArkClient $client) {
+        return $client->tokens()->all();
+    });
+});
+
+it('calls correct url for all with whitelist', function () {
+    $this->assertResponse('POST', 'tokens', function (ArkClient $client) {
+        return $client->tokens()->all([
+            'whitelist' => ['0x1234567890abcdef1234567890abcdef12345678'],
+        ]);
+    });
+});
+
+it('calls correct url for get', function () {
+    $this->assertResponse('GET', 'tokens/dummy', function (ArkClient $client) {
+        return $client->tokens()->get('dummy');
+    });
+});
+
+it('calls correct url for holders', function () {
+    $this->assertResponse('GET', 'tokens/dummy/holders', function (ArkClient $client) {
+        return $client->tokens()->holders('dummy');
+    });
+});
+
+it('calls correct url for transfers by token', function () {
+    $this->assertResponse('GET', 'tokens/dummy/transfers', function (ArkClient $client) {
+        return $client->tokens()->transfersByToken('dummy');
+    });
+});
+
+it('calls correct url for all transfers', function () {
+    $this->assertResponse('GET', 'tokens/transfers', function (ArkClient $client) {
+        return $client->tokens()->transfers();
+    });
+});
+
+it('calls correct url for whitelist', function () {
+    $this->assertResponse('GET', 'tokens/whitelist', function (ArkClient $client) {
+        return $client->tokens()->whitelist();
+    });
+});