burn

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 30, 2022 License: Apache-2.0 Imports: 5 Imported by: 0

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.

func GetBurn

func GetBurn(ctx context.Context, apiClient *api.APIClient, transferID string) (*api.Transfer, error)

GetBurn returns the status of the transfer given the transferID.

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
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL