https://github.com/raviganwal/ipfs_client_flutter

IPFS client for flutter
https://github.com/raviganwal/ipfs_client_flutter

ipfs ipfs-api ipfs-blockchain

Last synced: 2 days ago
JSON representation

IPFS client for flutter

• Host: GitHub
• URL: https://github.com/raviganwal/ipfs_client_flutter
• Owner: raviganwal
• License: mit
• Created: 2022-02-27T17:17:37.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-19T03:09:16.000Z (almost 3 years ago)
• Last Synced: 2024-12-17T11:43:21.940Z (6 days ago)
• Topics: ipfs, ipfs-api, ipfs-blockchain
• Language: Dart
• Homepage: https://github.com/raviganwal/ipfs_client_flutter
• Size: 34.2 KB
• Stars: 9
• Watchers: 1
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


A flutter client library for the [IPFS HTTP API](https://docs.ipfs.io/reference/http/api/).

### Features

* Make a directory

* List all directories/files in a directory/subdirectory

* File status

* Write a file

* Read a file

* Remove a file/directory

* Move/Rename a file

### Usage

```

  IpfsClient ipfsClient = IpfsClient();

```

OR

```

  IpfsClient ipfsClient = IpfsClient(url: "http://127.0.0.1:5001");

  // default is http://127.0.0.1:5001 so you don't need to pass url in case you are working on localhost

```

If your app uses `Basic Authorization` then,

```

  IpfsClient ipfsClient =

      IpfsClient(url: "YOUR_SERVER_URL", authorizationToken: "YOUR_TOKEN");

```

### How to make a directory in IPFS

```

  var response = await ipfsClient.mkdir(dir: 'myfolder');

```

### Get list of directories/files in a directory/subdirectory in the local mutable namespace.

```

  var response = await ipfsClient.ls(dir: 'myfolder');

```

If you dont pass any folder it will return all files and directories of root directory.

### How to Write to a file

```

    var response = await ipfsClient.write(

      dir: 'myfolder/sample.png',

      filePath: "/Users/myuser/Desktop/sample.png",

      fileName: "sample.png");

```

### How to read a file

```

  var response = await ipfsClient.read(dir: "myfolder/sample.png");

```

### How to remove a file

```

  var response = await ipfsClient.remove(dir: "myfolder/sample.png");

```

### How to move/rename a file

```

  var response = await ipfsClient.mv(oldPath: "myfolder/sample.png", newPath: "myfolder/MY_SAMPLE.png");

```