trust-machines / bitcoin-funding

OrangeFund.us

Orange Fund is a crowdfunding/fundraising platform that allows projects to raise native Bitcoin (BTC)

Deploy OrangeFund

In order to deploy an instance of OrangeFund, you can follow these steps:

0. Run npm i in the web/ folder
1. Set up a SQL database and run the following commands in the web folder

• npx db push to create and push updates to your SQL db according to schema.prisma
• npx prisma generate to update your schema definitions in prisma
• npx prisma studio to run a UI to browse your DB

2. Set up an Electrum server to track Bitcoin deposits through your own xpub (extended public address) and set of private keys
3. Use npm run start to run the Next.js server locally

Don't forget to set your environment variables in the .env file (see .env.example for an example).

Additionally, you can deploy an instance of Orange Fund to Vercel (https://vercel.app/)

Features

Current supported features:

• Create a project to raise BTC on a wallet with your own set of private keys
• Host an Electrum Server instance to support any Bitcoin wallet (whether it's a CEX withdrawal or a person's private wallet)
• Keep track of each funding event through on-chain governance on Stacks
• Upload rich media (jpeg, png, mp4, ...) to showcase the uniqueness of your project

Security

IMPORTANT: OrangeFund has not been audited by any external firm as of today.

Clarity Usage

Requires Clarinet

Install Clarinet: https://github.com/hirosystems/clarinet

OrangeFund is partly written in Clarity and therefore requires you to install Clarinet locally on the command line. Type the following command to check that you have Clarinet installed:

$ clarinet --version

Please make sure you have Clarinet version 0.31.1 or higher installed.

Download OrangeFund

1. Clone the repo:

$ git clone [email protected]:Trust-Machines/bitcoin-funding.git && cd bitcoin-funding

2. Run the unit test to confirm all the tests passed and everything is working:

$ clarinet test

3. Open the Clarinet console in order to interact with the contract

$ clarinet console

bitcoin-funding's Issues

Adjust to lower fees on Stacks

We use 0.01 fee, that's 100x too high, can lower to 0.001 :)

Add list of members on fund page

if members > 0

Unable to get testnet address when logging in

When logging in, I always get my mainnet address. The micro-stacks lib has an option to set the network but it does not seem to work.

Image maximum size and file type validation

Don't allow big files (e.g. max 5MB) and make sure it's an image (to prevent potential exploits) even tho they can easily spoof the mime type

After logging in the dehydratedState is null and the page does not load

Nicer avatar upload form inputs

Add loading signs / spinners on buttons

Refactor constants to uppercase

Use Sponsored Transactions to register BTC address

https://www.npmjs.com/package/@stacks/transactions

Show if on chain DAO registration failed

Upload avatars to S3

Upload to testnet + Vercel

Validate BTC input address

Fund page polling does not always refresh page properly (cache?)

Use BTC as main currency and show USD value in UI as reference

S3 uploads do not work on Vercel?

Fix encoding in api/user/verify

To link user to fundingWallet

Refactor PrismaClient into Singleton

Refactor RegistrationStatus into Enum

Don't allow front-end updates

After registering a user on chain, the fund flow does not always go to the next step

Handle Electrum server closes

Sometimes the electrum server hangs up. Causing the API to return an error. Maybe we can check if it's possible to retry.

Add and remove additional admins for a DAO

Fund activity feed order is wrong

It does not seem to be sorted properly

Rename DAO to Fund

Setup S3

@philipdesmedt I tried it this morning but could not get it to work. As you already set it up on your personal account, can you do this on the ballotbox account as well?

Show explorer links when on-chain TXs are in progress

Look into SQL query for fund/[slug]/transactions.ts

the double select on fundingTransaction seems a little slow (double joins statement?), need to look at the SQL that prisma generates and check if we can optimise it.