Prepare Transactions

curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "method": "newTokenization",
  "signerAddress": "0xSignerAddress",
  "tokenizerEmail": "tokenizer.email@example.com",
  "chainId": "aa36a7",
  "symbol": "BKN",
  "supplyCap": "10",
  "name": "Brickken",
  "gasLimit": "2000000 but can be omitted",
  "rpcUrl": "{URL_TO_RPC} but can be omitted"
}'

{
  "transactions": [
    {
      "from": "<string>",
      "to": "<string>",
      "value": {
        "type": "<string>",
        "hex": "<string>"
      },
      "nonce": 123,
      "chainId": 123,
      "data": "<string>",
      "type": 123,
      "maxPriorityFeePerGas": {
        "type": "<string>",
        "hex": "<string>"
      },
      "maxFeePerGas": {
        "type": "<string>",
        "hex": "<string>"
      },
      "gasLimit": {
        "type": "<string>",
        "hex": "<string>"
      }
    }
  ]
}

On Behalf Endpoints

Create Token on Behalf

Description: This endpoint prepares unsigned transactions for various blockchain operations. The operation is determined by the method field in the request body. Supported methods include: newTokenization, mintToken, whitelist, burnToken, approve, transferTo, transferFrom, dividendDistribution, and newSto.

Headers:

x-api-key: YOUR_API_KEY
Content-Type: application/json

Common Request Body Parameters:

method (string): Operation to perform.
signerAddress (string): Address initiating the transaction.
chainId (string): Chain ID in hex (e.g., “aa36a7”).
gasLimit (string, optional): Optional gas limit.
rpcUrl (string, optional): Optional RPC URL.

Method: newTokenization Prepares a new tokenization transaction.

Additional Request Body Parameters:

url (string): Token documentation URL.
name (string): Token name.
symbol (string): Token symbol (max 5 characters).
tokenizerEmail (string): The email of the tokenizer.
supplyCap (string, optional): Max token supply.
preMints (array, optional): Pre-mint configurations.
initialHolders (array, optional): Initial holder configurations.

Method: mintToken Prepares minting tokens to users.

Additional Request Body Parameters:

tokenSymbol (string): Symbol of the token.
userToMint (array of objects): Each object includes:
- email (string)
- investorAddress (string)
- amount (string)
- needWhitelist (boolean)

Method: whitelist Whitelists or blacklists users.

Additional Request Body Parameters:

tokenSymbol (string): Symbol of the token.
userToWhitelist (array of objects): Each includes:
- whitelistStatus (string): “true” or “false”.
- investorAddress (string)

Method: burnToken Burns tokens from the signer’s balance.

Additional Request Body Parameters:

tokenSymbol (string): Symbol of the token.
amount (string): Amount to burn.

Method: transferFrom Transfers tokens from one address to another (with prior approval).

Additional Request Body Parameters:

tokenSymbol (string): Symbol of the token.
from (string): Sender address.
to (string): Receiver address.
amount (string): Amount to transfer.

Method: transferTo Transfers tokens from signerAddress to another address.

Additional Request Body Parameters:

tokenSymbol (string): Symbol of the token.
to (string): Receiver address.
amount (string): Amount to transfer.

Method: approve Approves a spender to use tokens.

Additional Request Body Parameters:

tokenSymbol (string): Token to approve (can include BKN, USDT, USDC).
spenderAddress (string): Address being approved.
amount (string): Allowance amount.

Method: dividendDistribution Distributes paymentToken dividends to holders of tokenSymbol.

Additional Request Body Parameters:

tokenSymbol (string)
amount (string): Amount of payment token to distribute.

Note: Amounts are in whole units (e.g., 10 for 10 USDT).

Method: newSto Creates a new STO (Security Token Offering).

Additional Request Body Parameters:

tokenizerEmail (string)
tokenAmount (string)
offeringName (string)
startDate (string)
endDate (string)
acceptedCoin (string)
minRaiseUSD (string)
maxRaiseUSD (string)
minInvestment (string)
maxInvestment (string)
signerAddress (string)

POST

/

prepare-transactions

Prepare Transactions

curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "method": "newTokenization",
  "signerAddress": "0xSignerAddress",
  "tokenizerEmail": "tokenizer.email@example.com",
  "chainId": "aa36a7",
  "symbol": "BKN",
  "supplyCap": "10",
  "name": "Brickken",
  "gasLimit": "2000000 but can be omitted",
  "rpcUrl": "{URL_TO_RPC} but can be omitted"
}'

{
  "transactions": [
    {
      "from": "<string>",
      "to": "<string>",
      "value": {
        "type": "<string>",
        "hex": "<string>"
      },
      "nonce": 123,
      "chainId": 123,
      "data": "<string>",
      "type": 123,
      "maxPriorityFeePerGas": {
        "type": "<string>",
        "hex": "<string>"
      },
      "maxFeePerGas": {
        "type": "<string>",
        "hex": "<string>"
      },
      "gasLimit": {
        "type": "<string>",
        "hex": "<string>"
      }
    }
  ]
}

This endpoint prepares a new tokenization transaction. It is equivalent to using the prepare-transactions endpoint with the newTokenization method.

Request Body

The request body should include the following parameters:

{
  "method": "newTokenization",
  "tokenizerAddress": "0xB610470ae0fEa78A1B27cD3F0D4011eb5361fAf1",
  "chainId": "aa36a7",
  "rpcUrl": null,
  "url": "https://example.com/token-docs",
  "name": "Example Token",
  "tokenizerEmail": "tokenizer@example.com",
  "tokenSymbol": "EXMPL",
  "supplyCap": "1000000",
  "preMints": [],
  "initialHolders": []
}

Parameters

method (string): Must be “newTokenization”
tokenizerAddress (string): The address of the tokenizer initiating the transaction
chainId (string): The blockchain network chain ID in hex format
rpcUrl (string, optional): Optional RPC URL
url (string): URL associated with tokenization documents
name (string): The name of the token
tokenizerEmail (string): Email of the tokenizer
tokenSymbol (string): The symbol of the token (max 5 characters)
supplyCap (string): Maximum token supply cap
preMints (array): Array of pre-mint configurations
initialHolders (array): Array of initial token holders

Authorizations

x-api-key

string

header

required

Body

application/json

method

string

The operation to be performed. Possible values are newTokenization, mintToken, whitelist, burnToken, transferFrom, transferTo, approve, dividendDistribution, newSto.

Example:

"newTokenization"

signerAddress

string

The address of the user initiating the transaction.

Example:

"0xSignerAddress"

tokenizerEmail

string

The email of the user.

Example:

"tokenizer.email@example.com"

chainId

string

The blockchain network's chain ID in hexadecimal format (e.g., "aa36a7" for Sepolia testnet).

Example:

"aa36a7"

symbol

string

The token symbol (max 5 characters).

Example:

"BKN"

supplyCap

string

Max token supply.

Example:

"10"

name

string

Name of the token.

Example:

"Brickken"

gasLimit

string

An amount of gas units as limits. If not specified, it will be automatically estimated.

Example:

"2000000 but can be omitted"

rpcUrl

string

The RPC URL of the blockchain network. If not provided, a default RPC URL for the specified chain ID will be used.

Example:

"{URL_TO_RPC} but can be omitted"

Response

200 - application/json

Successful response

transactions

object[]

Show child attributes

Send Transactions Get STOs