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.

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

[DPA-1313]: feat(deployment): add link contract deployment #15379

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
55 changes: 55 additions & 0 deletions deployment/common/changeset/deploy_link_token.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package changeset

import (
"fmt"

"github.com/smartcontractkit/chainlink-common/pkg/logger"

"github.com/smartcontractkit/chainlink/deployment"
"github.com/smartcontractkit/chainlink/deployment/common/types"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/shared/generated/link_token"
)

var _ deployment.ChangeSet[uint64] = DeployLinkToken

// DeployLinkToken deploys a link token contract to the chain identified by the chainSelector.
func DeployLinkToken(e deployment.Environment, chainSelector uint64) (deployment.ChangesetOutput, error) {
c, ok := e.Chains[chainSelector]
if !ok {
return deployment.ChangesetOutput{}, fmt.Errorf("chain not found in environment")
}
newAddresses := deployment.NewMemoryAddressBook()
_, err := deployLinkTokenContract(
e.Logger, c, newAddresses,
)
if err != nil {
return deployment.ChangesetOutput{AddressBook: newAddresses}, err
}
return deployment.ChangesetOutput{AddressBook: newAddresses}, nil
}

func deployLinkTokenContract(
lggr logger.Logger,
chain deployment.Chain,
ab deployment.AddressBook,
) (*deployment.ContractDeploy[*link_token.LinkToken], error) {
linkToken, err := deployment.DeployContract[*link_token.LinkToken](lggr, chain, ab,
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not a criticism of you but I really hate that we have a function which returns a result, but also has a side-effect of updating a supplied address-book. :/ That's a sort of mis-matched use of function and side effect I'm not happy with. Need to rethink it.

You're doing it right, here, I think.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is the link deployment needed for test environments? If not, can we not use already deployed link contracts in various chains?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

/ That's a sort of mis-matched use of function and side effect I'm not happy with. Need to rethink it.

Good to know! I was kind of following the establish pattern here as seen in the code.

Is the link deployment needed for test environments? If not, can we not use already deployed link contracts in various chains?

My understanding is that this changeset will be used for future new chains as well? And we are building a common bunch of useful changesets?

Copy link
Contributor

Choose a reason for hiding this comment

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

Are we sure that this is the contract we can officially use as link contract for new chains? I was under impression this is just a test equivalent.

Copy link
Contributor

Choose a reason for hiding this comment

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

If this is the intended one, please ignore me

Copy link
Collaborator

Choose a reason for hiding this comment

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

Good to know! I was kind of following the establish pattern here as seen in the code.

Yeah - established patterns aren't all "Good" yet. We have been evolving this under deadline pressure, so we're just now coming back to re-evaluate emerging patterns. You're not doing bad here, it's more you're echoing something that I need to rethink.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If this is the intended one, please ignore me

@AnieeG thanks, let me double check with someone to be sure

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@AnieeG i doubled checked with Rodrigo, yes this is the one to use.

func(chain deployment.Chain) deployment.ContractDeploy[*link_token.LinkToken] {
linkTokenAddr, tx, linkToken, err2 := link_token.DeployLinkToken(
chain.DeployerKey,
chain.Client,
)
return deployment.ContractDeploy[*link_token.LinkToken]{
Address: linkTokenAddr,
Contract: linkToken,
Tx: tx,
Tv: deployment.NewTypeAndVersion(types.LinkToken, deployment.Version1_0_0),
Err: err2,
}
})
if err != nil {
lggr.Errorw("Failed to deploy link token", "err", err)
return linkToken, err
}
return linkToken, nil
}
39 changes: 39 additions & 0 deletions deployment/common/changeset/deploy_link_token_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package changeset_test

import (
"testing"

"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/zap/zapcore"

"github.com/smartcontractkit/chainlink/deployment/common/changeset"
"github.com/smartcontractkit/chainlink/deployment/environment/memory"
)

func TestDeployLinkToken(t *testing.T) {
t.Parallel()

lggr := logger.Test(t)
cfg := memory.MemoryEnvironmentConfig{
Nodes: 1,
Chains: 2,
}
env := memory.NewMemoryEnvironment(t, lggr, zapcore.DebugLevel, cfg)
chainSelector := env.AllChainSelectors()[0]

resp, err := changeset.DeployLinkToken(env, chainSelector)
require.NoError(t, err)
require.NotNil(t, resp)

// LinkToken should be deployed on chain 0
addrs, err := resp.AddressBook.AddressesForChain(chainSelector)
require.NoError(t, err)
require.Len(t, addrs, 1)

// nothing on chain 1
require.NotEqual(t, chainSelector, env.AllChainSelectors()[1])
oaddrs, _ := resp.AddressBook.AddressesForChain(env.AllChainSelectors()[1])
assert.Len(t, oaddrs, 0)
}
1 change: 1 addition & 0 deletions deployment/common/types/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const (
CancellerManyChainMultisig deployment.ContractType = "CancellerManyChainMultiSig"
ProposerManyChainMultisig deployment.ContractType = "ProposerManyChainMultiSig"
RBACTimelock deployment.ContractType = "RBACTimelock"
LinkToken deployment.ContractType = "LinkToken"
)

type MCMSWithTimelockConfig struct {
Expand Down
Loading