php-client/src/API/Tokens.php at 57e9bc612671ebb8e94c7dd939f200825661136a · ArkEcosystem/php-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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);
    }
}