github.com/mavryk-network/mvgo@v1.19.9/contract/fa12.go

// Copyright (c) 2020-2022 Blockwatch Data Inc.
// Author: alex@blockwatch.cc

package contract

import (
	"context"
	"encoding/json"
	"fmt"

	"github.com/mavryk-network/mvgo/codec"
	"github.com/mavryk-network/mvgo/mavryk"
	"github.com/mavryk-network/mvgo/micheline"
	"github.com/mavryk-network/mvgo/rpc"
)

// Represents a generic FA1 (tzip5) or FA1.2 (tzip7) token
type FA1Token struct {
	Address  mavryk.Address
	contract *Contract
}

func NewFA1Token(addr mavryk.Address, cli *rpc.Client) *FA1Token {
	return &FA1Token{Address: addr, contract: NewContract(addr, cli)}
}

func (t FA1Token) Contract() *Contract {
	return t.contract
}

func (t FA1Token) Equal(v FA1Token) bool {
	return t.Address.Equal(v.Address)
}

func (t FA1Token) ResolveMetadata(ctx context.Context) (*TokenMetadata, error) {
	return ResolveTokenMetadata(ctx, t.contract, mavryk.NewZ(0))
}

func (t FA1Token) GetBalance(ctx context.Context, owner mavryk.Address) (mavryk.Z, error) {
	var balance mavryk.Z
	prim, err := t.contract.RunCallback(ctx, "getBalance", micheline.NewBytes(owner.EncodePadded()))
	if err == nil {
		balance.SetBig(prim.Int)
	}
	return balance, err
}

func (t FA1Token) GetTotalSupply(ctx context.Context) (mavryk.Z, error) {
	var supply mavryk.Z
	prim, err := t.contract.RunCallback(ctx, "getTotalSupply", micheline.NewPrim(micheline.D_UNIT))
	if err == nil {
		supply.SetBig(prim.Int)
	}
	return supply, err
}

func (t FA1Token) GetAllowance(ctx context.Context, owner, spender mavryk.Address) (mavryk.Z, error) {
	var allowance mavryk.Z
	prim, err := t.contract.RunCallback(ctx, "getAllowance",
		micheline.NewPair(
			micheline.NewBytes(owner.EncodePadded()),
			micheline.NewBytes(spender.EncodePadded()),
		),
	)
	if err == nil {
		allowance.SetBig(prim.Int)
	}
	return allowance, err
}

func (t FA1Token) Approve(spender mavryk.Address, amount mavryk.Z) CallArguments {
	return NewFA1ApprovalArgs().
		Approve(spender, amount).
		WithSource(spender).
		WithDestination(t.Address)
}

func (t FA1Token) Revoke(spender mavryk.Address) CallArguments {
	return NewFA1ApprovalArgs().
		Revoke(spender).
		WithSource(spender).
		WithDestination(t.Address)
}

func (t FA1Token) Transfer(from, to mavryk.Address, amount mavryk.Z) CallArguments {
	return NewFA1TransferArgs().WithTransfer(from, to, amount).
		WithSource(from).
		WithDestination(t.Address)
}

type FA1Approval struct {
	Spender mavryk.Address `json:"spender"`
	Value   mavryk.Z       `json:"value"`
}

type FA1ApprovalArgs struct {
	TxArgs
	Approval FA1Approval `json:"approve"`
}

var _ CallArguments = (*FA1ApprovalArgs)(nil)

func NewFA1ApprovalArgs() *FA1ApprovalArgs {
	return &FA1ApprovalArgs{}
}

func (a *FA1ApprovalArgs) WithSource(addr mavryk.Address) CallArguments {
	a.Source = addr.Clone()
	return a
}

func (a *FA1ApprovalArgs) WithDestination(addr mavryk.Address) CallArguments {
	a.Destination = addr.Clone()
	return a
}

func (p *FA1ApprovalArgs) Approve(spender mavryk.Address, amount mavryk.Z) *FA1ApprovalArgs {
	p.Approval.Spender = spender.Clone()
	p.Approval.Value = amount.Clone()
	return p
}

func (p *FA1ApprovalArgs) Revoke(spender mavryk.Address) *FA1ApprovalArgs {
	p.Approval.Spender = spender.Clone()
	p.Approval.Value = mavryk.NewZ(0)
	return p
}

func (a FA1ApprovalArgs) Parameters() *micheline.Parameters {
	return &micheline.Parameters{
		Entrypoint: "approve",
		Value: micheline.NewPair(
			micheline.NewBytes(a.Approval.Spender.EncodePadded()),
			micheline.NewNat(a.Approval.Value.Big()),
		),
	}
}

func (p FA1ApprovalArgs) Encode() *codec.Transaction {
	return &codec.Transaction{
		Manager: codec.Manager{
			Source: p.Source,
		},
		Destination: p.Destination,
		Parameters:  p.Parameters(),
	}
}

type FA1Transfer struct {
	From   mavryk.Address `json:"from"`
	To     mavryk.Address `json:"to"`
	Amount mavryk.Z       `json:"value"`
}

// compatible with micheline.Value.Unmarshal()
func (t *FA1Transfer) UnmarshalJSON(data []byte) error {
	var xfer struct {
		Transfer struct {
			From   mavryk.Address `json:"from"`
			To     mavryk.Address `json:"to"`
			Amount mavryk.Z       `json:"value"`
		} `json:"transfer"`
	}
	if err := json.Unmarshal(data, &xfer); err != nil {
		return err
	}
	t.From = xfer.Transfer.From
	t.To = xfer.Transfer.To
	t.Amount = xfer.Transfer.Amount
	return nil
}

type FA1TransferArgs struct {
	TxArgs
	Transfer FA1Transfer
}

var _ CallArguments = (*FA1TransferArgs)(nil)

func NewFA1TransferArgs() *FA1TransferArgs {
	return &FA1TransferArgs{}
}

func (a *FA1TransferArgs) WithSource(addr mavryk.Address) CallArguments {
	a.Source = addr.Clone()
	return a
}

func (a *FA1TransferArgs) WithDestination(addr mavryk.Address) CallArguments {
	a.Destination = addr.Clone()
	return a
}

func (p *FA1TransferArgs) WithTransfer(from, to mavryk.Address, amount mavryk.Z) *FA1TransferArgs {
	p.Transfer.From = from.Clone()
	p.Transfer.To = to.Clone()
	p.Transfer.Amount = amount.Clone()
	return p
}

func (t FA1TransferArgs) Parameters() *micheline.Parameters {
	return &micheline.Parameters{
		Entrypoint: "transfer",
		Value: micheline.NewPair(
			micheline.NewBytes(t.Transfer.From.EncodePadded()),
			micheline.NewPair(
				micheline.NewBytes(t.Transfer.To.EncodePadded()),
				micheline.NewNat(t.Transfer.Amount.Big()),
			),
		),
	}
}

func (p FA1TransferArgs) Encode() *codec.Transaction {
	return &codec.Transaction{
		Manager: codec.Manager{
			Source: p.Source,
		},
		Destination: p.Destination,
		Parameters:  p.Parameters(),
	}
}

type FA1TransferReceipt struct {
	tx *rpc.Transaction
}

func NewFA1TransferReceipt(tx *rpc.Transaction) (*FA1TransferReceipt, error) {
	if tx.Parameters == nil {
		return nil, fmt.Errorf("missing transaction parameters")
	}
	if tx.Parameters.Entrypoint != "transfer" {
		return nil, fmt.Errorf("invalid transfer entrypoint name %q", tx.Parameters.Entrypoint)
	}
	return &FA1TransferReceipt{tx: tx}, nil
}

func (r FA1TransferReceipt) IsSuccess() bool {
	return r.tx.Result().Status.IsSuccess()
}

func (r FA1TransferReceipt) Request() FA1Transfer {
	typ := micheline.ITzip7.TypeOf("transfer")
	val := micheline.NewValue(typ, r.tx.Parameters.Value)
	xfer := FA1Transfer{}
	_ = val.Unmarshal(&xfer)
	return xfer
}

func (r FA1TransferReceipt) Result() *rpc.Transaction {
	return r.tx
}

func (r FA1TransferReceipt) Costs() mavryk.Costs {
	return r.tx.Costs()
}

func (r FA1TransferReceipt) BalanceUpdates() []TokenBalance {
	// TODO: read from ledger bigmap update
	return nil
}