This is the cl-ipfs-api2 Reference Manual, version 0.51, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:06:34 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-ipfs-api2
Bindings for the IPFS HTTP API.
Jaidyn Ann <jadedctrl@teknik.io>
LGPLv3
0.51
drakma
(system).
yason
(system).
arnesi
(system).
uiop
(system).
package.lisp
(file).
main.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-ipfs-api2/main.lisp
cl-ipfs-api2
(system).
*api-host*
(special variable).
*api-root*
(special variable).
*ipfs-root*
(special variable).
add
(function).
bitswap-ledger
(function).
bitswap-reprovide
(function).
bitswap-stat
(function).
bitswap-wantlist
(function).
block-get
(function).
block-put
(function).
block-rm
(function).
block-stat
(function).
bootstrap
(function).
bootstrap-add
(function).
bootstrap-add-default
(function).
bootstrap-list
(function).
bootstrap-rm
(function).
bootstrap-rm-all
(function).
cat
(function).
cid-base32
(function).
cid-bases
(function).
config
(function).
config-show
(function).
dag-get
(function).
dag-put
(function).
dag-resolve
(function).
dht-findpeer
(function).
dht-findprovs
(function).
dht-get
(function).
dht-provide
(function).
dht-put
(function).
dht-query
(function).
diag-cmds
(function).
diag-cmds-clear
(function).
diag-cmds-set-time
(function).
diag-sys
(function).
dl
(function).
dns
(function).
file-ls
(function).
files-chcid
(function).
files-cp
(function).
files-flush
(function).
files-ls
(function).
files-mkdir
(function).
files-mv
(function).
files-read
(function).
files-rm
(function).
files-stat
(function).
files-write
(function).
filestore-dups
(function).
filestore-ls
(function).
filestore-verify
(function).
id
(function).
key-gen
(function).
key-list
(function).
key-remove
(function).
key-rename
(function).
log-level
(function).
log-ls
(function).
log-tail
(function).
ls
(function).
name-publish
(function).
name-pubsub-cancel
(function).
name-pubsub-state
(function).
name-pubsub-subs
(function).
name-resolve
(function).
object-data
(function).
object-diff
(function).
object-get
(function).
object-links
(function).
object-new
(function).
object-patch-add-link
(function).
object-patch-rm-link
(function).
object-stat
(function).
p2p-close
(function).
p2p-listen
(function).
p2p-ls
(function).
p2p-stream-close
(function).
p2p-stream-ls
(function).
pin-add
(function).
pin-ls
(function).
pin-rm
(function).
pin-update
(function).
pin-verify
(function).
pubsub-ls
(function).
pubsub-peers
(function).
pubsub-pub
(function).
pubsub-sub
(function).
pubsub-sub-close
(function).
pubsub-sub-listen
(function).
pubsub-sub-process
(function).
pubsub-sub-read-char
(function).
refs
(function).
refs-local
(function).
repo-fsck
(function).
repo-gc
(function).
repo-stat
(function).
repo-verify
(function).
repo-version
(function).
resolve
(function).
shutdown
(function).
stats-bitswap
(function).
stats-bw
(function).
stats-repo
(function).
swarm-addrs
(function).
swarm-addrs-listen
(function).
swarm-addrs-local
(function).
swarm-connect
(function).
swarm-disconnect
(function).
swarm-filters
(function).
swarm-filters-add
(function).
swarm-filters-rm
(function).
swarm-peers
(function).
urlstore-add
(function).
version
(function).
version-deps
(function).
with-files-write
(macro).
config-get
(function).
config-set
(function).
empty-string-p
(function).
ipfs-call
(function).
make-call-url
(function).
p2p-forward
(function).
process-result
(function).
s-assoc
(function).
simplify
(function).
string+
(function).
url-encode
(function).
Packages are listed by definition order.
cl-ipfs-api2
cl-ipfs
ipfs
common-lisp
.
it.bese.arnesi
.
*api-host*
(special variable).
*api-root*
(special variable).
*ipfs-root*
(special variable).
add
(function).
bitswap-ledger
(function).
bitswap-reprovide
(function).
bitswap-stat
(function).
bitswap-wantlist
(function).
block-get
(function).
block-put
(function).
block-rm
(function).
block-stat
(function).
bootstrap
(function).
bootstrap-add
(function).
bootstrap-add-default
(function).
bootstrap-list
(function).
bootstrap-rm
(function).
bootstrap-rm-all
(function).
cat
(function).
cid-base32
(function).
cid-bases
(function).
config
(function).
config-show
(function).
dag-get
(function).
dag-put
(function).
dag-resolve
(function).
dht-findpeer
(function).
dht-findprovs
(function).
dht-get
(function).
dht-provide
(function).
dht-put
(function).
dht-query
(function).
diag-cmds
(function).
diag-cmds-clear
(function).
diag-cmds-set-time
(function).
diag-sys
(function).
dl
(function).
dns
(function).
file-ls
(function).
files-chcid
(function).
files-cp
(function).
files-flush
(function).
files-ls
(function).
files-mkdir
(function).
files-mv
(function).
files-read
(function).
files-rm
(function).
files-stat
(function).
files-write
(function).
filestore-dups
(function).
filestore-ls
(function).
filestore-verify
(function).
id
(function).
key-gen
(function).
key-list
(function).
key-remove
(function).
key-rename
(function).
log-level
(function).
log-ls
(function).
log-tail
(function).
ls
(function).
name-publish
(function).
name-pubsub-cancel
(function).
name-pubsub-state
(function).
name-pubsub-subs
(function).
name-resolve
(function).
object-data
(function).
object-diff
(function).
object-get
(function).
object-links
(function).
object-new
(function).
object-patch-add-link
(function).
object-patch-rm-link
(function).
object-stat
(function).
p2p-close
(function).
p2p-listen
(function).
p2p-ls
(function).
p2p-stream-close
(function).
p2p-stream-ls
(function).
pin-add
(function).
pin-ls
(function).
pin-rm
(function).
pin-update
(function).
pin-verify
(function).
pubsub-ls
(function).
pubsub-peers
(function).
pubsub-pub
(function).
pubsub-sub
(function).
pubsub-sub-close
(function).
pubsub-sub-listen
(function).
pubsub-sub-process
(function).
pubsub-sub-read-char
(function).
refs
(function).
refs-local
(function).
repo-fsck
(function).
repo-gc
(function).
repo-stat
(function).
repo-verify
(function).
repo-version
(function).
resolve
(function).
shutdown
(function).
stats-bitswap
(function).
stats-bw
(function).
stats-repo
(function).
swarm-addrs
(function).
swarm-addrs-listen
(function).
swarm-addrs-local
(function).
swarm-connect
(function).
swarm-disconnect
(function).
swarm-filters
(function).
swarm-filters-add
(function).
swarm-filters-rm
(function).
swarm-peers
(function).
urlstore-add
(function).
version
(function).
version-deps
(function).
with-files-write
(macro).
config-get
(function).
config-set
(function).
empty-string-p
(function).
ipfs-call
(function).
make-call-url
(function).
p2p-forward
(function).
process-result
(function).
s-assoc
(function).
simplify
(function).
string+
(function).
url-encode
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A convenience macro for files-write. In the body of the macro, any writes to the stream named by STREAM will be sent to the mfs file at DEST-PATH. PARAMS will be passed directly to the files-write function.
Add a file to IPFS, return it’s hash. /ipns/docs.ipfs.io/reference/api/http/#api-v0-add
Show the current ledger for a peer. /ipns/docs.ipfs.io/reference/api/http/#api-v0-bitswap-ledger
Trigger the reprovider. /ipns/docs.ipfs.io/reference/api/http/#api-v0-bitswap-reprovide
Show diagnostic info on the bitswap agent. /ipns/docs.ipfs.io/reference/api/http/#api-v0-bitswap-stat
Show blocks currently on the wantlist. /ipns/docs.ipfs.io/reference/api/http/#api-v0-bitswap-wantlist
Get a raw IPFS block. /ipns/docs.ipfs.io/reference/api/http/#api-v0-block-get
Store input as an IPFS block. /ipns/docs.ipfs.io/reference/api/http/#api-v0-block-put
Delete an IPFS block(s). /ipns/docs.ipfs.io/reference/api/http/#api-v0-block-rm
Print info about a raw IPFS block /ipns/docs.ipfs.io/reference/api/http/#api-v0-block-stat
Return a list of bootstrap peers /ipns/docs.ipfs.io/reference/api/http/#api-v0-bootstrap
Add a peer to the bootstrap list /ipns/docs.ipfs.io/reference/api/http/#api-v0-bootstrap-add
Add default peers to the bootstrap list /ipns/docs.ipfs.io/reference/api/http/#api-v0-bootstrap-add-default
Return a list of bootstrap peers /ipns/docs.ipfs.io/reference/api/http/#api-v0-bootstrap-list
Remove a peer from the bootstrap list /ipns/docs.ipfs.io/reference/api/http/#api-v0-bootstrap-rm
Remove a peer from the bootstrap list /ipns/docs.ipfs.io/reference/api/http/#api-v0-bootstrap-rm
Return a string of the data at the given IPFS path. /ipns/docs.ipfs.io/reference/api/http/#api-v0-cat
Convert a CID into Base32 CIDv1 /ipns/docs.ipfs.io/reference/api/http/#api-v0-cid-base32
Return a associative list of available bases in plist format; each base’s
name is a assigned a given code-number.
((CODE-A . NAME-A) (CODE-B . NAME-B) … (CODE-N . NAME-N))
/ipns/docs.ipfs.io/reference/api/http/#api-v0-cid-bases
Get/set a config key’s value. /ipns/docs.ipfs.io/reference/api/http/#api-v0-config
Return the config file’s contents, in alist-format… y’know, with several
sub-alists.
Doesn’t quite line up with #api-v0-config-show
/ipns/docs.ipfs.io/reference/api/http/#api-v0-config-show
Get a dag node from IPFS. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dag-get
Add a dag node to IPFS. Returns CID string. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dag-put
Resolve an IPLD block. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dag-resolve
Find the multiaddresses associated with a peer ID. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dht-findpeer
Find peers that can provide a specific value, given a key. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dht-findprovs
Query the routing system for a key’s best value. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dht-get
Announce to the network that you’re providing the given values. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dht-provide
Write a key-value pair to the routing system. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dht-put
Find the closest peer IDs to the given one by querying the DHT. /ipns/docs.ipfs.io/reference/api/http/#api-v0-dht-query
List commands run on this IPFS node. /ipns/docs.ipfs.io/reference/api/http/#api-v0-diag-cmds
Clear inactive requests from the log. /ipns/docs.ipfs.io/reference/api/http/#api-v0-diag-cmds-clear
Set how long to keep inactive requests in the log. /ipns/docs.ipfs.io/reference/api/http/#api-v0-diag-cmds-set-time
Print system diagnostic info. /ipns/docs.ipfs.io/reference/api/http/#api-v0-diag-sys
Write an IPFS file directly to a file on the local file-system.
Non-recursive, in the case of directories… for now.
(Thanks to this thread ♥: https://stackoverflow.com/a/12607423)
Is a general replacement for the ’get’ API call, but actually just uses
the ’cat’ call, due to some issues with using ’get’.
Will not actually return NIL when an error is reached (like other functions)
with an error-message, it’lll just write the error JSON to the file.
Whoops.
Resolve a domain into a path (usually /ipfs/). /ipns/docs.ipfs.io/reference/api/http/#api-v0-dns
List directory contents for UNIX filesystem objects. /ipns/docs.ipfs.io/reference/api/http/#api-v0-file-ls
Change the cid version or hash function of the root node of a given path. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-chcid
Copy files into mfs. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-cp
Flush a given path’s data to disk. Returns CID. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-flush
List directories in local mutable namespace. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-ls
Make a directory. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-mkdir
Move a file. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-mv
Read a file in given mfs. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-read
Remove a given file. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-rm
Remove a given file. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-rm
Write to a given file. First parameter can be a string or a path to a local file. /ipns/docs.ipfs.io/reference/api/http/#api-v0-files-rm
List blocks that’re both in the filestore and standard block storage. /ipns/docs.ipfs.io/reference/api/http/#api-v0-filestore-dups
List objects in filestore. /ipns/docs.ipfs.io/reference/api/http/#api-v0-filestore-ls
Verify objects in filestore. /ipns/docs.ipfs.io/reference/api/http/#api-v0-filestore-verify
Return info on a node by ID. Returns as an associative list, the public key, agent version, etc. If no node ID is specified, then your own is assumed. /ipns/docs.ipfs.io/reference/api/http/#api-v0-id
Create a new keypair. /ipns/docs.ipfs.io/reference/api/http/#api-v0-key-gen
List all local keypairs. /ipns/docs.ipfs.io/reference/api/http/#api-v0-key-list
Remove a keypair, based on name. /ipns/docs.ipfs.io/reference/api/http/#api-v0-key-remove
Rename a local keypair. /ipns/docs.ipfs.io/reference/api/http/#api-v0-key-rename
Change the logging level of a subsystem. /ipns/docs.ipfs.io/reference/api/http/#api-v0-log-level
List the logging subsystems. /ipns/docs.ipfs.io/reference/api/http/#api-v0-log-ls
Read the event log. /ipns/docs.ipfs.io/reference/api/http/#api-v0-log-tail
Returns all sub-objects (IPFS hashes) under a given IPFS/IPNS directory path. Returns as an associative list. /ipns/docs.ipfs.io/reference/api/http/#api-v0-ls
Publish an IPNS name– associate it with an IPFS path. /ipns/docs.ipfs.io/reference/api/http/#api-v0-name-publish
Cancel subscription to a name. /ipns/docs.ipfs.io/reference/api/http/#api-v0-name-pubsub-cancel
Query the state of IPNS pubsub. /ipns/docs.ipfs.io/reference/api/http/#api-v0-name-pubsub-state
Show current name subscriptions. /ipns/docs.ipfs.io/reference/api/http/#api-v0-name-pubsub-subs
Resolve a given IPNS name. /ipns/docs.ipfs.io/reference/api/http/#api-v0-name-resolve
Output the raw data of an IPFS object. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-data
Display the differences between two IPFS objects. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-diff
Get and serialize the named DAG node. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-get
Output the links pointed to by the specified object. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-links
Create a new object from an IPFS template. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-new
Add a link to a given object. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-patch-add-link
Remove a link from a given object. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-patch-rm-link
Get stats for a DAG node. /ipns/docs.ipfs.io/reference/api/http/#api-v0-object-stat
Stop listening for new connections to forward. /ipns/docs.ipfs.io/reference/api/http/#api-v0-p2p-close
Create libp2p service. /ipns/docs.ipfs.io/reference/api/http/#api-v0-p2p-listen
List active p2p listeners. /ipns/docs.ipfs.io/reference/api/http/#api-v0-p2p-ls
Close an active p2p stream. /ipns/docs.ipfs.io/reference/api/http/#api-v0-p2p-stream-close
List active p2p streams. /ipns/docs.ipfs.io/reference/api/http/#api-v0-p2p-stream-ls
Pin an object to local storage. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pin-add
List objects pinned to local storage. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pin-ls
Remove pinned objects from local storage. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pin-rm
Update a recursive pin. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pin-update
Verify that recursive pins are complete. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pin-verify
Return a list of subscribed topics. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pubsub-ls
Return a list of peers with pubsub enabled. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pubsub-peers
Publish a string to a given pubsub topic. /ipns/docs.ipfs.io/reference/api/http/#api-v0-pubsub-pub
Subscribe to a given pubsub topic— this function requires go-ipfs to be
installed on the current machine, and that ‘ipfs‘ is in the current $PATH.
This probably will only work on *nix systems (sorry Windows nerds).
Returns a uiop/launch-program::process-info socket– can be used in
conjunction with the #’pubsub-sub-* functions, or with :uiop/launch-program’s
functions.
A system-dependent replacement for
/ipns/docs.ipfs.io/reference/api/http/#api-v0-pubsub-sub
Close a ’pubsub stream’ (process-info-stream) and related processes.
Process a ’pubsub stream’ (process-info-stream) and #’listen it.
Turn a uiop process-info-stream (’pubsub stream’) into a fd-stream that is #’read-char-able, etc.
Process a ’pubsub stream’ (process-info-stream) and #’readchar it.
List links (references) from an object. /ipns/docs.ipfs.io/reference/api/http/#api-v0-refs
List all local references. /ipns/docs.ipfs.io/reference/api/http/#api-v0-refs-local
Remove repo lock-files. /ipns/docs.ipfs.io/reference/api/http/#api-v0-repo-fsck
Perform garbage collection on the repo. /ipns/docs.ipfs.io/reference/api/http/#api-v0-repo-gc
Get stats for the current repo. /ipns/docs.ipfs.io/reference/api/http/#api-v0-repo-stat
Verify that all repo blocks aren’t corrupted. /ipns/docs.ipfs.io/reference/api/http/#api-v0-repo-verify
Show the repo version. /ipns/docs.ipfs.io/reference/api/http/#api-v0-repo-version
Resolve a given name to an IPFS path.
Shut down the connected IPFS node. /ipns/docs.ipfs.io/reference/api/http/#api-v0-shutdown
Show diagnostics on bitswap. /ipns/docs.ipfs.io/reference/api/http/#api-v0-stats-bitswap
Return bandwidth information. /ipns/docs.ipfs.io/reference/api/http/#api-v0-stats-bw
Show diagnostics on current repo. /ipns/docs.ipfs.io/reference/api/http/#api-v0-stats-repo
List known addresses. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-addrs
List interface listening addresses. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-addrs-listen
List local addresses. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-addrs-local
Open connection to a given address. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-connect
Close connection to a given address. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-disconnect
List address filters. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-filters
Add an address filter. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-filters-add
Remove an address filter. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-filters-rm
List peers with open connections. /ipns/docs.ipfs.io/reference/api/http/#api-v0-swarm-peers
Add a URL via urlstore. /ipns/docs.ipfs.io/reference/api/http/#api-v0-urlstore-add
Return the current golang, system, repo, and IPFS versions. /ipns/docs.ipfs.io/reference/api/http/#api-v0-version
Return info about dependencies used for build; I.E., Go version, OS, etc. /ipns/docs.ipfs.io/reference/api/http/#api-v0-version
Get a config key’s value.
Doesn’t map with any existant API call; it’s just a convenience wrapper
around #’config.
Set a config key’s value.
Doesn’t map with any existant API call; it’s just a convenience wrapper
around #’config.
Return whether or not a given item is an empty string.
Make an IPFS HTTP API call. Quite commonly used.
Some calls return strings/raw data, and others return JSON.
When strings/arbitrary data are recieved, they’re returned verbatim.
But, when JSON is returned, it is parsed into a hashtable.
If the JSON is ’error JSON’, I.E., it signals that an error has been
recieved, two values are returned: NIL and the string-error-message.
Create the URL of an API call, as per the given arguments.
Symbols are assumed to be something like ’T (so boolean), nil likewise.
Arguments should look like this:
((’recursive’ nil)(’name’ ’xabbu’))
Forward connections to libp2p service. /ipns/docs.ipfs.io/reference/api/http/#api-v0-p2p-forward
Get the value of an associative list using a string key.
’Simplify’ a list. Remove any extraneous sublisting [ ((2 3)) -> (2 3) ],
and remove extraneous strings in otherwise pure alists, e.g.
[ (“Apple” (2 2) (3 3) (4 4)) -> ((2 2) (3 3) (4 4)) ]
Combine an arbitrary amount of strings into a single string.
Wrap around drakma’s url encoder, with a slight change– instead of using plus-signs for spaces, we want to use %20.
Jump to: | A B C D E F I K L M N O P R S U V W |
---|
Jump to: | A B C D E F I K L M N O P R S U V W |
---|
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Jump to: | C F M P S |
---|
Jump to: | C F M P S |
---|