Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Adds CrossVMMetadataViews to templates package #477

Merged
merged 4 commits into from
Mar 7, 2025
Merged

Adds CrossVMMetadataViews to templates package #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3dcc366
add CrossVMMetadataViews to templates package
joshuahannan Feb 26, 2025
2614a1d
add getters for ExampleToken and ExampleNFT
joshuahannan Feb 26, 2025
3f68298
add LinearCodeAddressGenerator to contracts
joshuahannan Mar 3, 2025
40781b8
update NFT contracts version
joshuahannan Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 30 additions & 16 deletions lib/go/contracts/contracts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

_ "github.com/kevinburke/go-bindata"
ftcontracts "github.com/onflow/flow-ft/lib/go/contracts"
"github.com/onflow/flow-go-sdk"
nftcontracts "github.com/onflow/flow-nft/lib/go/contracts"

"github.com/onflow/flow-core-contracts/lib/go/templates"
Expand All @@ -26,22 +27,23 @@ import (
///

const (
flowFeesFilename = "FlowFees.cdc"
storageFeesFilename = "FlowStorageFees.cdc"
executionParametersFilename = "FlowExecutionParameters.cdc"
flowServiceAccountFilename = "FlowServiceAccount.cdc"
flowTokenFilename = "FlowToken.cdc"
flowIdentityTableFilename = "FlowIDTableStaking.cdc"
flowQCFilename = "epochs/FlowClusterQC.cdc"
flowDKGFilename = "epochs/FlowDKG.cdc"
flowEpochFilename = "epochs/FlowEpoch.cdc"
flowLockedTokensFilename = "LockedTokens.cdc"
flowStakingProxyFilename = "StakingProxy.cdc"
flowStakingCollectionFilename = "FlowStakingCollection.cdc"
flowContractAuditsFilename = "FlowContractAudits.cdc"
flowNodeVersionBeaconFilename = "NodeVersionBeacon.cdc"
flowRandomBeaconHistoryFilename = "RandomBeaconHistory.cdc"
cryptoFilename = "Crypto.cdc"
flowFeesFilename = "FlowFees.cdc"
storageFeesFilename = "FlowStorageFees.cdc"
executionParametersFilename = "FlowExecutionParameters.cdc"
flowServiceAccountFilename = "FlowServiceAccount.cdc"
flowTokenFilename = "FlowToken.cdc"
flowIdentityTableFilename = "FlowIDTableStaking.cdc"
flowQCFilename = "epochs/FlowClusterQC.cdc"
flowDKGFilename = "epochs/FlowDKG.cdc"
flowEpochFilename = "epochs/FlowEpoch.cdc"
flowLockedTokensFilename = "LockedTokens.cdc"
flowStakingProxyFilename = "StakingProxy.cdc"
flowStakingCollectionFilename = "FlowStakingCollection.cdc"
flowContractAuditsFilename = "FlowContractAudits.cdc"
flowNodeVersionBeaconFilename = "NodeVersionBeacon.cdc"
flowRandomBeaconHistoryFilename = "RandomBeaconHistory.cdc"
cryptoFilename = "Crypto.cdc"
linearCodeAddressGeneratorFilename = "LinearCodeAddressGenerator.cdc"

// Test contracts
// only used for testing
Expand Down Expand Up @@ -301,6 +303,10 @@ func Crypto() []byte {
return assets.MustAsset(cryptoFilename)
}

func LinearCodeAddressGenerator() []byte {
return assets.MustAsset(linearCodeAddressGeneratorFilename)
}

/******************** Test contracts *********************/

// TESTFlowIDTableStaking returns the TestFlowIDTableStaking contract
Expand Down Expand Up @@ -361,3 +367,11 @@ func TestFlowFees(fungibleTokenAddress, flowTokenAddress, storageFeesAddress str

return []byte(code)
}

func ExampleToken(env templates.Environment) []byte {
return ftcontracts.ExampleToken(env.FungibleTokenAddress, env.MetadataViewsAddress, env.FungibleTokenMetadataViewsAddress)
}

func ExampleNFT(env templates.Environment) []byte {
return nftcontracts.ExampleNFTWithCrossVMPointers(flow.HexToAddress(env.NonFungibleTokenAddress), flow.HexToAddress(env.MetadataViewsAddress), flow.HexToAddress(env.ViewResolverAddress), flow.HexToAddress(env.EVMAddress), flow.HexToAddress(env.CrossVMMetadataViewsAddress))
}
Comment on lines +371 to +377
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming these are just added for testing?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I added them so we could use them for testing in flow-go

5 changes: 5 additions & 0 deletions lib/go/contracts/contracts_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,11 @@ func TestCrypto(t *testing.T) {
GetCadenceContractShouldSucceed(t, contract)
}

func TestLinearCodeAddressGenerator(t *testing.T) {
contract := string(contracts.LinearCodeAddressGenerator())
GetCadenceContractShouldSucceed(t, contract)
}

func TestFlowExecutionParameters(t *testing.T) {
env := templates.Environment{}
SetAllAddresses(&env)
Expand Down
6 changes: 3 additions & 3 deletions lib/go/contracts/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ toolchain go1.22.4

require (
github.com/kevinburke/go-bindata v3.24.0+incompatible
github.com/onflow/flow-core-contracts/lib/go/templates v1.5.1-preview
github.com/onflow/flow-core-contracts/lib/go/templates v1.6.1-0.20250226163127-3c9723416637
github.com/onflow/flow-ft/lib/go/contracts v1.0.1
github.com/onflow/flow-nft/lib/go/contracts v1.2.3
github.com/onflow/flow-go-sdk v1.0.0-preview.54
github.com/onflow/flow-nft/lib/go/contracts v1.2.4
github.com/stretchr/testify v1.9.0
)

Expand Down Expand Up @@ -38,7 +39,6 @@ require (
github.com/onflow/cadence v1.0.0-preview.51 // indirect
github.com/onflow/crypto v0.25.1 // indirect
github.com/onflow/flow-ft/lib/go/templates v1.0.1 // indirect
github.com/onflow/flow-go-sdk v1.0.0-preview.54 // indirect
github.com/onflow/flow-nft/lib/go/templates v1.2.1 // indirect
github.com/onflow/flow/protobuf/go/flow v0.4.3 // indirect
github.com/onflow/go-ethereum v1.13.4 // indirect
Expand Down
8 changes: 4 additions & 4 deletions lib/go/contracts/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,16 +221,16 @@ github.com/onflow/cadence v1.0.0-preview.51 h1:L+toCS2Sw9bsExc2PxeNMmAK96fn2LdTO
github.com/onflow/cadence v1.0.0-preview.51/go.mod h1:7wvvecnAZtYOspLOS3Lh+FuAmMeSrXhAWiycC3kQ1UU=
github.com/onflow/crypto v0.25.1 h1:0txy2PKPMM873JbpxQNbJmuOJtD56bfs48RQfm0ts5A=
github.com/onflow/crypto v0.25.1/go.mod h1:C8FbaX0x8y+FxWjbkHy0Q4EASCDR9bSPWZqlpCLYyVI=
github.com/onflow/flow-core-contracts/lib/go/templates v1.5.1-preview h1:C0PraQFfwpav4nJAf/RPE9BJyYD6lUMvt+cJyiMDeis=
github.com/onflow/flow-core-contracts/lib/go/templates v1.5.1-preview/go.mod h1:pN768Al/wLRlf3bwugv9TyxniqJxMu4sxnX9eQJam64=
github.com/onflow/flow-core-contracts/lib/go/templates v1.6.1-0.20250226163127-3c9723416637 h1:EhhRQDEAc5K3NOtFF+Qd7eXKOToYxEOtSqOtt70ia/Y=
github.com/onflow/flow-core-contracts/lib/go/templates v1.6.1-0.20250226163127-3c9723416637/go.mod h1:pN768Al/wLRlf3bwugv9TyxniqJxMu4sxnX9eQJam64=
github.com/onflow/flow-ft/lib/go/contracts v1.0.1 h1:Ts5ob+CoCY2EjEd0W6vdLJ7hLL3SsEftzXG2JlmSe24=
github.com/onflow/flow-ft/lib/go/contracts v1.0.1/go.mod h1:PwsL8fC81cjnUnTfmyL/HOIyHnyaw/JA474Wfj2tl6A=
github.com/onflow/flow-ft/lib/go/templates v1.0.1 h1:FDYKAiGowABtoMNusLuRCILIZDtVqJ/5tYI4VkF5zfM=
github.com/onflow/flow-ft/lib/go/templates v1.0.1/go.mod h1:uQ8XFqmMK2jxyBSVrmyuwdWjTEb+6zGjRYotfDJ5pAE=
github.com/onflow/flow-go-sdk v1.0.0-preview.54 h1:5GjCkyIyvE9KolOUUPTkGdEiV/8qOe1MGnLHOLBmthA=
github.com/onflow/flow-go-sdk v1.0.0-preview.54/go.mod h1:u9oFiS25TpnU1EW62PQlq22jzkwBAj4VEiiCBM6nhHo=
github.com/onflow/flow-nft/lib/go/contracts v1.2.3 h1:4ju20g1xgDKWBT63rOj5f/Sa4Lc+naCSWT4p31x9yQk=
github.com/onflow/flow-nft/lib/go/contracts v1.2.3/go.mod h1:eZ9VMMNfCq0ho6kV25xJn1kXeCfxnkhj3MwF3ed08gY=
github.com/onflow/flow-nft/lib/go/contracts v1.2.4 h1:gWJgSSgIGo0qWOqr90+khQ69VoYF9vNlqzF+Yh6YYy4=
github.com/onflow/flow-nft/lib/go/contracts v1.2.4/go.mod h1:eZ9VMMNfCq0ho6kV25xJn1kXeCfxnkhj3MwF3ed08gY=
github.com/onflow/flow-nft/lib/go/templates v1.2.1 h1:SAALMZPDw9Eb9p5kSLnmnFxjyig1MLiT4JUlLp0/bSE=
github.com/onflow/flow-nft/lib/go/templates v1.2.1/go.mod h1:W6hOWU0xltPqNpv9gQX8Pj8Jtf0OmRxc1XX2V0kzJaI=
github.com/onflow/flow/protobuf/go/flow v0.4.3 h1:gdY7Ftto8dtU+0wI+6ZgW4oE+z0DSDUMIDwVx8mqae8=
Expand Down
60 changes: 38 additions & 22 deletions lib/go/templates/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,30 @@ import (
)

const (
placeholderFungibleTokenAddress = "\"FungibleToken\""
placeholderNonFungibleTokenAddress = "\"NonFungibleToken\""
placeholderEVMAddress = "\"EVM\""
placeholderViewResolverAddress = "\"ViewResolver\""
placeholderFungibleTokenMVAddress = "\"FungibleTokenMetadataViews\""
placeholderMetadataViewsAddress = "\"MetadataViews\""
placeholderBurnerAddress = "\"Burner\""
placeholderCryptoAddress = "\"Crypto\""
placeholderFlowTokenAddress = "\"FlowToken\""
placeholderIDTableAddress = "\"FlowIDTableStaking\""
placeholderLockedTokensAddress = "\"LockedTokens\""
placeholderStakingProxyAddress = "\"StakingProxy\""
placeholderQuorumCertificateAddress = "\"FlowClusterQC\""
placeholderFlowFeesAddress = "\"FlowFees\""
placeholderStorageFeesAddress = "\"FlowStorageFees\""
placeholderExecutionParametersAddress = "\"FlowExecutionParameters\""
placeholderServiceAccountAddress = "\"FlowServiceAccount\""
placeholderDKGAddress = "\"FlowDKG\""
placeholderEpochAddress = "\"FlowEpoch\""
placeholderStakingCollectionAddress = "\"FlowStakingCollection\""
placeholderNodeVersionBeaconAddress = "\"NodeVersionBeacon\""
placeholderRandomBeaconHistoryAddress = "\"RandomBeaconHistory\""
placeholderFungibleTokenAddress = "\"FungibleToken\""
placeholderNonFungibleTokenAddress = "\"NonFungibleToken\""
placeholderEVMAddress = "\"EVM\""
placeholderViewResolverAddress = "\"ViewResolver\""
placeholderFungibleTokenMVAddress = "\"FungibleTokenMetadataViews\""
placeholderMetadataViewsAddress = "\"MetadataViews\""
placeholderCrossVMMetadataViewsAddress = "\"CrossVMMetadataViews\""
placeholderBurnerAddress = "\"Burner\""
placeholderCryptoAddress = "\"Crypto\""
placeholderFlowTokenAddress = "\"FlowToken\""
placeholderIDTableAddress = "\"FlowIDTableStaking\""
placeholderLockedTokensAddress = "\"LockedTokens\""
placeholderStakingProxyAddress = "\"StakingProxy\""
placeholderQuorumCertificateAddress = "\"FlowClusterQC\""
placeholderFlowFeesAddress = "\"FlowFees\""
placeholderStorageFeesAddress = "\"FlowStorageFees\""
placeholderExecutionParametersAddress = "\"FlowExecutionParameters\""
placeholderServiceAccountAddress = "\"FlowServiceAccount\""
placeholderDKGAddress = "\"FlowDKG\""
placeholderEpochAddress = "\"FlowEpoch\""
placeholderStakingCollectionAddress = "\"FlowStakingCollection\""
placeholderNodeVersionBeaconAddress = "\"NodeVersionBeacon\""
placeholderRandomBeaconHistoryAddress = "\"RandomBeaconHistory\""
placeholderLinearCodeAddressGeneratorAddress = "\"LinearCodeAddressGenerator\""
)

type Environment struct {
Expand All @@ -47,6 +49,7 @@ type Environment struct {
NonFungibleTokenAddress string
EVMAddress string
MetadataViewsAddress string
CrossVMMetadataViewsAddress string
FungibleTokenMetadataViewsAddress string
FungibleTokenSwitchboardAddress string
FlowTokenAddress string
Expand All @@ -63,6 +66,7 @@ type Environment struct {
ServiceAccountAddress string
NodeVersionBeaconAddress string
RandomBeaconHistoryAddress string
LinearCodeAddressGeneratorAddress string
}

func withHexPrefix(address string) string {
Expand Down Expand Up @@ -112,6 +116,12 @@ func ReplaceAddresses(code string, env Environment) string {
env.MetadataViewsAddress,
)

code = ReplaceAddress(
code,
placeholderCrossVMMetadataViewsAddress,
env.CrossVMMetadataViewsAddress,
)

code = ReplaceAddress(
code,
placeholderBurnerAddress,
Expand Down Expand Up @@ -232,5 +242,11 @@ func ReplaceAddresses(code string, env Environment) string {
env.RandomBeaconHistoryAddress,
)

code = ReplaceAddress(
code,
placeholderLinearCodeAddressGeneratorAddress,
env.LinearCodeAddressGeneratorAddress,
)

return code
}
4 changes: 2 additions & 2 deletions lib/go/test/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ require (
github.com/onflow/bridged-usdc/lib/go/contracts v1.0.0 // indirect
github.com/onflow/flow-ft/lib/go/contracts v1.0.1 // indirect
github.com/onflow/flow-ft/lib/go/templates v1.0.1 // indirect
github.com/onflow/flow-nft/lib/go/contracts v1.2.3 // indirect
github.com/onflow/flow-nft/lib/go/contracts v1.2.4 // indirect
github.com/onflow/flow-nft/lib/go/templates v1.2.1 // indirect
github.com/onflow/flow/protobuf/go/flow v0.4.7 // indirect
github.com/onflow/go-ethereum v1.14.7 // indirect
Expand Down Expand Up @@ -213,7 +213,7 @@ require (
// replaced by module version in this repo - disregard pinned version
github.com/onflow/flow-core-contracts/lib/go/contracts v1.5.1-preview
// replaced by module version in this repo - disregard pinned version
github.com/onflow/flow-core-contracts/lib/go/templates v1.5.1-preview
github.com/onflow/flow-core-contracts/lib/go/templates v1.6.1-0.20250226163127-3c9723416637
)

replace github.com/onflow/flow-core-contracts/lib/go/contracts => ../contracts
Expand Down
4 changes: 2 additions & 2 deletions lib/go/test/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,8 +582,8 @@ github.com/onflow/flow-go v0.38.0-util.0.20250130182921-c8d283b60d12 h1:RUmzt0En
github.com/onflow/flow-go v0.38.0-util.0.20250130182921-c8d283b60d12/go.mod h1:bXxLlDLhyMj05TGYWFJdKTZdySShJMT0eqgommYq48w=
github.com/onflow/flow-go-sdk v1.3.1 h1:2YdTL/R1/DjMYYmyKgArTeQ93GKvLlfCeCpMVH7b8q4=
github.com/onflow/flow-go-sdk v1.3.1/go.mod h1:0rMuCLShdX9F4pLBCPhlMGCFu8gu9SfiXT/Lc9qAi24=
github.com/onflow/flow-nft/lib/go/contracts v1.2.3 h1:4ju20g1xgDKWBT63rOj5f/Sa4Lc+naCSWT4p31x9yQk=
github.com/onflow/flow-nft/lib/go/contracts v1.2.3/go.mod h1:eZ9VMMNfCq0ho6kV25xJn1kXeCfxnkhj3MwF3ed08gY=
github.com/onflow/flow-nft/lib/go/contracts v1.2.4 h1:gWJgSSgIGo0qWOqr90+khQ69VoYF9vNlqzF+Yh6YYy4=
github.com/onflow/flow-nft/lib/go/contracts v1.2.4/go.mod h1:eZ9VMMNfCq0ho6kV25xJn1kXeCfxnkhj3MwF3ed08gY=
github.com/onflow/flow-nft/lib/go/templates v1.2.1 h1:SAALMZPDw9Eb9p5kSLnmnFxjyig1MLiT4JUlLp0/bSE=
github.com/onflow/flow-nft/lib/go/templates v1.2.1/go.mod h1:W6hOWU0xltPqNpv9gQX8Pj8Jtf0OmRxc1XX2V0kzJaI=
github.com/onflow/flow/protobuf/go/flow v0.4.7 h1:iP6DFx4wZ3ETORsyeqzHu7neFT3d1CXF6wdK+AOOjmc=
Expand Down
Loading