From aeded2f0eb39b9412a738eb8ae545d3131ba8960 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Thu, 7 Mar 2024 15:46:45 -0600 Subject: [PATCH 01/25] add Serialize util contract to support URL encoding serialized metadata --- cadence/contracts/utils/Serialize.cdc | 150 ++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 cadence/contracts/utils/Serialize.cdc diff --git a/cadence/contracts/utils/Serialize.cdc b/cadence/contracts/utils/Serialize.cdc new file mode 100644 index 00000000..441f61da --- /dev/null +++ b/cadence/contracts/utils/Serialize.cdc @@ -0,0 +1,150 @@ +/// This contract is a utility for serializing primitive types, arrays, and common metadata mapping formats to JSON +/// compatible strings. Also included are interfaces enabling custom serialization for structs and resources. +/// +/// Special thanks to @austinkline for the idea and initial implementation. +/// +access(all) +contract Serialize { + + /// Defines the interface for a struct that returns a serialized representation of itself + /// + access(all) + struct interface SerializableStruct { + access(all) fun serialize(): String + } + + /// Defines the interface for a resource that returns a serialized representation of itself + /// + access(all) + resource interface SerializableResource { + access(all) fun serialize(): String + } + + /// Method that returns a serialized representation of the given value or nil if the value is not serializable + /// + access(all) + fun tryToString(_ value: AnyStruct): String? { + // Call serialize on the value if available + if value.getType().isSubtype(of: Type<{SerializableStruct}>()) { + return (value as! {SerializableStruct}).serialize() + } + // Recursively serialize array & return + if value.getType().isSubtype(of: Type<[AnyStruct]>()) { + return self.arrayToString(value as! [AnyStruct]) + } + // Recursively serialize map & return + if value.getType().isSubtype(of: Type<{String: AnyStruct}>()) { + return self.mapToString(value as! {String: AnyStruct}) + } + // Handle primitive types & their respective optionals + switch value.getType() { + case Type(): + return value as! String + case Type(): + return value as? String ?? "nil" + case Type(): + return (value as! Character).toString() + case Type(): + return (value as? Character)?.toString() ?? "nil" + case Type(): + return self.boolToString(value as! Bool) + case Type(): + if value as? Bool == nil { + return "nil" + } + return self.boolToString(value as! Bool) + case Type
(): + return (value as! Address).toString() + case Type(): + return (value as? Address)?.toString() ?? "nil" + case Type(): + return (value as! Int8).toString() + case Type(): + return (value as! Int16).toString() + case Type(): + return (value as! Int32).toString() + case Type(): + return (value as! Int64).toString() + case Type(): + return (value as! Int128).toString() + case Type(): + return (value as! Int256).toString() + case Type(): + return (value as! Int).toString() + case Type(): + return (value as! UInt8).toString() + case Type(): + return (value as! UInt16).toString() + case Type(): + return (value as! UInt32).toString() + case Type(): + return (value as! UInt64).toString() + case Type(): + return (value as! UInt128).toString() + case Type(): + return (value as! UInt256).toString() + case Type(): + return (value as! Word8).toString() + case Type(): + return (value as! Word16).toString() + case Type(): + return (value as! Word32).toString() + case Type(): + return (value as! Word64).toString() + case Type(): + return (value as! Word128).toString() + case Type(): + return (value as! Word256).toString() + case Type(): + return (value as! UFix64).toString() + default: + return nil + } + } + + /// Method that returns a serialized representation of a provided boolean + /// + access(all) + fun boolToString(_ value: Bool): String { + return value ? "true" : "false" + } + + /// Method that returns a serialized representation of the given array or nil if the value is not serializable + /// + access(all) + fun arrayToString(_ arr: [AnyStruct]): String? { + var serializedArr = "[" + for i, element in arr { + let serializedElement = self.tryToString(element) + if serializedElement == nil { + return nil + } + serializedArr = serializedArr.concat("\"").concat(serializedElement!).concat("\"") + if i < arr.length - 1 { + serializedArr = serializedArr.concat(", ") + } + } + serializedArr.concat("]") + return serializedArr + } + + /// Method that returns a serialized representation of the given String-indexed mapping or nil if the value is not + /// serializable + /// + access(all) + fun mapToString(_ map: {String: AnyStruct}): String? { + var serializedMap = "{" + for i, key in map.keys { + let serializedValue = self.tryToString(map[key]!) + if serializedValue == nil { + return nil + } + serializedMap = serializedMap.concat("\"").concat(key).concat("\": \"").concat(serializedValue!).concat("\"}") + if i < map.length - 1 { + serializedMap = serializedMap.concat(", ") + } + } + serializedMap.concat("}") + return serializedMap + } +} From f07dd22ea45a8cffc97838fc75bfb804506d5fcc Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Thu, 7 Mar 2024 20:44:38 -0600 Subject: [PATCH 02/25] update Serialize util contract --- cadence/contracts/utils/Serialize.cdc | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/cadence/contracts/utils/Serialize.cdc b/cadence/contracts/utils/Serialize.cdc index 441f61da..9ec9beaa 100644 --- a/cadence/contracts/utils/Serialize.cdc +++ b/cadence/contracts/utils/Serialize.cdc @@ -34,7 +34,7 @@ contract Serialize { } // Recursively serialize map & return if value.getType().isSubtype(of: Type<{String: AnyStruct}>()) { - return self.mapToString(value as! {String: AnyStruct}) + return self.dictToString(dict: value as! {String: AnyStruct}, excludedNames: nil) } // Handle primitive types & their respective optionals switch value.getType() { @@ -132,19 +132,24 @@ contract Serialize { /// serializable /// access(all) - fun mapToString(_ map: {String: AnyStruct}): String? { - var serializedMap = "{" - for i, key in map.keys { - let serializedValue = self.tryToString(map[key]!) + fun dictToString(dict: {String: AnyStruct}, excludedNames: [String]?): String? { + if excludedNames != nil { + for k in excludedNames! { + dict.remove(key: k) + } + } + var serializedDict = "{" + for i, key in dict.keys { + let serializedValue = self.tryToString(dict[key]!) if serializedValue == nil { return nil } - serializedMap = serializedMap.concat("\"").concat(key).concat("\": \"").concat(serializedValue!).concat("\"}") - if i < map.length - 1 { - serializedMap = serializedMap.concat(", ") + serializedDict = serializedDict.concat("\"").concat(key).concat("\": \"").concat(serializedValue!).concat("\"}") + if i < dict.length - 1 { + serializedDict = serializedDict.concat(", ") } } - serializedMap.concat("}") - return serializedMap + serializedDict.concat("}") + return serializedDict } } From 324ddb0e61fc9035c2b28c440ace0c1396348dbe Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:12:08 -0500 Subject: [PATCH 03/25] add Serialize test cases --- cadence/contracts/utils/Serialize.cdc | 12 +- cadence/tests/Serialize_tests.cdc | 212 ++++++++++++++++++++++++++ flow.json | 7 + 3 files changed, 230 insertions(+), 1 deletion(-) create mode 100644 cadence/tests/Serialize_tests.cdc diff --git a/cadence/contracts/utils/Serialize.cdc b/cadence/contracts/utils/Serialize.cdc index 9ec9beaa..a6f3ccf7 100644 --- a/cadence/contracts/utils/Serialize.cdc +++ b/cadence/contracts/utils/Serialize.cdc @@ -38,6 +38,8 @@ contract Serialize { } // Handle primitive types & their respective optionals switch value.getType() { + case Type(): + return "nil" case Type(): return value as! String case Type(): @@ -83,6 +85,8 @@ contract Serialize { return (value as! UInt128).toString() case Type(): return (value as! UInt256).toString() + case Type(): + return (value as! UInt).toString() case Type(): return (value as! Word8).toString() case Type(): @@ -102,6 +106,11 @@ contract Serialize { } } + access(all) + fun tryToJSONString(_ value: AnyStruct): String? { + return "\"".concat(self.tryToString(value) ?? "nil").concat("\"") + } + /// Method that returns a serialized representation of a provided boolean /// access(all) @@ -129,7 +138,8 @@ contract Serialize { } /// Method that returns a serialized representation of the given String-indexed mapping or nil if the value is not - /// serializable + /// serializable. The interface here is largely the same as as the `MetadataViews.dictToTraits` method, though here + /// a JSON-compatible String is returned instead of a `Traits` array. /// access(all) fun dictToString(dict: {String: AnyStruct}, excludedNames: [String]?): String? { diff --git a/cadence/tests/Serialize_tests.cdc b/cadence/tests/Serialize_tests.cdc new file mode 100644 index 00000000..c01aa00f --- /dev/null +++ b/cadence/tests/Serialize_tests.cdc @@ -0,0 +1,212 @@ +import Test +import BlockchainHelpers + +import "Serialize" + +access(all) +let serializeAccount = Test.getAccount(0x0000000000000007) + +access(all) +fun setup() { + var err = Test.deployContract( + name: "Serialize", + path: "../contracts/utils/Serialize.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) +} + +access(all) +fun testIntsTryToJSONStringSucceeds() { + let i: Int = 127 + let i8: Int8 = 127 + let i16: Int16 = 127 + let i32: Int32 = 127 + let i64: Int64 = 127 + let i128: Int128 = 127 + let i256: Int256 = 127 + + let expected = "\"127\"" + + var actual = Serialize.tryToJSONString(i) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(i8) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(i16) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(i32) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(i64) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(i128) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(i256) + Test.assertEqual(expected, actual!) +} + +access(all) +fun testUIntsTryToJSONStringSucceeds() { + let ui: UInt = 255 + let ui8: UInt8 = 255 + let ui16: UInt16 = 255 + let ui32: UInt32 = 255 + let ui64: UInt64 = 255 + let ui128: UInt128 = 255 + let ui256: UInt256 = 255 + + let expected = "\"255\"" + + var actual = Serialize.tryToJSONString(ui) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(ui8) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(ui16) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(ui32) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(ui64) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(ui128) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(ui256) + Test.assertEqual(expected, actual!) +} + +access(all) +fun testWordsTryToJSONStringSucceeds() { + let word8: Word8 = 255 + let word16: Word16 = 255 + let word32: Word32 = 255 + let word64: Word64 = 255 + let word128: Word128 = 255 + let word256: Word256 = 255 + + let expected = "\"255\"" + + var actual = Serialize.tryToJSONString(word8) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(word16) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(word32) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(word64) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(word128) + Test.assertEqual(expected, actual!) + + actual = Serialize.tryToJSONString(word256) + Test.assertEqual(expected, actual!) +} + +access(all) +fun testAddressTryToJSONStringSucceeds() { + let address: Address = 0x0000000000000007 + let addressOpt: Address? = nil + + let expected = "\"0x0000000000000007\"" + let expectedOpt = "\"nil\"" + + var actual = Serialize.tryToJSONString(address) + Test.assertEqual(expected, actual!) + + var actualOpt = Serialize.tryToJSONString(addressOpt) + Test.assertEqual(expectedOpt, actualOpt!) +} + +access(all) +fun testStringTryToJSONStringSucceeds() { + let str: String = "Hello, World!" + let strOpt: String? = nil + + let expected = "\"Hello, World!\"" + let expectedOpt = "\"nil\"" + + var actual = Serialize.tryToJSONString(str) + Test.assertEqual(expected, actual!) + + var actualOpt = Serialize.tryToJSONString(strOpt) + Test.assertEqual(expectedOpt, actualOpt!) +} + +access(all) +fun testCharacterTryToJSONStringSucceeds() { + let char: Character = "c" + let charOpt: Character? = nil + + let expected = "\"c\"" + let expectedOpt = "\"nil\"" + + var actual = Serialize.tryToJSONString(char) + Test.assertEqual(expected, actual!) + + var actualOpt = Serialize.tryToJSONString(charOpt) + Test.assertEqual(expectedOpt, actualOpt!) +} + +access(all) +fun testUFix64TryToJSONStringSucceeds() { + let uf64: UFix64 = UFix64.max + + let expected = "\"184467440737.09551615\"" + + var actual = Serialize.tryToJSONString(uf64) + Test.assertEqual(expected, actual!) +} + +access(all) +fun testBoolTryToJSONStringSucceeds() { + let t: Bool = true + let f: Bool = false + + let expectedTrue = "\"true\"" + let expectedFalse = "\"false\"" + + var actualTrue = Serialize.tryToJSONString(t) + var actualFalse = Serialize.tryToJSONString(f) + + Test.assertEqual(expectedTrue, actualTrue!) + Test.assertEqual(expectedFalse, actualFalse!) +} + +access(all) +fun testBoolToStringSucceeds() { + let t: Bool = true + let f: Bool = false + + let expectedTrue = "true" + let expectedFalse = "false" + + var actualTrue = Serialize.boolToString(t) + var actualFalse = Serialize.boolToString(f) + + Test.assertEqual(expectedTrue, actualTrue) + Test.assertEqual(expectedFalse, actualFalse) +} + +// access(all) +// fun testArrayToStringSucceeds() { +// let arr: [AnyStruct] = + +// let expected = "\"true\"" + +// var actual = Serialize.tryToJSONString(t) + +// Test.assertEqual(expectedTrue, actualTrue!) +// Test.assertEqual(expectedFalse, actualFalse!) +// } \ No newline at end of file diff --git a/flow.json b/flow.json index 9562450d..ff11de22 100644 --- a/flow.json +++ b/flow.json @@ -143,6 +143,13 @@ "emulator": "f8d6e0586b0a20c7" } }, + "Serialize": { + "source": "./cadence/contracts/utils/Serialize.cdc", + "aliases": { + "emulator": "f8d6e0586b0a20c7", + "testing": "0000000000000007" + } + }, "StringUtils": { "source": "./cadence/contracts/utils/StringUtils.cdc", "aliases": { From 8878a769d4990be8751d31abcb176e35fed36f0c Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:33:25 -0500 Subject: [PATCH 04/25] fix array serialization --- cadence/contracts/utils/Serialize.cdc | 3 +-- cadence/tests/Serialize_tests.cdc | 26 +++++++++++++++++--------- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/cadence/contracts/utils/Serialize.cdc b/cadence/contracts/utils/Serialize.cdc index a6f3ccf7..52c6c1d1 100644 --- a/cadence/contracts/utils/Serialize.cdc +++ b/cadence/contracts/utils/Serialize.cdc @@ -133,8 +133,7 @@ contract Serialize { serializedArr = serializedArr.concat(", ") } } - serializedArr.concat("]") - return serializedArr + return serializedArr.concat("]") } /// Method that returns a serialized representation of the given String-indexed mapping or nil if the value is not diff --git a/cadence/tests/Serialize_tests.cdc b/cadence/tests/Serialize_tests.cdc index c01aa00f..3a7ad0f5 100644 --- a/cadence/tests/Serialize_tests.cdc +++ b/cadence/tests/Serialize_tests.cdc @@ -199,14 +199,22 @@ fun testBoolToStringSucceeds() { Test.assertEqual(expectedFalse, actualFalse) } -// access(all) -// fun testArrayToStringSucceeds() { -// let arr: [AnyStruct] = +access(all) +fun testArrayToJSONStringSucceeds() { + let arr: [AnyStruct] = [ + 127, + 255, + "Hello, World!", + "c", + Address(0x0000000000000007), + UFix64.max, + true + ] -// let expected = "\"true\"" - -// var actual = Serialize.tryToJSONString(t) + let expected = "[\"127\", \"255\", \"Hello, World!\", \"c\", \"0x0000000000000007\", \"184467440737.09551615\", \"true\"]" -// Test.assertEqual(expectedTrue, actualTrue!) -// Test.assertEqual(expectedFalse, actualFalse!) -// } \ No newline at end of file + var actual = Serialize.arrayToString(arr) + + Test.assertEqual(expected, actual!) +} + From 98e50a9f0f1650c5016a81cdb449f15e2f1ca991 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Fri, 15 Mar 2024 18:37:00 -0500 Subject: [PATCH 05/25] update ExampleNFT Traits for serialization testability --- cadence/contracts/example-assets/ExampleNFT.cdc | 4 ---- 1 file changed, 4 deletions(-) diff --git a/cadence/contracts/example-assets/ExampleNFT.cdc b/cadence/contracts/example-assets/ExampleNFT.cdc index 6ae33b52..61f57017 100644 --- a/cadence/contracts/example-assets/ExampleNFT.cdc +++ b/cadence/contracts/example-assets/ExampleNFT.cdc @@ -109,10 +109,6 @@ access(all) contract ExampleNFT: NonFungibleToken { let excludedTraits = ["mintedTime", "foo"] let traitsView = MetadataViews.dictToTraits(dict: self.metadata, excludedNames: excludedTraits) - // mintedTime is a unix timestamp, we should mark it with a displayType so platforms know how to show it. - let mintedTimeTrait = MetadataViews.Trait(name: "mintedTime", value: self.metadata["mintedTime"]!, displayType: "Date", rarity: nil) - traitsView.addTrait(mintedTimeTrait) - // foo is a trait with its own rarity let fooTraitRarity = MetadataViews.Rarity(score: 10.0, max: 100.0, description: "Common") let fooTrait = MetadataViews.Trait(name: "foo", value: self.metadata["foo"], displayType: nil, rarity: fooTraitRarity) From 487fce7d4d46834d91aab838976f55cd2d209da1 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 15:45:05 -0500 Subject: [PATCH 06/25] update serialization utils & tests --- .gitignore | 5 + .../utils/SerializationInterfaces.cdc | 30 +++ cadence/contracts/utils/Serialize.cdc | 141 +++++++------ cadence/contracts/utils/SerializeNFT.cdc | 185 ++++++++++++++++++ cadence/scripts/serialize/serialize_nft.cdc | 20 ++ .../serialize_nft_from_open_sea_strategy.cdc | 21 ++ cadence/tests/Serialize_tests.cdc | 109 ++++++++--- cadence/tests/serialize_nft_tests.cdc | 130 ++++++++++++ flow.json | 25 ++- 9 files changed, 564 insertions(+), 102 deletions(-) create mode 100644 cadence/contracts/utils/SerializationInterfaces.cdc create mode 100644 cadence/contracts/utils/SerializeNFT.cdc create mode 100644 cadence/scripts/serialize/serialize_nft.cdc create mode 100644 cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc create mode 100644 cadence/tests/serialize_nft_tests.cdc diff --git a/.gitignore b/.gitignore index 6a3b4a5c..0a5466db 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,9 @@ docs/ # Dotenv file .env +# flow-evm-gateway db/ files db/ + +# Cadence test framework coverage +coverage.json +coverage.lcov diff --git a/cadence/contracts/utils/SerializationInterfaces.cdc b/cadence/contracts/utils/SerializationInterfaces.cdc new file mode 100644 index 00000000..667982a5 --- /dev/null +++ b/cadence/contracts/utils/SerializationInterfaces.cdc @@ -0,0 +1,30 @@ +/// The contract defines an interface for serialization strategies that can be used to serialize the struct or resource +/// according to a specific format. +/// +access(all) contract SerializationInterfaces { + + /// A SerializationStrategy takes a reference to a SerializableResource or SerializableStruct and returns a + /// serialized representation of it. The strategy is responsible for determining the structure of the serialized + /// representation and the format of the serialized data. + /// + access(all) + struct interface SerializationStrategy { + /// Returns the types supported by the implementing strategy + /// + access(all) view fun getSupportedTypes(): [Type] { + return [] + } + + /// Returns serialized representation of the given resource according to the format of the implementing strategy + /// + access(all) fun serializeResource(_ r: &AnyResource): String? { + return nil + } + + /// Returns serialized representation of the given struct according to the format of the implementing strategy + /// + access(all) fun serializeStruct(_ s: AnyStruct): String? { + return nil + } + } +} diff --git a/cadence/contracts/utils/Serialize.cdc b/cadence/contracts/utils/Serialize.cdc index 52c6c1d1..9c73f430 100644 --- a/cadence/contracts/utils/Serialize.cdc +++ b/cadence/contracts/utils/Serialize.cdc @@ -1,3 +1,9 @@ +import "ViewResolver" +import "MetadataViews" +import "NonFungibleToken" + +import "SerializationInterfaces" + /// This contract is a utility for serializing primitive types, arrays, and common metadata mapping formats to JSON /// compatible strings. Also included are interfaces enabling custom serialization for structs and resources. /// @@ -6,129 +12,115 @@ access(all) contract Serialize { - /// Defines the interface for a struct that returns a serialized representation of itself + /// A basic serialization strategy that supports serializing resources and structs to JSON-compatible strings. /// access(all) - struct interface SerializableStruct { - access(all) fun serialize(): String - } - - /// Defines the interface for a resource that returns a serialized representation of itself - /// - access(all) - resource interface SerializableResource { - access(all) fun serialize(): String + struct JSONStringStrategy : SerializationInterfaces.SerializationStrategy { + /// Returns the types this stategy will attempt to serialize + /// + access(all) view fun getSupportedTypes(): [Type] { + return [Type<@AnyResource>(), Type()] + } + /// Returns the resource serialized on its identifier as an escaped JSON string + /// + access(all) fun serializeResource(_ r: &AnyResource): String? { + return Serialize.tryToJSONString(r.getType().identifier) + } + /// Returns the an escaped JSON string of the provided struct, calling through to Serialize.tryToJSONString + /// with the provided value + /// + access(all) fun serializeStruct(_ s: AnyStruct): String? { + return Serialize.tryToJSONString(s) + } } /// Method that returns a serialized representation of the given value or nil if the value is not serializable /// access(all) - fun tryToString(_ value: AnyStruct): String? { - // Call serialize on the value if available - if value.getType().isSubtype(of: Type<{SerializableStruct}>()) { - return (value as! {SerializableStruct}).serialize() - } + fun tryToJSONString(_ value: AnyStruct): String? { // Recursively serialize array & return if value.getType().isSubtype(of: Type<[AnyStruct]>()) { - return self.arrayToString(value as! [AnyStruct]) + return self.arrayToJSONString(value as! [AnyStruct]) } // Recursively serialize map & return if value.getType().isSubtype(of: Type<{String: AnyStruct}>()) { - return self.dictToString(dict: value as! {String: AnyStruct}, excludedNames: nil) + return self.dictToJSONString(dict: value as! {String: AnyStruct}, excludedNames: nil) } - // Handle primitive types & their respective optionals + // Handle primitive types & optionals switch value.getType() { case Type(): - return "nil" + return "\"nil\"" case Type(): - return value as! String + return "\"".concat(value as! String).concat("\"") case Type(): - return value as? String ?? "nil" + return "\"".concat(value as? String ?? "nil").concat("\"") case Type(): - return (value as! Character).toString() - case Type(): - return (value as? Character)?.toString() ?? "nil" + return "\"".concat((value as! Character).toString()).concat("\"") case Type(): - return self.boolToString(value as! Bool) - case Type(): - if value as? Bool == nil { - return "nil" - } - return self.boolToString(value as! Bool) + return "\"".concat(value as! Bool ? "true" : "false").concat("\"") case Type
(): - return (value as! Address).toString() + return "\"".concat((value as! Address).toString()).concat("\"") case Type(): - return (value as? Address)?.toString() ?? "nil" + return "\"".concat((value as? Address)?.toString() ?? "nil").concat("\"") case Type(): - return (value as! Int8).toString() + return "\"".concat((value as! Int8).toString()).concat("\"") case Type(): - return (value as! Int16).toString() + return "\"".concat((value as! Int16).toString()).concat("\"") case Type(): - return (value as! Int32).toString() + return "\"".concat((value as! Int32).toString()).concat("\"") case Type(): - return (value as! Int64).toString() + return "\"".concat((value as! Int64).toString()).concat("\"") case Type(): - return (value as! Int128).toString() + return "\"".concat((value as! Int128).toString()).concat("\"") case Type(): - return (value as! Int256).toString() + return "\"".concat((value as! Int256).toString()).concat("\"") case Type(): - return (value as! Int).toString() + return "\"".concat((value as! Int).toString()).concat("\"") case Type(): - return (value as! UInt8).toString() + return "\"".concat((value as! UInt8).toString()).concat("\"") case Type(): - return (value as! UInt16).toString() + return "\"".concat((value as! UInt16).toString()).concat("\"") case Type(): - return (value as! UInt32).toString() + return "\"".concat((value as! UInt32).toString()).concat("\"") case Type(): - return (value as! UInt64).toString() + return "\"".concat((value as! UInt64).toString()).concat("\"") case Type(): - return (value as! UInt128).toString() + return "\"".concat((value as! UInt128).toString()).concat("\"") case Type(): - return (value as! UInt256).toString() + return "\"".concat((value as! UInt256).toString()).concat("\"") case Type(): - return (value as! UInt).toString() + return "\"".concat((value as! UInt).toString()).concat("\"") case Type(): - return (value as! Word8).toString() + return "\"".concat((value as! Word8).toString()).concat("\"") case Type(): - return (value as! Word16).toString() + return "\"".concat((value as! Word16).toString()).concat("\"") case Type(): - return (value as! Word32).toString() + return "\"".concat((value as! Word32).toString()).concat("\"") case Type(): - return (value as! Word64).toString() + return "\"".concat((value as! Word64).toString()).concat("\"") case Type(): - return (value as! Word128).toString() + return "\"".concat((value as! Word128).toString()).concat("\"") case Type(): - return (value as! Word256).toString() + return "\"".concat((value as! Word256).toString()).concat("\"") case Type(): - return (value as! UFix64).toString() + return "\"".concat((value as! UFix64).toString()).concat("\"") default: return nil } - } - access(all) - fun tryToJSONString(_ value: AnyStruct): String? { - return "\"".concat(self.tryToString(value) ?? "nil").concat("\"") - } - - /// Method that returns a serialized representation of a provided boolean - /// - access(all) - fun boolToString(_ value: Bool): String { - return value ? "true" : "false" } - /// Method that returns a serialized representation of the given array or nil if the value is not serializable + /// Returns a serialized representation of the given array or nil if the value is not serializable /// access(all) - fun arrayToString(_ arr: [AnyStruct]): String? { + fun arrayToJSONString(_ arr: [AnyStruct]): String? { var serializedArr = "[" for i, element in arr { - let serializedElement = self.tryToString(element) + let serializedElement = self.tryToJSONString(element) if serializedElement == nil { return nil } - serializedArr = serializedArr.concat("\"").concat(serializedElement!).concat("\"") + serializedArr = serializedArr.concat(serializedElement!) if i < arr.length - 1 { serializedArr = serializedArr.concat(", ") } @@ -136,12 +128,12 @@ contract Serialize { return serializedArr.concat("]") } - /// Method that returns a serialized representation of the given String-indexed mapping or nil if the value is not - /// serializable. The interface here is largely the same as as the `MetadataViews.dictToTraits` method, though here + /// Returns a serialized representation of the given String-indexed mapping or nil if the value is not serializable. + /// The interface here is largely the same as as the `MetadataViews.dictToTraits` method, though here /// a JSON-compatible String is returned instead of a `Traits` array. /// access(all) - fun dictToString(dict: {String: AnyStruct}, excludedNames: [String]?): String? { + fun dictToJSONString(dict: {String: AnyStruct}, excludedNames: [String]?): String? { if excludedNames != nil { for k in excludedNames! { dict.remove(key: k) @@ -149,16 +141,15 @@ contract Serialize { } var serializedDict = "{" for i, key in dict.keys { - let serializedValue = self.tryToString(dict[key]!) + let serializedValue = self.tryToJSONString(dict[key]!) if serializedValue == nil { return nil } - serializedDict = serializedDict.concat("\"").concat(key).concat("\": \"").concat(serializedValue!).concat("\"}") + serializedDict = serializedDict.concat(self.tryToJSONString(key)!).concat(": ").concat(serializedValue!) if i < dict.length - 1 { serializedDict = serializedDict.concat(", ") } } - serializedDict.concat("}") - return serializedDict + return serializedDict.concat("}") } } diff --git a/cadence/contracts/utils/SerializeNFT.cdc b/cadence/contracts/utils/SerializeNFT.cdc new file mode 100644 index 00000000..4b36a643 --- /dev/null +++ b/cadence/contracts/utils/SerializeNFT.cdc @@ -0,0 +1,185 @@ +import "ViewResolver" +import "MetadataViews" +import "NonFungibleToken" + +import "SerializationInterfaces" +import "Serialize" + +/// This contract defines methods for serializing NFT metadata as a JSON compatible string, according to the common +/// OpenSea metadata format. NFTs can be serialized by reference via contract methods or via the +/// OpenSeaMetadataSerializationStrategy struct. +/// +access(all) contract SerializeNFT { + + /// This struct will serialize NFT metadata as a JSON-compatible URI according to the OpenSea metadata standard + /// + access(all) + struct OpenSeaMetadataSerializationStrategy : SerializationInterfaces.SerializationStrategy { + /// Returns the types this strategy is intended to serialize + /// + access(all) view fun getSupportedTypes(): [Type] { + return [ + Type<@{NonFungibleToken.NFT}>(), + Type(), + Type(), + Type() + ] + } + + /// Serializes the given NFT (as &AnyResource) as a JSON compatible string in the format of an + /// OpenSea-compatible metadata URI. If the given resource is not an NFT, this method returns nil. + /// + /// Reference: https://docs.opensea.io/docs/metadata-standards + /// + access(all) fun serializeResource(_ r: &AnyResource): String? { + if r.getType().isSubtype(of: Type<@{NonFungibleToken.NFT}>()) { + let nft = r as! &{NonFungibleToken.NFT} + return SerializeNFT.serializeNFTMetadataAsURI(nft) + } + return nil + } + + /// Serializes the given struct as a JSON compatible string in the format that conforms with overlapping values + /// expected by the OpenSea metadata standard. If the given struct is not a Display, NFTCollectionDisplay, or + /// Traits view, this method returns nil. + /// + access(all) fun serializeStruct(_ s: AnyStruct): String? { + switch s.getType() { + case Type(): + let view = s as! MetadataViews.NFTCollectionDisplay + return SerializeNFT.serializeNFTDisplay(nftDisplay: nil, collectionDisplay: view) + case Type(): + let view = s as! MetadataViews.Display + return SerializeNFT.serializeNFTDisplay(nftDisplay: view, collectionDisplay: nil) + case Type(): + let view = s as! MetadataViews.Traits + return SerializeNFT.serializeNFTTraitsAsAttributes(view) + default: + return nil + + } + } + } + + /// Serializes the metadata (as a JSON compatible String) for a given NFT according to formats expected by EVM + /// platforms like OpenSea. If you are a project owner seeking to expose custom traits on bridged NFTs and your + /// Trait.value is not natively serializable, you can implement a custom serialization method with the + /// `{SerializableStruct}` interface's `serialize` method. + /// + /// Reference: https://docs.opensea.io/docs/metadata-standards + /// + /// + /// @returns: A JSON compatible string containing the serialized display & collection display views as: + /// `{ + /// \"name\": \"\", + /// \"description\": \"\", + /// \"image\": \"\", + /// \"external_url\": \"\", + /// \"attributes\": [{\"trait_type\": \"\", \"value\": \"\"}, {...}] + /// }` + access(all) + fun serializeNFTMetadataAsURI(_ nft: &{NonFungibleToken.NFT}): String { + // Serialize the display values from the NFT's Display & NFTCollectionDisplay views + let nftDisplay = nft.resolveView(Type()) as! MetadataViews.Display? + let collectionDisplay = nft.resolveView(Type()) as! MetadataViews.NFTCollectionDisplay? + let display = self.serializeNFTDisplay(nftDisplay: nftDisplay, collectionDisplay: collectionDisplay) + + // Get the Traits view from the NFT, returning early if no traits are found + let traits = nft.resolveView(Type()) as! MetadataViews.Traits? + let attributes = self.serializeNFTTraitsAsAttributes(traits ?? MetadataViews.Traits([])) + + // Return an empty string if nothing is serializable + if display == nil && attributes == nil { + return "" + } + // Init the data format prefix & concatenate the serialized display & attributes + var serializedMetadata= "data:application/json;ascii,{" + if display != nil { + serializedMetadata = serializedMetadata.concat(display!) + } + if display != nil && attributes != nil { + serializedMetadata = serializedMetadata.concat(", ") + } + if attributes != nil { + serializedMetadata = serializedMetadata.concat(attributes!) + } + return serializedMetadata.concat("}") + } + + /// Serializes the display & collection display views of a given NFT as a JSON compatible string + /// + /// @param nftDisplay: The NFT's Display view from which values `name`, `description`, and `thumbnail` are serialized + /// @param collectionDisplay: The NFT's NFTCollectionDisplay view from which the `externalURL` is serialized + /// + /// @returns: A JSON compatible string containing the serialized display & collection display views as: + /// \"name\": \"\", \"description\": \"\", \"image\": \"\", \"external_url\": \"\", + /// + access(all) + fun serializeNFTDisplay(nftDisplay: MetadataViews.Display?, collectionDisplay: MetadataViews.NFTCollectionDisplay?): String? { + // Return early if both values are nil + if nftDisplay == nil && collectionDisplay == nil { + return nil + } + + // Initialize JSON fields + let name = "\"name\": " + let description = "\"description\": " + let image = "\"image\": " + let externalURL = "\"external_url\": " + var serializedResult = "" + + // Append results from the Display view to the serialized JSON compatible string + if nftDisplay != nil { + serializedResult = serializedResult + .concat(name).concat(Serialize.tryToJSONString(nftDisplay!.name)!).concat(", ") + .concat(description).concat(Serialize.tryToJSONString(nftDisplay!.description)!).concat(", ") + .concat(image).concat(Serialize.tryToJSONString(nftDisplay!.thumbnail.uri())!) + // Return here if collectionDisplay is not present + if collectionDisplay == nil { + return serializedResult + } + } + + // Append a comma if both Display & NFTCollection Display views are present + if nftDisplay != nil { + serializedResult = serializedResult.concat(", ") + } else { + // Otherwise, append the name & description fields from the NFTCollectionDisplay view, foregoing image + serializedResult = serializedResult + .concat(name).concat(Serialize.tryToJSONString(collectionDisplay!.name)!).concat(", ") + .concat(description).concat(Serialize.tryToJSONString(collectionDisplay!.description)!).concat(", ") + } + + return serializedResult + .concat(externalURL) + .concat(Serialize.tryToJSONString(collectionDisplay!.externalURL.url)!) + } + + /// Serializes given Traits view as a JSON compatible string. If a given Trait is not serializable, it is skipped + /// and not included in the serialized result. + /// + /// @param traits: The Traits view to be serialized + /// + /// @returns: A JSON compatible string containing the serialized traits as: + /// `\"attributes\": [{\"trait_type\": \"\", \"value\": \"\"}, {...}]` + /// + access(all) + fun serializeNFTTraitsAsAttributes(_ traits: MetadataViews.Traits): String { + // Serialize each trait as an attribute, building the serialized JSON compatible string + var serializedResult = "\"attributes\": [" + for i, trait in traits!.traits { + let value = Serialize.tryToJSONString(trait.value) + if value == nil { + continue + } + serializedResult = serializedResult.concat("{") + .concat("\"trait_type\": ").concat(Serialize.tryToJSONString(trait.name)!) + .concat(", \"value\": ").concat(value!) + .concat("}") + if i < traits!.traits.length - 1 { + serializedResult = serializedResult.concat(",") + } + } + return serializedResult.concat("]") + } +} diff --git a/cadence/scripts/serialize/serialize_nft.cdc b/cadence/scripts/serialize/serialize_nft.cdc new file mode 100644 index 00000000..3cb72baa --- /dev/null +++ b/cadence/scripts/serialize/serialize_nft.cdc @@ -0,0 +1,20 @@ +import "ViewResolver" +import "MetadataViews" +import "NonFungibleToken" + +import "SerializeNFT" + +access(all) +fun main(address: Address, storagePathIdentifier: String, id: UInt64): String? { + let storagePath = StoragePath(identifier: storagePathIdentifier) + ?? panic("Could not construct StoragePath from identifier") + if let collection = getAuthAccount(address).storage + .borrow<&{NonFungibleToken.Collection}>( + from: storagePath + ) { + if let nft = collection.borrowNFT(id) { + return SerializeNFT.serializeNFTMetadataAsURI(nft) + } + } + return nil +} diff --git a/cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc b/cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc new file mode 100644 index 00000000..95b8d1e2 --- /dev/null +++ b/cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc @@ -0,0 +1,21 @@ +import "ViewResolver" +import "MetadataViews" +import "NonFungibleToken" + +import "SerializeNFT" + +access(all) +fun main(address: Address, storagePathIdentifier: String, id: UInt64): String? { + let storagePath = StoragePath(identifier: storagePathIdentifier) + ?? panic("Could not construct StoragePath from identifier") + if let collection = getAuthAccount(address).storage + .borrow<&{NonFungibleToken.Collection}>( + from: storagePath + ) { + if let nft = collection.borrowNFT(id) { + let strategy = SerializeNFT.OpenSeaMetadataSerializationStrategy() + return strategy.serializeResource(nft) + } + } + return nil +} diff --git a/cadence/tests/Serialize_tests.cdc b/cadence/tests/Serialize_tests.cdc index 3a7ad0f5..cdfd30fb 100644 --- a/cadence/tests/Serialize_tests.cdc +++ b/cadence/tests/Serialize_tests.cdc @@ -1,14 +1,67 @@ import Test import BlockchainHelpers +import "NonFungibleToken" +import "ViewResolver" +import "MetadataViews" + import "Serialize" +import "SerializationInterfaces" access(all) -let serializeAccount = Test.getAccount(0x0000000000000007) +let admin = Test.getAccount(0x0000000000000007) +access(all) +let alice = Test.createAccount() + +// access(all) +// let testSerializableStructOutput = "{\"trait_type\": \"Name\", \"value\": \"TestSerializableStruct\"}" + +// access(all) +// struct TestSerializableStruct : SerializationInterfaces.SerializableStruct { +// access(all) +// fun serialize(): String { +// return testSerializableStructOutput +// } +// } access(all) fun setup() { var err = Test.deployContract( + name: "ViewResolver", + path: "../contracts/standards/ViewResolver.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "Burner", + path: "../contracts/standards/Burner.cdc", + arguments: [] + ) + err = Test.deployContract( + name: "FungibleToken", + path: "../contracts/standards/FungibleToken.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "NonFungibleToken", + path: "../contracts/standards/NonFungibleToken.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "MetadataViews", + path: "../contracts/standards/MetadataViews.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "SerializationInterfaces", + path: "../contracts/utils/SerializationInterfaces.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( name: "Serialize", path: "../contracts/utils/Serialize.cdc", arguments: [] @@ -184,37 +237,43 @@ fun testBoolTryToJSONStringSucceeds() { Test.assertEqual(expectedFalse, actualFalse!) } -access(all) -fun testBoolToStringSucceeds() { - let t: Bool = true - let f: Bool = false - - let expectedTrue = "true" - let expectedFalse = "false" - - var actualTrue = Serialize.boolToString(t) - var actualFalse = Serialize.boolToString(f) - - Test.assertEqual(expectedTrue, actualTrue) - Test.assertEqual(expectedFalse, actualFalse) -} - access(all) fun testArrayToJSONStringSucceeds() { let arr: [AnyStruct] = [ - 127, - 255, - "Hello, World!", - "c", - Address(0x0000000000000007), - UFix64.max, - true - ] + 127, + 255, + "Hello, World!", + "c", + Address(0x0000000000000007), + UFix64.max, + true + ] let expected = "[\"127\", \"255\", \"Hello, World!\", \"c\", \"0x0000000000000007\", \"184467440737.09551615\", \"true\"]" - var actual = Serialize.arrayToString(arr) + var actual = Serialize.arrayToJSONString(arr) Test.assertEqual(expected, actual!) } +access(all) +fun testDictToJSONStringSucceeds() { + let dict: {String: AnyStruct} = { + "bool": true, + "arr": [ 127, "Hello, World!" ] + } + + // Mapping values can be indexed in arbitrary order, so we need to check for all possible outputs + var expectedOne: String = "{\"bool\": \"true\", \"arr\": [\"127\", \"Hello, World!\"]}" + var expectedTwo: String = "{\"arr\": [\"127\", \"Hello, World!\"], \"bool\": \"true\"}" + + var actual: String? = Serialize.dictToJSONString(dict: dict, excludedNames: nil) + Test.assertEqual(true, expectedOne == actual! || expectedTwo == actual!) + + actual = Serialize.tryToJSONString(dict) + Test.assertEqual(true, expectedOne == actual! || expectedTwo == actual!) + + actual = Serialize.dictToJSONString(dict: dict, excludedNames: ["bool"]) + expectedOne = "{\"arr\": [\"127\", \"Hello, World!\"]}" + Test.assertEqual(true, expectedOne == actual!) +} diff --git a/cadence/tests/serialize_nft_tests.cdc b/cadence/tests/serialize_nft_tests.cdc new file mode 100644 index 00000000..a9291169 --- /dev/null +++ b/cadence/tests/serialize_nft_tests.cdc @@ -0,0 +1,130 @@ +import Test +import BlockchainHelpers + +import "NonFungibleToken" +import "ViewResolver" +import "MetadataViews" + +import "Serialize" +import "SerializationInterfaces" + +access(all) +let admin = Test.getAccount(0x0000000000000007) +access(all) +let alice = Test.createAccount() + +access(all) +fun setup() { + var err = Test.deployContract( + name: "ViewResolver", + path: "../contracts/standards/ViewResolver.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "Burner", + path: "../contracts/standards/Burner.cdc", + arguments: [] + ) + err = Test.deployContract( + name: "FungibleToken", + path: "../contracts/standards/FungibleToken.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "NonFungibleToken", + path: "../contracts/standards/NonFungibleToken.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "MetadataViews", + path: "../contracts/standards/MetadataViews.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "ExampleNFT", + path: "../contracts/example-assets/ExampleNFT.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "SerializationInterfaces", + path: "../contracts/utils/SerializationInterfaces.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "Serialize", + path: "../contracts/utils/Serialize.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "SerializeNFT", + path: "../contracts/utils/SerializeNFT.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) +} + +access(all) +fun testSerializeNFTSucceeds() { + let setupResult = executeTransaction( + "../transactions/example-assets/setup_collection.cdc", + [], + alice + ) + Test.expect(setupResult, Test.beSucceeded()) + + let mintResult = executeTransaction( + "../transactions/example-assets/mint_nft.cdc", + [alice.address, "ExampleNFT", "Example NFT Collection", "https://flow.com/examplenft.jpg", [], [], []], + admin + ) + Test.expect(mintResult, Test.beSucceeded()) + + let expectedPrefix = "data:application/json;ascii,{\"name\": \"ExampleNFT\", \"description\": \"Example NFT Collection\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://example-nft.onflow.org\", " + let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"54\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}" + let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"54\"}" + + let idsResult = executeScript( + "../scripts/nft/get_ids.cdc", + [alice.address, "cadenceExampleNFTCollection"] + ) + Test.expect(idsResult, Test.beSucceeded()) + let ids = idsResult.returnValue! as! [UInt64] + + let serializeMetadataResult = executeScript( + "../scripts/serialize/serialize_nft.cdc", + [alice.address, "cadenceExampleNFTCollection", ids[0]] + ) + Test.expect(serializeMetadataResult, Test.beSucceeded()) + + let serializedMetadata = serializeMetadataResult.returnValue! as! String + + Test.assertEqual(true, serializedMetadata == expectedPrefix.concat(altSuffix1) || serializedMetadata == expectedPrefix.concat(altSuffix2)) + // Test.assertEqual(serializedMetadata, expectedPrefix.concat(altSuffix1)) +} + +access(all) +fun testOpenSeaMetadataSerializationStrategySucceeds() { + let expectedPrefix = "data:application/json;ascii,{\"name\": \"ExampleNFT\", \"description\": \"Example NFT Collection\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://example-nft.onflow.org\", " + let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"54\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}" + let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"54\"}" + + let idsResult = executeScript( + "../scripts/nft/get_ids.cdc", + [alice.address, "cadenceExampleNFTCollection"] + ) + Test.expect(idsResult, Test.beSucceeded()) + let ids = idsResult.returnValue! as! [UInt64] + + let serializeMetadataResult = executeScript( + "../scripts/serialize/serialize_nft_from_open_sea_strategy.cdc", + [alice.address, "cadenceExampleNFTCollection", ids[0]] + ) + Test.expect(serializeMetadataResult, Test.beSucceeded()) +} diff --git a/flow.json b/flow.json index ff11de22..9b42a063 100644 --- a/flow.json +++ b/flow.json @@ -16,7 +16,8 @@ "source": "./cadence/contracts/standards/Burner.cdc", "aliases": { "emulator": "ee82856bf20e2aa6", - "previewnet": "b6763b4399a888c8" + "previewnet": "b6763b4399a888c8", + "testing": "0000000000000007" } }, "CrossVMNFT": { @@ -41,7 +42,8 @@ "ExampleNFT": { "source": "./cadence/contracts/example-assets/ExampleNFT.cdc", "aliases": { - "emulator": "179b6b1cb6755e31" + "emulator": "179b6b1cb6755e31", + "testing": "0000000000000007" } }, "FlowEVMBridge": { @@ -89,6 +91,7 @@ "emulator": "ee82856bf20e2aa6", "mainnet": "f233dcee88fe0abe", "previewnet": "a0225e7000ac82a9", + "testing": "0000000000000007", "testnet": "9a0766d93b6608b7" } }, @@ -98,6 +101,7 @@ "emulator": "f8d6e0586b0a20c7", "mainnet": "f233dcee88fe0abe", "previewnet": "a0225e7000ac82a9", + "testing": "0000000000000007", "testnet": "9a0766d93b6608b7" } }, @@ -125,6 +129,7 @@ "emulator": "f8d6e0586b0a20c7", "mainnet": "1d7e57aa55817448", "previewnet": "b6763b4399a888c8", + "testing": "0000000000000007", "testnet": "631e88ae7f1d7c20" } }, @@ -134,6 +139,7 @@ "emulator": "f8d6e0586b0a20c7", "mainnet": "1d7e57aa55817448", "previewnet": "b6763b4399a888c8", + "testing": "0000000000000007", "testnet": "631e88ae7f1d7c20" } }, @@ -150,6 +156,20 @@ "testing": "0000000000000007" } }, + "SerializeNFT": { + "source": "./cadence/contracts/utils/SerializeNFT.cdc", + "aliases": { + "emulator": "f8d6e0586b0a20c7", + "testing": "0000000000000007" + } + }, + "SerializationInterfaces": { + "source": "./cadence/contracts/utils/SerializationInterfaces.cdc", + "aliases": { + "emulator": "f8d6e0586b0a20c7", + "testing": "0000000000000007" + } + }, "StringUtils": { "source": "./cadence/contracts/utils/StringUtils.cdc", "aliases": { @@ -162,6 +182,7 @@ "emulator": "f8d6e0586b0a20c7", "mainnet": "1d7e57aa55817448", "previewnet": "b6763b4399a888c8", + "testing": "0000000000000007", "testnet": "631e88ae7f1d7c20" } } From 001674b7ab86c8ae230f563fb1eee970ba6a98e7 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 17:24:52 -0500 Subject: [PATCH 07/25] update foundry ci workflow --- .github/workflows/{test.yml => foundry_test.yml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename .github/workflows/{test.yml => foundry_test.yml} (96%) diff --git a/.github/workflows/test.yml b/.github/workflows/foundry_test.yml similarity index 96% rename from .github/workflows/test.yml rename to .github/workflows/foundry_test.yml index 9282e829..6e514359 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/foundry_test.yml @@ -1,6 +1,6 @@ name: test -on: workflow_dispatch +on: pull_request env: FOUNDRY_PROFILE: ci From d08ff745fc455921c1906e49e6e00d21af9712f8 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 17:33:09 -0500 Subject: [PATCH 08/25] add Cadence tests to CI workflow --- .github/workflows/cadence_test.yml | 39 ++++++++++++++++++++++++++++++ local/normalize_coverage_report.sh | 3 +++ local/run_cadence_tests.sh | 1 + 3 files changed, 43 insertions(+) create mode 100644 .github/workflows/cadence_test.yml create mode 100644 local/normalize_coverage_report.sh create mode 100644 local/run_cadence_tests.sh diff --git a/.github/workflows/cadence_test.yml b/.github/workflows/cadence_test.yml new file mode 100644 index 00000000..fee3a807 --- /dev/null +++ b/.github/workflows/cadence_test.yml @@ -0,0 +1,39 @@ +name: CI + +on: + pull_request: + branches: [main] + push: + branches: [main] + +jobs: + tests: + name: Flow CLI Tests + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: '1.20.x' + - uses: actions/cache@v1 + with: + path: ~/go/pkg/mod + key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} + restore-keys: | + ${{ runner.os }}-go- + - name: Install Flow CLI + run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/feature/stable-cadence/install.sh)" + - name: Flow CLI Version + run: flow version + - name: Update PATH + run: echo "/root/.local/bin" >> $GITHUB_PATH + - name: Run tests + run: sh local/run_cadence_tests.sh + - name: Normalize coverage report filepaths + run : sh ./local/normalize_coverage_report.sh + - name: Upload coverage reports to Codecov + uses: codecov/codecov-action@v3 + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} + \ No newline at end of file diff --git a/local/normalize_coverage_report.sh b/local/normalize_coverage_report.sh new file mode 100644 index 00000000..8de7ee5f --- /dev/null +++ b/local/normalize_coverage_report.sh @@ -0,0 +1,3 @@ +sed -i 's/A.0000000000000007.SerializationInterfaces/cadence\contracts\/SerializationInterfaces.cdc/' coverage.lcov +sed -i 's/A.0000000000000007.Serialize/cadence\/contracts\/utils\/Serialize.cdc/' coverage.lcov +sed -i 's/A.0000000000000007.SerializeNFT/cadence\contracts\/SerializeNFT.cdc/' coverage.lcov \ No newline at end of file diff --git a/local/run_cadence_tests.sh b/local/run_cadence_tests.sh new file mode 100644 index 00000000..94e3a833 --- /dev/null +++ b/local/run_cadence_tests.sh @@ -0,0 +1 @@ +flow-c1 test --cover --covercode="contracts" --coverprofile="coverage.lcov" cadence/tests/*_tests.cdc \ No newline at end of file From 59be19d555c04d9a07cd2e2b790d1c19b2ea9991 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 17:37:51 -0500 Subject: [PATCH 09/25] update Cadence tests to run on PR --- .github/workflows/cadence_test.yml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/workflows/cadence_test.yml b/.github/workflows/cadence_test.yml index fee3a807..0839697c 100644 --- a/.github/workflows/cadence_test.yml +++ b/.github/workflows/cadence_test.yml @@ -1,10 +1,6 @@ name: CI -on: - pull_request: - branches: [main] - push: - branches: [main] +on: pull_request jobs: tests: From f4f0e215293997eea4c129370f696c8ae8c60894 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 17:46:05 -0500 Subject: [PATCH 10/25] update Flow CLI version used for CI --- .github/workflows/cadence_test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/cadence_test.yml b/.github/workflows/cadence_test.yml index 0839697c..69caf3c9 100644 --- a/.github/workflows/cadence_test.yml +++ b/.github/workflows/cadence_test.yml @@ -19,7 +19,7 @@ jobs: restore-keys: | ${{ runner.os }}-go- - name: Install Flow CLI - run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/feature/stable-cadence/install.sh)" + run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)" -- v1.12.0-cadence-v1.0.0-M8-2 - name: Flow CLI Version run: flow version - name: Update PATH From c34d6fdb546130c89ee9cef37250a8e0e0edfe45 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 17:47:19 -0500 Subject: [PATCH 11/25] fix test script command --- local/run_cadence_tests.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local/run_cadence_tests.sh b/local/run_cadence_tests.sh index 94e3a833..29da3dbb 100644 --- a/local/run_cadence_tests.sh +++ b/local/run_cadence_tests.sh @@ -1 +1 @@ -flow-c1 test --cover --covercode="contracts" --coverprofile="coverage.lcov" cadence/tests/*_tests.cdc \ No newline at end of file +flow test --cover --covercode="contracts" --coverprofile="coverage.lcov" cadence/tests/*_tests.cdc \ No newline at end of file From 9e649c4988d4439e5fcb61426506bbf385934ef8 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 18:15:57 -0500 Subject: [PATCH 12/25] add NFT serialization into bridge to EVM --- cadence/args/deploy-factory-args.json | 2 +- cadence/contracts/bridge/FlowEVMBridge.cdc | 34 ++++++++++++++++------ solidity/src/FlowBridgedERC721.sol | 4 +++ 3 files changed, 30 insertions(+), 10 deletions(-) diff --git a/cadence/args/deploy-factory-args.json b/cadence/args/deploy-factory-args.json index 9b27592d..d49bf2f5 100644 --- a/cadence/args/deploy-factory-args.json +++ b/cadence/args/deploy-factory-args.json @@ -1,7 +1,7 @@ [ { "type": "String", - "value": "608060405234801561001057600080fd5b50338061003757604051631e4fbdf760e01b81526000600482015260240160405180910390fd5b61004081610046565b50610096565b600080546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b61255c806100a56000396000f3fe60806040523480156200001157600080fd5b5060043610620000ab5760003560e01c80638da5cb5b116200006e5780638da5cb5b1462000155578063d56e0ccf1462000167578063daa09e54146200019e578063f2fde38b14620001b5578063f93241dd14620001cc57600080fd5b806304433bbc14620000b05780630a2c0ce914620000e4578063335f4c76146200010a57806361a169051462000132578063715018a61462000149575b600080fd5b620000c7620000c1366004620006ae565b620001e3565b6040516001600160a01b0390911681526020015b60405180910390f35b620000fb620000f5366004620006ef565b62000216565b604051620000db919062000775565b620001216200011b366004620006ef565b620002ca565b6040519015158152602001620000db565b620000c7620001433660046200078a565b620002f8565b62000153620003f9565b005b6000546001600160a01b0316620000c7565b620000c762000178366004620006ae565b80516020818301810180516001825292820191909301209152546001600160a01b031681565b62000121620001af366004620006ef565b62000411565b62000153620001c6366004620006ef565b6200048c565b620000fb620001dd366004620006ef565b620004d4565b6000600182604051620001f791906200086c565b908152604051908190036020019020546001600160a01b031692915050565b6001600160a01b03811660009081526002602052604090208054606091906200023f906200088a565b80601f01602080910402602001604051908101604052809291908181526020018280546200026d906200088a565b8015620002be5780601f106200029257610100808354040283529160200191620002be565b820191906000526020600020905b815481529060010190602001808311620002a057829003601f168201915b50505050509050919050565b6001600160a01b03811660009081526002602052604081208054620002ef906200088a565b15159392505050565b60006200030462000576565b600080546001600160a01b031687878787876040516200032490620005f5565b6200033596959493929190620008c6565b604051809103906000f08015801562000352573d6000803e3d6000fd5b509050806001856040516200036891906200086c565b908152604080516020928190038301902080546001600160a01b0319166001600160a01b039485161790559183166000908152600290915220620003ad8582620009a4565b507fbebce54951ebf20c0dcd195a45bb2388d9ac8e38b5974e00bb63c5822dbe65f08188888888604051620003e795949392919062000a71565b60405180910390a19695505050505050565b6200040362000576565b6200040f6000620005a5565b565b6040516301ffc9a760e01b81526380ac58cd60e01b60048201526000906001600160a01b038316906301ffc9a790602401602060405180830381865afa15801562000460573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019062000486919062000ae3565b92915050565b6200049662000576565b6001600160a01b038116620004c657604051631e4fbdf760e01b8152600060048201526024015b60405180910390fd5b620004d181620005a5565b50565b60026020526000908152604090208054620004ef906200088a565b80601f01602080910402602001604051908101604052809291908181526020018280546200051d906200088a565b80156200056e5780601f1062000542576101008083540402835291602001916200056e565b820191906000526020600020905b8154815290600101906020018083116200055057829003601f168201915b505050505081565b6000546001600160a01b031633146200040f5760405163118cdaa760e01b8152336004820152602401620004bd565b600080546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b611a1f8062000b0883390190565b634e487b7160e01b600052604160045260246000fd5b600082601f8301126200062b57600080fd5b813567ffffffffffffffff8082111562000649576200064962000603565b604051601f8301601f19908116603f0116810190828211818310171562000674576200067462000603565b816040528381528660208588010111156200068e57600080fd5b836020870160208301376000602085830101528094505050505092915050565b600060208284031215620006c157600080fd5b813567ffffffffffffffff811115620006d957600080fd5b620006e78482850162000619565b949350505050565b6000602082840312156200070257600080fd5b81356001600160a01b03811681146200071a57600080fd5b9392505050565b60005b838110156200073e57818101518382015260200162000724565b50506000910152565b600081518084526200076181602086016020860162000721565b601f01601f19169290920160200192915050565b6020815260006200071a602083018462000747565b600080600080600060a08688031215620007a357600080fd5b853567ffffffffffffffff80821115620007bc57600080fd5b620007ca89838a0162000619565b96506020880135915080821115620007e157600080fd5b620007ef89838a0162000619565b955060408801359150808211156200080657600080fd5b6200081489838a0162000619565b945060608801359150808211156200082b57600080fd5b6200083989838a0162000619565b935060808801359150808211156200085057600080fd5b506200085f8882890162000619565b9150509295509295909350565b600082516200088081846020870162000721565b9190910192915050565b600181811c908216806200089f57607f821691505b602082108103620008c057634e487b7160e01b600052602260045260246000fd5b50919050565b6001600160a01b038716815260c060208201819052600090620008ec9083018862000747565b828103604084015262000900818862000747565b9050828103606084015262000916818762000747565b905082810360808401526200092c818662000747565b905082810360a084015262000942818562000747565b9998505050505050505050565b601f8211156200099f576000816000526020600020601f850160051c810160208610156200097a5750805b601f850160051c820191505b818110156200099b5782815560010162000986565b5050505b505050565b815167ffffffffffffffff811115620009c157620009c162000603565b620009d981620009d284546200088a565b846200094f565b602080601f83116001811462000a115760008415620009f85750858301515b600019600386901b1c1916600185901b1785556200099b565b600085815260208120601f198616915b8281101562000a425788860151825594840194600190910190840162000a21565b508582101562000a615787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6001600160a01b038616815260a06020820181905260009062000a979083018762000747565b828103604084015262000aab818762000747565b9050828103606084015262000ac1818662000747565b9050828103608084015262000ad7818562000747565b98975050505050505050565b60006020828403121562000af657600080fd5b815180151581146200071a57600080fdfe60806040523480156200001157600080fd5b5060405162001a1f38038062001a1f833981016040819052620000349162000202565b858585600062000045838262000386565b50600162000054828262000386565b5050506001600160a01b0381166200008657604051631e4fbdf760e01b81526000600482015260240160405180910390fd5b6200009181620000cb565b506008620000a0848262000386565b506009620000af838262000386565b50600a620000be828262000386565b5050505050505062000452565b600780546001600160a01b038381166001600160a01b0319831681179093556040519116919082907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e090600090a35050565b80516001600160a01b03811681146200013557600080fd5b919050565b634e487b7160e01b600052604160045260246000fd5b600082601f8301126200016257600080fd5b81516001600160401b03808211156200017f576200017f6200013a565b604051601f8301601f19908116603f01168101908282118183101715620001aa57620001aa6200013a565b8160405283815260209250866020858801011115620001c857600080fd5b600091505b83821015620001ec5785820183015181830184015290820190620001cd565b6000602085830101528094505050505092915050565b60008060008060008060c087890312156200021c57600080fd5b62000227876200011d565b60208801519096506001600160401b03808211156200024557600080fd5b620002538a838b0162000150565b965060408901519150808211156200026a57600080fd5b620002788a838b0162000150565b955060608901519150808211156200028f57600080fd5b6200029d8a838b0162000150565b94506080890151915080821115620002b457600080fd5b620002c28a838b0162000150565b935060a0890151915080821115620002d957600080fd5b50620002e889828a0162000150565b9150509295509295509295565b600181811c908216806200030a57607f821691505b6020821081036200032b57634e487b7160e01b600052602260045260246000fd5b50919050565b601f82111562000381576000816000526020600020601f850160051c810160208610156200035c5750805b601f850160051c820191505b818110156200037d5782815560010162000368565b5050505b505050565b81516001600160401b03811115620003a257620003a26200013a565b620003ba81620003b38454620002f5565b8462000331565b602080601f831160018114620003f25760008415620003d95750858301515b600019600386901b1c1916600185901b1785556200037d565b600085815260208120601f198616915b82811015620004235788860151825594840194600190910190840162000402565b5085821015620004425787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6115bd80620004626000396000f3fe608060405234801561001057600080fd5b50600436106101735760003560e01c80638da5cb5b116100de578063b49bbd9411610097578063cd279c7c11610071578063cd279c7c1461030f578063e8a3d48514610322578063e985e9c51461032a578063f2fde38b1461033d57600080fd5b8063b49bbd94146102e1578063b88d4fde146102e9578063c87b56dd146102fc57600080fd5b80638da5cb5b1461029d57806394e29329146102ae57806395d89b41146102b6578063a159047b146102be578063a22cb465146102c6578063a76b4d56146102d957600080fd5b806342966c681161013057806342966c681461021b5780634f558e791461022e5780635e0a9661146102595780636352211e1461026157806370a0823114610274578063715018a61461029557600080fd5b806301ffc9a71461017857806306fdde03146101a0578063081812fc146101b5578063095ea7b3146101e057806323b872dd146101f557806342842e0e14610208575b600080fd5b61018b61018636600461109c565b610350565b60405190151581526020015b60405180910390f35b6101a8610361565b6040516101979190611109565b6101c86101c336600461111c565b6103f3565b6040516001600160a01b039091168152602001610197565b6101f36101ee366004611151565b61041c565b005b6101f361020336600461117b565b61042b565b6101f361021636600461117b565b6104bb565b6101f361022936600461111c565b6104db565b61018b61023c36600461111c565b6000908152600260205260409020546001600160a01b0316151590565b6101a86104e7565b6101c861026f36600461111c565b6104f6565b6102876102823660046111b7565b610501565b604051908152602001610197565b6101f3610549565b6007546001600160a01b03166101c8565b6101a861055d565b6101a861056c565b6101a861057b565b6101f36102d43660046111d2565b610609565b6101a8610614565b6101a8610621565b6101f36102f736600461129a565b61062e565b6101a861030a36600461111c565b610645565b6101f361031d366004611316565b610650565b6101a861066c565b61018b610338366004611381565b61067b565b6101f361034b3660046111b7565b6106a9565b600061035b826106e7565b92915050565b606060008054610370906113b4565b80601f016020809104026020016040519081016040528092919081815260200182805461039c906113b4565b80156103e95780601f106103be576101008083540402835291602001916103e9565b820191906000526020600020905b8154815290600101906020018083116103cc57829003601f168201915b5050505050905090565b60006103fe8261070c565b506000828152600460205260409020546001600160a01b031661035b565b610427828233610745565b5050565b6001600160a01b03821661045a57604051633250574960e11b8152600060048201526024015b60405180910390fd5b6000610467838333610752565b9050836001600160a01b0316816001600160a01b0316146104b5576040516364283d7b60e01b81526001600160a01b0380861660048301526024820184905282166044820152606401610451565b50505050565b6104d68383836040518060200160405280600081525061062e565b505050565b61042760008233610752565b606060098054610370906113b4565b600061035b8261070c565b60006001600160a01b03821661052d576040516322718ad960e21b815260006004820152602401610451565b506001600160a01b031660009081526003602052604090205490565b61055161084b565b61055b6000610878565b565b606060088054610370906113b4565b606060018054610370906113b4565b60098054610588906113b4565b80601f01602080910402602001604051908101604052809291908181526020018280546105b4906113b4565b80156106015780601f106105d657610100808354040283529160200191610601565b820191906000526020600020905b8154815290600101906020018083116105e457829003601f168201915b505050505081565b6104273383836108ca565b600a8054610588906113b4565b60088054610588906113b4565b61063984848461042b565b6104b584848484610969565b606061035b82610a92565b61065861084b565b6106628383610ba3565b6104d68282610bbd565b6060600a8054610370906113b4565b6001600160a01b03918216600090815260056020908152604080832093909416825291909152205460ff1690565b6106b161084b565b6001600160a01b0381166106db57604051631e4fbdf760e01b815260006004820152602401610451565b6106e481610878565b50565b60006001600160e01b03198216632483248360e11b148061035b575061035b82610c0d565b6000818152600260205260408120546001600160a01b03168061035b57604051637e27328960e01b815260048101849052602401610451565b6104d68383836001610c5d565b6000828152600260205260408120546001600160a01b039081169083161561077f5761077f818486610d63565b6001600160a01b038116156107bd5761079c600085600080610c5d565b6001600160a01b038116600090815260036020526040902080546000190190555b6001600160a01b038516156107ec576001600160a01b0385166000908152600360205260409020805460010190555b60008481526002602052604080822080546001600160a01b0319166001600160a01b0389811691821790925591518793918516917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef91a4949350505050565b6007546001600160a01b0316331461055b5760405163118cdaa760e01b8152336004820152602401610451565b600780546001600160a01b038381166001600160a01b0319831681179093556040519116919082907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e090600090a35050565b6001600160a01b0382166108fc57604051630b61174360e31b81526001600160a01b0383166004820152602401610451565b6001600160a01b03838116600081815260056020908152604080832094871680845294825291829020805460ff191686151590811790915591519182527f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31910160405180910390a3505050565b6001600160a01b0383163b156104b557604051630a85bd0160e11b81526001600160a01b0384169063150b7a02906109ab9033908890879087906004016113ee565b6020604051808303816000875af19250505080156109e6575060408051601f3d908101601f191682019092526109e39181019061142b565b60015b610a4f573d808015610a14576040519150601f19603f3d011682016040523d82523d6000602084013e610a19565b606091505b508051600003610a4757604051633250574960e11b81526001600160a01b0385166004820152602401610451565b805181602001fd5b6001600160e01b03198116630a85bd0160e11b14610a8b57604051633250574960e11b81526001600160a01b0385166004820152602401610451565b5050505050565b6060610a9d8261070c565b5060008281526006602052604081208054610ab7906113b4565b80601f0160208091040260200160405190810160405280929190818152602001828054610ae3906113b4565b8015610b305780601f10610b0557610100808354040283529160200191610b30565b820191906000526020600020905b815481529060010190602001808311610b1357829003601f168201915b505050505090506000610b4e60408051602081019091526000815290565b90508051600003610b60575092915050565b815115610b92578082604051602001610b7a929190611448565b60405160208183030381529060405292505050919050565b610b9b84610dc7565b949350505050565b610427828260405180602001604052806000815250610e3c565b6000828152600660205260409020610bd582826114c7565b506040518281527ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce79060200160405180910390a15050565b60006001600160e01b031982166380ac58cd60e01b1480610c3e57506001600160e01b03198216635b5e139f60e01b145b8061035b57506301ffc9a760e01b6001600160e01b031983161461035b565b8080610c7157506001600160a01b03821615155b15610d33576000610c818461070c565b90506001600160a01b03831615801590610cad5750826001600160a01b0316816001600160a01b031614155b8015610cc05750610cbe818461067b565b155b15610ce95760405163a9fbf51f60e01b81526001600160a01b0384166004820152602401610451565b8115610d315783856001600160a01b0316826001600160a01b03167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92560405160405180910390a45b505b5050600090815260046020526040902080546001600160a01b0319166001600160a01b0392909216919091179055565b610d6e838383610e53565b6104d6576001600160a01b038316610d9c57604051637e27328960e01b815260048101829052602401610451565b60405163177e802f60e01b81526001600160a01b038316600482015260248101829052604401610451565b6060610dd28261070c565b506000610dea60408051602081019091526000815290565b90506000815111610e0a5760405180602001604052806000815250610e35565b80610e1484610eb6565b604051602001610e25929190611448565b6040516020818303038152906040525b9392505050565b610e468383610f49565b6104d66000848484610969565b60006001600160a01b03831615801590610b9b5750826001600160a01b0316846001600160a01b03161480610e8d5750610e8d848461067b565b80610b9b5750506000908152600460205260409020546001600160a01b03908116911614919050565b60606000610ec383610fae565b600101905060008167ffffffffffffffff811115610ee357610ee361120e565b6040519080825280601f01601f191660200182016040528015610f0d576020820181803683370190505b5090508181016020015b600019016f181899199a1a9b1b9c1cb0b131b232b360811b600a86061a8153600a8504945084610f1757509392505050565b6001600160a01b038216610f7357604051633250574960e11b815260006004820152602401610451565b6000610f8183836000610752565b90506001600160a01b038116156104d6576040516339e3563760e11b815260006004820152602401610451565b60008072184f03e93ff9f4daa797ed6e38ed64bf6a1f0160401b8310610fed5772184f03e93ff9f4daa797ed6e38ed64bf6a1f0160401b830492506040015b6d04ee2d6d415b85acef81000000008310611019576d04ee2d6d415b85acef8100000000830492506020015b662386f26fc10000831061103757662386f26fc10000830492506010015b6305f5e100831061104f576305f5e100830492506008015b612710831061106357612710830492506004015b60648310611075576064830492506002015b600a831061035b5760010192915050565b6001600160e01b0319811681146106e457600080fd5b6000602082840312156110ae57600080fd5b8135610e3581611086565b60005b838110156110d45781810151838201526020016110bc565b50506000910152565b600081518084526110f58160208601602086016110b9565b601f01601f19169290920160200192915050565b602081526000610e3560208301846110dd565b60006020828403121561112e57600080fd5b5035919050565b80356001600160a01b038116811461114c57600080fd5b919050565b6000806040838503121561116457600080fd5b61116d83611135565b946020939093013593505050565b60008060006060848603121561119057600080fd5b61119984611135565b92506111a760208501611135565b9150604084013590509250925092565b6000602082840312156111c957600080fd5b610e3582611135565b600080604083850312156111e557600080fd5b6111ee83611135565b91506020830135801515811461120357600080fd5b809150509250929050565b634e487b7160e01b600052604160045260246000fd5b600067ffffffffffffffff8084111561123f5761123f61120e565b604051601f8501601f19908116603f011681019082821181831017156112675761126761120e565b8160405280935085815286868601111561128057600080fd5b858560208301376000602087830101525050509392505050565b600080600080608085870312156112b057600080fd5b6112b985611135565b93506112c760208601611135565b925060408501359150606085013567ffffffffffffffff8111156112ea57600080fd5b8501601f810187136112fb57600080fd5b61130a87823560208401611224565b91505092959194509250565b60008060006060848603121561132b57600080fd5b61133484611135565b925060208401359150604084013567ffffffffffffffff81111561135757600080fd5b8401601f8101861361136857600080fd5b61137786823560208401611224565b9150509250925092565b6000806040838503121561139457600080fd5b61139d83611135565b91506113ab60208401611135565b90509250929050565b600181811c908216806113c857607f821691505b6020821081036113e857634e487b7160e01b600052602260045260246000fd5b50919050565b6001600160a01b0385811682528416602082015260408101839052608060608201819052600090611421908301846110dd565b9695505050505050565b60006020828403121561143d57600080fd5b8151610e3581611086565b6000835161145a8184602088016110b9565b83519083019061146e8183602088016110b9565b01949350505050565b601f8211156104d6576000816000526020600020601f850160051c810160208610156114a05750805b601f850160051c820191505b818110156114bf578281556001016114ac565b505050505050565b815167ffffffffffffffff8111156114e1576114e161120e565b6114f5816114ef84546113b4565b84611477565b602080601f83116001811461152a57600084156115125750858301515b600019600386901b1c1916600185901b1785556114bf565b600085815260208120601f198616915b828110156115595788860151825594840194600190910190840161153a565b50858210156115775787850151600019600388901b60f8161c191681555b5050505050600190811b0190555056fea26469706673582212200a956fe468b09a46bc7a03d4becd5721b90561dd1417ed9a36008af773946ad764736f6c63430008170033a26469706673582212209c26a1468da9c564746b513a99be6d96c5f2951e2ee06e1cdfc4889115eb44b664736f6c63430008170033" + "value": "608060405234801561001057600080fd5b50338061003757604051631e4fbdf760e01b81526000600482015260240160405180910390fd5b61004081610046565b50610096565b600080546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b6129f4806100a56000396000f3fe60806040523480156200001157600080fd5b5060043610620000ab5760003560e01c80638da5cb5b116200006e5780638da5cb5b1462000155578063d56e0ccf1462000167578063daa09e54146200019e578063f2fde38b14620001b5578063f93241dd14620001cc57600080fd5b806304433bbc14620000b05780630a2c0ce914620000e4578063335f4c76146200010a57806361a169051462000132578063715018a61462000149575b600080fd5b620000c7620000c1366004620006ae565b620001e3565b6040516001600160a01b0390911681526020015b60405180910390f35b620000fb620000f5366004620006ef565b62000216565b604051620000db919062000775565b620001216200011b366004620006ef565b620002ca565b6040519015158152602001620000db565b620000c7620001433660046200078a565b620002f8565b62000153620003f9565b005b6000546001600160a01b0316620000c7565b620000c762000178366004620006ae565b80516020818301810180516001825292820191909301209152546001600160a01b031681565b62000121620001af366004620006ef565b62000411565b62000153620001c6366004620006ef565b6200048c565b620000fb620001dd366004620006ef565b620004d4565b6000600182604051620001f791906200086c565b908152604051908190036020019020546001600160a01b031692915050565b6001600160a01b03811660009081526002602052604090208054606091906200023f906200088a565b80601f01602080910402602001604051908101604052809291908181526020018280546200026d906200088a565b8015620002be5780601f106200029257610100808354040283529160200191620002be565b820191906000526020600020905b815481529060010190602001808311620002a057829003601f168201915b50505050509050919050565b6001600160a01b03811660009081526002602052604081208054620002ef906200088a565b15159392505050565b60006200030462000576565b600080546001600160a01b031687878787876040516200032490620005f5565b6200033596959493929190620008c6565b604051809103906000f08015801562000352573d6000803e3d6000fd5b509050806001856040516200036891906200086c565b908152604080516020928190038301902080546001600160a01b0319166001600160a01b039485161790559183166000908152600290915220620003ad8582620009a4565b507fbebce54951ebf20c0dcd195a45bb2388d9ac8e38b5974e00bb63c5822dbe65f08188888888604051620003e795949392919062000a71565b60405180910390a19695505050505050565b6200040362000576565b6200040f6000620005a5565b565b6040516301ffc9a760e01b81526380ac58cd60e01b60048201526000906001600160a01b038316906301ffc9a790602401602060405180830381865afa15801562000460573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019062000486919062000ae3565b92915050565b6200049662000576565b6001600160a01b038116620004c657604051631e4fbdf760e01b8152600060048201526024015b60405180910390fd5b620004d181620005a5565b50565b60026020526000908152604090208054620004ef906200088a565b80601f01602080910402602001604051908101604052809291908181526020018280546200051d906200088a565b80156200056e5780601f1062000542576101008083540402835291602001916200056e565b820191906000526020600020905b8154815290600101906020018083116200055057829003601f168201915b505050505081565b6000546001600160a01b031633146200040f5760405163118cdaa760e01b8152336004820152602401620004bd565b600080546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b611eb78062000b0883390190565b634e487b7160e01b600052604160045260246000fd5b600082601f8301126200062b57600080fd5b813567ffffffffffffffff8082111562000649576200064962000603565b604051601f8301601f19908116603f0116810190828211818310171562000674576200067462000603565b816040528381528660208588010111156200068e57600080fd5b836020870160208301376000602085830101528094505050505092915050565b600060208284031215620006c157600080fd5b813567ffffffffffffffff811115620006d957600080fd5b620006e78482850162000619565b949350505050565b6000602082840312156200070257600080fd5b81356001600160a01b03811681146200071a57600080fd5b9392505050565b60005b838110156200073e57818101518382015260200162000724565b50506000910152565b600081518084526200076181602086016020860162000721565b601f01601f19169290920160200192915050565b6020815260006200071a602083018462000747565b600080600080600060a08688031215620007a357600080fd5b853567ffffffffffffffff80821115620007bc57600080fd5b620007ca89838a0162000619565b96506020880135915080821115620007e157600080fd5b620007ef89838a0162000619565b955060408801359150808211156200080657600080fd5b6200081489838a0162000619565b945060608801359150808211156200082b57600080fd5b6200083989838a0162000619565b935060808801359150808211156200085057600080fd5b506200085f8882890162000619565b9150509295509295909350565b600082516200088081846020870162000721565b9190910192915050565b600181811c908216806200089f57607f821691505b602082108103620008c057634e487b7160e01b600052602260045260246000fd5b50919050565b6001600160a01b038716815260c060208201819052600090620008ec9083018862000747565b828103604084015262000900818862000747565b9050828103606084015262000916818762000747565b905082810360808401526200092c818662000747565b905082810360a084015262000942818562000747565b9998505050505050505050565b601f8211156200099f576000816000526020600020601f850160051c810160208610156200097a5750805b601f850160051c820191505b818110156200099b5782815560010162000986565b5050505b505050565b815167ffffffffffffffff811115620009c157620009c162000603565b620009d981620009d284546200088a565b846200094f565b602080601f83116001811462000a115760008415620009f85750858301515b600019600386901b1c1916600185901b1785556200099b565b600085815260208120601f198616915b8281101562000a425788860151825594840194600190910190840162000a21565b508582101562000a615787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6001600160a01b038616815260a06020820181905260009062000a979083018762000747565b828103604084015262000aab818762000747565b9050828103606084015262000ac1818662000747565b9050828103608084015262000ad7818562000747565b98975050505050505050565b60006020828403121562000af657600080fd5b815180151581146200071a57600080fdfe60806040523480156200001157600080fd5b5060405162001eb738038062001eb7833981016040819052620000349162000202565b858585600062000045838262000386565b50600162000054828262000386565b5050506001600160a01b0381166200008657604051631e4fbdf760e01b81526000600482015260240160405180910390fd5b6200009181620000cb565b50600c620000a0848262000386565b50600d620000af838262000386565b50600e620000be828262000386565b5050505050505062000452565b600b80546001600160a01b038381166001600160a01b0319831681179093556040519116919082907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e090600090a35050565b80516001600160a01b03811681146200013557600080fd5b919050565b634e487b7160e01b600052604160045260246000fd5b600082601f8301126200016257600080fd5b81516001600160401b03808211156200017f576200017f6200013a565b604051601f8301601f19908116603f01168101908282118183101715620001aa57620001aa6200013a565b8160405283815260209250866020858801011115620001c857600080fd5b600091505b83821015620001ec5785820183015181830184015290820190620001cd565b6000602085830101528094505050505092915050565b60008060008060008060c087890312156200021c57600080fd5b62000227876200011d565b60208801519096506001600160401b03808211156200024557600080fd5b620002538a838b0162000150565b965060408901519150808211156200026a57600080fd5b620002788a838b0162000150565b955060608901519150808211156200028f57600080fd5b6200029d8a838b0162000150565b94506080890151915080821115620002b457600080fd5b620002c28a838b0162000150565b935060a0890151915080821115620002d957600080fd5b50620002e889828a0162000150565b9150509295509295509295565b600181811c908216806200030a57607f821691505b6020821081036200032b57634e487b7160e01b600052602260045260246000fd5b50919050565b601f82111562000381576000816000526020600020601f850160051c810160208610156200035c5750805b601f850160051c820191505b818110156200037d5782815560010162000368565b5050505b505050565b81516001600160401b03811115620003a257620003a26200013a565b620003ba81620003b38454620002f5565b8462000331565b602080601f831160018114620003f25760008415620003d95750858301515b600019600386901b1c1916600185901b1785556200037d565b600085815260208120601f198616915b82811015620004235788860151825594840194600190910190840162000402565b5085821015620004425787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b611a5580620004626000396000f3fe608060405234801561001057600080fd5b50600436106101cf5760003560e01c806370a0823111610104578063a76b4d56116100a2578063cd279c7c11610071578063cd279c7c146103a8578063e8a3d485146103bb578063e985e9c5146103c3578063f2fde38b146103d657600080fd5b8063a76b4d5614610372578063b49bbd941461037a578063b88d4fde14610382578063c87b56dd1461039557600080fd5b806394e29329116100de57806394e293291461034757806395d89b411461034f578063a159047b14610357578063a22cb4651461035f57600080fd5b806370a082311461031b578063715018a61461032e5780638da5cb5b1461033657600080fd5b80632f745c59116101715780634f558e791161014b5780634f558e79146102c25780634f6ccce7146102ed5780635e0a9661146103005780636352211e1461030857600080fd5b80632f745c591461028957806342842e0e1461029c57806342966c68146102af57600080fd5b8063095ea7b3116101ad578063095ea7b31461023c57806318160ddd1461025157806318e97fd11461026357806323b872dd1461027657600080fd5b806301ffc9a7146101d457806306fdde03146101fc578063081812fc14610211575b600080fd5b6101e76101e2366004611494565b6103e9565b60405190151581526020015b60405180910390f35b6102046103fa565b6040516101f39190611501565b61022461021f366004611514565b61048c565b6040516001600160a01b0390911681526020016101f3565b61024f61024a366004611549565b6104b5565b005b6009545b6040519081526020016101f3565b61024f61027136600461161f565b6104c4565b61024f610284366004611666565b6104d6565b610255610297366004611549565b610566565b61024f6102aa366004611666565b6105cb565b61024f6102bd366004611514565b6105eb565b6101e76102d0366004611514565b6000908152600260205260409020546001600160a01b0316151590565b6102556102fb366004611514565b6105f7565b610204610650565b610224610316366004611514565b61065f565b6102556103293660046116a2565b61066a565b61024f6106b2565b600b546001600160a01b0316610224565b6102046106c6565b6102046106d5565b6102046106e4565b61024f61036d3660046116bd565b610772565b61020461077d565b61020461078a565b61024f6103903660046116f9565b610797565b6102046103a3366004611514565b6107ae565b61024f6103b6366004611775565b6107b9565b6102046107d5565b6101e76103d13660046117cc565b6107e4565b61024f6103e43660046116a2565b610812565b60006103f482610850565b92915050565b606060008054610409906117ff565b80601f0160208091040260200160405190810160405280929190818152602001828054610435906117ff565b80156104825780601f1061045757610100808354040283529160200191610482565b820191906000526020600020905b81548152906001019060200180831161046557829003601f168201915b5050505050905090565b600061049782610875565b506000828152600460205260409020546001600160a01b03166103f4565b6104c08282336108ae565b5050565b6104cc6108bb565b6104c082826108e8565b6001600160a01b03821661050557604051633250574960e11b8152600060048201526024015b60405180910390fd5b6000610512838333610938565b9050836001600160a01b0316816001600160a01b031614610560576040516364283d7b60e01b81526001600160a01b03808616600483015260248201849052821660448201526064016104fc565b50505050565b60006105718361066a565b82106105a25760405163295f44f760e21b81526001600160a01b0384166004820152602481018390526044016104fc565b506001600160a01b03919091166000908152600760209081526040808320938352929052205490565b6105e683838360405180602001604052806000815250610797565b505050565b6104c060008233610938565b600061060260095490565b821061062b5760405163295f44f760e21b815260006004820152602481018390526044016104fc565b6009828154811061063e5761063e611839565b90600052602060002001549050919050565b6060600d8054610409906117ff565b60006103f482610875565b60006001600160a01b038216610696576040516322718ad960e21b8152600060048201526024016104fc565b506001600160a01b031660009081526003602052604090205490565b6106ba6108bb565b6106c4600061094d565b565b6060600c8054610409906117ff565b606060018054610409906117ff565b600d80546106f1906117ff565b80601f016020809104026020016040519081016040528092919081815260200182805461071d906117ff565b801561076a5780601f1061073f5761010080835404028352916020019161076a565b820191906000526020600020905b81548152906001019060200180831161074d57829003601f168201915b505050505081565b6104c033838361099f565b600e80546106f1906117ff565b600c80546106f1906117ff565b6107a28484846104d6565b61056084848484610a3e565b60606103f482610b67565b6107c16108bb565b6107cb8383610c70565b6105e682826108e8565b6060600e8054610409906117ff565b6001600160a01b03918216600090815260056020908152604080832093909416825291909152205460ff1690565b61081a6108bb565b6001600160a01b03811661084457604051631e4fbdf760e01b8152600060048201526024016104fc565b61084d8161094d565b50565b60006001600160e01b0319821663780e9d6360e01b14806103f457506103f482610c8a565b6000818152600260205260408120546001600160a01b0316806103f457604051637e27328960e01b8152600481018490526024016104fc565b6105e68383836001610caf565b600b546001600160a01b031633146106c45760405163118cdaa760e01b81523360048201526024016104fc565b6000828152600660205260409020610900828261189f565b506040518281527ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce79060200160405180910390a15050565b6000610945848484610db5565b949350505050565b600b80546001600160a01b038381166001600160a01b0319831681179093556040519116919082907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e090600090a35050565b6001600160a01b0382166109d157604051630b61174360e31b81526001600160a01b03831660048201526024016104fc565b6001600160a01b03838116600081815260056020908152604080832094871680845294825291829020805460ff191686151590811790915591519182527f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31910160405180910390a3505050565b6001600160a01b0383163b1561056057604051630a85bd0160e11b81526001600160a01b0384169063150b7a0290610a8090339088908790879060040161195f565b6020604051808303816000875af1925050508015610abb575060408051601f3d908101601f19168201909252610ab89181019061199c565b60015b610b24573d808015610ae9576040519150601f19603f3d011682016040523d82523d6000602084013e610aee565b606091505b508051600003610b1c57604051633250574960e11b81526001600160a01b03851660048201526024016104fc565b805181602001fd5b6001600160e01b03198116630a85bd0160e11b14610b6057604051633250574960e11b81526001600160a01b03851660048201526024016104fc565b5050505050565b6060610b7282610875565b5060008281526006602052604081208054610b8c906117ff565b80601f0160208091040260200160405190810160405280929190818152602001828054610bb8906117ff565b8015610c055780601f10610bda57610100808354040283529160200191610c05565b820191906000526020600020905b815481529060010190602001808311610be857829003601f168201915b505050505090506000610c2360408051602081019091526000815290565b90508051600003610c35575092915050565b815115610c67578082604051602001610c4f9291906119b9565b60405160208183030381529060405292505050919050565b61094584610e82565b6104c0828260405180602001604052806000815250610ef7565b60006001600160e01b03198216632483248360e11b14806103f457506103f482610f0e565b8080610cc357506001600160a01b03821615155b15610d85576000610cd384610875565b90506001600160a01b03831615801590610cff5750826001600160a01b0316816001600160a01b031614155b8015610d125750610d1081846107e4565b155b15610d3b5760405163a9fbf51f60e01b81526001600160a01b03841660048201526024016104fc565b8115610d835783856001600160a01b0316826001600160a01b03167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92560405160405180910390a45b505b5050600090815260046020526040902080546001600160a01b0319166001600160a01b0392909216919091179055565b600080610dc3858585610f5e565b90506001600160a01b038116610e2057610e1b84600980546000838152600a60205260408120829055600182018355919091527f6e1540171b6c0c960b71a7020d9f60077f6af931a8bbf590da0223dacf75c7af0155565b610e43565b846001600160a01b0316816001600160a01b031614610e4357610e438185611057565b6001600160a01b038516610e5f57610e5a846110e8565b610945565b846001600160a01b0316816001600160a01b031614610945576109458585611197565b6060610e8d82610875565b506000610ea560408051602081019091526000815290565b90506000815111610ec55760405180602001604052806000815250610ef0565b80610ecf846111e7565b604051602001610ee09291906119b9565b6040516020818303038152906040525b9392505050565b610f01838361127a565b6105e66000848484610a3e565b60006001600160e01b031982166380ac58cd60e01b1480610f3f57506001600160e01b03198216635b5e139f60e01b145b806103f457506301ffc9a760e01b6001600160e01b03198316146103f4565b6000828152600260205260408120546001600160a01b0390811690831615610f8b57610f8b8184866112df565b6001600160a01b03811615610fc957610fa8600085600080610caf565b6001600160a01b038116600090815260036020526040902080546000190190555b6001600160a01b03851615610ff8576001600160a01b0385166000908152600360205260409020805460010190555b60008481526002602052604080822080546001600160a01b0319166001600160a01b0389811691821790925591518793918516917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef91a4949350505050565b60006110628361066a565b6000838152600860205260409020549091508082146110b5576001600160a01b03841660009081526007602090815260408083208584528252808320548484528184208190558352600890915290208190555b5060009182526008602090815260408084208490556001600160a01b039094168352600781528383209183525290812055565b6009546000906110fa906001906119e8565b6000838152600a60205260408120546009805493945090928490811061112257611122611839565b90600052602060002001549050806009838154811061114357611143611839565b6000918252602080832090910192909255828152600a9091526040808220849055858252812055600980548061117b5761117b611a09565b6001900381819060005260206000200160009055905550505050565b600060016111a48461066a565b6111ae91906119e8565b6001600160a01b039093166000908152600760209081526040808320868452825280832085905593825260089052919091209190915550565b606060006111f483611343565b600101905060008167ffffffffffffffff81111561121457611214611573565b6040519080825280601f01601f19166020018201604052801561123e576020820181803683370190505b5090508181016020015b600019016f181899199a1a9b1b9c1cb0b131b232b360811b600a86061a8153600a850494508461124857509392505050565b6001600160a01b0382166112a457604051633250574960e11b8152600060048201526024016104fc565b60006112b283836000610938565b90506001600160a01b038116156105e6576040516339e3563760e11b8152600060048201526024016104fc565b6112ea83838361141b565b6105e6576001600160a01b03831661131857604051637e27328960e01b8152600481018290526024016104fc565b60405163177e802f60e01b81526001600160a01b0383166004820152602481018290526044016104fc565b60008072184f03e93ff9f4daa797ed6e38ed64bf6a1f0160401b83106113825772184f03e93ff9f4daa797ed6e38ed64bf6a1f0160401b830492506040015b6d04ee2d6d415b85acef810000000083106113ae576d04ee2d6d415b85acef8100000000830492506020015b662386f26fc1000083106113cc57662386f26fc10000830492506010015b6305f5e10083106113e4576305f5e100830492506008015b61271083106113f857612710830492506004015b6064831061140a576064830492506002015b600a83106103f45760010192915050565b60006001600160a01b038316158015906109455750826001600160a01b0316846001600160a01b03161480611455575061145584846107e4565b806109455750506000908152600460205260409020546001600160a01b03908116911614919050565b6001600160e01b03198116811461084d57600080fd5b6000602082840312156114a657600080fd5b8135610ef08161147e565b60005b838110156114cc5781810151838201526020016114b4565b50506000910152565b600081518084526114ed8160208601602086016114b1565b601f01601f19169290920160200192915050565b602081526000610ef060208301846114d5565b60006020828403121561152657600080fd5b5035919050565b80356001600160a01b038116811461154457600080fd5b919050565b6000806040838503121561155c57600080fd5b6115658361152d565b946020939093013593505050565b634e487b7160e01b600052604160045260246000fd5b600067ffffffffffffffff808411156115a4576115a4611573565b604051601f8501601f19908116603f011681019082821181831017156115cc576115cc611573565b816040528093508581528686860111156115e557600080fd5b858560208301376000602087830101525050509392505050565b600082601f83011261161057600080fd5b610ef083833560208501611589565b6000806040838503121561163257600080fd5b82359150602083013567ffffffffffffffff81111561165057600080fd5b61165c858286016115ff565b9150509250929050565b60008060006060848603121561167b57600080fd5b6116848461152d565b92506116926020850161152d565b9150604084013590509250925092565b6000602082840312156116b457600080fd5b610ef08261152d565b600080604083850312156116d057600080fd5b6116d98361152d565b9150602083013580151581146116ee57600080fd5b809150509250929050565b6000806000806080858703121561170f57600080fd5b6117188561152d565b93506117266020860161152d565b925060408501359150606085013567ffffffffffffffff81111561174957600080fd5b8501601f8101871361175a57600080fd5b61176987823560208401611589565b91505092959194509250565b60008060006060848603121561178a57600080fd5b6117938461152d565b925060208401359150604084013567ffffffffffffffff8111156117b657600080fd5b6117c2868287016115ff565b9150509250925092565b600080604083850312156117df57600080fd5b6117e88361152d565b91506117f66020840161152d565b90509250929050565b600181811c9082168061181357607f821691505b60208210810361183357634e487b7160e01b600052602260045260246000fd5b50919050565b634e487b7160e01b600052603260045260246000fd5b601f8211156105e6576000816000526020600020601f850160051c810160208610156118785750805b601f850160051c820191505b8181101561189757828155600101611884565b505050505050565b815167ffffffffffffffff8111156118b9576118b9611573565b6118cd816118c784546117ff565b8461184f565b602080601f83116001811461190257600084156118ea5750858301515b600019600386901b1c1916600185901b178555611897565b600085815260208120601f198616915b8281101561193157888601518255948401946001909101908401611912565b508582101561194f5787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6001600160a01b0385811682528416602082015260408101839052608060608201819052600090611992908301846114d5565b9695505050505050565b6000602082840312156119ae57600080fd5b8151610ef08161147e565b600083516119cb8184602088016114b1565b8351908301906119df8183602088016114b1565b01949350505050565b818103818111156103f457634e487b7160e01b600052601160045260246000fd5b634e487b7160e01b600052603160045260246000fdfea26469706673582212206ff38700c73b602455dbb7964f2d3281f62efc77263f0f3bdb67f5e4ee5d4f3f64736f6c63430008170033a26469706673582212207f55223fc039b168a1e0c0bb9dc8d219b8219d1b2151fe8e9843aecefd41f82664736f6c63430008170033" }, { "type": "UInt64", diff --git a/cadence/contracts/bridge/FlowEVMBridge.cdc b/cadence/contracts/bridge/FlowEVMBridge.cdc index 70ce13da..ade1e789 100644 --- a/cadence/contracts/bridge/FlowEVMBridge.cdc +++ b/cadence/contracts/bridge/FlowEVMBridge.cdc @@ -15,6 +15,7 @@ import "FlowEVMBridgeConfig" import "FlowEVMBridgeUtils" import "FlowEVMBridgeNFTEscrow" import "FlowEVMBridgeTemplates" +import "SerializeNFT" /// The FlowEVMBridge contract is the main entrypoint for bridging NFT & FT assets between Flow & FlowEVM. /// @@ -135,11 +136,6 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { let tokenType = token.getType() let tokenID = token.id let evmID = CrossVMNFT.getEVMID(from: &token as &{NonFungibleToken.NFT}) ?? UInt256(token.id) - // Grab the URI from the NFT if available - var uri: String = "" - if let metadata = token.resolveView(Type()) as! CrossVMNFT.EVMBridgedMetadata? { - uri = metadata.uri.uri() - } // Lock the NFT & calculate the storage used by the NFT let storageUsed = FlowEVMBridgeNFTEscrow.lockNFT(<-token) @@ -159,6 +155,16 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { let isFactoryDeployed = FlowEVMBridgeUtils.isEVMContractBridgeOwned(evmContractAddress: associatedAddress) // Controlled by the bridge - mint or transfer based on existence if isFactoryDeployed { + // Grab the URI from the NFT if available + var uri: String = "" + // Default to project-specified URI + if let metadata = token.resolveView(Type()) as! CrossVMNFT.EVMBridgedMetadata? { + uri = metadata.uri.uri() + } else { + // Otherwise, serialize the NFT using OpenSea Metadata strategy + uri = SerializeNFT.serializeNFTMetadataAsURI(&token as &{NonFungibleToken.NFT}) + } + // Check if the ERC721 exists let existsResponse = EVM.decodeABI( types: [Type()], @@ -173,17 +179,27 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { assert(existsResponse.length == 1, message: "Invalid response length") let exists = existsResponse[0] as! Bool if exists { - // if so transfer - let callResult: EVM.Result = FlowEVMBridgeUtils.call( + // If so transfer + let transferResult: EVM.Result = FlowEVMBridgeUtils.call( signature: "safeTransferFrom(address,address,uint256)", targetEVMAddress: associatedAddress, args: [self.getBridgeCOAEVMAddress(), to, evmID], gasLimit: 15000000, value: 0.0 ) - assert(callResult.status == EVM.Status.successful, message: "Tranfer to bridge recipient failed") + assert(transferResult.status == EVM.Status.successful, message: "Tranfer to bridge recipient failed") + + // And update the URI to reflect current metadata + let updateURIResult: EVM.Result = FlowEVMBridgeUtils.call( + signature: "updateTokenURI(uint256,string)", + targetEVMAddress: associatedAddress, + args: [evmID, uri], + gasLimit: 15000000, + value: 0.0 + ) + assert(updateURIResult.status == EVM.Status.successful, message: "Tranfer to bridge recipient failed") } else { - // Otherwise mint + // Otherwise mint with current URI let callResult: EVM.Result = FlowEVMBridgeUtils.call( signature: "safeMint(address,uint256,string)", targetEVMAddress: associatedAddress, diff --git a/solidity/src/FlowBridgedERC721.sol b/solidity/src/FlowBridgedERC721.sol index d4dc4369..4742587c 100644 --- a/solidity/src/FlowBridgedERC721.sol +++ b/solidity/src/FlowBridgedERC721.sol @@ -30,6 +30,10 @@ contract FlowBridgedERC721 is ERC721, ERC721URIStorage, ERC721Burnable, ERC721En _setTokenURI(tokenId, uri); } + function updateTokenURI(uint256 tokenId, string memory uri) public onlyOwner { + _setTokenURI(tokenId, uri); + } + function contractURI() public view returns (string memory) { return contractMetadata; } From 969e079cdcd6e28b3f80af8eb627ead863d7edf9 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 18:42:05 -0500 Subject: [PATCH 13/25] add metadata syncing on tokenURI when bridging from EVM to Cadence --- .../args/bridged-nft-code-chunks-args.json | 12 ++++-- cadence/contracts/bridge/FlowEVMBridge.cdc | 18 ++++++--- .../emulator/EVMBridgedNFTTemplate.cdc | 38 ++++++++++++++++--- 3 files changed, 54 insertions(+), 14 deletions(-) diff --git a/cadence/args/bridged-nft-code-chunks-args.json b/cadence/args/bridged-nft-code-chunks-args.json index 0129757d..f451dd38 100644 --- a/cadence/args/bridged-nft-code-chunks-args.json +++ b/cadence/args/bridged-nft-code-chunks-args.json @@ -10,7 +10,7 @@ "value": "696d706f7274204e6f6e46756e6769626c65546f6b656e2066726f6d203078663864366530353836623061323063370a696d706f7274204d6574616461746156696577732066726f6d203078663864366530353836623061323063370a696d706f727420566965775265736f6c7665722066726f6d203078663864366530353836623061323063370a696d706f72742046756e6769626c65546f6b656e2066726f6d203078656538323835366266323065326161360a696d706f727420466c6f77546f6b656e2066726f6d203078306165353363623665336634326137390a0a696d706f72742045564d2066726f6d203078663864366530353836623061323063370a0a696d706f7274204943726f7373564d2066726f6d203078663864366530353836623061323063370a696d706f7274204945564d4272696467654e46544d696e7465722066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d4272696467654e4654457363726f772066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d427269646765436f6e6669672066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d4272696467655574696c732066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d4272696467652066726f6d203078663864366530353836623061323063370a696d706f72742043726f7373564d4e46542066726f6d203078663864366530353836623061323063370a0a2f2f2f205468697320636f6e747261637420697320612074656d706c617465207573656420627920466c6f7745564d42726964676520746f20646566696e652045564d2d6e6174697665204e46547320627269646765642066726f6d20466c6f772045564d20746f20466c6f772e0a2f2f2f2055706f6e206465706c6f796d656e74206f66207468697320636f6e74726163742c2074686520636f6e7472616374206e616d65206973206465726976656420617320612066756e6374696f6e206f6620746865206173736574207479706520286865726520616e2045524337323120616b610a2f2f2f20616e204e46542920616e642074686520636f6e747261637427732045564d20616464726573732e20546865206465726976656420636f6e7472616374206e616d65206973207468656e206a6f696e65642077697468207468697320636f6e7472616374277320636f64652c0a2f2f2f207072657061726564206173206368756e6b7320696e20466c6f7745564d42726964676554656d706c61746573206265666f7265206265696e67206465706c6f79656420746f2074686520466c6f772045564d20427269646765206163636f756e742e0a2f2f2f0a2f2f2f204f6e206272696467696e672c2074686520455243373231206973207472616e7366657272656420746f2074686520627269646765277320436164656e63654f776e65644163636f756e742045564d206164647265737320616e642061206e6577204e4654206973206d696e7465642066726f6d0a2f2f2f207468697320636f6e747261637420746f20746865206272696467696e672063616c6c65722e204f6e2072657475726e20746f20466c6f772045564d2c2074686520726576657273652070726f6365737320697320666f6c6c6f776564202d2074686520746f6b656e206973206275726e65640a2f2f2f20696e207468697320636f6e747261637420616e642074686520455243373231206973207472616e7366657272656420746f2074686520646566696e656420726563697069656e742e20496e2074686973207761792c2074686520436164656e636520746f6b656e206163747320617320610a2f2f2f20726570726573656e746174696f6e206f6620626f7468207468652045564d204e465420616e642074687573206f776e6572736869702072696768747320746f2069742075706f6e206272696467696e67206261636b20746f20466c6f772045564d2e0a2f2f2f0a2f2f2f20546f20627269646765206265747765656e20564d732c20612063616c6c65722063616e20656974686572207573652074686520636f6e7472616374206d6574686f647320646566696e65642062656c6f772c206f72207573652074686520466c6f7745564d42726964676527730a2f2f2f206272696467696e67206d6574686f64732077686963682077696c6c2070726f6772616d61746963616c6c7920726f757465206272696467696e672063616c6c7320746f207468697320636f6e74726163742e0a2f2f2f0a2f2f20544f444f3a20496d706c656d656e74204e465420636f6e747261637420696e74657266616365206f6e636520763220617661696c61626c65206c6f63616c6c790a61636365737328616c6c2920636f6e747261637420" }, { "type": "String", - "value": "203a204943726f7373564d2c204945564d4272696467654e46544d696e7465722c204e6f6e46756e6769626c65546f6b656e207b0a0a202020202f2f2f20506f696e74657220746f2074686520466163746f7279206465706c6f79656420536f6c696469747920636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365740a2020202061636365737328616c6c29206c65742065766d4e4654436f6e7472616374416464726573733a2045564d2e45564d416464726573730a202020202f2f2f20506f696e74657220746f2074686520466c6f77204e465420636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365742c207468697320636f6e7472616374206164647265737320696e207468697320636173650a2020202061636365737328616c6c29206c657420666c6f774e4654436f6e7472616374416464726573733a20416464726573730a202020202f2f2f204e616d65206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c6574206e616d653a20537472696e670a202020202f2f2f2053796d626f6c206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a202020202f2f2f20555249206f662074686520636f6e74726163742c20696620617661696c61626c6520617320612076617220696e2063617365207468652062726964676520656e61626c65732063726f73732d564d204d657461646174612073796e63696e6720696e20746865206675747572650a2020202061636365737328616c6c292076617220636f6e74726163745552493a20537472696e673f0a202020202f2f2f2052657461696e206120436f6c6c656374696f6e20746f207265666572656e6365207768656e207265736f6c76696e6720436f6c6c656374696f6e204d657461646174610a202020206163636573732873656c6629206c657420636f6c6c656374696f6e3a2040436f6c6c656374696f6e0a0a202020202f2f2f20546865204e4654207265736f7572636520726570726573656e74696e672074686520627269646765642045524337323120746f6b656e0a202020202f2f2f0a2020202061636365737328616c6c29207265736f75726365204e46543a2043726f7373564d4e46542e45564d4e4654207b0a20202020202020202f2f2f2054686520436164656e6365204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742069643a2055496e7436340a20202020202020202f2f2f2054686520455243373231204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742065766d49443a2055496e743235360a20202020202020202f2f2f20546865206e616d65206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c6574206e616d653a20537472696e670a20202020202020202f2f2f205468652073796d626f6c206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a20202020202020202f2f2f2054686520555249206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c6574207572693a20537472696e670a20202020202020202f2f2f204164646974696f6e616c206f6e636861696e206d657461646174610a202020202020202061636365737328616c6c29206c6574206d657461646174613a207b537472696e673a20416e795374727563747d0a0a2020202020202020696e6974280a2020202020202020202020206e616d653a20537472696e672c0a20202020202020202020202073796d626f6c3a20537472696e672c0a20202020202020202020202065766d49443a2055496e743235362c0a2020202020202020202020207572693a20537472696e672c0a2020202020202020202020206d657461646174613a207b537472696e673a20416e795374727563747d0a202020202020202029207b0a20202020202020202020202073656c662e6e616d65203d206e616d650a20202020202020202020202073656c662e73796d626f6c203d2073796d626f6c0a20202020202020202020202073656c662e6964203d2073656c662e757569640a20202020202020202020202073656c662e65766d4944203d2065766d49440a20202020202020202020202073656c662e757269203d207572690a20202020202020202020202073656c662e6d65746164617461203d206d657461646174610a20202020202020207d0a0a20202020202020202f2f2f2052657475726e7320746865206d65746164617461207669657720747970657320737570706f727465642062792074686973204e46540a202020202020202061636365737328616c6c2920766965772066756e20676574566965777328293a205b547970655d207b0a20202020202020202020202072657475726e205b0a20202020202020202020202020202020547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e53657269616c3e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28290a2020202020202020202020205d0a20202020202020207d0a0a20202020202020202f2f2f205265736f6c7665732061206d65746164617461207669657720666f722074686973204e46540a202020202020202061636365737328616c6c292066756e207265736f6c766556696577285f20766965773a2054797065293a20416e795374727563743f207b0a2020202020202020202020207377697463682076696577207b0a202020202020202020202020202020202f2f20576520646f6e2774206b6e6f772077686174206b696e64206f662066696c65207468652055524920726570726573656e747320284950465320762048545450292c20736f2077652063616e2774207265736f6c766520446973706c617920766965770a202020202020202020202020202020202f2f20776974682074686520555249206173207468756d626e61696c202d207765206d61792061206e6577207374616e64617264207669657720666f722045564d204e465473202d207468697320697320696e746572696d0a202020202020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a202020202020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a2020202020202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a2020202020202020202020202020202020202020202020207572693a2043726f7373564d4e46542e5552492873656c662e746f6b656e5552492829290a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e53657269616c3e28293a0a202020202020202020202020202020202020202072657475726e204d6574616461746156696577732e53657269616c280a20202020202020202020202020202020202020202020202073656c662e69640a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28293a0a202020202020202020202020202020202020202072657475726e20" + "value": "203a204943726f7373564d2c204945564d4272696467654e46544d696e7465722c204e6f6e46756e6769626c65546f6b656e207b0a0a202020202f2f2f20506f696e74657220746f2074686520466163746f7279206465706c6f79656420536f6c696469747920636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365740a2020202061636365737328616c6c29206c65742065766d4e4654436f6e7472616374416464726573733a2045564d2e45564d416464726573730a202020202f2f2f20506f696e74657220746f2074686520466c6f77204e465420636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365742c207468697320636f6e7472616374206164647265737320696e207468697320636173650a2020202061636365737328616c6c29206c657420666c6f774e4654436f6e7472616374416464726573733a20416464726573730a202020202f2f2f204e616d65206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c6574206e616d653a20537472696e670a202020202f2f2f2053796d626f6c206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a202020202f2f2f20555249206f662074686520636f6e74726163742c20696620617661696c61626c6520617320612076617220696e2063617365207468652062726964676520656e61626c65732063726f73732d564d204d657461646174612073796e63696e6720696e20746865206675747572650a2020202061636365737328616c6c292076617220636f6e74726163745552493a20537472696e673f0a202020202f2f2f2052657461696e206120436f6c6c656374696f6e20746f207265666572656e6365207768656e207265736f6c76696e6720436f6c6c656374696f6e204d657461646174610a202020206163636573732873656c6629206c657420636f6c6c656374696f6e3a2040436f6c6c656374696f6e0a202020202f2f2f204d617070696e67206f6620746f6b656e205552497320696e6465786564206f6e207468656972204552433732312049442e205468697320776f756c64206e6f74206e6f726d616c6c792062652072657461696e65642077697468696e206120436164656e6365204e46540a202020202f2f2f20636f6e74726163742c206275742073696e6365204e4654206d65746164617461206d6179206265207570646174656420696e2045564d2c20697427732072657461696e6564206865726520736f207468617420746865206272696467652063616e207570646174650a202020202f2f2f20697420616761696e73742074686520736f757263652045524337323120636f6e7472616374207768696368206973207472656174656420617320746865204e4654277320736f75726365206f662074727574682e0a2020202061636365737328616c6c29206c657420746f6b656e555249733a207b55496e743235363a20537472696e677d0a0a202020202f2f2f20546865204e4654207265736f7572636520726570726573656e74696e672074686520627269646765642045524337323120746f6b656e0a202020202f2f2f0a2020202061636365737328616c6c29207265736f75726365204e46543a2043726f7373564d4e46542e45564d4e4654207b0a20202020202020202f2f2f2054686520436164656e6365204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742069643a2055496e7436340a20202020202020202f2f2f2054686520455243373231204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742065766d49443a2055496e743235360a20202020202020202f2f2f20546865206e616d65206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c6574206e616d653a20537472696e670a20202020202020202f2f2f205468652073796d626f6c206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a20202020202020202f2f2f204164646974696f6e616c206f6e636861696e206d657461646174610a202020202020202061636365737328616c6c29206c6574206d657461646174613a207b537472696e673a20416e795374727563747d0a0a2020202020202020696e6974280a2020202020202020202020206e616d653a20537472696e672c0a20202020202020202020202073796d626f6c3a20537472696e672c0a20202020202020202020202065766d49443a2055496e743235362c0a2020202020202020202020206d657461646174613a207b537472696e673a20416e795374727563747d0a202020202020202029207b0a20202020202020202020202073656c662e6e616d65203d206e616d650a20202020202020202020202073656c662e73796d626f6c203d2073796d626f6c0a20202020202020202020202073656c662e6964203d2073656c662e757569640a20202020202020202020202073656c662e65766d4944203d2065766d49440a20202020202020202020202073656c662e6d65746164617461203d206d657461646174610a20202020202020207d0a0a20202020202020202f2f2f2052657475726e7320746865206d65746164617461207669657720747970657320737570706f727465642062792074686973204e46540a202020202020202061636365737328616c6c2920766965772066756e20676574566965777328293a205b547970655d207b0a20202020202020202020202072657475726e205b0a20202020202020202020202020202020547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e53657269616c3e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28290a2020202020202020202020205d0a20202020202020207d0a0a20202020202020202f2f2f205265736f6c7665732061206d65746164617461207669657720666f722074686973204e46540a202020202020202061636365737328616c6c292066756e207265736f6c766556696577285f20766965773a2054797065293a20416e795374727563743f207b0a2020202020202020202020207377697463682076696577207b0a202020202020202020202020202020202f2f20576520646f6e2774206b6e6f772077686174206b696e64206f662066696c65207468652055524920726570726573656e747320284950465320762048545450292c20736f2077652063616e2774207265736f6c766520446973706c617920766965770a202020202020202020202020202020202f2f20776974682074686520555249206173207468756d626e61696c202d207765206d61792061206e6577207374616e64617264207669657720666f722045564d204e465473202d207468697320697320696e746572696d0a202020202020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a202020202020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a2020202020202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a2020202020202020202020202020202020202020202020207572693a2043726f7373564d4e46542e5552492873656c662e746f6b656e5552492829290a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e53657269616c3e28293a0a202020202020202020202020202020202020202072657475726e204d6574616461746156696577732e53657269616c280a20202020202020202020202020202020202020202020202073656c662e69640a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28293a0a202020202020202020202020202020202020202072657475726e20" }, { "type": "String", "value": "2e7265736f6c7665436f6e747261637456696577280a2020202020202020202020202020202020202020202020207265736f75726365547970653a2073656c662e6765745479706528292c0a20202020202020202020202020202020202020202020202076696577547970653a20547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28290a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28293a0a202020202020202020202020202020202020202072657475726e20" @@ -22,7 +22,13 @@ "value": "2e637265617465456d707479436f6c6c656374696f6e286e6674547970653a2073656c662e676574547970652829290a20202020202020207d0a0a20202020202020202f2a202d2d2d2043726f7373564d4e465420636f6e666f726d616e6365202d2d2d202a2f0a20202020202020202f2f0a20202020202020202f2f2f2052657475726e73207468652045564d20636f6e74726163742061646472657373206f6620746865204e46540a202020202020202061636365737328616c6c2920766965772066756e2067657445564d436f6e74726163744164647265737328293a2045564d2e45564d41646472657373207b0a20202020202020202020202072657475726e20" }, { "type": "String", - "value": "2e67657445564d436f6e74726163744164647265737328290a20202020202020207d0a0a20202020202020202f2f2f2053696d696c617220746f204552433732312e746f6b656e555249206d6574686f642c2072657475726e732074686520555249206f6620746865204e465420776974682073656c662e65766d49442061742074696d65206f66206272696467696e670a202020202020202061636365737328616c6c2920766965772066756e20746f6b656e55524928293a20537472696e67207b0a20202020202020202020202072657475726e2073656c662e7572690a20202020202020207d0a202020207d0a0a202020202f2f2f2054686973207265736f7572636520686f6c6473206173736f636961746564204e4654732c20616e642073657276657320717565726965732061626f75742073746f726564204e4654730a2020202061636365737328616c6c29207265736f7572636520436f6c6c656374696f6e3a204e6f6e46756e6769626c65546f6b656e2e436f6c6c656374696f6e2c2043726f7373564d4e46542e45564d4e4654436f6c6c656374696f6e207b0a20202020202020202f2f2f2064696374696f6e617279206f66204e465420636f6e666f726d696e6720746f6b656e7320696e6465786564206f6e2074686569722049440a202020202020202061636365737328636f6e74726163742920766172206f776e65644e4654733a20407b55496e7436343a20" + "value": "2e67657445564d436f6e74726163744164647265737328290a20202020202020207d0a0a20202020202020202f2f2f2053696d696c617220746f204552433732312e746f6b656e555249206d6574686f642c2072657475726e732074686520555249206f6620746865204e465420776974682073656c662e65766d49442061742074696d65206f66206272696467696e670a202020202020202061636365737328616c6c2920766965772066756e20746f6b656e55524928293a20537472696e67207b0a20202020202020202020202072657475726e20" + }, { + "type": "String", + "value": "2e746f6b656e555249735b73656c662e65766d49445d203f3f2022220a20202020202020207d0a0a20202020202020202f2a202d2d2d20427269646765206f6e6c79206d6574686f64202d2d2d202a2f0a20202020202020202f2f0a20202020202020202f2f2f20416c6c6f7773207468652062726964676520746f20757064617465207468652055524920616761696e73742074686520736f757263652045524337323120636f6e7472616374206f6e206272696467696e67206261636b20746f20436164656e63650a2020202020202020616363657373286163636f756e74290a202020202020202066756e20757064617465555249285f206e65773a20537472696e6729207b0a202020202020202020202020" + }, { + "type": "String", + "value": "2e757064617465546f6b656e5552492869643a2073656c662e65766d49442c206e65775552493a206e6577290a20202020202020207d0a202020207d0a0a202020202f2f2f2054686973207265736f7572636520686f6c6473206173736f636961746564204e4654732c20616e642073657276657320717565726965732061626f75742073746f726564204e4654730a2020202061636365737328616c6c29207265736f7572636520436f6c6c656374696f6e3a204e6f6e46756e6769626c65546f6b656e2e436f6c6c656374696f6e2c2043726f7373564d4e46542e45564d4e4654436f6c6c656374696f6e207b0a20202020202020202f2f2f2064696374696f6e617279206f66204e465420636f6e666f726d696e6720746f6b656e7320696e6465786564206f6e2074686569722049440a202020202020202061636365737328636f6e74726163742920766172206f776e65644e4654733a20407b55496e7436343a20" }, { "type": "String", "value": "2e4e46547d0a20202020202020202f2f2f204d617070696e67206f662045564d2049447320746f20466c6f77204e4654204944730a202020202020202061636365737328636f6e747261637429206c65742065766d4944546f466c6f7749443a207b55496e743235363a2055496e7436347d0a0a202020202020202061636365737328616c6c29207661722073746f72616765506174683a2053746f72616765506174680a202020202020202061636365737328616c6c2920766172207075626c6963506174683a205075626c6963506174680a0a2020202020202020696e6974202829207b0a20202020202020202020202073656c662e6f776e65644e465473203c2d207b7d0a20202020202020202020202073656c662e65766d4944546f466c6f774944203d207b7d0a2020202020202020202020206c657420636f6c6c656374696f6e44617461203d20" @@ -67,7 +73,7 @@ "value": "2e637265617465456d707479436f6c6c656374696f6e286e6674547970653a20547970653c40" }, { "type": "String", - "value": "2e4e46543e2829290a20202020202020202020202020202020202020207d290a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e20636f6c6c656374696f6e446174610a2020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28293a0a202020202020202020202020202020206c6574206d65646961203d204d6574616461746156696577732e4d65646961280a202020202020202020202020202020202020202066696c653a204d6574616461746156696577732e4854545046696c65280a20202020202020202020202020202020202020202020202075726c3a202268747470733a2f2f6173736574732e776562736974652d66696c65732e636f6d2f3566363239346330633761386364643634336231633832302f3566363239346330633761386364613535636231633933365f466c6f775f576f72646d61726b2e737667220a2020202020202020202020202020202020202020292c0a20202020202020202020202020202020202020206d65646961547970653a2022696d6167652f7376672b786d6c220a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e204d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c6179280a20202020202020202020202020202020202020206e616d653a202254686520466c6f77564d2042726964676564204e465420436f6c6c656374696f6e222c0a20202020202020202020202020202020202020206465736372697074696f6e3a20225468697320636f6c6c656374696f6e2077617320627269646765642066726f6d20466c6f772045564d2e222c0a202020202020202020202020202020202020202065787465726e616c55524c3a204d6574616461746156696577732e45787465726e616c55524c282268747470733a2f2f6272696467652e666c6f772e636f6d2f6e667422292c0a2020202020202020202020202020202020202020737175617265496d6167653a206d656469612c0a202020202020202020202020202020202020202062616e6e6572496d6167653a206d656469612c0a2020202020202020202020202020202020202020736f6369616c733a207b7d0a20202020202020202020202020202020290a2020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a2020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a20202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202020202020202020207572693a2073656c662e636f6e747261637455524920213d206e696c203f2043726f7373564d4e46542e5552492873656c662e636f6e74726163745552492129203a2043726f7373564d4e46542e555249282222290a20202020202020202020202020202020290a20202020202020207d0a202020202020202072657475726e206e696c0a202020207d0a0a202020202f2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a0a2020202020202020496e7465726e616c204d6574686f64730a202020202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2f0a0a202020202f2f2f20416c6c6f7773207468652062726964676520746f0a20202020616363657373286163636f756e74290a2020202066756e206d696e744e46542869643a2055496e743235362c20746f6b656e5552493a20537472696e67293a20404e4654207b0a202020202020202072657475726e203c2d637265617465204e4654280a2020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202065766d49443a2069642c0a2020202020202020202020207572693a20746f6b656e5552492c0a2020202020202020202020206d657461646174613a207b0a20202020202020202020202020202020224272696467656420426c6f636b223a2067657443757272656e74426c6f636b28292e6865696768742c0a2020202020202020202020202020202022427269646765642054696d657374616d70223a2067657443757272656e74426c6f636b28292e74696d657374616d700a2020202020202020202020207d0a2020202020202020290a202020207d0a0a20202020696e6974286e616d653a20537472696e672c2073796d626f6c3a20537472696e672c2065766d436f6e7472616374416464726573733a2045564d2e45564d416464726573732c20636f6e74726163745552493a20537472696e673f29207b0a202020202020202073656c662e65766d4e4654436f6e747261637441646472657373203d2065766d436f6e7472616374416464726573730a202020202020202073656c662e666c6f774e4654436f6e747261637441646472657373203d2073656c662e6163636f756e742e616464726573730a202020202020202073656c662e6e616d65203d206e616d650a202020202020202073656c662e73796d626f6c203d2073796d626f6c0a202020202020202073656c662e636f6e7472616374555249203d20636f6e74726163745552490a202020202020202073656c662e636f6c6c656374696f6e203c2d2063726561746520436f6c6c656374696f6e28290a0a2020202020202020466c6f7745564d427269646765436f6e6669672e6173736f63696174655479706528547970653c40" + "value": "2e4e46543e2829290a20202020202020202020202020202020202020207d290a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e20636f6c6c656374696f6e446174610a2020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28293a0a202020202020202020202020202020206c6574206d65646961203d204d6574616461746156696577732e4d65646961280a202020202020202020202020202020202020202066696c653a204d6574616461746156696577732e4854545046696c65280a20202020202020202020202020202020202020202020202075726c3a202268747470733a2f2f6173736574732e776562736974652d66696c65732e636f6d2f3566363239346330633761386364643634336231633832302f3566363239346330633761386364613535636231633933365f466c6f775f576f72646d61726b2e737667220a2020202020202020202020202020202020202020292c0a20202020202020202020202020202020202020206d65646961547970653a2022696d6167652f7376672b786d6c220a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e204d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c6179280a20202020202020202020202020202020202020206e616d653a202254686520466c6f77564d2042726964676564204e465420436f6c6c656374696f6e222c0a20202020202020202020202020202020202020206465736372697074696f6e3a20225468697320636f6c6c656374696f6e2077617320627269646765642066726f6d20466c6f772045564d2e222c0a202020202020202020202020202020202020202065787465726e616c55524c3a204d6574616461746156696577732e45787465726e616c55524c282268747470733a2f2f6272696467652e666c6f772e636f6d2f6e667422292c0a2020202020202020202020202020202020202020737175617265496d6167653a206d656469612c0a202020202020202020202020202020202020202062616e6e6572496d6167653a206d656469612c0a2020202020202020202020202020202020202020736f6369616c733a207b7d0a20202020202020202020202020202020290a2020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a2020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a20202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202020202020202020207572693a2073656c662e636f6e747261637455524920213d206e696c203f2043726f7373564d4e46542e5552492873656c662e636f6e74726163745552492129203a2043726f7373564d4e46542e555249282222290a20202020202020202020202020202020290a20202020202020207d0a202020202020202072657475726e206e696c0a202020207d0a0a202020202f2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a0a2020202020202020496e7465726e616c204d6574686f64730a202020202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2f0a0a202020202f2f2f20416c6c6f7773207468652062726964676520746f206d696e74204e4654732066726f6d206272696467652d646566696e6564204e465420636f6e7472616374730a202020202f2f2f0a20202020616363657373286163636f756e74290a2020202066756e206d696e744e46542869643a2055496e743235362c20746f6b656e5552493a20537472696e67293a20404e4654207b0a2020202020202020707265207b0a20202020202020202020202073656c662e746f6b656e555249735b69645d203d3d206e696c3a20224120746f6b656e20776974682074686520676976656e2045524337323120494420616c726561647920657869737473220a20202020202020207d0a202020202020202073656c662e746f6b656e555249735b69645d203d20746f6b656e5552490a202020202020202072657475726e203c2d637265617465204e4654280a2020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202065766d49443a2069642c0a2020202020202020202020207572693a20746f6b656e5552492c0a2020202020202020202020206d657461646174613a207b0a20202020202020202020202020202020224272696467656420426c6f636b223a2067657443757272656e74426c6f636b28292e6865696768742c0a2020202020202020202020202020202022427269646765642054696d657374616d70223a2067657443757272656e74426c6f636b28292e74696d657374616d700a2020202020202020202020207d0a2020202020202020290a202020207d0a0a202020202f2f2f20416c6c6f7773207468652062726964676520746f207570646174652074686520555249206f662062726964676564204e4654732e205468697320617373756d65732074686174207468652045564d2d646566696e696e672070726f6a656374206d617920636f6e7461696e0a202020202f2f2f206c6f67696320286f6e636861696e206f72206f6666636861696e292077686963682075706461746573204e4654206d6574616461746120696e2074686520736f757263652045524337323120636f6e74726163742e204f6e206272696467696e672c20746865205552492063616e0a202020202f2f2f207468656e206265207570646174656420696e207468697320636f6e747261637420746f207265666c6563742074686520736f757263652045524337323120636f6e74726163742773206d657461646174612e0a202020202f2f2f0a20202020616363657373286163636f756e74290a2020202066756e207570646174655552492869643a2055496e743235362c206e65775552493a20537472696e6729207b0a2020202020202020707265207b0a20202020202020202020202073656c662e746f6b656e555249735b69645d20213d206e696c3a20224e6f20746f6b656e20776974682074686520676976656e2045524337323120494420657869737473220a20202020202020207d0a202020202020202073656c662e746f6b656e555249735b69645d203d206e65775552490a202020207d0a0a20202020696e6974286e616d653a20537472696e672c2073796d626f6c3a20537472696e672c2065766d436f6e7472616374416464726573733a2045564d2e45564d416464726573732c20636f6e74726163745552493a20537472696e673f29207b0a202020202020202073656c662e65766d4e4654436f6e747261637441646472657373203d2065766d436f6e7472616374416464726573730a202020202020202073656c662e666c6f774e4654436f6e747261637441646472657373203d2073656c662e6163636f756e742e616464726573730a202020202020202073656c662e6e616d65203d206e616d650a202020202020202073656c662e73796d626f6c203d2073796d626f6c0a202020202020202073656c662e636f6e7472616374555249203d20636f6e74726163745552490a202020202020202073656c662e746f6b656e55524973203d207b7d0a202020202020202073656c662e636f6c6c656374696f6e203c2d2063726561746520436f6c6c656374696f6e28290a0a2020202020202020466c6f7745564d427269646765436f6e6669672e6173736f63696174655479706528547970653c40" }, { "type": "String", "value": "2e4e46543e28292c20776974683a2073656c662e65766d4e4654436f6e747261637441646472657373290a2020202020202020466c6f7745564d4272696467654e4654457363726f772e696e697469616c697a65457363726f77280a202020202020202020202020666f72547970653a20547970653c40" diff --git a/cadence/contracts/bridge/FlowEVMBridge.cdc b/cadence/contracts/bridge/FlowEVMBridge.cdc index ade1e789..967d64fb 100644 --- a/cadence/contracts/bridge/FlowEVMBridge.cdc +++ b/cadence/contracts/bridge/FlowEVMBridge.cdc @@ -188,7 +188,7 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { value: 0.0 ) assert(transferResult.status == EVM.Status.successful, message: "Tranfer to bridge recipient failed") - + // And update the URI to reflect current metadata let updateURIResult: EVM.Result = FlowEVMBridgeUtils.call( signature: "updateTokenURI(uint256,string)", @@ -224,7 +224,7 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { /// Public entrypoint to bridge NFTs from EVM to Cadence /// - /// @param owner: The EVM address of the NFT owner. Current ownership and successful transfer (via + /// @param owner: The EVM address of the NFT owner. Current ownership and successful transfer (via /// `protectedTransferCall`) is validated before the bridge request is executed. /// @param calldata: Caller-provided approve() call, enabling contract COA to operate on NFT in EVM contract /// @param id: The NFT ID to bridged @@ -257,7 +257,7 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { // Get the EVMAddress of the ERC721 contract associated with the type let associatedAddress = FlowEVMBridgeConfig.getEVMAddressAssociated(with: type) ?? panic("No EVMAddress found for token type") - + // Ensure the caller is either the current owner or approved for the NFT let isAuthorized: Bool = FlowEVMBridgeUtils.isOwnerOrApproved( ofNFT: id, @@ -277,9 +277,18 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { evmContractAddress: associatedAddress ) assert(isEscrowed, message: "Transfer to bridge COA failed - cannot bridge NFT without bridge escrow") + // Get the token URI from the ERC721 contract + let uri = FlowEVMBridgeUtils.getTokenURI(evmContractAddress: associatedAddress, id: id) // If the NFT is currently locked, unlock and return if let cadenceID = FlowEVMBridgeNFTEscrow.getLockedCadenceID(type: type, evmID: id) { - return <-FlowEVMBridgeNFTEscrow.unlockNFT(type: type, id: cadenceID) + let nft <- FlowEVMBridgeNFTEscrow.unlockNFT(type: type, id: cadenceID) + + // If the NFT is bridge-defined, update the URI from the source ERC721 contract + if self.account.address == FlowEVMBridgeUtils.getContractAddress(fromType: type) { + nft.updateTokenURI(uri) + } + + return <-nft } // Otherwise, we expect the NFT to be minted in Cadence let contractAddress = FlowEVMBridgeUtils.getContractAddress(fromType: type)! @@ -287,7 +296,6 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { let contractName = FlowEVMBridgeUtils.getContractName(fromType: type)! let nftContract = getAccount(contractAddress).contracts.borrow<&{IEVMBridgeNFTMinter}>(name: contractName)! - let uri = FlowEVMBridgeUtils.getTokenURI(evmContractAddress: associatedAddress, id: id) let nft <- nftContract.mintNFT(id: id, tokenURI: uri) return <-nft } diff --git a/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc b/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc index 45cb7aeb..17e17e28 100644 --- a/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc +++ b/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc @@ -42,6 +42,10 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi access(all) var contractURI: String? /// Retain a Collection to reference when resolving Collection Metadata access(self) let collection: @Collection + /// Mapping of token URIs indexed on their ERC721 ID. This would not normally be retained within a Cadence NFT + /// contract, but since NFT metadata may be updated in EVM, it's retained here so that the bridge can update + /// it against the source ERC721 contract which is treated as the NFT's source of truth. + access(all) let tokenURIs: {UInt256: String} /// The NFT resource representing the bridged ERC721 token /// @@ -54,8 +58,6 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi access(all) let name: String /// The symbol of the NFT as defined in the ERC721 contract access(all) let symbol: String - /// The URI of the NFT as defined in the ERC721 contract - access(all) let uri: String /// Additional onchain metadata access(all) let metadata: {String: AnyStruct} @@ -63,14 +65,12 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi name: String, symbol: String, evmID: UInt256, - uri: String, metadata: {String: AnyStruct} ) { self.name = name self.symbol = symbol self.id = self.uuid self.evmID = evmID - self.uri = uri self.metadata = metadata } @@ -127,7 +127,15 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi /// Similar to ERC721.tokenURI method, returns the URI of the NFT with self.evmID at time of bridging access(all) view fun tokenURI(): String { - return self.uri + return {{CONTRACT_NAME}}.tokenURIs[self.evmID] ?? "" + } + + /* --- Bridge only method --- */ + // + /// Allows the bridge to update the URI against the source ERC721 contract on bridging back to Cadence + access(account) + fun updateURI(_ new: String) { + {{CONTRACT_NAME}}.updateTokenURI(id: self.evmID, newURI: new) } } @@ -330,9 +338,14 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi Internal Methods ***********************/ - /// Allows the bridge to + /// Allows the bridge to mint NFTs from bridge-defined NFT contracts + /// access(account) fun mintNFT(id: UInt256, tokenURI: String): @NFT { + pre { + self.tokenURIs[id] == nil: "A token with the given ERC721 ID already exists" + } + self.tokenURIs[id] = tokenURI return <-create NFT( name: self.name, symbol: self.symbol, @@ -345,12 +358,25 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi ) } + /// Allows the bridge to update the URI of bridged NFTs. This assumes that the EVM-defining project may contain + /// logic (onchain or offchain) which updates NFT metadata in the source ERC721 contract. On bridging, the URI can + /// then be updated in this contract to reflect the source ERC721 contract's metadata. + /// + access(account) + fun updateURI(id: UInt256, newURI: String) { + pre { + self.tokenURIs[id] != nil: "No token with the given ERC721 ID exists" + } + self.tokenURIs[id] = newURI + } + init(name: String, symbol: String, evmContractAddress: EVM.EVMAddress, contractURI: String?) { self.evmNFTContractAddress = evmContractAddress self.flowNFTContractAddress = self.account.address self.name = name self.symbol = symbol self.contractURI = contractURI + self.tokenURIs = {} self.collection <- create Collection() FlowEVMBridgeConfig.associateType(Type<@{{CONTRACT_NAME}}.NFT>(), with: self.evmNFTContractAddress) From de837be56e420f87b2fd049f06b53d18279ac761 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 18:44:56 -0500 Subject: [PATCH 14/25] update serialize_tests.cdc --- cadence/tests/Serialize_tests.cdc | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/cadence/tests/Serialize_tests.cdc b/cadence/tests/Serialize_tests.cdc index cdfd30fb..91daa122 100644 --- a/cadence/tests/Serialize_tests.cdc +++ b/cadence/tests/Serialize_tests.cdc @@ -13,17 +13,6 @@ let admin = Test.getAccount(0x0000000000000007) access(all) let alice = Test.createAccount() -// access(all) -// let testSerializableStructOutput = "{\"trait_type\": \"Name\", \"value\": \"TestSerializableStruct\"}" - -// access(all) -// struct TestSerializableStruct : SerializationInterfaces.SerializableStruct { -// access(all) -// fun serialize(): String { -// return testSerializableStructOutput -// } -// } - access(all) fun setup() { var err = Test.deployContract( From 90210f74dd3e44488ca0527cfeaa706026c11323 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Mon, 18 Mar 2024 19:18:07 -0500 Subject: [PATCH 15/25] fix conformance errors & update setup commands --- .../args/bridged-nft-code-chunks-args.json | 9 ++-- cadence/contracts/bridge/FlowEVMBridge.cdc | 31 ++++++------ .../contracts/bridge/IEVMBridgeNFTMinter.cdc | 7 +++ .../emulator/EVMBridgedNFTTemplate.cdc | 21 +++------ flow.json | 12 ++--- local/setup_emulator.1.sh | 20 ++++---- local/setup_emulator.2.sh | 47 ++++++++++--------- local/setup_emulator.3.sh | 2 +- 8 files changed, 77 insertions(+), 72 deletions(-) diff --git a/cadence/args/bridged-nft-code-chunks-args.json b/cadence/args/bridged-nft-code-chunks-args.json index f451dd38..b506de26 100644 --- a/cadence/args/bridged-nft-code-chunks-args.json +++ b/cadence/args/bridged-nft-code-chunks-args.json @@ -10,7 +10,7 @@ "value": "696d706f7274204e6f6e46756e6769626c65546f6b656e2066726f6d203078663864366530353836623061323063370a696d706f7274204d6574616461746156696577732066726f6d203078663864366530353836623061323063370a696d706f727420566965775265736f6c7665722066726f6d203078663864366530353836623061323063370a696d706f72742046756e6769626c65546f6b656e2066726f6d203078656538323835366266323065326161360a696d706f727420466c6f77546f6b656e2066726f6d203078306165353363623665336634326137390a0a696d706f72742045564d2066726f6d203078663864366530353836623061323063370a0a696d706f7274204943726f7373564d2066726f6d203078663864366530353836623061323063370a696d706f7274204945564d4272696467654e46544d696e7465722066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d4272696467654e4654457363726f772066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d427269646765436f6e6669672066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d4272696467655574696c732066726f6d203078663864366530353836623061323063370a696d706f727420466c6f7745564d4272696467652066726f6d203078663864366530353836623061323063370a696d706f72742043726f7373564d4e46542066726f6d203078663864366530353836623061323063370a0a2f2f2f205468697320636f6e747261637420697320612074656d706c617465207573656420627920466c6f7745564d42726964676520746f20646566696e652045564d2d6e6174697665204e46547320627269646765642066726f6d20466c6f772045564d20746f20466c6f772e0a2f2f2f2055706f6e206465706c6f796d656e74206f66207468697320636f6e74726163742c2074686520636f6e7472616374206e616d65206973206465726976656420617320612066756e6374696f6e206f6620746865206173736574207479706520286865726520616e2045524337323120616b610a2f2f2f20616e204e46542920616e642074686520636f6e747261637427732045564d20616464726573732e20546865206465726976656420636f6e7472616374206e616d65206973207468656e206a6f696e65642077697468207468697320636f6e7472616374277320636f64652c0a2f2f2f207072657061726564206173206368756e6b7320696e20466c6f7745564d42726964676554656d706c61746573206265666f7265206265696e67206465706c6f79656420746f2074686520466c6f772045564d20427269646765206163636f756e742e0a2f2f2f0a2f2f2f204f6e206272696467696e672c2074686520455243373231206973207472616e7366657272656420746f2074686520627269646765277320436164656e63654f776e65644163636f756e742045564d206164647265737320616e642061206e6577204e4654206973206d696e7465642066726f6d0a2f2f2f207468697320636f6e747261637420746f20746865206272696467696e672063616c6c65722e204f6e2072657475726e20746f20466c6f772045564d2c2074686520726576657273652070726f6365737320697320666f6c6c6f776564202d2074686520746f6b656e206973206275726e65640a2f2f2f20696e207468697320636f6e747261637420616e642074686520455243373231206973207472616e7366657272656420746f2074686520646566696e656420726563697069656e742e20496e2074686973207761792c2074686520436164656e636520746f6b656e206163747320617320610a2f2f2f20726570726573656e746174696f6e206f6620626f7468207468652045564d204e465420616e642074687573206f776e6572736869702072696768747320746f2069742075706f6e206272696467696e67206261636b20746f20466c6f772045564d2e0a2f2f2f0a2f2f2f20546f20627269646765206265747765656e20564d732c20612063616c6c65722063616e20656974686572207573652074686520636f6e7472616374206d6574686f647320646566696e65642062656c6f772c206f72207573652074686520466c6f7745564d42726964676527730a2f2f2f206272696467696e67206d6574686f64732077686963682077696c6c2070726f6772616d61746963616c6c7920726f757465206272696467696e672063616c6c7320746f207468697320636f6e74726163742e0a2f2f2f0a2f2f20544f444f3a20496d706c656d656e74204e465420636f6e747261637420696e74657266616365206f6e636520763220617661696c61626c65206c6f63616c6c790a61636365737328616c6c2920636f6e747261637420" }, { "type": "String", - "value": "203a204943726f7373564d2c204945564d4272696467654e46544d696e7465722c204e6f6e46756e6769626c65546f6b656e207b0a0a202020202f2f2f20506f696e74657220746f2074686520466163746f7279206465706c6f79656420536f6c696469747920636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365740a2020202061636365737328616c6c29206c65742065766d4e4654436f6e7472616374416464726573733a2045564d2e45564d416464726573730a202020202f2f2f20506f696e74657220746f2074686520466c6f77204e465420636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365742c207468697320636f6e7472616374206164647265737320696e207468697320636173650a2020202061636365737328616c6c29206c657420666c6f774e4654436f6e7472616374416464726573733a20416464726573730a202020202f2f2f204e616d65206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c6574206e616d653a20537472696e670a202020202f2f2f2053796d626f6c206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a202020202f2f2f20555249206f662074686520636f6e74726163742c20696620617661696c61626c6520617320612076617220696e2063617365207468652062726964676520656e61626c65732063726f73732d564d204d657461646174612073796e63696e6720696e20746865206675747572650a2020202061636365737328616c6c292076617220636f6e74726163745552493a20537472696e673f0a202020202f2f2f2052657461696e206120436f6c6c656374696f6e20746f207265666572656e6365207768656e207265736f6c76696e6720436f6c6c656374696f6e204d657461646174610a202020206163636573732873656c6629206c657420636f6c6c656374696f6e3a2040436f6c6c656374696f6e0a202020202f2f2f204d617070696e67206f6620746f6b656e205552497320696e6465786564206f6e207468656972204552433732312049442e205468697320776f756c64206e6f74206e6f726d616c6c792062652072657461696e65642077697468696e206120436164656e6365204e46540a202020202f2f2f20636f6e74726163742c206275742073696e6365204e4654206d65746164617461206d6179206265207570646174656420696e2045564d2c20697427732072657461696e6564206865726520736f207468617420746865206272696467652063616e207570646174650a202020202f2f2f20697420616761696e73742074686520736f757263652045524337323120636f6e7472616374207768696368206973207472656174656420617320746865204e4654277320736f75726365206f662074727574682e0a2020202061636365737328616c6c29206c657420746f6b656e555249733a207b55496e743235363a20537472696e677d0a0a202020202f2f2f20546865204e4654207265736f7572636520726570726573656e74696e672074686520627269646765642045524337323120746f6b656e0a202020202f2f2f0a2020202061636365737328616c6c29207265736f75726365204e46543a2043726f7373564d4e46542e45564d4e4654207b0a20202020202020202f2f2f2054686520436164656e6365204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742069643a2055496e7436340a20202020202020202f2f2f2054686520455243373231204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742065766d49443a2055496e743235360a20202020202020202f2f2f20546865206e616d65206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c6574206e616d653a20537472696e670a20202020202020202f2f2f205468652073796d626f6c206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a20202020202020202f2f2f204164646974696f6e616c206f6e636861696e206d657461646174610a202020202020202061636365737328616c6c29206c6574206d657461646174613a207b537472696e673a20416e795374727563747d0a0a2020202020202020696e6974280a2020202020202020202020206e616d653a20537472696e672c0a20202020202020202020202073796d626f6c3a20537472696e672c0a20202020202020202020202065766d49443a2055496e743235362c0a2020202020202020202020206d657461646174613a207b537472696e673a20416e795374727563747d0a202020202020202029207b0a20202020202020202020202073656c662e6e616d65203d206e616d650a20202020202020202020202073656c662e73796d626f6c203d2073796d626f6c0a20202020202020202020202073656c662e6964203d2073656c662e757569640a20202020202020202020202073656c662e65766d4944203d2065766d49440a20202020202020202020202073656c662e6d65746164617461203d206d657461646174610a20202020202020207d0a0a20202020202020202f2f2f2052657475726e7320746865206d65746164617461207669657720747970657320737570706f727465642062792074686973204e46540a202020202020202061636365737328616c6c2920766965772066756e20676574566965777328293a205b547970655d207b0a20202020202020202020202072657475726e205b0a20202020202020202020202020202020547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e53657269616c3e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28290a2020202020202020202020205d0a20202020202020207d0a0a20202020202020202f2f2f205265736f6c7665732061206d65746164617461207669657720666f722074686973204e46540a202020202020202061636365737328616c6c292066756e207265736f6c766556696577285f20766965773a2054797065293a20416e795374727563743f207b0a2020202020202020202020207377697463682076696577207b0a202020202020202020202020202020202f2f20576520646f6e2774206b6e6f772077686174206b696e64206f662066696c65207468652055524920726570726573656e747320284950465320762048545450292c20736f2077652063616e2774207265736f6c766520446973706c617920766965770a202020202020202020202020202020202f2f20776974682074686520555249206173207468756d626e61696c202d207765206d61792061206e6577207374616e64617264207669657720666f722045564d204e465473202d207468697320697320696e746572696d0a202020202020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a202020202020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a2020202020202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a2020202020202020202020202020202020202020202020207572693a2043726f7373564d4e46542e5552492873656c662e746f6b656e5552492829290a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e53657269616c3e28293a0a202020202020202020202020202020202020202072657475726e204d6574616461746156696577732e53657269616c280a20202020202020202020202020202020202020202020202073656c662e69640a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28293a0a202020202020202020202020202020202020202072657475726e20" + "value": "203a204943726f7373564d2c204945564d4272696467654e46544d696e7465722c204e6f6e46756e6769626c65546f6b656e207b0a0a202020202f2f2f20506f696e74657220746f2074686520466163746f7279206465706c6f79656420536f6c696469747920636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365740a2020202061636365737328616c6c29206c65742065766d4e4654436f6e7472616374416464726573733a2045564d2e45564d416464726573730a202020202f2f2f20506f696e74657220746f2074686520466c6f77204e465420636f6e7472616374206164647265737320646566696e696e672074686520627269646765642061737365742c207468697320636f6e7472616374206164647265737320696e207468697320636173650a2020202061636365737328616c6c29206c657420666c6f774e4654436f6e7472616374416464726573733a20416464726573730a202020202f2f2f204e616d65206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c6574206e616d653a20537472696e670a202020202f2f2f2053796d626f6c206f6620746865204e465420636f6c6c656374696f6e20646566696e656420696e2074686520636f72726573706f6e64696e672045524337323120636f6e74726163740a2020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a202020202f2f2f20555249206f662074686520636f6e74726163742c20696620617661696c61626c6520617320612076617220696e2063617365207468652062726964676520656e61626c65732063726f73732d564d204d657461646174612073796e63696e6720696e20746865206675747572650a2020202061636365737328616c6c292076617220636f6e74726163745552493a20537472696e673f0a202020202f2f2f2052657461696e206120436f6c6c656374696f6e20746f207265666572656e6365207768656e207265736f6c76696e6720436f6c6c656374696f6e204d657461646174610a202020206163636573732873656c6629206c657420636f6c6c656374696f6e3a2040436f6c6c656374696f6e0a202020202f2f2f204d617070696e67206f6620746f6b656e205552497320696e6465786564206f6e207468656972204552433732312049442e205468697320776f756c64206e6f74206e6f726d616c6c792062652072657461696e65642077697468696e206120436164656e6365204e46540a202020202f2f2f20636f6e74726163742c206275742073696e6365204e4654206d65746164617461206d6179206265207570646174656420696e2045564d2c20697427732072657461696e6564206865726520736f207468617420746865206272696467652063616e207570646174650a202020202f2f2f20697420616761696e73742074686520736f757263652045524337323120636f6e7472616374207768696368206973207472656174656420617320746865204e4654277320736f75726365206f662074727574682e0a2020202061636365737328616c6c29206c657420746f6b656e555249733a207b55496e743235363a20537472696e677d0a0a202020202f2f2f20546865204e4654207265736f7572636520726570726573656e74696e672074686520627269646765642045524337323120746f6b656e0a202020202f2f2f0a2020202061636365737328616c6c29207265736f75726365204e46543a2043726f7373564d4e46542e45564d4e4654207b0a20202020202020202f2f2f2054686520436164656e6365204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742069643a2055496e7436340a20202020202020202f2f2f2054686520455243373231204944206f6620746865204e46540a202020202020202061636365737328616c6c29206c65742065766d49443a2055496e743235360a20202020202020202f2f2f20546865206e616d65206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c6574206e616d653a20537472696e670a20202020202020202f2f2f205468652073796d626f6c206f6620746865204e465420617320646566696e656420696e207468652045524337323120636f6e74726163740a202020202020202061636365737328616c6c29206c65742073796d626f6c3a20537472696e670a20202020202020202f2f2f204164646974696f6e616c206f6e636861696e206d657461646174610a202020202020202061636365737328616c6c29206c6574206d657461646174613a207b537472696e673a20416e795374727563747d0a0a2020202020202020696e6974280a2020202020202020202020206e616d653a20537472696e672c0a20202020202020202020202073796d626f6c3a20537472696e672c0a20202020202020202020202065766d49443a2055496e743235362c0a2020202020202020202020206d657461646174613a207b537472696e673a20416e795374727563747d0a202020202020202029207b0a20202020202020202020202073656c662e6e616d65203d206e616d650a20202020202020202020202073656c662e73796d626f6c203d2073796d626f6c0a20202020202020202020202073656c662e6964203d2073656c662e757569640a20202020202020202020202073656c662e65766d4944203d2065766d49440a20202020202020202020202073656c662e6d65746164617461203d206d657461646174610a20202020202020207d0a0a20202020202020202f2f2f2052657475726e7320746865206d65746164617461207669657720747970657320737570706f727465642062792074686973204e46540a202020202020202061636365737328616c6c2920766965772066756e20676574566965777328293a205b547970655d207b0a20202020202020202020202072657475726e205b0a20202020202020202020202020202020547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e53657269616c3e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28292c0a20202020202020202020202020202020547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28290a2020202020202020202020205d0a20202020202020207d0a0a20202020202020202f2f2f205265736f6c7665732061206d65746164617461207669657720666f722074686973204e46540a202020202020202061636365737328616c6c292066756e207265736f6c766556696577285f20766965773a2054797065293a20416e795374727563743f207b0a2020202020202020202020207377697463682076696577207b0a202020202020202020202020202020202f2f20576520646f6e2774206b6e6f772077686174206b696e64206f662066696c65207468652055524920726570726573656e747320284950465320762048545450292c20736f2077652063616e2774207265736f6c766520446973706c617920766965770a202020202020202020202020202020202f2f20776974682074686520555249206173207468756d626e61696c202d207765206d61792061206e6577207374616e64617264207669657720666f722045564d204e465473202d207468697320697320696e746572696d0a202020202020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a202020202020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a2020202020202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a2020202020202020202020202020202020202020202020207572693a2043726f7373564d4e46542e55524928626173655552493a206e696c2c2076616c75653a2073656c662e746f6b656e5552492829290a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e53657269616c3e28293a0a202020202020202020202020202020202020202072657475726e204d6574616461746156696577732e53657269616c280a20202020202020202020202020202020202020202020202073656c662e69640a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28293a0a202020202020202020202020202020202020202072657475726e20" }, { "type": "String", "value": "2e7265736f6c7665436f6e747261637456696577280a2020202020202020202020202020202020202020202020207265736f75726365547970653a2073656c662e6765745479706528292c0a20202020202020202020202020202020202020202020202076696577547970653a20547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446174613e28290a2020202020202020202020202020202020202020290a202020202020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28293a0a202020202020202020202020202020202020202072657475726e20" @@ -25,10 +25,7 @@ "value": "2e67657445564d436f6e74726163744164647265737328290a20202020202020207d0a0a20202020202020202f2f2f2053696d696c617220746f204552433732312e746f6b656e555249206d6574686f642c2072657475726e732074686520555249206f6620746865204e465420776974682073656c662e65766d49442061742074696d65206f66206272696467696e670a202020202020202061636365737328616c6c2920766965772066756e20746f6b656e55524928293a20537472696e67207b0a20202020202020202020202072657475726e20" }, { "type": "String", - "value": "2e746f6b656e555249735b73656c662e65766d49445d203f3f2022220a20202020202020207d0a0a20202020202020202f2a202d2d2d20427269646765206f6e6c79206d6574686f64202d2d2d202a2f0a20202020202020202f2f0a20202020202020202f2f2f20416c6c6f7773207468652062726964676520746f20757064617465207468652055524920616761696e73742074686520736f757263652045524337323120636f6e7472616374206f6e206272696467696e67206261636b20746f20436164656e63650a2020202020202020616363657373286163636f756e74290a202020202020202066756e20757064617465555249285f206e65773a20537472696e6729207b0a202020202020202020202020" - }, { - "type": "String", - "value": "2e757064617465546f6b656e5552492869643a2073656c662e65766d49442c206e65775552493a206e6577290a20202020202020207d0a202020207d0a0a202020202f2f2f2054686973207265736f7572636520686f6c6473206173736f636961746564204e4654732c20616e642073657276657320717565726965732061626f75742073746f726564204e4654730a2020202061636365737328616c6c29207265736f7572636520436f6c6c656374696f6e3a204e6f6e46756e6769626c65546f6b656e2e436f6c6c656374696f6e2c2043726f7373564d4e46542e45564d4e4654436f6c6c656374696f6e207b0a20202020202020202f2f2f2064696374696f6e617279206f66204e465420636f6e666f726d696e6720746f6b656e7320696e6465786564206f6e2074686569722049440a202020202020202061636365737328636f6e74726163742920766172206f776e65644e4654733a20407b55496e7436343a20" + "value": "2e746f6b656e555249735b73656c662e65766d49445d203f3f2022220a20202020202020207d0a202020207d0a0a202020202f2f2f2054686973207265736f7572636520686f6c6473206173736f636961746564204e4654732c20616e642073657276657320717565726965732061626f75742073746f726564204e4654730a2020202061636365737328616c6c29207265736f7572636520436f6c6c656374696f6e3a204e6f6e46756e6769626c65546f6b656e2e436f6c6c656374696f6e2c2043726f7373564d4e46542e45564d4e4654436f6c6c656374696f6e207b0a20202020202020202f2f2f2064696374696f6e617279206f66204e465420636f6e666f726d696e6720746f6b656e7320696e6465786564206f6e2074686569722049440a202020202020202061636365737328636f6e74726163742920766172206f776e65644e4654733a20407b55496e7436343a20" }, { "type": "String", "value": "2e4e46547d0a20202020202020202f2f2f204d617070696e67206f662045564d2049447320746f20466c6f77204e4654204944730a202020202020202061636365737328636f6e747261637429206c65742065766d4944546f466c6f7749443a207b55496e743235363a2055496e7436347d0a0a202020202020202061636365737328616c6c29207661722073746f72616765506174683a2053746f72616765506174680a202020202020202061636365737328616c6c2920766172207075626c6963506174683a205075626c6963506174680a0a2020202020202020696e6974202829207b0a20202020202020202020202073656c662e6f776e65644e465473203c2d207b7d0a20202020202020202020202073656c662e65766d4944546f466c6f774944203d207b7d0a2020202020202020202020206c657420636f6c6c656374696f6e44617461203d20" @@ -73,7 +70,7 @@ "value": "2e637265617465456d707479436f6c6c656374696f6e286e6674547970653a20547970653c40" }, { "type": "String", - "value": "2e4e46543e2829290a20202020202020202020202020202020202020207d290a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e20636f6c6c656374696f6e446174610a2020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28293a0a202020202020202020202020202020206c6574206d65646961203d204d6574616461746156696577732e4d65646961280a202020202020202020202020202020202020202066696c653a204d6574616461746156696577732e4854545046696c65280a20202020202020202020202020202020202020202020202075726c3a202268747470733a2f2f6173736574732e776562736974652d66696c65732e636f6d2f3566363239346330633761386364643634336231633832302f3566363239346330633761386364613535636231633933365f466c6f775f576f72646d61726b2e737667220a2020202020202020202020202020202020202020292c0a20202020202020202020202020202020202020206d65646961547970653a2022696d6167652f7376672b786d6c220a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e204d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c6179280a20202020202020202020202020202020202020206e616d653a202254686520466c6f77564d2042726964676564204e465420436f6c6c656374696f6e222c0a20202020202020202020202020202020202020206465736372697074696f6e3a20225468697320636f6c6c656374696f6e2077617320627269646765642066726f6d20466c6f772045564d2e222c0a202020202020202020202020202020202020202065787465726e616c55524c3a204d6574616461746156696577732e45787465726e616c55524c282268747470733a2f2f6272696467652e666c6f772e636f6d2f6e667422292c0a2020202020202020202020202020202020202020737175617265496d6167653a206d656469612c0a202020202020202020202020202020202020202062616e6e6572496d6167653a206d656469612c0a2020202020202020202020202020202020202020736f6369616c733a207b7d0a20202020202020202020202020202020290a2020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a2020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a20202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202020202020202020207572693a2073656c662e636f6e747261637455524920213d206e696c203f2043726f7373564d4e46542e5552492873656c662e636f6e74726163745552492129203a2043726f7373564d4e46542e555249282222290a20202020202020202020202020202020290a20202020202020207d0a202020202020202072657475726e206e696c0a202020207d0a0a202020202f2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a0a2020202020202020496e7465726e616c204d6574686f64730a202020202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2f0a0a202020202f2f2f20416c6c6f7773207468652062726964676520746f206d696e74204e4654732066726f6d206272696467652d646566696e6564204e465420636f6e7472616374730a202020202f2f2f0a20202020616363657373286163636f756e74290a2020202066756e206d696e744e46542869643a2055496e743235362c20746f6b656e5552493a20537472696e67293a20404e4654207b0a2020202020202020707265207b0a20202020202020202020202073656c662e746f6b656e555249735b69645d203d3d206e696c3a20224120746f6b656e20776974682074686520676976656e2045524337323120494420616c726561647920657869737473220a20202020202020207d0a202020202020202073656c662e746f6b656e555249735b69645d203d20746f6b656e5552490a202020202020202072657475726e203c2d637265617465204e4654280a2020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202065766d49443a2069642c0a2020202020202020202020207572693a20746f6b656e5552492c0a2020202020202020202020206d657461646174613a207b0a20202020202020202020202020202020224272696467656420426c6f636b223a2067657443757272656e74426c6f636b28292e6865696768742c0a2020202020202020202020202020202022427269646765642054696d657374616d70223a2067657443757272656e74426c6f636b28292e74696d657374616d700a2020202020202020202020207d0a2020202020202020290a202020207d0a0a202020202f2f2f20416c6c6f7773207468652062726964676520746f207570646174652074686520555249206f662062726964676564204e4654732e205468697320617373756d65732074686174207468652045564d2d646566696e696e672070726f6a656374206d617920636f6e7461696e0a202020202f2f2f206c6f67696320286f6e636861696e206f72206f6666636861696e292077686963682075706461746573204e4654206d6574616461746120696e2074686520736f757263652045524337323120636f6e74726163742e204f6e206272696467696e672c20746865205552492063616e0a202020202f2f2f207468656e206265207570646174656420696e207468697320636f6e747261637420746f207265666c6563742074686520736f757263652045524337323120636f6e74726163742773206d657461646174612e0a202020202f2f2f0a20202020616363657373286163636f756e74290a2020202066756e207570646174655552492869643a2055496e743235362c206e65775552493a20537472696e6729207b0a2020202020202020707265207b0a20202020202020202020202073656c662e746f6b656e555249735b69645d20213d206e696c3a20224e6f20746f6b656e20776974682074686520676976656e2045524337323120494420657869737473220a20202020202020207d0a202020202020202073656c662e746f6b656e555249735b69645d203d206e65775552490a202020207d0a0a20202020696e6974286e616d653a20537472696e672c2073796d626f6c3a20537472696e672c2065766d436f6e7472616374416464726573733a2045564d2e45564d416464726573732c20636f6e74726163745552493a20537472696e673f29207b0a202020202020202073656c662e65766d4e4654436f6e747261637441646472657373203d2065766d436f6e7472616374416464726573730a202020202020202073656c662e666c6f774e4654436f6e747261637441646472657373203d2073656c662e6163636f756e742e616464726573730a202020202020202073656c662e6e616d65203d206e616d650a202020202020202073656c662e73796d626f6c203d2073796d626f6c0a202020202020202073656c662e636f6e7472616374555249203d20636f6e74726163745552490a202020202020202073656c662e746f6b656e55524973203d207b7d0a202020202020202073656c662e636f6c6c656374696f6e203c2d2063726561746520436f6c6c656374696f6e28290a0a2020202020202020466c6f7745564d427269646765436f6e6669672e6173736f63696174655479706528547970653c40" + "value": "2e4e46543e2829290a20202020202020202020202020202020202020207d290a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e20636f6c6c656374696f6e446174610a2020202020202020202020206361736520547970653c4d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c61793e28293a0a202020202020202020202020202020206c6574206d65646961203d204d6574616461746156696577732e4d65646961280a202020202020202020202020202020202020202066696c653a204d6574616461746156696577732e4854545046696c65280a20202020202020202020202020202020202020202020202075726c3a202268747470733a2f2f6173736574732e776562736974652d66696c65732e636f6d2f3566363239346330633761386364643634336231633832302f3566363239346330633761386364613535636231633933365f466c6f775f576f72646d61726b2e737667220a2020202020202020202020202020202020202020292c0a20202020202020202020202020202020202020206d65646961547970653a2022696d6167652f7376672b786d6c220a20202020202020202020202020202020290a2020202020202020202020202020202072657475726e204d6574616461746156696577732e4e4654436f6c6c656374696f6e446973706c6179280a20202020202020202020202020202020202020206e616d653a202254686520466c6f77564d2042726964676564204e465420436f6c6c656374696f6e222c0a20202020202020202020202020202020202020206465736372697074696f6e3a20225468697320636f6c6c656374696f6e2077617320627269646765642066726f6d20466c6f772045564d2e222c0a202020202020202020202020202020202020202065787465726e616c55524c3a204d6574616461746156696577732e45787465726e616c55524c282268747470733a2f2f6272696467652e666c6f772e636f6d2f6e667422292c0a2020202020202020202020202020202020202020737175617265496d6167653a206d656469612c0a202020202020202020202020202020202020202062616e6e6572496d6167653a206d656469612c0a2020202020202020202020202020202020202020736f6369616c733a207b7d0a20202020202020202020202020202020290a2020202020202020202020206361736520547970653c43726f7373564d4e46542e45564d427269646765644d657461646174613e28293a0a2020202020202020202020202020202072657475726e2043726f7373564d4e46542e45564d427269646765644d65746164617461280a20202020202020202020202020202020202020206e616d653a2073656c662e6e616d652c0a202020202020202020202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202020202020202020207572693a2073656c662e636f6e747261637455524920213d206e696c203f2043726f7373564d4e46542e55524928626173655552493a206e696c2c2076616c75653a2073656c662e636f6e74726163745552492129203a2043726f7373564d4e46542e55524928626173655552493a206e696c2c2076616c75653a202222290a20202020202020202020202020202020290a20202020202020207d0a202020202020202072657475726e206e696c0a202020207d0a0a202020202f2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a0a2020202020202020496e7465726e616c204d6574686f64730a202020202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2f0a0a202020202f2f2f20416c6c6f7773207468652062726964676520746f206d696e74204e4654732066726f6d206272696467652d646566696e6564204e465420636f6e7472616374730a202020202f2f2f0a20202020616363657373286163636f756e74290a2020202066756e206d696e744e46542869643a2055496e743235362c20746f6b656e5552493a20537472696e67293a20404e4654207b0a2020202020202020707265207b0a20202020202020202020202073656c662e746f6b656e555249735b69645d203d3d206e696c3a20224120746f6b656e20776974682074686520676976656e2045524337323120494420616c726561647920657869737473220a20202020202020207d0a202020202020202073656c662e746f6b656e555249735b69645d203d20746f6b656e5552490a202020202020202072657475726e203c2d637265617465204e4654280a2020202020202020202020206e616d653a2073656c662e6e616d652c0a20202020202020202020202073796d626f6c3a2073656c662e73796d626f6c2c0a20202020202020202020202065766d49443a2069642c0a2020202020202020202020206d657461646174613a207b0a20202020202020202020202020202020224272696467656420426c6f636b223a2067657443757272656e74426c6f636b28292e6865696768742c0a2020202020202020202020202020202022427269646765642054696d657374616d70223a2067657443757272656e74426c6f636b28292e74696d657374616d700a2020202020202020202020207d0a2020202020202020290a202020207d0a0a202020202f2f2f20416c6c6f7773207468652062726964676520746f207570646174652074686520555249206f662062726964676564204e4654732e205468697320617373756d65732074686174207468652045564d2d646566696e696e672070726f6a656374206d617920636f6e7461696e0a202020202f2f2f206c6f67696320286f6e636861696e206f72206f6666636861696e292077686963682075706461746573204e4654206d6574616461746120696e2074686520736f757263652045524337323120636f6e74726163742e204f6e206272696467696e672c20746865205552492063616e0a202020202f2f2f207468656e206265207570646174656420696e207468697320636f6e747261637420746f207265666c6563742074686520736f757263652045524337323120636f6e74726163742773206d657461646174612e0a202020202f2f2f0a20202020616363657373286163636f756e74290a2020202066756e20757064617465546f6b656e5552492865766d49443a2055496e743235362c206e65775552493a20537472696e6729207b0a2020202020202020707265207b0a20202020202020202020202073656c662e746f6b656e555249735b65766d49445d20213d206e696c3a20224e6f20746f6b656e20776974682074686520676976656e2045524337323120494420657869737473220a20202020202020207d0a202020202020202069662073656c662e746f6b656e555249735b65766d49445d20213d206e6577555249207b0a20202020202020202020202073656c662e746f6b656e555249735b65766d49445d203d206e65775552490a20202020202020207d0a202020207d0a0a20202020696e6974286e616d653a20537472696e672c2073796d626f6c3a20537472696e672c2065766d436f6e7472616374416464726573733a2045564d2e45564d416464726573732c20636f6e74726163745552493a20537472696e673f29207b0a202020202020202073656c662e65766d4e4654436f6e747261637441646472657373203d2065766d436f6e7472616374416464726573730a202020202020202073656c662e666c6f774e4654436f6e747261637441646472657373203d2073656c662e6163636f756e742e616464726573730a202020202020202073656c662e6e616d65203d206e616d650a202020202020202073656c662e73796d626f6c203d2073796d626f6c0a202020202020202073656c662e636f6e7472616374555249203d20636f6e74726163745552490a202020202020202073656c662e746f6b656e55524973203d207b7d0a202020202020202073656c662e636f6c6c656374696f6e203c2d2063726561746520436f6c6c656374696f6e28290a0a2020202020202020466c6f7745564d427269646765436f6e6669672e6173736f63696174655479706528547970653c40" }, { "type": "String", "value": "2e4e46543e28292c20776974683a2073656c662e65766d4e4654436f6e747261637441646472657373290a2020202020202020466c6f7745564d4272696467654e4654457363726f772e696e697469616c697a65457363726f77280a202020202020202020202020666f72547970653a20547970653c40" diff --git a/cadence/contracts/bridge/FlowEVMBridge.cdc b/cadence/contracts/bridge/FlowEVMBridge.cdc index 967d64fb..f63be6f5 100644 --- a/cadence/contracts/bridge/FlowEVMBridge.cdc +++ b/cadence/contracts/bridge/FlowEVMBridge.cdc @@ -137,6 +137,16 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { let tokenID = token.id let evmID = CrossVMNFT.getEVMID(from: &token as &{NonFungibleToken.NFT}) ?? UInt256(token.id) + // Grab the URI from the NFT if available + var uri: String = "" + // Default to project-specified URI + if let metadata = token.resolveView(Type()) as! CrossVMNFT.EVMBridgedMetadata? { + uri = metadata.uri.uri() + } else { + // Otherwise, serialize the NFT using OpenSea Metadata strategy + uri = SerializeNFT.serializeNFTMetadataAsURI(&token as &{NonFungibleToken.NFT}) + } + // Lock the NFT & calculate the storage used by the NFT let storageUsed = FlowEVMBridgeNFTEscrow.lockNFT(<-token) // Calculate the bridge fee on current rates @@ -155,15 +165,6 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { let isFactoryDeployed = FlowEVMBridgeUtils.isEVMContractBridgeOwned(evmContractAddress: associatedAddress) // Controlled by the bridge - mint or transfer based on existence if isFactoryDeployed { - // Grab the URI from the NFT if available - var uri: String = "" - // Default to project-specified URI - if let metadata = token.resolveView(Type()) as! CrossVMNFT.EVMBridgedMetadata? { - uri = metadata.uri.uri() - } else { - // Otherwise, serialize the NFT using OpenSea Metadata strategy - uri = SerializeNFT.serializeNFTMetadataAsURI(&token as &{NonFungibleToken.NFT}) - } // Check if the ERC721 exists let existsResponse = EVM.decodeABI( @@ -277,6 +278,11 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { evmContractAddress: associatedAddress ) assert(isEscrowed, message: "Transfer to bridge COA failed - cannot bridge NFT without bridge escrow") + + // Derive the defining Cadence contract name & address & attempt to borrow it as IEVMBridgeNFTMinter + let contractName = FlowEVMBridgeUtils.getContractName(fromType: type)! + let contractAddress = FlowEVMBridgeUtils.getContractAddress(fromType: type)! + let nftContract = getAccount(contractAddress).contracts.borrow<&{IEVMBridgeNFTMinter}>(name: contractName) // Get the token URI from the ERC721 contract let uri = FlowEVMBridgeUtils.getTokenURI(evmContractAddress: associatedAddress, id: id) // If the NFT is currently locked, unlock and return @@ -285,18 +291,15 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { // If the NFT is bridge-defined, update the URI from the source ERC721 contract if self.account.address == FlowEVMBridgeUtils.getContractAddress(fromType: type) { - nft.updateTokenURI(uri) + nftContract!.updateTokenURI(evmID: id, newURI: uri) } return <-nft } // Otherwise, we expect the NFT to be minted in Cadence - let contractAddress = FlowEVMBridgeUtils.getContractAddress(fromType: type)! assert(self.account.address == contractAddress, message: "Unexpected error bridging NFT from EVM") - let contractName = FlowEVMBridgeUtils.getContractName(fromType: type)! - let nftContract = getAccount(contractAddress).contracts.borrow<&{IEVMBridgeNFTMinter}>(name: contractName)! - let nft <- nftContract.mintNFT(id: id, tokenURI: uri) + let nft <- nftContract!.mintNFT(id: id, tokenURI: uri) return <-nft } diff --git a/cadence/contracts/bridge/IEVMBridgeNFTMinter.cdc b/cadence/contracts/bridge/IEVMBridgeNFTMinter.cdc index 8c6b09c1..ef74aa74 100644 --- a/cadence/contracts/bridge/IEVMBridgeNFTMinter.cdc +++ b/cadence/contracts/bridge/IEVMBridgeNFTMinter.cdc @@ -9,4 +9,11 @@ contract interface IEVMBridgeNFTMinter { /// access(account) fun mintNFT(id: UInt256, tokenURI: String): @{NonFungibleToken.NFT} + + /// Allows the bridge to update the URI of bridged NFTs. This assumes that the EVM-defining project may contain + /// logic (onchain or offchain) which updates NFT metadata in the source ERC721 contract. On bridging, the URI can + /// then be updated in this contract to reflect the source ERC721 contract's metadata. + /// + access(account) + fun updateTokenURI(evmID: UInt256, newURI: String) } diff --git a/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc b/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc index 17e17e28..6b2bbc2c 100644 --- a/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc +++ b/cadence/contracts/templates/emulator/EVMBridgedNFTTemplate.cdc @@ -93,7 +93,7 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi return CrossVMNFT.EVMBridgedMetadata( name: self.name, symbol: self.symbol, - uri: CrossVMNFT.URI(self.tokenURI()) + uri: CrossVMNFT.URI(baseURI: nil, value: self.tokenURI()) ) case Type(): return MetadataViews.Serial( @@ -129,14 +129,6 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi access(all) view fun tokenURI(): String { return {{CONTRACT_NAME}}.tokenURIs[self.evmID] ?? "" } - - /* --- Bridge only method --- */ - // - /// Allows the bridge to update the URI against the source ERC721 contract on bridging back to Cadence - access(account) - fun updateURI(_ new: String) { - {{CONTRACT_NAME}}.updateTokenURI(id: self.evmID, newURI: new) - } } /// This resource holds associated NFTs, and serves queries about stored NFTs @@ -328,7 +320,7 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi return CrossVMNFT.EVMBridgedMetadata( name: self.name, symbol: self.symbol, - uri: self.contractURI != nil ? CrossVMNFT.URI(self.contractURI!) : CrossVMNFT.URI("") + uri: self.contractURI != nil ? CrossVMNFT.URI(baseURI: nil, value: self.contractURI!) : CrossVMNFT.URI(baseURI: nil, value: "") ) } return nil @@ -350,7 +342,6 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi name: self.name, symbol: self.symbol, evmID: id, - uri: tokenURI, metadata: { "Bridged Block": getCurrentBlock().height, "Bridged Timestamp": getCurrentBlock().timestamp @@ -363,11 +354,13 @@ access(all) contract {{CONTRACT_NAME}} : ICrossVM, IEVMBridgeNFTMinter, NonFungi /// then be updated in this contract to reflect the source ERC721 contract's metadata. /// access(account) - fun updateURI(id: UInt256, newURI: String) { + fun updateTokenURI(evmID: UInt256, newURI: String) { pre { - self.tokenURIs[id] != nil: "No token with the given ERC721 ID exists" + self.tokenURIs[evmID] != nil: "No token with the given ERC721 ID exists" + } + if self.tokenURIs[evmID] != newURI { + self.tokenURIs[evmID] = newURI } - self.tokenURIs[id] = newURI } init(name: String, symbol: String, evmContractAddress: EVM.EVMAddress, contractURI: String?) { diff --git a/flow.json b/flow.json index 9b42a063..11422490 100644 --- a/flow.json +++ b/flow.json @@ -149,22 +149,22 @@ "emulator": "f8d6e0586b0a20c7" } }, - "Serialize": { - "source": "./cadence/contracts/utils/Serialize.cdc", + "SerializationInterfaces": { + "source": "./cadence/contracts/utils/SerializationInterfaces.cdc", "aliases": { "emulator": "f8d6e0586b0a20c7", "testing": "0000000000000007" } }, - "SerializeNFT": { - "source": "./cadence/contracts/utils/SerializeNFT.cdc", + "Serialize": { + "source": "./cadence/contracts/utils/Serialize.cdc", "aliases": { "emulator": "f8d6e0586b0a20c7", "testing": "0000000000000007" } }, - "SerializationInterfaces": { - "source": "./cadence/contracts/utils/SerializationInterfaces.cdc", + "SerializeNFT": { + "source": "./cadence/contracts/utils/SerializeNFT.cdc", "aliases": { "emulator": "f8d6e0586b0a20c7", "testing": "0000000000000007" diff --git a/local/setup_emulator.1.sh b/local/setup_emulator.1.sh index 5e19e876..20641e18 100644 --- a/local/setup_emulator.1.sh +++ b/local/setup_emulator.1.sh @@ -1,21 +1,21 @@ #!/bin/bash -flow-c1 transactions send ./cadence/transactions/evm/create_account.cdc 100.0 +flow transactions send ./cadence/transactions/evm/create_account.cdc 100.0 -flow-c1 accounts add-contract ./cadence/contracts/utils/ArrayUtils.cdc -flow-c1 accounts add-contract ./cadence/contracts/utils/StringUtils.cdc -flow-c1 accounts add-contract ./cadence/contracts/utils/ScopedFTProviders.cdc +flow accounts add-contract ./cadence/contracts/utils/ArrayUtils.cdc +flow accounts add-contract ./cadence/contracts/utils/StringUtils.cdc +flow accounts add-contract ./cadence/contracts/utils/ScopedFTProviders.cdc -flow-c1 accounts update-contract ./cadence/contracts/standards/EVM.cdc +flow accounts update-contract ./cadence/contracts/standards/EVM.cdc # Create COA in emulator-account # Deploy the Factory contract - NOTE THE `deployedContractAddress` IN THE EMITTED EVENT -flow-c1 transactions send ./cadence/transactions/evm/deploy.cdc \ +flow transactions send ./cadence/transactions/evm/deploy.cdc \ --args-json "$(cat ./cadence/args/deploy-factory-args.json)" # Deploy initial bridge contracts -flow-c1 accounts add-contract ./cadence/contracts/bridge/BridgePermissions.cdc -flow-c1 accounts add-contract ./cadence/contracts/bridge/ICrossVM.cdc -flow-c1 accounts add-contract ./cadence/contracts/bridge/CrossVMNFT.cdc -flow-c1 accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeConfig.cdc \ No newline at end of file +flow accounts add-contract ./cadence/contracts/bridge/BridgePermissions.cdc +flow accounts add-contract ./cadence/contracts/bridge/ICrossVM.cdc +flow accounts add-contract ./cadence/contracts/bridge/CrossVMNFT.cdc +flow accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeConfig.cdc \ No newline at end of file diff --git a/local/setup_emulator.2.sh b/local/setup_emulator.2.sh index ee98fcf7..17b19c66 100644 --- a/local/setup_emulator.2.sh +++ b/local/setup_emulator.2.sh @@ -1,55 +1,60 @@ # Provided address is the address of the Factory contract deployed in the previous txn -flow-c1 accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeUtils.cdc \ +flow accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeUtils.cdc \ -flow-c1 accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeNFTEscrow.cdc -flow-c1 accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeTemplates.cdc +flow accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeNFTEscrow.cdc +flow accounts add-contract ./cadence/contracts/bridge/FlowEVMBridgeTemplates.cdc # Add the templated contract code chunks for FlowEVMBridgedNFTTemplate.cdc contents -flow-c1 transactions send ./cadence/transactions/bridge/admin/upsert_contract_code_chunks.cdc \ +flow transactions send ./cadence/transactions/bridge/admin/upsert_contract_code_chunks.cdc \ --args-json "$(cat ./cadence/args/bridged-nft-code-chunks-args.json)" --gas-limit 1600 -flow-c1 accounts add-contract ./cadence/contracts/bridge/IEVMBridgeNFTMinter.cdc +flow accounts add-contract ./cadence/contracts/bridge/IEVMBridgeNFTMinter.cdc + +# Deploy Serialization Utils +flow accounts add-contract ./cadence/contracts/utils/SerializationInterfaces.cdc +flow accounts add-contract ./cadence/contracts/utils/Serialize.cdc +flow accounts add-contract ./cadence/contracts/utils/SerializeNFT.cdc # Deploy main bridge interface & contract -flow-c1 accounts add-contract ./cadence/contracts/bridge/IFlowEVMNFTBridge.cdc -flow-c1 accounts add-contract ./cadence/contracts/bridge/FlowEVMBridge.cdc +flow accounts add-contract ./cadence/contracts/bridge/IFlowEVMNFTBridge.cdc +flow accounts add-contract ./cadence/contracts/bridge/FlowEVMBridge.cdc # Deploy the bridge router directing calls from COAs to the dedicated bridge -flow-c1 accounts add-contract ./cadence/contracts/bridge/EVMBridgeRouter.cdc 0xf8d6e0586b0a20c7 FlowEVMBridge +flow accounts add-contract ./cadence/contracts/bridge/EVMBridgeRouter.cdc 0xf8d6e0586b0a20c7 FlowEVMBridge # Create `example-nft` account 179b6b1cb6755e31 with private key 96dfbadf086daa187100a24b1fd2b709b702954bbd030a394148e11bcbb799ef -flow-c1 accounts create --key "351e1310301a7374430f6077d7b1b679c9574f8e045234eac09568ceb15c4f5d937104b4c3180df1e416da20c9d58aac576ffc328a342198a5eae4a29a13c47a" +flow accounts create --key "351e1310301a7374430f6077d7b1b679c9574f8e045234eac09568ceb15c4f5d937104b4c3180df1e416da20c9d58aac576ffc328a342198a5eae4a29a13c47a" # Create `user` account 0xf3fcd2c1a78f5eee with private key bce84aae316aec618888e5bdd24a3c8b8af46896c1ebe457e2f202a4a9c43075 -flow-c1 accounts create --key "c695fa608bd40821552fae13bb710c917309690ed69c22866abad19d276c99296379358321d0123d7074c817dd646ae8f651734526179eaed9f33eba16601ff6" +flow accounts create --key "c695fa608bd40821552fae13bb710c917309690ed69c22866abad19d276c99296379358321d0123d7074c817dd646ae8f651734526179eaed9f33eba16601ff6" # Create `erc721` account 0xe03daebed8ca0615 with private key bf602a4cdffb5610a008622f6601ba7059f8a6f533d7489457deb3d45875acb0 -flow-c1 accounts create --key "9103fd9106a83a2ede667e2486848e13e5854ea512af9bbec9ad2aec155bd5b5c146b53a6c3fd619c591ae0cd730acb875e5b6e074047cf31d620b53c55a4fb4" +flow accounts create --key "9103fd9106a83a2ede667e2486848e13e5854ea512af9bbec9ad2aec155bd5b5c146b53a6c3fd619c591ae0cd730acb875e5b6e074047cf31d620b53c55a4fb4" # Give the user some FLOW -flow-c1 transactions send ./cadence/transactions/flow-token/transfer_flow.cdc 0xf3fcd2c1a78f5eee 100.0 +flow transactions send ./cadence/transactions/flow-token/transfer_flow.cdc 0xf3fcd2c1a78f5eee 100.0 # Give the erc721 some FLOW -flow-c1 transactions send ./cadence/transactions/flow-token/transfer_flow.cdc 0xe03daebed8ca0615 100.0 +flow transactions send ./cadence/transactions/flow-token/transfer_flow.cdc 0xe03daebed8ca0615 100.0 # Create a COA for the user -flow-c1 transactions send ./cadence/transactions/evm/create_account.cdc 10.0 --signer user +flow transactions send ./cadence/transactions/evm/create_account.cdc 10.0 --signer user # Create a COA for the erc721 -flow-c1 transactions send ./cadence/transactions/evm/create_account.cdc 10.0 --signer erc721 +flow transactions send ./cadence/transactions/evm/create_account.cdc 10.0 --signer erc721 # user transfers Flow to the COA -flow-c1 transactions send ./cadence/transactions/evm/deposit.cdc 10.0 --signer user +flow transactions send ./cadence/transactions/evm/deposit.cdc 10.0 --signer user # erc721 transfers Flow to the COA -flow-c1 transactions send ./cadence/transactions/evm/deposit.cdc 10.0 --signer erc721 +flow transactions send ./cadence/transactions/evm/deposit.cdc 10.0 --signer erc721 # Setup User with Example NFT collection - Will break flow.json config due to bug in CLI - break here and update flow.json manually -flow-c1 accounts add-contract ./cadence/contracts/example-assets/ExampleNFT.cdc --signer example-nft +flow accounts add-contract ./cadence/contracts/example-assets/ExampleNFT.cdc --signer example-nft -flow-c1 transactions send ./cadence/transactions/example-assets/setup_collection.cdc --signer user -flow-c1 transactions send ./cadence/transactions/example-assets/mint_nft.cdc f3fcd2c1a78f5eee example description thumbnail '[]' '[]' '[]' --signer example-nft +flow transactions send ./cadence/transactions/example-assets/setup_collection.cdc --signer user +flow transactions send ./cadence/transactions/example-assets/mint_nft.cdc f3fcd2c1a78f5eee example description thumbnail '[]' '[]' '[]' --signer example-nft # Deploy ExampleERC721 contract with erc721's COA as owner - NOTE THE `deployedContractAddress` EMITTED IN THE RESULTING EVENT -flow-c1 transactions send ./cadence/transactions/evm/deploy.cdc \ +flow transactions send ./cadence/transactions/evm/deploy.cdc \ --args-json "$(cat ./cadence/args/deploy-erc721-args.json)" --signer erc721 \ No newline at end of file diff --git a/local/setup_emulator.3.sh b/local/setup_emulator.3.sh index 6485be51..0b7f6054 100644 --- a/local/setup_emulator.3.sh +++ b/local/setup_emulator.3.sh @@ -1,4 +1,4 @@ # Mint an ERC721 with ID 42 to the user's COA -flow-c1 transactions send ./cadence/transactions/example-assets/safe_mint_erc721.cdc \ +flow transactions send ./cadence/transactions/example-assets/safe_mint_erc721.cdc \ 42 "URI" 200000 \ --signer erc721 From 85bec37e9cbc1fcbaf5ca88592f169f743fa27c9 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Tue, 19 Mar 2024 16:59:53 -0500 Subject: [PATCH 16/25] update serialization tests --- cadence/tests/serialize_nft_tests.cdc | 39 ++++++++++++------- ...erialize_tests.cdc => serialize_tests.cdc} | 4 -- 2 files changed, 25 insertions(+), 18 deletions(-) rename cadence/tests/{Serialize_tests.cdc => serialize_tests.cdc} (99%) diff --git a/cadence/tests/serialize_nft_tests.cdc b/cadence/tests/serialize_nft_tests.cdc index a9291169..33e392d7 100644 --- a/cadence/tests/serialize_nft_tests.cdc +++ b/cadence/tests/serialize_nft_tests.cdc @@ -1,17 +1,13 @@ import Test import BlockchainHelpers -import "NonFungibleToken" -import "ViewResolver" -import "MetadataViews" - import "Serialize" import "SerializationInterfaces" -access(all) -let admin = Test.getAccount(0x0000000000000007) -access(all) -let alice = Test.createAccount() +access(all) let admin = Test.getAccount(0x0000000000000007) +access(all) let alice = Test.createAccount() + +access(all) var mintedBlockHeight: UInt64 = 0 access(all) fun setup() { @@ -44,6 +40,12 @@ fun setup() { arguments: [] ) Test.expect(err, Test.beNil()) + err = Test.deployContract( + name: "FungibleTokenMetadataViews", + path: "../contracts/standards/FungibleTokenMetadataViews.cdc", + arguments: [] + ) + Test.expect(err, Test.beNil()) err = Test.deployContract( name: "ExampleNFT", path: "../contracts/example-assets/ExampleNFT.cdc", @@ -86,9 +88,16 @@ fun testSerializeNFTSucceeds() { ) Test.expect(mintResult, Test.beSucceeded()) + let heightResult = executeScript( + "../scripts/test/get_block_height.cdc", + [] + ) + mintedBlockHeight = heightResult.returnValue! as! UInt64 + let heightString = mintedBlockHeight.toString() + let expectedPrefix = "data:application/json;ascii,{\"name\": \"ExampleNFT\", \"description\": \"Example NFT Collection\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://example-nft.onflow.org\", " - let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"54\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}" - let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"54\"}" + let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}") + let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"}") let idsResult = executeScript( "../scripts/nft/get_ids.cdc", @@ -105,15 +114,17 @@ fun testSerializeNFTSucceeds() { let serializedMetadata = serializeMetadataResult.returnValue! as! String - Test.assertEqual(true, serializedMetadata == expectedPrefix.concat(altSuffix1) || serializedMetadata == expectedPrefix.concat(altSuffix2)) - // Test.assertEqual(serializedMetadata, expectedPrefix.concat(altSuffix1)) + // Test.assertEqual(true, serializedMetadata == expectedPrefix.concat(altSuffix1) || serializedMetadata == expectedPrefix.concat(altSuffix2)) + Test.assertEqual(serializedMetadata, expectedPrefix.concat(altSuffix1)) } access(all) fun testOpenSeaMetadataSerializationStrategySucceeds() { + let heightString = mintedBlockHeight.toString() + let expectedPrefix = "data:application/json;ascii,{\"name\": \"ExampleNFT\", \"description\": \"Example NFT Collection\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://example-nft.onflow.org\", " - let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"54\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}" - let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"54\"}" + let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}") + let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"}") let idsResult = executeScript( "../scripts/nft/get_ids.cdc", diff --git a/cadence/tests/Serialize_tests.cdc b/cadence/tests/serialize_tests.cdc similarity index 99% rename from cadence/tests/Serialize_tests.cdc rename to cadence/tests/serialize_tests.cdc index 91daa122..a7a1ccc9 100644 --- a/cadence/tests/Serialize_tests.cdc +++ b/cadence/tests/serialize_tests.cdc @@ -1,10 +1,6 @@ import Test import BlockchainHelpers -import "NonFungibleToken" -import "ViewResolver" -import "MetadataViews" - import "Serialize" import "SerializationInterfaces" From ebcabf8e49e16a5faa4eb8487ad3471fa8342a7a Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Tue, 19 Mar 2024 18:19:59 -0500 Subject: [PATCH 17/25] minimize serialization utils by removing interfaces & strategies --- .../contracts/utils/DelegatedCOACaller.cdc | 137 ++++++++++ .../utils/SerializationInterfaces.cdc | 30 --- cadence/contracts/utils/Serialize.cdc | 24 -- cadence/contracts/utils/SerializeNFT.cdc | 56 +--- .../serialize_nft_from_open_sea_strategy.cdc | 21 -- .../scripts/serialize/serialize_nft_old.cdc | 239 ++++++++++++++++++ cadence/tests/serialize_nft_tests.cdc | 29 --- cadence/tests/serialize_tests.cdc | 7 - flow.json | 7 - local/normalize_coverage_report.sh | 1 - local/setup_emulator.2.sh | 1 - 11 files changed, 378 insertions(+), 174 deletions(-) create mode 100644 cadence/contracts/utils/DelegatedCOACaller.cdc delete mode 100644 cadence/contracts/utils/SerializationInterfaces.cdc delete mode 100644 cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc create mode 100644 cadence/scripts/serialize/serialize_nft_old.cdc diff --git a/cadence/contracts/utils/DelegatedCOACaller.cdc b/cadence/contracts/utils/DelegatedCOACaller.cdc new file mode 100644 index 00000000..f712792c --- /dev/null +++ b/cadence/contracts/utils/DelegatedCOACaller.cdc @@ -0,0 +1,137 @@ +import "FungibleToken" + +import "EVM" + +import "FlowEVMBridgeUtils" + +access(all) +contract DelegatedCOACaller { + + access(all) + let pathPrefix: String + + access(all) + event CallerCreated(address: EVM.EVMAddress, owner: Address?) + + access(all) + struct interface ICallParameters { + access(all) let to: EVM.EVMAddress + access(all) let data: [UInt8] + access(all) let gasLimit: UInt64 + access(all) let value: EVM.Balance + } + + access(all) + struct CallParameters : ICallParameters{ + access(all) let to: EVM.EVMAddress + access(all) let data: [UInt8] + access(all) let gasLimit: UInt64 + access(all) let value: EVM.Balance + + init( + to: EVM.EVMAddress, + data: [UInt8], + gasLimit: UInt64, + value: EVM.Balance + ) { + self.to = to + self.data = data + self.gasLimit = gasLimit + self.value = value + } + } + + access(all) + resource interface ICaller : EVM.Addressable { + access(all) + var pendingCall: {ICallParameters}? + + access(EVM.Owner | EVM.Call) + fun setPendingCall(_ parameters: {ICallParameters}) { + pre { + self.pendingCall == nil: "Call already pending" + } + } + + access(EVM.Owner | EVM.Call) + fun reset() { + self.pendingCall = nil + } + + access(all) + fun executeCall(): EVM.Result { + pre { + self.pendingCall != nil: "No pending call found" + } + post { + self.pendingCall == nil + } + } + } + + access(all) + resource Caller : ICaller, EVM.Addressable { + access(self) + let coaCapability: Capability + access(all) + var pendingCall: {ICallParameters}? + + init(coaCapability: Capability) { + pre { + coaCapability.borrow() != nil: "Invalid COA Capability" + } + self.coaCapability = coaCapability + self.pendingCall = nil + } + + /// The EVM address of the associated CadenceOwnedAccount + access(all)caSt + view fun address(): EVM.EVMAddress { + return self.borrowCOA().address() + } + + access(all) + fun executeCall(): EVM.Result { + let callResult = self.borrowCOA().call( + to: self.pendingCall!.to, + data: self.pendingCall!.data, + gasLimit: self.pendingCall!.gasLimit, + value: self.pendingCall!.value + ) + self.reset() + return callResult + } + + access(EVM.Owner | EVM.Call) + fun setPendingCall(_ parameters: {ICallParameters}) { + self.pendingCall = parameters + } + + access(EVM.Owner | EVM.Call) + fun reset() { + self.pendingCall = nil + } + + access(self) + view fun borrowCOA(): auth(EVM.Call) &EVM.CadenceOwnedAccount { + return self.coaCapability.borrow() ?? panic("Invalid COA Capability") + } + } + + access(all) + fun createCaller(coaCapability: Capability): @Caller { + let caller <- create Caller(coaCapability: coaCapability) + emit CallerCreated(address: caller.address(), owner: coaCapability.borrow()!.owner?.address) + return <-caller + } + + access(all) + view fun deriveStoragePath(from coaAddress: EVM.EVMAddress): StoragePath? { + let addressHex = FlowEVMBridgeUtils.getEVMAddressAsHexString(address: coaAddress) + return StoragePath(identifier: self.pathPrefix.concat(addressHex)) + } + + init() { + self.pathPrefix = "delegatedCOACaller_" + } +} diff --git a/cadence/contracts/utils/SerializationInterfaces.cdc b/cadence/contracts/utils/SerializationInterfaces.cdc deleted file mode 100644 index 667982a5..00000000 --- a/cadence/contracts/utils/SerializationInterfaces.cdc +++ /dev/null @@ -1,30 +0,0 @@ -/// The contract defines an interface for serialization strategies that can be used to serialize the struct or resource -/// according to a specific format. -/// -access(all) contract SerializationInterfaces { - - /// A SerializationStrategy takes a reference to a SerializableResource or SerializableStruct and returns a - /// serialized representation of it. The strategy is responsible for determining the structure of the serialized - /// representation and the format of the serialized data. - /// - access(all) - struct interface SerializationStrategy { - /// Returns the types supported by the implementing strategy - /// - access(all) view fun getSupportedTypes(): [Type] { - return [] - } - - /// Returns serialized representation of the given resource according to the format of the implementing strategy - /// - access(all) fun serializeResource(_ r: &AnyResource): String? { - return nil - } - - /// Returns serialized representation of the given struct according to the format of the implementing strategy - /// - access(all) fun serializeStruct(_ s: AnyStruct): String? { - return nil - } - } -} diff --git a/cadence/contracts/utils/Serialize.cdc b/cadence/contracts/utils/Serialize.cdc index 9c73f430..19347bc1 100644 --- a/cadence/contracts/utils/Serialize.cdc +++ b/cadence/contracts/utils/Serialize.cdc @@ -2,8 +2,6 @@ import "ViewResolver" import "MetadataViews" import "NonFungibleToken" -import "SerializationInterfaces" - /// This contract is a utility for serializing primitive types, arrays, and common metadata mapping formats to JSON /// compatible strings. Also included are interfaces enabling custom serialization for structs and resources. /// @@ -12,28 +10,6 @@ import "SerializationInterfaces" access(all) contract Serialize { - /// A basic serialization strategy that supports serializing resources and structs to JSON-compatible strings. - /// - access(all) - struct JSONStringStrategy : SerializationInterfaces.SerializationStrategy { - /// Returns the types this stategy will attempt to serialize - /// - access(all) view fun getSupportedTypes(): [Type] { - return [Type<@AnyResource>(), Type()] - } - /// Returns the resource serialized on its identifier as an escaped JSON string - /// - access(all) fun serializeResource(_ r: &AnyResource): String? { - return Serialize.tryToJSONString(r.getType().identifier) - } - /// Returns the an escaped JSON string of the provided struct, calling through to Serialize.tryToJSONString - /// with the provided value - /// - access(all) fun serializeStruct(_ s: AnyStruct): String? { - return Serialize.tryToJSONString(s) - } - } - /// Method that returns a serialized representation of the given value or nil if the value is not serializable /// access(all) diff --git a/cadence/contracts/utils/SerializeNFT.cdc b/cadence/contracts/utils/SerializeNFT.cdc index 4b36a643..c519e3a2 100644 --- a/cadence/contracts/utils/SerializeNFT.cdc +++ b/cadence/contracts/utils/SerializeNFT.cdc @@ -2,65 +2,13 @@ import "ViewResolver" import "MetadataViews" import "NonFungibleToken" -import "SerializationInterfaces" import "Serialize" /// This contract defines methods for serializing NFT metadata as a JSON compatible string, according to the common -/// OpenSea metadata format. NFTs can be serialized by reference via contract methods or via the -/// OpenSeaMetadataSerializationStrategy struct. +/// OpenSea metadata format. NFTs and metadata views can be serialized by reference via contract methods. /// access(all) contract SerializeNFT { - /// This struct will serialize NFT metadata as a JSON-compatible URI according to the OpenSea metadata standard - /// - access(all) - struct OpenSeaMetadataSerializationStrategy : SerializationInterfaces.SerializationStrategy { - /// Returns the types this strategy is intended to serialize - /// - access(all) view fun getSupportedTypes(): [Type] { - return [ - Type<@{NonFungibleToken.NFT}>(), - Type(), - Type(), - Type() - ] - } - - /// Serializes the given NFT (as &AnyResource) as a JSON compatible string in the format of an - /// OpenSea-compatible metadata URI. If the given resource is not an NFT, this method returns nil. - /// - /// Reference: https://docs.opensea.io/docs/metadata-standards - /// - access(all) fun serializeResource(_ r: &AnyResource): String? { - if r.getType().isSubtype(of: Type<@{NonFungibleToken.NFT}>()) { - let nft = r as! &{NonFungibleToken.NFT} - return SerializeNFT.serializeNFTMetadataAsURI(nft) - } - return nil - } - - /// Serializes the given struct as a JSON compatible string in the format that conforms with overlapping values - /// expected by the OpenSea metadata standard. If the given struct is not a Display, NFTCollectionDisplay, or - /// Traits view, this method returns nil. - /// - access(all) fun serializeStruct(_ s: AnyStruct): String? { - switch s.getType() { - case Type(): - let view = s as! MetadataViews.NFTCollectionDisplay - return SerializeNFT.serializeNFTDisplay(nftDisplay: nil, collectionDisplay: view) - case Type(): - let view = s as! MetadataViews.Display - return SerializeNFT.serializeNFTDisplay(nftDisplay: view, collectionDisplay: nil) - case Type(): - let view = s as! MetadataViews.Traits - return SerializeNFT.serializeNFTTraitsAsAttributes(view) - default: - return nil - - } - } - } - /// Serializes the metadata (as a JSON compatible String) for a given NFT according to formats expected by EVM /// platforms like OpenSea. If you are a project owner seeking to expose custom traits on bridged NFTs and your /// Trait.value is not natively serializable, you can implement a custom serialization method with the @@ -115,7 +63,7 @@ access(all) contract SerializeNFT { /// \"name\": \"\", \"description\": \"\", \"image\": \"\", \"external_url\": \"\", /// access(all) - fun serializeNFTDisplay(nftDisplay: MetadataViews.Display?, collectionDisplay: MetadataViews.NFTCollectionDisplay?): String? { + fun serializeNFTDisplay(nftDisplay: MetadataViews.Display?, collectionDisplay: MetadataViews.NFTCollectionDisplay?, ): String? { // Return early if both values are nil if nftDisplay == nil && collectionDisplay == nil { return nil diff --git a/cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc b/cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc deleted file mode 100644 index 95b8d1e2..00000000 --- a/cadence/scripts/serialize/serialize_nft_from_open_sea_strategy.cdc +++ /dev/null @@ -1,21 +0,0 @@ -import "ViewResolver" -import "MetadataViews" -import "NonFungibleToken" - -import "SerializeNFT" - -access(all) -fun main(address: Address, storagePathIdentifier: String, id: UInt64): String? { - let storagePath = StoragePath(identifier: storagePathIdentifier) - ?? panic("Could not construct StoragePath from identifier") - if let collection = getAuthAccount(address).storage - .borrow<&{NonFungibleToken.Collection}>( - from: storagePath - ) { - if let nft = collection.borrowNFT(id) { - let strategy = SerializeNFT.OpenSeaMetadataSerializationStrategy() - return strategy.serializeResource(nft) - } - } - return nil -} diff --git a/cadence/scripts/serialize/serialize_nft_old.cdc b/cadence/scripts/serialize/serialize_nft_old.cdc new file mode 100644 index 00000000..810edfa4 --- /dev/null +++ b/cadence/scripts/serialize/serialize_nft_old.cdc @@ -0,0 +1,239 @@ +import ViewResolver from 0x631e88ae7f1d7c20 +import MetadataViews from 0x631e88ae7f1d7c20 +import NonFungibleToken from 0x631e88ae7f1d7c20 + +/// Defines the interface for a struct that returns a serialized representation of itself +/// +access(all) +struct interface SerializableStruct { + access(all) fun serialize(): String +} + +/// Method that returns a serialized representation of the given value or nil if the value is not serializable +/// +access(all) +fun tryToJSONString(_ value: AnyStruct): String? { + // Call serialize on the value if available + if value.getType().isSubtype(of: Type<{SerializableStruct}>()) { + return (value as! {SerializableStruct}).serialize() + } + // Recursively serialize array & return + if value.getType().isSubtype(of: Type<[AnyStruct]>()) { + return arrayToJSONString(value as! [AnyStruct]) + } + // Recursively serialize map & return + if value.getType().isSubtype(of: Type<{String: AnyStruct}>()) { + return dictToJSONString(dict: value as! {String: AnyStruct}, excludedNames: nil) + } + // Handle primitive types & optionals + switch value.getType() { + case Type(): + return "\"nil\"" + case Type(): + return "\"".concat(value as! String).concat("\"") + case Type(): + return "\"".concat(value as? String ?? "nil").concat("\"") + case Type(): + return "\"".concat((value as! Character).toString()).concat("\"") + case Type(): + return "\"".concat(value as! Bool ? "true" : "false").concat("\"") + case Type
(): + return "\"".concat((value as! Address).toString()).concat("\"") + case Type(): + return "\"".concat((value as? Address)?.toString() ?? "nil").concat("\"") + case Type(): + return "\"".concat((value as! Int8).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Int16).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Int32).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Int64).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Int128).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Int256).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Int).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UInt8).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UInt16).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UInt32).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UInt64).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UInt128).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UInt256).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UInt).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Word8).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Word16).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Word32).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Word64).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Word128).toString()).concat("\"") + case Type(): + return "\"".concat((value as! Word256).toString()).concat("\"") + case Type(): + return "\"".concat((value as! UFix64).toString()).concat("\"") + default: + return nil + } +} + +/// Method that returns a serialized representation of the given array or nil if the value is not serializable +/// +access(all) +fun arrayToJSONString(_ arr: [AnyStruct]): String? { + var serializedArr = "[" + for i, element in arr { + let serializedElement = tryToJSONString(element) + if serializedElement == nil { + return nil + } + serializedArr = serializedArr.concat(serializedElement!) + if i < arr.length - 1 { + serializedArr = serializedArr.concat(", ") + } + } + return serializedArr.concat("]") +} + +/// Method that returns a serialized representation of the given String-indexed mapping or nil if the value is not +/// serializable. The interface here is largely the same as as the `MetadataViews.dictToTraits` method, though here +/// a JSON-compatible String is returned instead of a `Traits` array. +/// +access(all) +fun dictToJSONString(dict: {String: AnyStruct}, excludedNames: [String]?): String? { + if excludedNames != nil { + for k in excludedNames! { + dict.remove(key: k) + } + } + var serializedDict = "{" + for i, key in dict.keys { + let serializedValue = tryToJSONString(dict[key]!) + if serializedValue == nil { + return nil + } + serializedDict = serializedDict.concat(tryToJSONString(key)!).concat(": ").concat(serializedValue!) + if i < dict.length - 1 { + serializedDict = serializedDict.concat(", ") + } + } + return serializedDict.concat("}") +} + +/// Serializes the metadata (as a JSON compatible String) for a given NFT according to formats expected by EVM +/// platforms like OpenSea. If you are a project owner seeking to expose custom traits on bridged NFTs and your +/// Trait.value is not natively serializable, you can implement a custom serialization method with the +/// `{SerializableStruct}` interface's `serialize` method. +/// +/// REF: https://github.com/ethereum/ercs/blob/master/ERCS/erc-721.md +/// REF: https://github.com/ethereum/ercs/blob/master/ERCS/erc-1155.md#erc-1155-metadata-uri-json-schema +/// REF: https://docs.opensea.io/docs/metadata-standards +/// +access(all) +fun serializeNFTMetadata(_ nft: &{MetadataViews.Resolver}): String { + // if nft.getType().isSubtype(of: Type<@{SerializableResource}>()) { + // let serializable = nft as! &{SerializableResource} + // return serializable.serialize() + // } + let display = serializeNFTDisplay(nft) + let attributes = serializeNFTTraitsAsAttributes(nft) + if display == nil && attributes == nil { + return "" + } + var serializedMetadata= "data:application/json;utf8,{" + if display != nil { + serializedMetadata = serializedMetadata.concat(display!) + } + if display != nil && attributes != nil { + serializedMetadata = serializedMetadata.concat(", ") + } + if attributes != nil { + serializedMetadata = serializedMetadata.concat(attributes!) + } + return serializedMetadata.concat("}") +} + +/// Serializes the display & collection display views of a given NFT as a JSON compatible string +/// +access(all) +fun serializeNFTDisplay(_ nft: &{MetadataViews.Resolver}): String? { + // Resolve Display & NFTCollection Display view, returning early if neither are found + let nftDisplay: MetadataViews.Display? = nft.resolveView(Type()) as! MetadataViews.Display? + let collectionDisplay: MetadataViews.NFTCollectionDisplay? = nft.resolveView(Type()) as! MetadataViews.NFTCollectionDisplay? + if nftDisplay == nil && collectionDisplay == nil { + return nil + } + // Initialize the JSON fields + let name = "\"name\": " + let description = "\"description\": " + let image = "\"image\": " + var serializedResult = "" + // Append results from the Display view to the serialized JSON compatible string + if nftDisplay != nil { + serializedResult = serializedResult.concat(name).concat(tryToJSONString(nftDisplay!.name)!).concat(", ") + .concat(description).concat(tryToJSONString(nftDisplay!.description)!).concat(", ") + .concat(image).concat(tryToJSONString(nftDisplay!.thumbnail.uri())!) + } + // Append a comma if both Display & NFTCollection Display views are present + if nftDisplay != nil && collectionDisplay != nil { + serializedResult = serializedResult.concat(", ") + } + // Serialize the external URL from the NFTCollection Display view & return + let externalURL = "\"external_url\": " + if collectionDisplay != nil { + serializedResult = serializedResult.concat(externalURL).concat(tryToJSONString(collectionDisplay!.externalURL.url)!) + } + return serializedResult +} + +/// Serializes a given NFT's Traits view as a JSON compatible string. If a given Trait is not serializable, it is +/// skipped and not included in the serialized result. If you are a project owner seeking to expose custom traits +/// on bridged NFTs and your Trait.value is not natively serializable, you can implement a custom serialization +/// method with the `{SerializableStruct}` interface's `serialize` method. +/// +access(all) +fun serializeNFTTraitsAsAttributes(_ nft: &{MetadataViews.Resolver}): String? { + // Get the Traits view from the NFT, returning early if no traits are found + let traits = nft.resolveView(Type()) as! MetadataViews.Traits? + if traits == nil { + return nil + } + + // Serialize each trait as an attribute, building the serialized JSON compatible string + var serializedResult = "\"attributes\": [" + for i, trait in traits!.traits { + let value = tryToJSONString(trait.value) + if value == nil { + continue + } + serializedResult = serializedResult.concat("{") + .concat("\"trait_type\": ").concat(tryToJSONString(trait.name)!) + .concat(", \"value\": ").concat(value!) + .concat("}") + if i < traits!.traits.length - 1 { + serializedResult = serializedResult.concat(",") + } + } + return serializedResult.concat("]") +} + +access(all) +fun main(address: Address, storagePathIdentifier: String, id: UInt64): String? { + let storagePath = StoragePath(identifier: storagePathIdentifier)! + if let collection = getAuthAccount(address).borrow<&{MetadataViews.ResolverCollection}>(from: storagePath) { + let nft = collection.borrowViewResolver(id: id) as &{MetadataViews.Resolver} + return serializeNFTMetadata(nft) + } + return nil +} diff --git a/cadence/tests/serialize_nft_tests.cdc b/cadence/tests/serialize_nft_tests.cdc index 33e392d7..caf2b1e8 100644 --- a/cadence/tests/serialize_nft_tests.cdc +++ b/cadence/tests/serialize_nft_tests.cdc @@ -2,7 +2,6 @@ import Test import BlockchainHelpers import "Serialize" -import "SerializationInterfaces" access(all) let admin = Test.getAccount(0x0000000000000007) access(all) let alice = Test.createAccount() @@ -52,12 +51,6 @@ fun setup() { arguments: [] ) Test.expect(err, Test.beNil()) - err = Test.deployContract( - name: "SerializationInterfaces", - path: "../contracts/utils/SerializationInterfaces.cdc", - arguments: [] - ) - Test.expect(err, Test.beNil()) err = Test.deployContract( name: "Serialize", path: "../contracts/utils/Serialize.cdc", @@ -117,25 +110,3 @@ fun testSerializeNFTSucceeds() { // Test.assertEqual(true, serializedMetadata == expectedPrefix.concat(altSuffix1) || serializedMetadata == expectedPrefix.concat(altSuffix2)) Test.assertEqual(serializedMetadata, expectedPrefix.concat(altSuffix1)) } - -access(all) -fun testOpenSeaMetadataSerializationStrategySucceeds() { - let heightString = mintedBlockHeight.toString() - - let expectedPrefix = "data:application/json;ascii,{\"name\": \"ExampleNFT\", \"description\": \"Example NFT Collection\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://example-nft.onflow.org\", " - let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}") - let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"}") - - let idsResult = executeScript( - "../scripts/nft/get_ids.cdc", - [alice.address, "cadenceExampleNFTCollection"] - ) - Test.expect(idsResult, Test.beSucceeded()) - let ids = idsResult.returnValue! as! [UInt64] - - let serializeMetadataResult = executeScript( - "../scripts/serialize/serialize_nft_from_open_sea_strategy.cdc", - [alice.address, "cadenceExampleNFTCollection", ids[0]] - ) - Test.expect(serializeMetadataResult, Test.beSucceeded()) -} diff --git a/cadence/tests/serialize_tests.cdc b/cadence/tests/serialize_tests.cdc index a7a1ccc9..b0e32a19 100644 --- a/cadence/tests/serialize_tests.cdc +++ b/cadence/tests/serialize_tests.cdc @@ -2,7 +2,6 @@ import Test import BlockchainHelpers import "Serialize" -import "SerializationInterfaces" access(all) let admin = Test.getAccount(0x0000000000000007) @@ -40,12 +39,6 @@ fun setup() { arguments: [] ) Test.expect(err, Test.beNil()) - err = Test.deployContract( - name: "SerializationInterfaces", - path: "../contracts/utils/SerializationInterfaces.cdc", - arguments: [] - ) - Test.expect(err, Test.beNil()) err = Test.deployContract( name: "Serialize", path: "../contracts/utils/Serialize.cdc", diff --git a/flow.json b/flow.json index 11422490..0b48e44a 100644 --- a/flow.json +++ b/flow.json @@ -149,13 +149,6 @@ "emulator": "f8d6e0586b0a20c7" } }, - "SerializationInterfaces": { - "source": "./cadence/contracts/utils/SerializationInterfaces.cdc", - "aliases": { - "emulator": "f8d6e0586b0a20c7", - "testing": "0000000000000007" - } - }, "Serialize": { "source": "./cadence/contracts/utils/Serialize.cdc", "aliases": { diff --git a/local/normalize_coverage_report.sh b/local/normalize_coverage_report.sh index 8de7ee5f..37fc2917 100644 --- a/local/normalize_coverage_report.sh +++ b/local/normalize_coverage_report.sh @@ -1,3 +1,2 @@ -sed -i 's/A.0000000000000007.SerializationInterfaces/cadence\contracts\/SerializationInterfaces.cdc/' coverage.lcov sed -i 's/A.0000000000000007.Serialize/cadence\/contracts\/utils\/Serialize.cdc/' coverage.lcov sed -i 's/A.0000000000000007.SerializeNFT/cadence\contracts\/SerializeNFT.cdc/' coverage.lcov \ No newline at end of file diff --git a/local/setup_emulator.2.sh b/local/setup_emulator.2.sh index 17b19c66..4143ef95 100644 --- a/local/setup_emulator.2.sh +++ b/local/setup_emulator.2.sh @@ -11,7 +11,6 @@ flow transactions send ./cadence/transactions/bridge/admin/upsert_contract_code_ flow accounts add-contract ./cadence/contracts/bridge/IEVMBridgeNFTMinter.cdc # Deploy Serialization Utils -flow accounts add-contract ./cadence/contracts/utils/SerializationInterfaces.cdc flow accounts add-contract ./cadence/contracts/utils/Serialize.cdc flow accounts add-contract ./cadence/contracts/utils/SerializeNFT.cdc From 86735b572eb3e001adad8a11ef006db497749a3c Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Tue, 19 Mar 2024 19:58:28 -0500 Subject: [PATCH 18/25] fix NFT serialization, add test cases & add contract URI serialization on deployERC721 --- cadence/contracts/bridge/FlowEVMBridge.cdc | 25 ++++++-- cadence/contracts/utils/SerializeNFT.cdc | 44 +++++++------- cadence/tests/serialize_nft_tests.cdc | 70 +++++++++++++++++++++- 3 files changed, 110 insertions(+), 29 deletions(-) diff --git a/cadence/contracts/bridge/FlowEVMBridge.cdc b/cadence/contracts/bridge/FlowEVMBridge.cdc index f63be6f5..ff336bd7 100644 --- a/cadence/contracts/bridge/FlowEVMBridge.cdc +++ b/cadence/contracts/bridge/FlowEVMBridge.cdc @@ -143,7 +143,7 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { if let metadata = token.resolveView(Type()) as! CrossVMNFT.EVMBridgedMetadata? { uri = metadata.uri.uri() } else { - // Otherwise, serialize the NFT using OpenSea Metadata strategy + // Otherwise, serialize the NFT uri = SerializeNFT.serializeNFTMetadataAsURI(&token as &{NonFungibleToken.NFT}) } @@ -416,13 +416,26 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { // Borrow the ViewResolver to attempt to resolve the EVMBridgedMetadata view let viewResolver = getAccount(cadenceAddress).contracts.borrow<&{ViewResolver}>(name: name)! var contractURI = "" - if let bridgedMetadata = viewResolver.resolveContractView( + // Try to resolve the EVMBridgedMetadata + let bridgedMetadata = viewResolver.resolveContractView( resourceType: forNFTType, viewType: Type() - ) as! CrossVMNFT.EVMBridgedMetadata? { - name = bridgedMetadata.name - symbol = bridgedMetadata.symbol - contractURI = bridgedMetadata.uri.uri() + ) as! CrossVMNFT.EVMBridgedMetadata? + // Default to project-defined URI if available + if bridgedMetadata != nil { + name = bridgedMetadata!.name + symbol = bridgedMetadata!.symbol + contractURI = bridgedMetadata!.uri.uri() + } else { + // Otherwise, serialize collection-level NFTCollectionDisplay + if let collectionDisplay = viewResolver.resolveContractView( + resourceType: forNFTType, + viewType: Type() + ) as! MetadataViews.NFTCollectionDisplay? { + name = collectionDisplay.name + let serializedDisplay = SerializeNFT.serializeFromDisplays(nftDisplay: nil, collectionDisplay: collectionDisplay)! + contractURI = "data:application/json;ascii,{".concat(serializedDisplay).concat("}") + } } // Call to the factory contract to deploy an ERC721 diff --git a/cadence/contracts/utils/SerializeNFT.cdc b/cadence/contracts/utils/SerializeNFT.cdc index c519e3a2..c8a97501 100644 --- a/cadence/contracts/utils/SerializeNFT.cdc +++ b/cadence/contracts/utils/SerializeNFT.cdc @@ -30,7 +30,7 @@ access(all) contract SerializeNFT { // Serialize the display values from the NFT's Display & NFTCollectionDisplay views let nftDisplay = nft.resolveView(Type()) as! MetadataViews.Display? let collectionDisplay = nft.resolveView(Type()) as! MetadataViews.NFTCollectionDisplay? - let display = self.serializeNFTDisplay(nftDisplay: nftDisplay, collectionDisplay: collectionDisplay) + let display = self.serializeFromDisplays(nftDisplay: nftDisplay, collectionDisplay: collectionDisplay) // Get the Traits view from the NFT, returning early if no traits are found let traits = nft.resolveView(Type()) as! MetadataViews.Traits? @@ -41,7 +41,7 @@ access(all) contract SerializeNFT { return "" } // Init the data format prefix & concatenate the serialized display & attributes - var serializedMetadata= "data:application/json;ascii,{" + var serializedMetadata = "data:application/json;ascii,{" if display != nil { serializedMetadata = serializedMetadata.concat(display!) } @@ -49,21 +49,24 @@ access(all) contract SerializeNFT { serializedMetadata = serializedMetadata.concat(", ") } if attributes != nil { - serializedMetadata = serializedMetadata.concat(attributes!) + serializedMetadata = serializedMetadata.concat(attributes) } return serializedMetadata.concat("}") } - /// Serializes the display & collection display views of a given NFT as a JSON compatible string + /// Serializes the display & collection display views of a given NFT as a JSON compatible string. If nftDisplay is + /// present, the value is returned as token-level metadata. If nftDisplay is nil and collectionDisplay is present, + /// the value is returned as contract-level metadata. If both values are nil, nil is returned. /// /// @param nftDisplay: The NFT's Display view from which values `name`, `description`, and `thumbnail` are serialized /// @param collectionDisplay: The NFT's NFTCollectionDisplay view from which the `externalURL` is serialized /// - /// @returns: A JSON compatible string containing the serialized display & collection display views as: - /// \"name\": \"\", \"description\": \"\", \"image\": \"\", \"external_url\": \"\", + /// @returns: A JSON compatible string containing the serialized display & collection display views as either: + /// \"name\": \"\", \"description\": \"\", \"image\": \"\", \"external_url\": \"\", + /// \"name\": \"\", \"description\": \"\", \"image\": \"\", \"external_link\": \"\", /// access(all) - fun serializeNFTDisplay(nftDisplay: MetadataViews.Display?, collectionDisplay: MetadataViews.NFTCollectionDisplay?, ): String? { + fun serializeFromDisplays(nftDisplay: MetadataViews.Display?, collectionDisplay: MetadataViews.NFTCollectionDisplay?): String? { // Return early if both values are nil if nftDisplay == nil && collectionDisplay == nil { return nil @@ -74,33 +77,32 @@ access(all) contract SerializeNFT { let description = "\"description\": " let image = "\"image\": " let externalURL = "\"external_url\": " + let externalLink = "\"external_link\": " var serializedResult = "" - // Append results from the Display view to the serialized JSON compatible string + // Append results from the token-level Display view to the serialized JSON compatible string if nftDisplay != nil { serializedResult = serializedResult .concat(name).concat(Serialize.tryToJSONString(nftDisplay!.name)!).concat(", ") .concat(description).concat(Serialize.tryToJSONString(nftDisplay!.description)!).concat(", ") .concat(image).concat(Serialize.tryToJSONString(nftDisplay!.thumbnail.uri())!) - // Return here if collectionDisplay is not present - if collectionDisplay == nil { - return serializedResult + // Append the `externa_url` value from NFTCollectionDisplay view if present + if collectionDisplay != nil { + return serializedResult.concat(", ") + .concat(externalURL).concat(Serialize.tryToJSONString(collectionDisplay!.externalURL.url)!) } } - // Append a comma if both Display & NFTCollection Display views are present - if nftDisplay != nil { - serializedResult = serializedResult.concat(", ") - } else { - // Otherwise, append the name & description fields from the NFTCollectionDisplay view, foregoing image - serializedResult = serializedResult - .concat(name).concat(Serialize.tryToJSONString(collectionDisplay!.name)!).concat(", ") - .concat(description).concat(Serialize.tryToJSONString(collectionDisplay!.description)!).concat(", ") + if collectionDisplay == nil { + return serializedResult } + // Without token-level view, serialize as contract-level metadata return serializedResult - .concat(externalURL) - .concat(Serialize.tryToJSONString(collectionDisplay!.externalURL.url)!) + .concat(name).concat(Serialize.tryToJSONString(collectionDisplay!.name)!).concat(", ") + .concat(description).concat(Serialize.tryToJSONString(collectionDisplay!.description)!).concat(", ") + .concat(image).concat(Serialize.tryToJSONString(collectionDisplay!.squareImage.file.uri())!).concat(", ") + .concat(externalLink).concat(Serialize.tryToJSONString(collectionDisplay!.externalURL.url)!) } /// Serializes given Traits view as a JSON compatible string. If a given Trait is not serializable, it is skipped diff --git a/cadence/tests/serialize_nft_tests.cdc b/cadence/tests/serialize_nft_tests.cdc index caf2b1e8..efd97991 100644 --- a/cadence/tests/serialize_nft_tests.cdc +++ b/cadence/tests/serialize_nft_tests.cdc @@ -1,7 +1,10 @@ import Test import BlockchainHelpers +import "MetadataViews" + import "Serialize" +import "SerializeNFT" access(all) let admin = Test.getAccount(0x0000000000000007) access(all) let alice = Test.createAccount() @@ -107,6 +110,69 @@ fun testSerializeNFTSucceeds() { let serializedMetadata = serializeMetadataResult.returnValue! as! String - // Test.assertEqual(true, serializedMetadata == expectedPrefix.concat(altSuffix1) || serializedMetadata == expectedPrefix.concat(altSuffix2)) - Test.assertEqual(serializedMetadata, expectedPrefix.concat(altSuffix1)) + Test.assertEqual(true, serializedMetadata == expectedPrefix.concat(altSuffix1) || serializedMetadata == expectedPrefix.concat(altSuffix2)) +} + +// Returns nil when no displays are provided +access(all) +fun testSerializeNilDisplaysReturnsNil() { + let serializedResult = SerializeNFT.serializeFromDisplays(nftDisplay: nil, collectionDisplay: nil) + Test.assertEqual(nil, serializedResult) +} + +// Given just token-level Display, serialize as tokenURI format +access(all) +fun testSerializeNFTDisplaySucceeds() { + let display = MetadataViews.Display( + name: "NAME", + description: "NFT Description", + thumbnail: MetadataViews.HTTPFile(url: "https://flow.com/examplenft.jpg"), + ) + + let expected = "\"name\": \"NAME\", \"description\": \"NFT Description\", \"image\": \"https://flow.com/examplenft.jpg\"" + + let serializedResult = SerializeNFT.serializeFromDisplays(nftDisplay: display, collectionDisplay: nil) + Test.assertEqual(expected, serializedResult!) +} + +// Given just token-level Display, serialize as contractURI format +access(all) +fun testSerializeNFTCollectionDisplaySucceeds() { + let collectionDisplay = MetadataViews.NFTCollectionDisplay( + name: "NAME", + description: "NFT Description", + externalURL: MetadataViews.ExternalURL("https://flow.com"), + squareImage: MetadataViews.Media(file: MetadataViews.HTTPFile(url: "https://flow.com/square_image.jpg"), mediaType: "image"), + bannerImage: MetadataViews.Media(file: MetadataViews.HTTPFile(url: "https://flow.com/square_image.jpg"), mediaType: "image"), + socials: {} + ) + + let expected = "\"name\": \"NAME\", \"description\": \"NFT Description\", \"image\": \"https://flow.com/square_image.jpg\", \"external_link\": \"https://flow.com\"" + + let serializedResult = SerializeNFT.serializeFromDisplays(nftDisplay: nil, collectionDisplay: collectionDisplay) + Test.assertEqual(expected, serializedResult!) +} + +// Given bol token- & contract-level Displays, serialize as tokenURI format +access(all) +fun testSerializeBothDisplaysSucceeds() { + let nftDisplay = MetadataViews.Display( + name: "NAME", + description: "NFT Description", + thumbnail: MetadataViews.HTTPFile(url: "https://flow.com/examplenft.jpg"), + ) + + let collectionDisplay = MetadataViews.NFTCollectionDisplay( + name: "NAME", + description: "NFT Description", + externalURL: MetadataViews.ExternalURL("https://flow.com"), + squareImage: MetadataViews.Media(file: MetadataViews.HTTPFile(url: "https://flow.com/square_image.jpg"), mediaType: "image"), + bannerImage: MetadataViews.Media(file: MetadataViews.HTTPFile(url: "https://flow.com/square_image.jpg"), mediaType: "image"), + socials: {} + ) + + let expected = "\"name\": \"NAME\", \"description\": \"NFT Description\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://flow.com\"" + + let serializedResult = SerializeNFT.serializeFromDisplays(nftDisplay: nftDisplay, collectionDisplay: collectionDisplay) + Test.assertEqual(expected, serializedResult!) } From 8c3b445376e8fdeccacfe3a223b0d7a90313f936 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Tue, 19 Mar 2024 19:59:50 -0500 Subject: [PATCH 19/25] add test/get_block_height script --- cadence/scripts/test/get_block_height.cdc | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 cadence/scripts/test/get_block_height.cdc diff --git a/cadence/scripts/test/get_block_height.cdc b/cadence/scripts/test/get_block_height.cdc new file mode 100644 index 00000000..cd95b66d --- /dev/null +++ b/cadence/scripts/test/get_block_height.cdc @@ -0,0 +1,4 @@ +access(all) +fun main(): UInt64 { + return getCurrentBlock().height +} \ No newline at end of file From ad2c31944931c0711493e60cc168a5784402d1c7 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Tue, 19 Mar 2024 22:20:06 -0500 Subject: [PATCH 20/25] fix foundry_test ci failures --- cadence/contracts/bridge/FlowEVMBridge.cdc | 2 +- foundry.toml | 1 - solidity/test/FlowBridgeFactory.t.sol | 9 +++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/cadence/contracts/bridge/FlowEVMBridge.cdc b/cadence/contracts/bridge/FlowEVMBridge.cdc index ff336bd7..2b22f681 100644 --- a/cadence/contracts/bridge/FlowEVMBridge.cdc +++ b/cadence/contracts/bridge/FlowEVMBridge.cdc @@ -146,7 +146,7 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { // Otherwise, serialize the NFT uri = SerializeNFT.serializeNFTMetadataAsURI(&token as &{NonFungibleToken.NFT}) } - + // Lock the NFT & calculate the storage used by the NFT let storageUsed = FlowEVMBridgeNFTEscrow.lockNFT(<-token) // Calculate the bridge fee on current rates diff --git a/foundry.toml b/foundry.toml index eff86f58..2b5e79b5 100644 --- a/foundry.toml +++ b/foundry.toml @@ -4,6 +4,5 @@ out = "./solidity/out" libs = ["./solidity/lib"] script = "./solidity/script" test = "./solidity/test" -eth_rpc_url = "http://127.0.0.1:8545" # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options diff --git a/solidity/test/FlowBridgeFactory.t.sol b/solidity/test/FlowBridgeFactory.t.sol index 08c6c5b1..05d6e73a 100644 --- a/solidity/test/FlowBridgeFactory.t.sol +++ b/solidity/test/FlowBridgeFactory.t.sol @@ -1,13 +1,14 @@ // SPDX-License-Identifier: UNLICENSED pragma solidity ^0.8.17; -import {Test, console2} from "forge-std/Test.sol"; +import {Test} from "forge-std/Test.sol"; + import {FlowBridgeFactory} from "../src/FlowBridgeFactory.sol"; import {FlowBridgedERC721} from "../src/FlowBridgedERC721.sol"; contract FlowBridgeFactoryTest is Test { - FlowBridgeFactory public factory; - FlowBridgedERC721 public deployedERC721Contract; + FlowBridgeFactory internal factory; + FlowBridgedERC721 internal deployedERC721Contract; string name; string symbol; @@ -16,7 +17,7 @@ contract FlowBridgeFactoryTest is Test { string contractURI; address deployedERC721Address; - function setUp() public { + function setUp() public virtual { factory = new FlowBridgeFactory(); name = "name"; symbol = "symbol"; From 2757b83f4b5b45ad5680a19db5d3195ddb8e8fc4 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Wed, 20 Mar 2024 12:04:58 -0500 Subject: [PATCH 21/25] update serialization serialized json data prefix --- cadence/contracts/bridge/FlowEVMBridge.cdc | 2 +- cadence/contracts/utils/SerializeNFT.cdc | 2 +- cadence/tests/serialize_nft_tests.cdc | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cadence/contracts/bridge/FlowEVMBridge.cdc b/cadence/contracts/bridge/FlowEVMBridge.cdc index 2b22f681..48608972 100644 --- a/cadence/contracts/bridge/FlowEVMBridge.cdc +++ b/cadence/contracts/bridge/FlowEVMBridge.cdc @@ -434,7 +434,7 @@ contract FlowEVMBridge : IFlowEVMNFTBridge { ) as! MetadataViews.NFTCollectionDisplay? { name = collectionDisplay.name let serializedDisplay = SerializeNFT.serializeFromDisplays(nftDisplay: nil, collectionDisplay: collectionDisplay)! - contractURI = "data:application/json;ascii,{".concat(serializedDisplay).concat("}") + contractURI = "data:application/json;utf8,{".concat(serializedDisplay).concat("}") } } diff --git a/cadence/contracts/utils/SerializeNFT.cdc b/cadence/contracts/utils/SerializeNFT.cdc index c8a97501..42cd631e 100644 --- a/cadence/contracts/utils/SerializeNFT.cdc +++ b/cadence/contracts/utils/SerializeNFT.cdc @@ -41,7 +41,7 @@ access(all) contract SerializeNFT { return "" } // Init the data format prefix & concatenate the serialized display & attributes - var serializedMetadata = "data:application/json;ascii,{" + var serializedMetadata = "data:application/json;utf8,{" if display != nil { serializedMetadata = serializedMetadata.concat(display!) } diff --git a/cadence/tests/serialize_nft_tests.cdc b/cadence/tests/serialize_nft_tests.cdc index efd97991..ef0e1bbc 100644 --- a/cadence/tests/serialize_nft_tests.cdc +++ b/cadence/tests/serialize_nft_tests.cdc @@ -91,7 +91,7 @@ fun testSerializeNFTSucceeds() { mintedBlockHeight = heightResult.returnValue! as! UInt64 let heightString = mintedBlockHeight.toString() - let expectedPrefix = "data:application/json;ascii,{\"name\": \"ExampleNFT\", \"description\": \"Example NFT Collection\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://example-nft.onflow.org\", " + let expectedPrefix = "data:application/json;utf8,{\"name\": \"ExampleNFT\", \"description\": \"Example NFT Collection\", \"image\": \"https://flow.com/examplenft.jpg\", \"external_url\": \"https://example-nft.onflow.org\", " let altSuffix1 = "\"attributes\": [{\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"},{\"trait_type\": \"foo\", \"value\": \"nil\"}]}") let altSuffix2 = "\"attributes\": [{\"trait_type\": \"foo\", \"value\": \"nil\"}]}, {\"trait_type\": \"mintedBlock\", \"value\": \"".concat(heightString).concat("\"}") From 886a718c868de95851e3f45b7230cc0f3b345b74 Mon Sep 17 00:00:00 2001 From: Ardit Marku Date: Wed, 20 Mar 2024 19:36:14 +0200 Subject: [PATCH 22/25] Update flow-cli version used in CI workflow --- .github/workflows/cadence_test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/cadence_test.yml b/.github/workflows/cadence_test.yml index 69caf3c9..ee4a3111 100644 --- a/.github/workflows/cadence_test.yml +++ b/.github/workflows/cadence_test.yml @@ -19,7 +19,7 @@ jobs: restore-keys: | ${{ runner.os }}-go- - name: Install Flow CLI - run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)" -- v1.12.0-cadence-v1.0.0-M8-2 + run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)" -- v1.15.0-cadence-v1.0.0-preview.12 - name: Flow CLI Version run: flow version - name: Update PATH From eb43517e2ee6ce9c1a6184d2729c36e8b149a65b Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Wed, 20 Mar 2024 13:07:08 -0500 Subject: [PATCH 23/25] remove unnecessary script --- .../scripts/serialize/serialize_nft_old.cdc | 239 ------------------ 1 file changed, 239 deletions(-) delete mode 100644 cadence/scripts/serialize/serialize_nft_old.cdc diff --git a/cadence/scripts/serialize/serialize_nft_old.cdc b/cadence/scripts/serialize/serialize_nft_old.cdc deleted file mode 100644 index 810edfa4..00000000 --- a/cadence/scripts/serialize/serialize_nft_old.cdc +++ /dev/null @@ -1,239 +0,0 @@ -import ViewResolver from 0x631e88ae7f1d7c20 -import MetadataViews from 0x631e88ae7f1d7c20 -import NonFungibleToken from 0x631e88ae7f1d7c20 - -/// Defines the interface for a struct that returns a serialized representation of itself -/// -access(all) -struct interface SerializableStruct { - access(all) fun serialize(): String -} - -/// Method that returns a serialized representation of the given value or nil if the value is not serializable -/// -access(all) -fun tryToJSONString(_ value: AnyStruct): String? { - // Call serialize on the value if available - if value.getType().isSubtype(of: Type<{SerializableStruct}>()) { - return (value as! {SerializableStruct}).serialize() - } - // Recursively serialize array & return - if value.getType().isSubtype(of: Type<[AnyStruct]>()) { - return arrayToJSONString(value as! [AnyStruct]) - } - // Recursively serialize map & return - if value.getType().isSubtype(of: Type<{String: AnyStruct}>()) { - return dictToJSONString(dict: value as! {String: AnyStruct}, excludedNames: nil) - } - // Handle primitive types & optionals - switch value.getType() { - case Type(): - return "\"nil\"" - case Type(): - return "\"".concat(value as! String).concat("\"") - case Type(): - return "\"".concat(value as? String ?? "nil").concat("\"") - case Type(): - return "\"".concat((value as! Character).toString()).concat("\"") - case Type(): - return "\"".concat(value as! Bool ? "true" : "false").concat("\"") - case Type
(): - return "\"".concat((value as! Address).toString()).concat("\"") - case Type(): - return "\"".concat((value as? Address)?.toString() ?? "nil").concat("\"") - case Type(): - return "\"".concat((value as! Int8).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Int16).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Int32).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Int64).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Int128).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Int256).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Int).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UInt8).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UInt16).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UInt32).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UInt64).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UInt128).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UInt256).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UInt).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Word8).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Word16).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Word32).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Word64).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Word128).toString()).concat("\"") - case Type(): - return "\"".concat((value as! Word256).toString()).concat("\"") - case Type(): - return "\"".concat((value as! UFix64).toString()).concat("\"") - default: - return nil - } -} - -/// Method that returns a serialized representation of the given array or nil if the value is not serializable -/// -access(all) -fun arrayToJSONString(_ arr: [AnyStruct]): String? { - var serializedArr = "[" - for i, element in arr { - let serializedElement = tryToJSONString(element) - if serializedElement == nil { - return nil - } - serializedArr = serializedArr.concat(serializedElement!) - if i < arr.length - 1 { - serializedArr = serializedArr.concat(", ") - } - } - return serializedArr.concat("]") -} - -/// Method that returns a serialized representation of the given String-indexed mapping or nil if the value is not -/// serializable. The interface here is largely the same as as the `MetadataViews.dictToTraits` method, though here -/// a JSON-compatible String is returned instead of a `Traits` array. -/// -access(all) -fun dictToJSONString(dict: {String: AnyStruct}, excludedNames: [String]?): String? { - if excludedNames != nil { - for k in excludedNames! { - dict.remove(key: k) - } - } - var serializedDict = "{" - for i, key in dict.keys { - let serializedValue = tryToJSONString(dict[key]!) - if serializedValue == nil { - return nil - } - serializedDict = serializedDict.concat(tryToJSONString(key)!).concat(": ").concat(serializedValue!) - if i < dict.length - 1 { - serializedDict = serializedDict.concat(", ") - } - } - return serializedDict.concat("}") -} - -/// Serializes the metadata (as a JSON compatible String) for a given NFT according to formats expected by EVM -/// platforms like OpenSea. If you are a project owner seeking to expose custom traits on bridged NFTs and your -/// Trait.value is not natively serializable, you can implement a custom serialization method with the -/// `{SerializableStruct}` interface's `serialize` method. -/// -/// REF: https://github.com/ethereum/ercs/blob/master/ERCS/erc-721.md -/// REF: https://github.com/ethereum/ercs/blob/master/ERCS/erc-1155.md#erc-1155-metadata-uri-json-schema -/// REF: https://docs.opensea.io/docs/metadata-standards -/// -access(all) -fun serializeNFTMetadata(_ nft: &{MetadataViews.Resolver}): String { - // if nft.getType().isSubtype(of: Type<@{SerializableResource}>()) { - // let serializable = nft as! &{SerializableResource} - // return serializable.serialize() - // } - let display = serializeNFTDisplay(nft) - let attributes = serializeNFTTraitsAsAttributes(nft) - if display == nil && attributes == nil { - return "" - } - var serializedMetadata= "data:application/json;utf8,{" - if display != nil { - serializedMetadata = serializedMetadata.concat(display!) - } - if display != nil && attributes != nil { - serializedMetadata = serializedMetadata.concat(", ") - } - if attributes != nil { - serializedMetadata = serializedMetadata.concat(attributes!) - } - return serializedMetadata.concat("}") -} - -/// Serializes the display & collection display views of a given NFT as a JSON compatible string -/// -access(all) -fun serializeNFTDisplay(_ nft: &{MetadataViews.Resolver}): String? { - // Resolve Display & NFTCollection Display view, returning early if neither are found - let nftDisplay: MetadataViews.Display? = nft.resolveView(Type()) as! MetadataViews.Display? - let collectionDisplay: MetadataViews.NFTCollectionDisplay? = nft.resolveView(Type()) as! MetadataViews.NFTCollectionDisplay? - if nftDisplay == nil && collectionDisplay == nil { - return nil - } - // Initialize the JSON fields - let name = "\"name\": " - let description = "\"description\": " - let image = "\"image\": " - var serializedResult = "" - // Append results from the Display view to the serialized JSON compatible string - if nftDisplay != nil { - serializedResult = serializedResult.concat(name).concat(tryToJSONString(nftDisplay!.name)!).concat(", ") - .concat(description).concat(tryToJSONString(nftDisplay!.description)!).concat(", ") - .concat(image).concat(tryToJSONString(nftDisplay!.thumbnail.uri())!) - } - // Append a comma if both Display & NFTCollection Display views are present - if nftDisplay != nil && collectionDisplay != nil { - serializedResult = serializedResult.concat(", ") - } - // Serialize the external URL from the NFTCollection Display view & return - let externalURL = "\"external_url\": " - if collectionDisplay != nil { - serializedResult = serializedResult.concat(externalURL).concat(tryToJSONString(collectionDisplay!.externalURL.url)!) - } - return serializedResult -} - -/// Serializes a given NFT's Traits view as a JSON compatible string. If a given Trait is not serializable, it is -/// skipped and not included in the serialized result. If you are a project owner seeking to expose custom traits -/// on bridged NFTs and your Trait.value is not natively serializable, you can implement a custom serialization -/// method with the `{SerializableStruct}` interface's `serialize` method. -/// -access(all) -fun serializeNFTTraitsAsAttributes(_ nft: &{MetadataViews.Resolver}): String? { - // Get the Traits view from the NFT, returning early if no traits are found - let traits = nft.resolveView(Type()) as! MetadataViews.Traits? - if traits == nil { - return nil - } - - // Serialize each trait as an attribute, building the serialized JSON compatible string - var serializedResult = "\"attributes\": [" - for i, trait in traits!.traits { - let value = tryToJSONString(trait.value) - if value == nil { - continue - } - serializedResult = serializedResult.concat("{") - .concat("\"trait_type\": ").concat(tryToJSONString(trait.name)!) - .concat(", \"value\": ").concat(value!) - .concat("}") - if i < traits!.traits.length - 1 { - serializedResult = serializedResult.concat(",") - } - } - return serializedResult.concat("]") -} - -access(all) -fun main(address: Address, storagePathIdentifier: String, id: UInt64): String? { - let storagePath = StoragePath(identifier: storagePathIdentifier)! - if let collection = getAuthAccount(address).borrow<&{MetadataViews.ResolverCollection}>(from: storagePath) { - let nft = collection.borrowViewResolver(id: id) as &{MetadataViews.Resolver} - return serializeNFTMetadata(nft) - } - return nil -} From 3c57f2efd13c48e34bf443bb29ea9824e65e06ae Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Thu, 21 Mar 2024 11:21:04 -0500 Subject: [PATCH 24/25] update test comments --- cadence/tests/serialize_nft_tests.cdc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cadence/tests/serialize_nft_tests.cdc b/cadence/tests/serialize_nft_tests.cdc index ef0e1bbc..1000bb60 100644 --- a/cadence/tests/serialize_nft_tests.cdc +++ b/cadence/tests/serialize_nft_tests.cdc @@ -135,7 +135,7 @@ fun testSerializeNFTDisplaySucceeds() { Test.assertEqual(expected, serializedResult!) } -// Given just token-level Display, serialize as contractURI format +// Given just contract-level Display, serialize as contractURI format access(all) fun testSerializeNFTCollectionDisplaySucceeds() { let collectionDisplay = MetadataViews.NFTCollectionDisplay( From a17d812a72b9fd649efbfca9d1e948c7cb4f5d38 Mon Sep 17 00:00:00 2001 From: Giovanni Sanchez <108043524+sisyphusSmiling@users.noreply.github.com> Date: Fri, 29 Mar 2024 15:21:26 -0500 Subject: [PATCH 25/25] remove unused contract --- .../contracts/utils/DelegatedCOACaller.cdc | 137 ------------------ 1 file changed, 137 deletions(-) delete mode 100644 cadence/contracts/utils/DelegatedCOACaller.cdc diff --git a/cadence/contracts/utils/DelegatedCOACaller.cdc b/cadence/contracts/utils/DelegatedCOACaller.cdc deleted file mode 100644 index f712792c..00000000 --- a/cadence/contracts/utils/DelegatedCOACaller.cdc +++ /dev/null @@ -1,137 +0,0 @@ -import "FungibleToken" - -import "EVM" - -import "FlowEVMBridgeUtils" - -access(all) -contract DelegatedCOACaller { - - access(all) - let pathPrefix: String - - access(all) - event CallerCreated(address: EVM.EVMAddress, owner: Address?) - - access(all) - struct interface ICallParameters { - access(all) let to: EVM.EVMAddress - access(all) let data: [UInt8] - access(all) let gasLimit: UInt64 - access(all) let value: EVM.Balance - } - - access(all) - struct CallParameters : ICallParameters{ - access(all) let to: EVM.EVMAddress - access(all) let data: [UInt8] - access(all) let gasLimit: UInt64 - access(all) let value: EVM.Balance - - init( - to: EVM.EVMAddress, - data: [UInt8], - gasLimit: UInt64, - value: EVM.Balance - ) { - self.to = to - self.data = data - self.gasLimit = gasLimit - self.value = value - } - } - - access(all) - resource interface ICaller : EVM.Addressable { - access(all) - var pendingCall: {ICallParameters}? - - access(EVM.Owner | EVM.Call) - fun setPendingCall(_ parameters: {ICallParameters}) { - pre { - self.pendingCall == nil: "Call already pending" - } - } - - access(EVM.Owner | EVM.Call) - fun reset() { - self.pendingCall = nil - } - - access(all) - fun executeCall(): EVM.Result { - pre { - self.pendingCall != nil: "No pending call found" - } - post { - self.pendingCall == nil - } - } - } - - access(all) - resource Caller : ICaller, EVM.Addressable { - access(self) - let coaCapability: Capability - access(all) - var pendingCall: {ICallParameters}? - - init(coaCapability: Capability) { - pre { - coaCapability.borrow() != nil: "Invalid COA Capability" - } - self.coaCapability = coaCapability - self.pendingCall = nil - } - - /// The EVM address of the associated CadenceOwnedAccount - access(all)caSt - view fun address(): EVM.EVMAddress { - return self.borrowCOA().address() - } - - access(all) - fun executeCall(): EVM.Result { - let callResult = self.borrowCOA().call( - to: self.pendingCall!.to, - data: self.pendingCall!.data, - gasLimit: self.pendingCall!.gasLimit, - value: self.pendingCall!.value - ) - self.reset() - return callResult - } - - access(EVM.Owner | EVM.Call) - fun setPendingCall(_ parameters: {ICallParameters}) { - self.pendingCall = parameters - } - - access(EVM.Owner | EVM.Call) - fun reset() { - self.pendingCall = nil - } - - access(self) - view fun borrowCOA(): auth(EVM.Call) &EVM.CadenceOwnedAccount { - return self.coaCapability.borrow() ?? panic("Invalid COA Capability") - } - } - - access(all) - fun createCaller(coaCapability: Capability): @Caller { - let caller <- create Caller(coaCapability: coaCapability) - emit CallerCreated(address: caller.address(), owner: coaCapability.borrow()!.owner?.address) - return <-caller - } - - access(all) - view fun deriveStoragePath(from coaAddress: EVM.EVMAddress): StoragePath? { - let addressHex = FlowEVMBridgeUtils.getEVMAddressAsHexString(address: coaAddress) - return StoragePath(identifier: self.pathPrefix.concat(addressHex)) - } - - init() { - self.pathPrefix = "delegatedCOACaller_" - } -}