feat: Support Register/List/Update Smart Contract #65

jianlunz-cb · 2024-12-17T05:21:22Z

What changed? Why?

Support Register/List/Update Smart Contract

Test:

>>> SmartContract.register(contract_name="Test Contract", contract_address="0x0000000071727de22e5e9d8baf0edac6f37da040", network_id="base-sepolia", abi=[
...   {
...     "constant": True,
...     "name": "myField",
...     "outputs": [
...       {
...         "name": "",
...         "type": "uint256"
...       }
...     ],
...     "type": "function"
...   }
... ])

CDP API RESPONSE: Status: 200, Data: b'{"abi":"[{\\"constant\\":true,\\"name\\":\\"myField\\",\\"outputs\\":[{\\"name\\":\\"\\",\\"type\\":\\"uint256\\"}],\\"type\\":\\"function\\"}]","contract_address":"0x0000000071727De22e5E9d8bAF0EDaC6f37Da040","contract_name":"Test Contract","is_external":true,"network_id":"base-sepolia","smart_contract_id":"0104b87a-6617-45f4-924f-06b26e21d77e","type":"custom"}\n'
SmartContract: (smart_contract_id: 0104b87a-6617-45f4-924f-06b26e21d77e, wallet_id: None, network_id: base-sepolia, contract_address: 0x0000000071727De22e5E9d8bAF0EDaC6f37Da040, type: custom, transaction_hash: None, transaction_link: None, status: None)

>>> SmartContract.update(contract_name="Updated Test Contract", contract_address="0x0000000071727de22e5e9d8baf0edac6f37da040", network_id="base-sepolia", abi=[
...   {
...     "constant": False,
...     "name": "newField",
...     "outputs": [
...       {
...         "name": "",
...         "type": "uint256"
...       }
...     ],
...     "type": "function"
...   }
... ])

CDP API RESPONSE: Status: 200, Data: b'{"abi":"[{\\"constant\\":false,\\"name\\":\\"newField\\",\\"outputs\\":[{\\"name\\":\\"\\",\\"type\\":\\"uint256\\"}],\\"type\\":\\"function\\"}]","contract_address":"0x0000000071727De22e5E9d8bAF0EDaC6f37Da040","contract_name":"Updated Test Contract","is_external":true,"network_id":"base-sepolia","smart_contract_id":"0104b87a-6617-45f4-924f-06b26e21d77e","type":"custom"}\n'
SmartContract: (smart_contract_id: 0104b87a-6617-45f4-924f-06b26e21d77e, wallet_id: None, network_id: base-sepolia, contract_address: 0x0000000071727De22e5E9d8bAF0EDaC6f37Da040, type: custom, transaction_hash: None, transaction_link: None, status: None)

>>> l = SmartContract.list()
>>> for sc in l:
...      print(sc)

{"abi":"[{\\"constant\\":false,\\"name\\":\\"newField\\",\\"outputs\\":[{\\"name\\":\\"\\",\\"type\\":\\"uint256\\"}],\\"type\\":\\"function\\"}]","contract_address":"0x0000000071727de22e5e9d8baf0edac6f37da040","contract_name":"Updated Test Contract","is_external":false,"network_id":"base-sepolia","smart_contract_id":"","type":"custom"}
SmartContract: (smart_contract_id: , wallet_id: None, network_id: base-sepolia, contract_address: 0x0000000071727de22e5e9d8baf0edac6f37da040, type: custom, transaction_hash: None, transaction_link: None, status: None)

Qualified Impact

cb-heimdall · 2024-12-17T05:21:28Z

🟡 Heimdall Review Status

Requirement Status More Info

Reviews

🟡 0/1

Denominator calculation

Show calculation

1 if user is bot 0

1 if user is external 0

From .codeflow.yml 1

Additional review requirements

Show calculation

Max	0

0

From CODEOWNERS 0

Global minimum 0

Max 1

1

1 if commit is unverified 1

Sum 2

alex-stone · 2024-12-17T19:30:33Z

cdp/smart_contract.py

@@ -141,6 +156,16 @@ def deployer_address(self) -> str:
        """
        return self._model.deployer_address

+    @property
+    def is_external(self) -> str:


This should return a boolean

Good catch updated

alex-stone · 2024-12-17T21:37:54Z

cdp/smart_contract.py

+
+        """
+        return self._model.contract_name
+
    @property
    def deployer_address(self) -> str:


I think now a lot of these other properties will be only set if is_external is false.

This is the NodeJS change we had to make to support this:
coinbase/coinbase-sdk-nodejs@94680a6#diff-2c6bead48767df9b8a842ac4887f9e676b0b38a3b6fc2c4bdb7ff6e2d9ddbb7dR227

I added a check of the external fields before returning. If it looks good I'll apply it to the nodejs change

If it looks good I'll apply it to the nodejs change

I just linked the change that was made to the NodeJS to handle this!

We'll also want to handle #sign, #wait, #broadcast, etc... to ensure they throw appropriate errors when called on external contracts

Gotcha, updated! Thank you

alex-stone · 2024-12-17T23:30:24Z

Can you make sure your commits are getting verified?

You may need git config scoped to this repo that includes your specific external GitHub username + signing key configuration

John-peterson-coinbase · 2024-12-18T03:44:55Z

Please rebase down to only verified commits

jianlunz-cb · 2024-12-18T17:23:18Z

Please rebase down to only verified commits

Thank you, just reabased all the previous commit into one

alex-stone · 2024-12-18T18:08:05Z

cdp/smart_contract.py

@@ -373,6 +414,105 @@ def read(
        )
        return cls._convert_solidity_value(model)

+    @classmethod
+    def update(


Update should be an instance method.

E.g. we've already registered or fetched a SmartContract resource that we then can call update on

We can leave a class method helper, but we should be able to update off the actual contract resource.

smart_contract.update(name="New Name")

alex-stone

Lets fast-follow with the instance method update function and add it to the Changelog!

jianlunz-cb marked this pull request as ready for review December 17, 2024 07:20

jianlunz-cb requested a review from alex-stone December 17, 2024 07:20

alex-stone changed the base branch from master to v0.13.0 December 17, 2024 19:29

alex-stone reviewed Dec 17, 2024

View reviewed changes

jianlunz-cb requested a review from alex-stone December 17, 2024 20:56

alex-stone reviewed Dec 17, 2024

View reviewed changes

jianlunz-cb requested a review from alex-stone December 17, 2024 22:54

feat: Support Register/List/Update Smart Contract

fdcbd42

jianlunz-cb force-pushed the register_sc branch from 280d634 to fdcbd42 Compare December 18, 2024 17:21

alex-stone reviewed Dec 18, 2024

View reviewed changes

alex-stone approved these changes Dec 18, 2024

View reviewed changes

jianlunz-cb merged commit 2ee0c2c into v0.13.0 Dec 18, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Support Register/List/Update Smart Contract #65

feat: Support Register/List/Update Smart Contract #65

jianlunz-cb commented Dec 17, 2024 •

edited

Loading

cb-heimdall commented Dec 17, 2024 •

edited

Loading

alex-stone Dec 17, 2024

jianlunz-cb Dec 17, 2024

alex-stone Dec 17, 2024

jianlunz-cb Dec 17, 2024

alex-stone Dec 17, 2024

alex-stone Dec 17, 2024

jianlunz-cb Dec 18, 2024

alex-stone commented Dec 17, 2024

John-peterson-coinbase commented Dec 18, 2024

jianlunz-cb commented Dec 18, 2024

alex-stone Dec 18, 2024

alex-stone Dec 18, 2024

alex-stone left a comment

feat: Support Register/List/Update Smart Contract #65

feat: Support Register/List/Update Smart Contract #65

Conversation

jianlunz-cb commented Dec 17, 2024 • edited Loading

What changed? Why?

Qualified Impact

cb-heimdall commented Dec 17, 2024 • edited Loading

🟡 Heimdall Review Status

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-stone commented Dec 17, 2024

John-peterson-coinbase commented Dec 18, 2024

jianlunz-cb commented Dec 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-stone left a comment

Choose a reason for hiding this comment

jianlunz-cb commented Dec 17, 2024 •

edited

Loading

cb-heimdall commented Dec 17, 2024 •

edited

Loading