Create

Use this endpoint to create a rune launchpad

  • Creating a rune launchpad requires a pre-payment for splitting the rune tokens

  • The pre-payment details are in the charge field returned by the endpoint

  • You will also need to send us the premined tokens, the address and amount for the premined tokens are in the tokenCharge field

  • Make sure to send the bitcoin pre-payment in a single transaction and UTXO

  • Make sure to send the rune transfer in a single transfer transaction

  • After bitcoin payment and the rune tokens are received, we will initiate a splitting transaction. The details of this transaction are available in the runeSplitParameters field, the txid will appear in the txid field there

  • Only after this splitting transaction is confirmed the launchapd will enter into a state ready. This means that the launchapd is ready and waiting to be started.

  • Ask an ordinalsbot team member to start the launchpad by moving it into state minting or allowlist

  • As of right now salesCap is limited to 9000, ask us privately if you need an increase

POST a new rune launchpad order

Create a rune launchpad

POST https://api.ordinalsbot.com/runes/launchpad/create

Request Body

NameTypeDescription

id*

String

Human-readable launchpad id

rune*

String

The name of rune you want to sell (with spacers)

creatorAddress*

String

The bitcoin address where we will send the proceeds from the sale

saleSize*

Number

We will sell this many tokens per batch (equivalent to terms.amount in runestone)

salesCap*

Number

The number of available batches for sale (equivalent to terms.cap in runestone)

totalTokensForSale*

Number

The total amount of tokens that are available for sale on the launchpad. Must equal saleSize * salesCap

price*

Number

Price per token

splittingFee*

Number

Chain fee in sat/vb for the splitting transaction required before starting the launchpad

publicAllocation

Number

Publicly available allocation of tokens

allowList

Object

The allowlist

accessRules

Array

Array of objects that set rules on who can claim tokens from the launchpad. e.g. [{"api": "brc20", "token": "TRIO", "allocation":10}] This will check user address balance for brc20 TRIO tokens and allow them to claim 10 rune launchpad tokens per TRIO they hold.

metadata

Object

Any metatada you wish for your collection you can pass it as any type of JS object here. Max size 10kb.

{
    "id": "f5c055a5-05c7-4208-b911-beb6191a8068",
    "charge": {
        "address": "bc1qrt6u67my3ucgjj0lmvvtwgkvcnx3dq3yeupdz0",
        "amount": 5450200
    },
    "tokenCharge": {
        "address": "bc1qcqpyymhqq5sqpxz3c9ws20lqg6t2gxsnt83jpa",
        "amount": 1000000,
        "rune": "TRIO•ORDINALSBOT"
    },
    "runeSplitParameters": {
        "rune": "TRIO•ORDINALSBOT",
        "splitsNumber": 1000,
        "splitSize": 1000,
        "fee": 5450200,
        "executed": false
    },
    "rune": "TRIO•ORDINALSBOT",
    "creatorAddress": "bc1pgnwmg7wplc09cm9fctgmgalu7l4synjh7khwzre9qlcvg5xy0k5qz9mwe3",
    "saleSize": 1000,
    "salesCap": 1000,
    "totalTokensForSale": 1000000,
    "price": 1,
    "publicAllocation": 0,
    "state": "waiting-prepayment",
    "paidItemCount": 0,
    "allocatedItemCount": 0,
    "mintedItemCount": 0,
    "createdAt": {
        ".sv": "timestamp"
    }
}
// Here's a sample payload you can POST to create a rune order
{
    "splittingFee": 100,
    "rune": "TRIO•ORDINALSBOT",
    "creatorAddress": "bc1pgnwmg7wplc09cm9fctgmgalu7l4synjh7khwzre9qlcvg5xy0k5qz9mwe3",
    "price": 1,
    "saleSize": 1000,
    "salesCap": 1000,
    "totalTokensForSale": 1000000
}

Last updated