Skip to content

[DO NOT MERGE] Flow FT Contracts: Mainnet → Master upgrade diff #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
vishalchangrani wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[DO NOT MERGE] Flow FT Contracts: Mainnet → Master upgrade diff #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 54 additions & 19 deletions contracts/FungibleToken.cdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ access(all) contract interface FungibleToken: ViewResolver {

/// Function to ask a provider if a specific amount of tokens
/// is available to be withdrawn
/// This could be useful to avoid panicking when calling withdraw
/// This could be useful to avoid panicing when calling withdraw
/// when the balance is unknown
/// Additionally, if the provider is pulling from multiple vaults
/// it only needs to check some of the vaults until the desired amount
Expand All @@ -124,7 +124,10 @@ access(all) contract interface FungibleToken: ViewResolver {
post {
// `result` refers to the return value
result.balance == amount:
"FungibleToken.Provider.withdraw: Cannot withdraw tokens! The balance of the withdrawn tokens (\(result.balance)) is not equal to the amount requested to be withdrawn (\(amount))"
"FungibleToken.Provider.withdraw: Cannot withdraw tokens!"
.concat("The balance of the withdrawn tokens (").concat(result.balance.toString())
.concat(") is not equal to the amount requested to be withdrawn (")
.concat(amount.toString()).concat(")")
}
}
}
Expand Down Expand Up @@ -182,15 +185,12 @@ access(all) contract interface FungibleToken: ViewResolver {
/// This is to prevent vault owners from spamming fake Burned events.
access(contract) fun burnCallback() {
pre {
emit Burned(
type: self.getType().identifier,
amount: self.balance,
fromUUID: self.uuid
)
emit Burned(type: self.getType().identifier, amount: self.balance, fromUUID: self.uuid)
}
post {
self.balance == 0.0:
"FungibleToken.Vault.burnCallback: Cannot burn this `Vault` with `Burner.burn()`. The balance must be set to zero during the `burnCallback` method so that it cannot be spammed."
"FungibleToken.Vault.burnCallback: Cannot burn this Vault with Burner.burn(). "
.concat("The balance must be set to zero during the burnCallback method so that it cannot be spammed.")
}
}

Expand Down Expand Up @@ -222,17 +222,28 @@ access(all) contract interface FungibleToken: ViewResolver {
access(Withdraw) fun withdraw(amount: UFix64): @{Vault} {
pre {
self.balance >= amount:
"FungibleToken.Vault.withdraw: Cannot withdraw tokens! The amount requested to be withdrawn (\(amount)) is greater than the balance of the `Vault` (\(self.balance))."
"FungibleToken.Vault.withdraw: Cannot withdraw tokens! "
.concat("The amount requested to be withdrawn (").concat(amount.toString())
.concat(") is greater than the balance of the Vault (")
.concat(self.balance.toString()).concat(").")
}
post {
result.getType() == self.getType():
"FungibleToken.Vault.withdraw: Cannot withdraw tokens! The withdraw method tried to return an incompatible `Vault` type <\(result.getType().identifier)>. It must return a `Vault` with the same type as self <\(self.getType().identifier)>."
result.getType() == self.getType():
"FungibleToken.Vault.withdraw: Cannot withdraw tokens! "
.concat("The withdraw method tried to return an incompatible Vault type <")
.concat(result.getType().identifier).concat(">. ")
.concat("It must return a Vault with the same type as self <")
.concat(self.getType().identifier).concat(">.")

// use the special function `before` to get the value of the `balance` field
// at the beginning of the function execution
//
self.balance == before(self.balance) - amount:
"FungibleToken.Vault.withdraw: Cannot withdraw tokens! The sender's balance after the withdrawal (\(self.balance)) must be the difference of the previous balance (\(before(self.balance))) and the amount withdrawn (\(amount))"
"FungibleToken.Vault.withdraw: Cannot withdraw tokens! "
.concat("The sender's balance after the withdrawal (")
.concat(self.balance.toString())
.concat(") must be the difference of the previous balance (").concat(before(self.balance.toString()))
.concat(") and the amount withdrawn (").concat(amount.toString()).concat(")")

emit Withdrawn(
type: result.getType().identifier,
Expand All @@ -251,8 +262,14 @@ access(all) contract interface FungibleToken: ViewResolver {
// Assert that the concrete type of the deposited vault is the same
// as the vault that is accepting the deposit
pre {
from.isInstance(self.getType()):
"FungibleToken.Vault.deposit: Cannot deposit tokens! The type of the deposited tokens <\(from.getType().identifier)> has to be the same type as the `Vault` being deposited into <\(self.getType().identifier)>. Check that you are withdrawing and depositing to the correct paths in the sender and receiver accounts and that those paths hold the same `Vault` types."
from.isInstance(self.getType()):
"FungibleToken.Vault.deposit: Cannot deposit tokens! "
.concat("The type of the deposited tokens <")
.concat(from.getType().identifier)
.concat("> has to be the same type as the Vault being deposited into <")
.concat(self.getType().identifier)
.concat(">. Check that you are withdrawing and depositing to the correct paths in the sender and receiver accounts ")
.concat("and that those paths hold the same Vault types.")
}
post {
emit Deposited(
Expand All @@ -264,7 +281,11 @@ access(all) contract interface FungibleToken: ViewResolver {
balanceAfter: self.balance
)
self.balance == before(self.balance) + before(from.balance):
"FungibleToken.Vault.deposit: Cannot deposit tokens! The receiver's balance after the deposit (\(self.balance)) must be the sum of the previous balance (\(before(self.balance))) and the amount deposited (\(before(from.balance)))"
"FungibleToken.Vault.deposit: Cannot deposit tokens! "
.concat("The receiver's balance after the deposit (")
.concat(self.balance.toString())
.concat(") must be the sum of the previous balance (").concat(before(self.balance.toString()))
.concat(") and the amount deposited (").concat(before(from.balance).toString()).concat(")")
}
}

Expand All @@ -274,10 +295,17 @@ access(all) contract interface FungibleToken: ViewResolver {
access(all) fun createEmptyVault(): @{Vault} {
post {
result.balance == 0.0:
"FungibleToken.Vault.createEmptyVault: Empty `Vault` creation failed! The newly created `Vault` must have zero balance but it has a balance of \(result.balance)"
"FungibleToken.Vault.createEmptyVault: Empty Vault creation failed! "
.concat("The newly created Vault must have zero balance but it has a balance of ")
.concat(result.balance.toString())

result.getType() == self.getType():
"FungibleToken.Vault.createEmptyVault: Empty `Vault` creation failed! The type of the new `Vault` <\(result.getType().identifier)> has to be the same type as the `Vault` that created it <\(self.getType().identifier)>."
"FungibleToken.Vault.createEmptyVault: Empty Vault creation failed! "
.concat("The type of the new Vault <")
.concat(result.getType().identifier)
.concat("> has to be the same type as the Vault that created it <")
.concat(self.getType().identifier)
.concat(">.")
}
}
}
Expand All @@ -288,10 +316,17 @@ access(all) contract interface FungibleToken: ViewResolver {
access(all) fun createEmptyVault(vaultType: Type): @{FungibleToken.Vault} {
post {
result.balance == 0.0:
"FungibleToken.createEmptyVault: Empty `Vault` creation failed! The newly created `Vault` must have zero balance but it has a balance of \(result.balance)"
"FungibleToken.createEmptyVault: Empty Vault creation failed! "
.concat("The newly created Vault must have zero balance but it has a balance of (")
.concat(result.balance.toString()).concat(")")

result.getType() == vaultType:
"FungibleToken.createEmptyVault: Empty `Vault` creation failed! The type of the new `Vault` <\(result.getType().identifier)> has to be the same as the type that was requested <\(vaultType.identifier)>."
"FungibleToken.Vault.createEmptyVault: Empty Vault creation failed! "
.concat("The type of the new Vault <")
.concat(result.getType().identifier)
.concat("> has to be the same as the type that was requested <")
.concat(vaultType.identifier)
.concat(">.")
}
}
}
8 changes: 6 additions & 2 deletions contracts/FungibleTokenMetadataViews.cdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,13 @@ access(all) contract FungibleTokenMetadataViews {
) {
pre {
receiverLinkedType.isSubtype(of: Type<&{FungibleToken.Receiver}>()):
"FungibleTokenMetadataViews.FTVaultData.init: Invalid receiverLinkedType. The receiver public type <\(receiverLinkedType.identifier)> must be a subtype of <\(Type<&{FungibleToken.Receiver}>().identifier)>."
"Receiver public type <".concat(receiverLinkedType.identifier)
.concat("> must be a subtype of <").concat(Type<&{FungibleToken.Receiver}>().identifier)
.concat(">.")
metadataLinkedType.isSubtype(of: Type<&{FungibleToken.Vault}>()):
"FungibleTokenMetadataViews.FTVaultData.init: Invalid metadataLinkedType. The metadata linked type <\(metadataLinkedType.identifier)> must be a subtype of <\(Type<&{FungibleToken.Vault}>().identifier)>."
"Metadata linked type <".concat(metadataLinkedType.identifier)
.concat("> must be a subtype of <").concat(Type<&{FungibleToken.Vault}>().identifier)
.concat(">.")
}
self.storagePath = storagePath
self.receiverPath = receiverPath
Expand Down
Loading
Loading