Documentation
¶
Index ¶
Constants ¶
View Source
const BurnAddress = "0x0000000000000000000000000000000000000000"
BurnAddress 0x00 where tokens are sent to be removed from circulation
Variables ¶
This section is empty.
Functions ¶
func Burn ¶
func Burn( ctx context.Context, apiClient *api.APIClient, l1signer signers.L1Signer, l2signer signers.L2Signer, request GetSignableBurnRequest) (*api.CreateTransferResponseV1, error)
Burn permanently removes tokens from circulation. To burn an asset, you need to transfer the asset to the burn address. We have added burn functions in the SDK for clarity, and these are just wrappers for standard transfer functions to BurnAddress. Using the transfer functions with the burn address as a recipient will also work just the same.
Types ¶
type GetSignableBurnRequest ¶
type GetSignableBurnRequest struct {
// Amount of the token to burn
Amount string
// Ethereum address of the user
Sender string
// Token to burn
Token *api.SignableToken
}
Source Files
Click to show internal directories.
Click to hide internal directories.