Add built-in transferCoinTransaction() function
#20
Conversation
| /** | ||
| * Queries the count of an account's coins | ||
| * Queries the count of an account's coins aggregated | ||
| * | ||
| * @param accountAddress The account address we want to get the total count for | ||
| * @returns An object { count : number } | ||
| * @returns An object { count : number } where `number` is the aggregated count of all account's coin | ||
| */ | ||
| async getAccountCoinsCount(args: { accountAddress: HexInput }): Promise<GetAccountCoinsCountResponse> { | ||
| const count = getAccountCoinsCount({ aptosConfig: this.config, ...args }); |
There was a problem hiding this comment.
I think this query may be confusing. Is it supposed to be the number of coin types? Or combined between multiple coin types?
Let's be concrete
If I have 5 DogCoin and 7 CatCoin, would the number be:
- 2 (the number of types of coins I have)
- 12 (the aggregate number between both coins, which isn't really a useful value)
There was a problem hiding this comment.
this is an existing query in sdk v1. I believe it returns the former. can validate it in a second PR as it is not really relevant to this PR
| const txnDeserializer = new Deserializer(transaction.rawTransaction); | ||
| const rawTransaction = RawTransaction.deserialize(txnDeserializer); |
There was a problem hiding this comment.
Hmm, this is an interesting way of handling it, where you need to deserialize by passing the deserializer in. Might be interesting if we also just provide a way to deserialize the bytes directly (if you only have that).
There was a problem hiding this comment.
I believe @xbtmatt has some thoughts about it
| const recipientCoins = await aptos.getAccountCoinsData({ accountAddress: recipient.accountAddress.toString() }); | ||
| const senderCoinsAfter = await aptos.getAccountCoinsData({ accountAddress: sender.accountAddress.toString() }); |
There was a problem hiding this comment.
We may want to consider unioning HexInput with AccountAddress or only taking in AccountAddress, since this seems to be a common pattern that is being repeated around.
The wallet adapter can be less stringent probably.
There was a problem hiding this comment.
I think most users will get this data from some servers, that will return the address as a string (or in some cases as Uint8Array) - that was the thought behind accepting HexInput as an input and not force them initialize AccountAddress when they want to query for an address
| const aptos = new Aptos(config); | ||
| const sender = Account.generate({ scheme: SigningScheme.Ed25519 }); | ||
| const recipient = Account.generate({ scheme: SigningScheme.Ed25519 }); | ||
| await aptos.fundAccount({ accountAddress: sender.accountAddress.toString(), amount: 100000000 }); |
There was a problem hiding this comment.
I suggest we make these numbers constants for the test
There was a problem hiding this comment.
yes, we need a test framework. will work on it after we have full test cover to our code (not a P0 for alpha version)
src/internal/coin.ts
Outdated
| import { APTOS_COIN } from "../utils/const"; | ||
| import { generateTransaction } from "./transaction_submission"; | ||
|
|
||
| export async function transaferCoinTransaction(args: { |
There was a problem hiding this comment.
So, we can't call it just transfer because everything is unioned together on a single interface?
There was a problem hiding this comment.
in the future, we will have support for FA, NFT, Object, etc. since they all under the same namespace we can't call each transfer. we can always have each related transfer function under each namespace, but that's just confusing for the user imo.
also, I think transferCoin makes sense, as this function transfers coin
0xmaayan
force-pushed
the
transfer_coin
branch
from
0d01864
to
10b855b
Compare
Description
Adds a built in
transferCoinTransactiontoAptos.This function generates a transfer coin transaction that can be simulated and/or sign and submit. That is to have support for wallets and developers.
In addition, added a
signAndSubmitTransactionAPI function for a single signer transaction to ease the user submission flowTest Plan