| @@ 24-118 (lines=95) @@ | ||
| 21 | * @autogenerated |
|
| 22 | * @codeCoverageIgnore |
|
| 23 | */ |
|
| 24 | final class Dht implements Api |
|
| 25 | { |
|
| 26 | /** |
|
| 27 | * Query the DHT for all of the multiaddresses associated with a Peer ID. |
|
| 28 | * |
|
| 29 | * @Endpoint(name="dht:findpeer") |
|
| 30 | * |
|
| 31 | * @param string $arg the ID of the peer to search for |
|
| 32 | * @param bool $verbose print extra information |
|
| 33 | * |
|
| 34 | * @return Command |
|
| 35 | */ |
|
| 36 | public function findpeer(string $arg, bool $verbose = false): Command |
|
| 37 | { |
|
| 38 | return new Command(__METHOD__, get_defined_vars()); |
|
| 39 | } |
|
| 40 | ||
| 41 | /** |
|
| 42 | * Find peers in the DHT that can provide a specific value, given a key. |
|
| 43 | * |
|
| 44 | * @Endpoint(name="dht:findprovs") |
|
| 45 | * |
|
| 46 | * @param string $arg the key to find providers for |
|
| 47 | * @param bool $verbose print extra information |
|
| 48 | * @param int $numProviders the number of providers to find |
|
| 49 | * |
|
| 50 | * @return Command |
|
| 51 | */ |
|
| 52 | public function findprovs(string $arg, bool $verbose = false, int $numProviders = 20): Command |
|
| 53 | { |
|
| 54 | return new Command(__METHOD__, get_defined_vars()); |
|
| 55 | } |
|
| 56 | ||
| 57 | /** |
|
| 58 | * Given a key, query the DHT for its best value. |
|
| 59 | * |
|
| 60 | * @Endpoint(name="dht:get") |
|
| 61 | * |
|
| 62 | * @param string $arg the key to find a value for |
|
| 63 | * @param bool $verbose print extra information |
|
| 64 | * |
|
| 65 | * @return Command |
|
| 66 | */ |
|
| 67 | public function get(string $arg, bool $verbose = false): Command |
|
| 68 | { |
|
| 69 | return new Command(__METHOD__, get_defined_vars()); |
|
| 70 | } |
|
| 71 | ||
| 72 | /** |
|
| 73 | * Announce to the network that you are providing given values. |
|
| 74 | * |
|
| 75 | * @Endpoint(name="dht:provide") |
|
| 76 | * |
|
| 77 | * @param string $arg the key[s] to send provide records for |
|
| 78 | * @param bool $verbose print extra information |
|
| 79 | * @param bool $recursive recursively provide entire graph |
|
| 80 | * |
|
| 81 | * @return Command |
|
| 82 | */ |
|
| 83 | public function provide(string $arg, bool $verbose = false, bool $recursive = false): Command |
|
| 84 | { |
|
| 85 | return new Command(__METHOD__, get_defined_vars()); |
|
| 86 | } |
|
| 87 | ||
| 88 | /** |
|
| 89 | * Write a key/value pair to the DHT. |
|
| 90 | * |
|
| 91 | * @Endpoint(name="dht:put") |
|
| 92 | * |
|
| 93 | * @param string $arg the key to store the value at |
|
| 94 | * @param string $arg1 the value to store |
|
| 95 | * @param bool $verbose print extra information |
|
| 96 | * |
|
| 97 | * @return Command |
|
| 98 | */ |
|
| 99 | public function put(string $arg, string $arg1, bool $verbose = false): Command |
|
| 100 | { |
|
| 101 | return new Command(__METHOD__, get_defined_vars()); |
|
| 102 | } |
|
| 103 | ||
| 104 | /** |
|
| 105 | * Find the closest Peer IDs to a given Peer ID by querying the DHT. |
|
| 106 | * |
|
| 107 | * @Endpoint(name="dht:query") |
|
| 108 | * |
|
| 109 | * @param string $arg the peerID to run the query against |
|
| 110 | * @param bool $verbose print extra information |
|
| 111 | * |
|
| 112 | * @return Command |
|
| 113 | */ |
|
| 114 | public function query(string $arg, bool $verbose = false): Command |
|
| 115 | { |
|
| 116 | return new Command(__METHOD__, get_defined_vars()); |
|
| 117 | } |
|
| 118 | } |
|
| 119 | ||
| @@ 24-99 (lines=76) @@ | ||
| 21 | * @autogenerated |
|
| 22 | * @codeCoverageIgnore |
|
| 23 | */ |
|
| 24 | final class Name implements Api |
|
| 25 | { |
|
| 26 | /** |
|
| 27 | * Publish IPNS names. |
|
| 28 | * |
|
| 29 | * @Endpoint(name="name:publish") |
|
| 30 | * |
|
| 31 | * @param string $arg ipfs path of the object to be published |
|
| 32 | * @param bool $resolve resolve given path before publishing |
|
| 33 | * @param string $lifetime time duration that the record will be valid for |
|
| 34 | * @param string $ttl time duration this record should be cached for (caution: experimental) |
|
| 35 | * @param string $key name of the key to be used or a valid PeerID, as listed by ‘ipfs key list -l’ |
|
| 36 | * |
|
| 37 | * @return Command |
|
| 38 | */ |
|
| 39 | public function publish(string $arg, bool $resolve = true, string $lifetime = '24h', string $ttl = null, string $key = 'self'): Command |
|
| 40 | { |
|
| 41 | return new Command(__METHOD__, get_defined_vars()); |
|
| 42 | } |
|
| 43 | ||
| 44 | /** |
|
| 45 | * Cancel a name subscription. |
|
| 46 | * |
|
| 47 | * @Endpoint(name="name:pubsub:cancel") |
|
| 48 | * |
|
| 49 | * @param string $arg name to cancel the subscription for |
|
| 50 | * |
|
| 51 | * @return Command |
|
| 52 | */ |
|
| 53 | public function pubsubCancel(string $arg): Command |
|
| 54 | { |
|
| 55 | return new Command(__METHOD__, get_defined_vars()); |
|
| 56 | } |
|
| 57 | ||
| 58 | /** |
|
| 59 | * Query the state of IPNS pubsub. |
|
| 60 | * |
|
| 61 | * @Endpoint(name="name:pubsub:state") |
|
| 62 | * |
|
| 63 | * @return Command |
|
| 64 | */ |
|
| 65 | public function pubsubState(): Command |
|
| 66 | { |
|
| 67 | return new Command(__METHOD__, get_defined_vars()); |
|
| 68 | } |
|
| 69 | ||
| 70 | /** |
|
| 71 | * Show current name subscriptions. |
|
| 72 | * |
|
| 73 | * @Endpoint(name="name:pubsub:subs") |
|
| 74 | * |
|
| 75 | * @return Command |
|
| 76 | */ |
|
| 77 | public function pubsubSubs(): Command |
|
| 78 | { |
|
| 79 | return new Command(__METHOD__, get_defined_vars()); |
|
| 80 | } |
|
| 81 | ||
| 82 | /** |
|
| 83 | * Resolve IPNS names. |
|
| 84 | * |
|
| 85 | * @Endpoint(name="name:resolve") |
|
| 86 | * |
|
| 87 | * @param string $arg the IPNS name to resolve |
|
| 88 | * @param bool $recursive resolve until the result is not an IPNS name |
|
| 89 | * @param bool $nocache do not use cached entries |
|
| 90 | * @param uint $dhtRecordCount number of records to request for DHT resolution |
|
| 91 | * @param string $dhtTimeout max time to collect values during DHT resolution eg “30s” |
|
| 92 | * |
|
| 93 | * @return Command |
|
| 94 | */ |
|
| 95 | public function resolve(string $arg = null, bool $recursive = false, bool $nocache = false, uint $dhtRecordCount = null, string $dhtTimeout = null): Command |
|
| 96 | { |
|
| 97 | return new Command(__METHOD__, get_defined_vars()); |
|
| 98 | } |
|
| 99 | } |
|
| 100 | ||
| @@ 24-114 (lines=91) @@ | ||
| 21 | * @autogenerated |
|
| 22 | * @codeCoverageIgnore |
|
| 23 | */ |
|
| 24 | final class P2p implements Api |
|
| 25 | { |
|
| 26 | /** |
|
| 27 | * Close active p2p listener. |
|
| 28 | * |
|
| 29 | * @Endpoint(name="p2p:listener:close") |
|
| 30 | * |
|
| 31 | * @param string $arg P2P listener protocol Required: no |
|
| 32 | * @param bool $all close all listeners |
|
| 33 | * |
|
| 34 | * @return Command |
|
| 35 | */ |
|
| 36 | public function listenerClose(string $arg = null, bool $all = false): Command |
|
| 37 | { |
|
| 38 | return new Command(__METHOD__, get_defined_vars()); |
|
| 39 | } |
|
| 40 | ||
| 41 | /** |
|
| 42 | * List active p2p listeners. |
|
| 43 | * |
|
| 44 | * @Endpoint(name="p2p:listener:ls") |
|
| 45 | * |
|
| 46 | * @param bool $headers print table headers (HandlerID, Protocol, Local, Remote) |
|
| 47 | * |
|
| 48 | * @return Command |
|
| 49 | */ |
|
| 50 | public function listenerLs(bool $headers = false): Command |
|
| 51 | { |
|
| 52 | return new Command(__METHOD__, get_defined_vars()); |
|
| 53 | } |
|
| 54 | ||
| 55 | /** |
|
| 56 | * Forward p2p connections to a network multiaddr. |
|
| 57 | * |
|
| 58 | * @Endpoint(name="p2p:listener:open") |
|
| 59 | * |
|
| 60 | * @param string $arg protocol identifier |
|
| 61 | * @param string $arg1 request handling application address |
|
| 62 | * |
|
| 63 | * @return Command |
|
| 64 | */ |
|
| 65 | public function listenerOpen(string $arg, string $arg1): Command |
|
| 66 | { |
|
| 67 | return new Command(__METHOD__, get_defined_vars()); |
|
| 68 | } |
|
| 69 | ||
| 70 | /** |
|
| 71 | * Close active p2p stream. |
|
| 72 | * |
|
| 73 | * @Endpoint(name="p2p:stream:close") |
|
| 74 | * |
|
| 75 | * @param string $arg stream HandlerID Required: no |
|
| 76 | * @param bool $all close all streams |
|
| 77 | * |
|
| 78 | * @return Command |
|
| 79 | */ |
|
| 80 | public function streamClose(string $arg = null, bool $all = false): Command |
|
| 81 | { |
|
| 82 | return new Command(__METHOD__, get_defined_vars()); |
|
| 83 | } |
|
| 84 | ||
| 85 | /** |
|
| 86 | * Dial to a p2p listener. |
|
| 87 | * |
|
| 88 | * @Endpoint(name="p2p:stream:dial") |
|
| 89 | * |
|
| 90 | * @param string $arg remote peer to connect to Required: |
|
| 91 | * @param string $arg1 protocol identifier |
|
| 92 | * @param string $arg2 address to listen for connection/s (default: /ip4/127 |
|
| 93 | * |
|
| 94 | * @return Command |
|
| 95 | */ |
|
| 96 | public function streamDial(string $arg, string $arg1, string $arg2 = null): Command |
|
| 97 | { |
|
| 98 | return new Command(__METHOD__, get_defined_vars()); |
|
| 99 | } |
|
| 100 | ||
| 101 | /** |
|
| 102 | * List active p2p streams. |
|
| 103 | * |
|
| 104 | * @Endpoint(name="p2p:stream:ls") |
|
| 105 | * |
|
| 106 | * @param bool $headers print table headers (HagndlerID, Protocol, Local, Remote) |
|
| 107 | * |
|
| 108 | * @return Command |
|
| 109 | */ |
|
| 110 | public function streamLs(bool $headers = false): Command |
|
| 111 | { |
|
| 112 | return new Command(__METHOD__, get_defined_vars()); |
|
| 113 | } |
|
| 114 | } |
|
| 115 | ||
| @@ 24-103 (lines=80) @@ | ||
| 21 | * @autogenerated |
|
| 22 | * @codeCoverageIgnore |
|
| 23 | */ |
|
| 24 | final class Pin implements Api |
|
| 25 | { |
|
| 26 | /** |
|
| 27 | * Pin objects to local storage. |
|
| 28 | * |
|
| 29 | * @Endpoint(name="pin:add") |
|
| 30 | * |
|
| 31 | * @param string $arg path to object(s) to be pinned |
|
| 32 | * @param bool $recursive recursively pin the object linked to by the specified object(s) |
|
| 33 | * @param bool $progress show progress |
|
| 34 | * |
|
| 35 | * @return Command |
|
| 36 | */ |
|
| 37 | public function add(string $arg, bool $recursive = true, bool $progress = false): Command |
|
| 38 | { |
|
| 39 | return new Command(__METHOD__, get_defined_vars()); |
|
| 40 | } |
|
| 41 | ||
| 42 | /** |
|
| 43 | * List objects pinned to local storage. |
|
| 44 | * |
|
| 45 | * @Endpoint(name="pin:ls") |
|
| 46 | * |
|
| 47 | * @param string $arg path to object(s) to be listed |
|
| 48 | * @param string $type the type of pinned keys to list |
|
| 49 | * @param bool $quiet write just hashes of objects |
|
| 50 | * |
|
| 51 | * @return Command |
|
| 52 | */ |
|
| 53 | public function ls(string $arg = null, string $type = 'all', bool $quiet = false): Command |
|
| 54 | { |
|
| 55 | return new Command(__METHOD__, get_defined_vars()); |
|
| 56 | } |
|
| 57 | ||
| 58 | /** |
|
| 59 | * Remove pinned objects from local storage. |
|
| 60 | * |
|
| 61 | * @Endpoint(name="pin:rm") |
|
| 62 | * |
|
| 63 | * @param string $arg path to object(s) to be unpinned |
|
| 64 | * @param bool $recursive recursively unpin the object linked to by the specified object(s) |
|
| 65 | * |
|
| 66 | * @return Command |
|
| 67 | */ |
|
| 68 | public function rm(string $arg, bool $recursive = true): Command |
|
| 69 | { |
|
| 70 | return new Command(__METHOD__, get_defined_vars()); |
|
| 71 | } |
|
| 72 | ||
| 73 | /** |
|
| 74 | * Update a recursive pin. |
|
| 75 | * |
|
| 76 | * @Endpoint(name="pin:update") |
|
| 77 | * |
|
| 78 | * @param string $arg path to old object |
|
| 79 | * @param string $arg1 path to new object to be pinned |
|
| 80 | * @param bool $unpin remove the old pin |
|
| 81 | * |
|
| 82 | * @return Command |
|
| 83 | */ |
|
| 84 | public function update(string $arg, string $arg1, bool $unpin = true): Command |
|
| 85 | { |
|
| 86 | return new Command(__METHOD__, get_defined_vars()); |
|
| 87 | } |
|
| 88 | ||
| 89 | /** |
|
| 90 | * Verify that recursive pins are complete. |
|
| 91 | * |
|
| 92 | * @Endpoint(name="pin:verify") |
|
| 93 | * |
|
| 94 | * @param bool $verbose also write the hashes of non-broken pins |
|
| 95 | * @param bool $quiet write just hashes of broken pins |
|
| 96 | * |
|
| 97 | * @return Command |
|
| 98 | */ |
|
| 99 | public function verify(bool $verbose = false, bool $quiet = false): Command |
|
| 100 | { |
|
| 101 | return new Command(__METHOD__, get_defined_vars()); |
|
| 102 | } |
|
| 103 | } |
|
| 104 | ||