commonPayloads.go

package aptos

import (
	"errors"
	"github.com/aptos-labs/aptos-go-sdk/bcs"
)

/**
 * The purpose of this file is to contain entry function payloads for reuse across multiple different signers.  This is
 * because FeePayer, and Multi-sig transactions will use these payloads, in addition to SingleSigner transactions
 */

// FungibleAssetPrimaryStoreTransferPayload builds an [EntryFunction] payload to transfer between two primary stores.
// This is similar to [CoinTransferPayload].
//
// Args:
//   - faMetadataAddress is the [AccountAddress] of the metadata for the fungible asset
//   - dest is the destination [AccountAddress]
//   - amount is the amount of coins to transfer
//
// Note: for now, if metadata is nil, then it will fail to build. But in the future, APT will be the default.
func FungibleAssetPrimaryStoreTransferPayload(faMetadataAddress *AccountAddress, dest AccountAddress, amount uint64) (payload *EntryFunction, err error) {
	if faMetadataAddress == nil {
		return nil, errors.New("fa metadata address is nil")
	}
	amountBytes, err := bcs.SerializeU64(amount)
	if err != nil {
		return nil, err
	}

	// Build up the associated struct tag
	structTag := &StructTag{Address: AccountOne, Module: "fungible_asset", Name: "Metadata"}
	typeTag := TypeTag{Value: structTag}

	return &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name:    "primary_fungible_store",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{typeTag},
		Args: [][]byte{
			faMetadataAddress[:],
			dest[:],
			amountBytes,
		},
	}, nil
}

// FungibleAssetTransferPayload builds an EntryFunction payload to transfer between two fungible asset stores
//
// Args:
//   - faMetadataAddress is the [AccountAddress] of the metadata for the fungible asset
//   - source is the store [AccountAddress] to transfer from
//   - dest is the destination [AccountAddress]
//   - amount is the amount of coins to transfer
//
// Note: for now, if metadata is nil, then it will fail to build. But in the future, APT will be the default
func FungibleAssetTransferPayload(faMetadataAddress *AccountAddress, source AccountAddress, dest AccountAddress, amount uint64) (payload *EntryFunction, err error) {
	if faMetadataAddress == nil {
		return nil, errors.New("fa metadata address is nil")
	}
	amountBytes, err := bcs.SerializeU64(amount)
	if err != nil {
		return nil, err
	}

	// Build up the associated struct tag
	structTag := &StructTag{Address: AccountOne, Module: "fungible_asset", Name: "FungibleStore"}
	typeTag := TypeTag{Value: structTag}

	return &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name:    "fungible_asset",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{typeTag},
		Args: [][]byte{
			faMetadataAddress[:],
			source[:],
			dest[:],
			amountBytes,
		},
	}, nil
}