Skip to content

Latest commit

 

History

History
128 lines (99 loc) · 6.63 KB

README.md

File metadata and controls

128 lines (99 loc) · 6.63 KB
Raw

JUNGLELABᵀᴹ

junglelab

JungleLab LNFT Digital Assets is a web-based platform for issuing and transacting with non-fungible tokens on the Bitcoin Liquid Network. JungleLab is sponsoring its future development and hosting an exemplary curated instance of it for use by artists & organisers at JungleLab. [Blockstream] (https://www.blockstream.com) & [Jan3] (https://jan3.com) is sponsoring its development and hosting an exemplary curated instance of it for use by Bitcoin artists at [Raretoshi] (https://raretoshi.com)

Features

  • User accounts and profiles for artists and collectors include custom avatars, contact info and biography
  • Users can follow other artists and collectors and like/favorite individual artworks
  • Artists can upload digital media files (jpg, png, gif, mp4) representing an artwork and add metadata like a title, description, and tags
  • Selected metadata is published in the liquid asset registry so that tokens can be recognized by external wallets
  • Media files are added to the IPFS network upon being uploaded and are given a unique content identifier (CID) derived from the SHA256 hash of the file
  • The CID is embedded in the Liquid token issuance transaction contract, permanently and provably linking the file to the token
  • Artworks are listed in a searchable/sortable/filterable marketplace gallery
  • Artists can list an artwork for sale by setting an optional listing price, royalty rate, and/or auction period
  • Bids and sales are conducted peer-to-peer using atomic swaps so the platform host does not need to escrow funds
  • Listings, bids, transfers and new artwork activity are logged and presented in a site-wide feed
  • A web-based liquid wallet is integrated into the user's profile page and allows them to fund their accounts with L-BTC or any kind of liquid asset
  • Wallets can be backed up and imported using a 12-word BIP mnemonic seed phrase
  • Built-in integration with the coinos.io API allows users to instantly convert BTC to L-BTC by depositing to an on-chain address or paying a lightning network invoice
  • Royalties and auction holding periods are enforced through a 2-of-2 signing server that only signs off on transactions that meet certain conditions

Tech stack summary

Front-end

Back-end

3rd-party APIs

Installation pre-requisites

Setup codespaces development environment

Open in GitHub Codespaces

#!/bin/bash
run bash script for auto config: 
./install-script.sh

curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | bash
npm i -g pnpm
pnpm install
cd hasura
cp .env.sample .env
docker run -it -v $PWD/app:/app --entrypoint pnpm asoltys/lnft-server install
docker network create net
docker-compose up -d
hasura migrate apply
hasura metadata apply
hasura seeds apply
hasura metadata reload
docker exec -it ipfs ipfs config --json Gateway.PublicGateways '{ "ipfs": { "Paths": ["/ipfs", "/ipns"], "UseSubdomains": false } }'
docker exec -it ipfs ipfs config Addresses.Gateway "/ip4/0.0.0.0/tcp/8080"
sudo cp ../static/user.png storage/QmcbyjMMT5fFtoiWRJiwV8xoiRWJpSRwC6qCFMqp7EXD4Z.webp
docker exec -it ipfs ipfs add /export/QmcbyjMMT5fFtoiWRJiwV8xoiRWJpSRwC6qCFMqp7EXD4Z.webp
docker exec -it liquid elements-cli createwallet coinos
docker exec -it liquid elements-cli rescanblockchain
docker restart lapp
cd ..
pnpm dev

After following these steps, your site should now be available at http://localhost:3000/.

# liquid network regtest

chmod +x mine.sh
./mine.sh   
# this script will run continually to mine regtest blocks, you may want to run it in a separate terminal window or tab

docker exec -it liquid elements-cli -datadir=/home/elements/.elements sendtoaddress <address> 1   
# get <address> from http://localhost:3000/wallet
# adds liquid regtest funds to the user wallet

Setup local development environment

pnpm install
curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | bash
cd hasura
cp .env.sample .env
docker run -it -v $PWD/app:/app --entrypoint pnpm asoltys/lnft-server install
docker-compose up -d
hasura migrate apply
hasura metadata apply
hasura seeds apply
hasura metadata reload
docker exec -it ipfs ipfs config --json Gateway.PublicGateways '{ "ipfs": { "Paths": ["/ipfs", "/ipns"], "UseSubdomains": false } }'
docker exec -it ipfs ipfs config Addresses.Gateway "/ip4/0.0.0.0/tcp/8080"
sudo cp ../static/user.png storage/QmcbyjMMT5fFtoiWRJiwV8xoiRWJpSRwC6qCFMqp7EXD4Z.webp
docker exec -it ipfs ipfs add /export/QmcbyjMMT5fFtoiWRJiwV8xoiRWJpSRwC6qCFMqp7EXD4Z.webp
docker exec -it liquid elements-cli createwallet coinos
docker exec -it liquid elements-cli rescanblockchain
docker restart lapp
cd ..
pnpm dev   # site is now available at http://localhost:3000/

After following these steps, your site should now be available at http://localhost:3000/.

# liquid network regtest

chmod +x mine.sh
./mine.sh   
# this script will run continually to mine regtest blocks, you may want to run it in a separate terminal window or tab

docker exec -it liquid elements-cli -datadir=/home/elements/.elements sendtoaddress <address> 1   
# get <address> from http://localhost:3000/wallet
# adds liquid regtest funds to the user wallet