SDK reference

Every call in @backburn/sdk.

backburn.swap

ts
backburn.swap({ wallet, from, to, amount, speed? })

Quote, plan, build, sign with the given signer, relay and follow. Returns the signature, amounts, fee plan, vault and rebate.

backburn.send

ts
backburn.send(signedTransaction, { mint })

Relays a transaction you built, with the mint’s vault as the rebate address.

backburn.vault

ts
backburn.vault(mint)

The mint’s vault: address, balance, live auction, totals.

backburn.plan

ts
backburn.plan(transaction, { speed })

The fee plan for a compiled transaction.

backburn.rebateUrl

ts
backburn.rebateUrl(mint, { apiKey })

The Helius URL that carries the vault as the rebate address, for senders with their own key.

Program helpers

The package also exports the program’s PDAs and instruction builders (vaultAddress(mint), openVault, startAuction, burn, routeProtocol), for burners and keepers that build their own transactions. Program lists the accounts and instructions they address.