⚠️ Disclaimer: This project is still in development. Some changes will be introduced over the next weeks, so please use this project with caution.

FXHASH Generative Token simplest boilerplate

This is the (arguably) simplest boilerplate to implement a Generative Token on fxhash.

Before diving into the development of your token, we recommend reading the Guide to mint a Generative Token to get some understanding of the process.

If you are looking for a boilerplate that handles the compression to a ZIP file at the cost of running a command, packaging modules, minifying, you can use the fxhash params boilerplate instead. The boilerplate also comes with fx(lens). An interactive environment to view, tweak and develop generative tokens for the fx(hash) platform.

Installation

Clone the repository on your machine and move to the directory

$ git clone https://github.com/fxhash/params-simple-boilerplate.git your_folder && cd your_folder

fxhash snippet

fxhash requires you to use a javascript code snippet so that the platform can inject some code when tokens will be generated from your Generative Token. The code snippet is already in the index.html file of this boilerplate, so you don't have to add it yourself.

During the development stages, the snippet will generate a random hash each time the page is refreshed. This way, it helps you reproduce the conditions in which your token will be executed on fxhash.

The code snippet exposes the $fx object with the following structure:

{
  hash: String, // a random 64 characters hexadecimal string. This particular variable will be hardcoded with a static hash when someone mints a token from your GT
  rand: () => Number, // a PRNG function that generates deterministic PRN between 0 and 1. Simply use it instead of Math.random().
  preview: () => void, // trigger for capture module
  isPreview: Boolean, // is TRUE when capture module is running the project
  params: (definitions) => void, // sets your projects fx(params) definitions
  getParam: (id: String) => any, // get transformed fx(params) value by id
  getParams: () => any, // get all transformed fx(params) values
  getRawParam: (id: String) => any, // get raw fx(params) value by id 
  getRawParams: () => any, // get all raw fx(params) values
  getDefinitions: () => any, // get all fx(params) definitions
  features: (features) => void, // sets your projects features
  getFeature: (id: String) => any, // get feature by id
  getFeatures: () => any, // get all features
}

The index.js of this boilerplate quickly demonstrates how to use the whole "SDK".

How do Generative Tokens work

This is how Generative Tokens work on fxhash:

you upload your project to the platform (see next section)
you mint your project
when a collector will mint its unique token from your Generative Token, a random hash will be hard-coded in the fxhash code snippet
the token will now have its own index.html file, with a static hash, ensuring its immutability

The Guide to mint a Generative Token give in-depth details about this process.

Publish your token

Once you are happy with the results, you ned to compress the contents of this directory to a ZIP file. The index.html must be at the root of the archive.

Go to https://fxhash.xyz/sandbox/ and upload your .zip file in there to see if it works properly.

Finally, you can mint your token using the same .zip file.

Rules to follow

Theses rules must be followed to ensure that your token will be future-proof, accepted by fxhash, and behave in the intended way

the zip file must be under 15 Mb
any path to a resource must be relative (./path/to/file.ext)
no external resources allowed, you must put all your resources in the public/ folder (sub-folders are OK)
no network calls allowed (but calls to get resources from within your public/ folder)
you must handle any viewport size (by implementing a response to the resize event of the window)
you cannot use random number generation without a seed (the same input hash must always yield the same output). The fxrand function does a very good job in that regard.

louisholley / fxhash-simple-boilerplate