kylefang/stacks-puppet-node
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-puppet-node.git synced 2026-04-28 11:46:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2782 from friedger/fix/transfer_docs

Browse Source 
Clarify difference between stx-transfer? and (n)ft-transfer?
This commit is contained in:
Aaron Blankstein
2021-08-17 08:55:37 -05:00
committed by GitHub
parent 5ba08fc697 1b0f078a4e
commit f0dcf9c79d
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/vm/docs/mod.rs
View File

@@ -1463,7 +1463,8 @@ const TOKEN_TRANSFER: SpecialAPI = SpecialAPI {
output_type: "(response bool uint)",
signature: "(ft-transfer? token-name amount sender recipient)",
description: "`ft-transfer?` is used to increase the token balance for the `recipient` principal for a token
type defined using `define-fungible-token` by debiting the `sender` principal.
type defined using `define-fungible-token` by debiting the `sender` principal. In contrast to `stx-transfer?`,
any user can transfer the assets. When used, relevant guards need to be added.
This function returns (ok true) if the transfer is successful. In the event of an unsuccessful transfer it returns
one of the following error codes:
@@ -1486,7 +1487,8 @@ const ASSET_TRANSFER: SpecialAPI = SpecialAPI {
signature: "(nft-transfer? asset-class asset-identifier sender recipient)",
description: "`nft-transfer?` is used to change the owner of an asset identified by `asset-identifier`
from `sender` to `recipient`. The `asset-class` must have been defined by `define-non-fungible-token` and `asset-identifier`
must be of the type specified in that definition.
must be of the type specified in that definition. In contrast to `stx-transfer?`, any user can transfer the asset.
When used, relevant guards need to be added.
This function returns (ok true) if the transfer is successful. In the event of an unsuccessful transfer it returns
one of the following error codes: