activestorage-nft

Activestorage::Nft

ActiveStorage adapter for NFT.storage.

Uploaded files are automatically pinned on the pinata.cloud IPFS pinning service, courtesey of Protocol Labs.

Note on uniqueness

When uploading a file that already exists (same content hash), an ActiveRecord::RecordNotUnique exception will be raised.

Installation

Add this line to your application's Gemfile:

gem 'activestorage-nft'

And then execute:

$ bundle install

Usage

In your Rails 5.2+ app, run:

rails active_storage:install

This will copy over active_storage migration for creating the tables and then run:

rails db:migrate

We now need to tell activestorage to use the nft service. Declare a Nft service in config/storage.yml. Each service requires a api_key and a gateway_endpoint.

nft:
  service: nft
  gateway_endpoint: https://gateway.pinata.cloud
  api_key: <%= ENV["NFT_STORAGE_API_KEY"] %>

Direct Upload

# TODO

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/buhrmi/activestorage-nft. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Activestorage::Nft project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.