stx.me

Hassle-free STX donations for any website

Allow your biggest fans to support your work through a Bitcoin-powered internet.

Receive donations in under 5 minutes

Add a div to your page
Add the stx.me library to your page
Profit

Try it out

Getting Started

Add the stx.me container to your webpage

<div id="stx-me"></div>

Add the stx.me script to your webpage

<script src="https://unpkg.com/stx-me/dist/stx.me.js"></script>

Initialize stx.me with your wallet address

<script>
    stx.me('SP2D71SFBCAX1VE664GKQP2Y7YMRDW6YJGVQVXB1T');
</script>

Add stx.me stylesheet (optional)

<link rel="stylesheet" href="https://unpkg.com/stx-me/dist/stx.me.css"></link>

The example on this page uses the stx.me stylesheet

Configuration

The stx.me function takes a second, optional parameter of options. The following options are allowed:

interface AppDetails {
  name: string;
  icon: string;
}

interface ConfigOptions {
  showAddress?: boolean;
  appDetails?: AppDetails;
  successMessage?: string;
  buttonText?: string;
  network?: string;
}

AppDetails

Used to configure what users will see within the Stacks wallet.

Parameter	Default	Description
name	`document.title`	An app name to display in the Stacks wallet.
icon	`/favicon.ico`	The path to an icon to display in the Stacks wallet.

ConfigOptions

Used to configure how the stx.me button behaves.

Parameter	Default	Description
showAddress	`false`	Display your stacks address on your webpage.
appDetails	See AppDetails	Configuration for the Stacks wallet pop ups.
successMessage	Thanks for your donation!	A message to display to users on successful donation.
buttonText	Send Me STX	A message to display on the donation button.
network	`mainnet`	The Stacks network transactions should be sent on.