filecoin

README

filecoin-sdk

Filecoin SDK is used to interact with the Filecoin blockchain, it contains various functions can be used to web3 wallet.

Installation

go get

To obtain the latest version, simply require the project using :

go get -u github.com/okx/go-wallet-sdk/coins/filecoin

Usage

New Address

	privateKeyHex := "0x7c6207c56b6aa5ed4345c5f662816408e273cbdf64e2f01d54ced0125d6172c2"
	address, err := GetAddressByPrivateKey(privateKeyHex, MainnetPrefix)
	if err != nil {
		// todo
	}

Transfer

	from := "f1bh3d2y6xxugpg3ygzxnjhcrs5ffxh5nvqmanbia"
	to := "f1fvs2fjqr6ozk477zkwzvermhledmfkswt34cmhi"
	nonce := 0
	value := big.NewInt(20000000000000000)
	gasLimit := 210000
	gasFeeCap := big.NewInt(9455791480)
	gasPremium := big.NewInt(120242)
	method := 0
	message := NewTx(from, to, nonce, method, gasLimit, value, gasFeeCap, gasPremium)
	privateKeyHex := "0x7c6207c56b6aa5ed4345c5f662816408e273cbdf64e2f01d54ced0125d6172c2"
	tx, err := SignTx(message, privateKeyHex)
	if err != nil {
		// todo
	}

License

Most packages or folder are MIT licensed, see package or folder for the respective license.

Documentation

Index

• Constants
• Variables
• func AddressToBytes(addr string) []byte
• func GetAddressByPrivateKey(privateKeyHex string, chainId string) (string, error)
• func GetAddressByPublicKey(publicKeyHex string, chainId string) (string, error)
• func GetPublicKey(privateKeyHex string) (string, error)
• func NewPrivateKey() string
• func SignedTx(message *Message, signHex string) (string, error)
• type BigInt
  • func (bn BigInt) Bytes() []byte
  • func (bn BigInt) MarshalJSON() ([]byte, error)
• type Message
  • func NewTx(from, to string, nonce, method, gasLimit int, ...) *Message
  • func (m *Message) Hash() []byte
  • func (m *Message) Serialize() []byte
• type Signature
• type SignedMessage
  • func SignTx(message *Message, privateKeyHex string) (*SignedMessage, error)

Constants

const (
	MainnetPrefix = "f"
	TestnetPrefix = "t"
)

const (
	ID byte = iota
	SECP256K1
	Actor
	BLS
)

Variables

var (
	AddressEncoding = base32.NewEncoding(encodeStd)
)

Functions

func AddressToBytes

func AddressToBytes(addr string) []byte

func GetAddressByPrivateKey

func GetAddressByPrivateKey(privateKeyHex string, chainId string) (string, error)

func GetAddressByPublicKey

func GetAddressByPublicKey(publicKeyHex string, chainId string) (string, error)

func GetPublicKey

func GetPublicKey(privateKeyHex string) (string, error)

func NewPrivateKey

func NewPrivateKey() string

func SignedTx

func SignedTx(message *Message, signHex string) (string, error)

Types

type BigInt

type BigInt big.Int

func (BigInt) Bytes

func (bn BigInt) Bytes() []byte

func (BigInt) MarshalJSON

func (bn BigInt) MarshalJSON() ([]byte, error)

type Message

type Message struct {
	Version    uint64  `json:"Version"`
	To         string  `json:"To"`
	From       string  `json:"From"`
	Nonce      uint64  `json:"Nonce"`
	Value      *BigInt `json:"Value"`
	GasLimit   int64   `json:"GasLimit"`
	GasFeeCap  *BigInt `json:"GasFeeCap"`
	GasPremium *BigInt `json:"GasPremium"`
	Method     uint64  `json:"Method"`
	Params     []byte  `json:"Params"`
}

func NewTx

func NewTx(from, to string, nonce, method, gasLimit int, value, gasFeeCap, gasPremium *big.Int) *Message

func (*Message) Hash

func (m *Message) Hash() []byte

func (*Message) Serialize

func (m *Message) Serialize() []byte

type Signature

type Signature struct {
	Type byte
	Data []byte
}

type SignedMessage

type SignedMessage struct {
	Message   *Message  `json:"Message"`
	Signature Signature `json:"Signature"`
}

func SignTx

func SignTx(message *Message, privateKeyHex string) (*SignedMessage, error)