add docs and changesets

celo-org · Mar 26, 2024 · 3070be6 · 3070be6
1 parent 74c7685
commit 3070be6
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 20 deletions.
diff --git a/.changeset/tough-ears-study.md b/.changeset/tough-ears-study.md
@@ -0,0 +1,5 @@
+---
+'@celo/celocli': patch
+---
+
+Add ability to build and view governance proposals which interact with contracts verified on celoscan
diff --git a/.changeset/young-foxes-compete.md b/.changeset/young-foxes-compete.md
@@ -0,0 +1,5 @@
+---
+'@celo/explorer': minor
+---
+
+Adds Celoscan as source for fetching verified contract metadata
diff --git a/packages/cli/.gitignore b/packages/cli/.gitignore
@@ -10,4 +10,5 @@ oclif.manifest.json
 src/generated
 .devchain/
 .devchain.tar.gz
+transactions.json
 transactions2.json
diff --git a/packages/cli/transactions.json b/packages/cli/transactions.json
diff --git a/packages/docs/sdk/docs/explorer/classes/block_explorer.BlockExplorer.md b/packages/docs/sdk/docs/explorer/classes/block_explorer.BlockExplorer.md
@@ -180,7 +180,7 @@ ___
 ▸ **getContractMappingFromSourcify**(`address`): `Promise`\<`undefined` \| [`ContractMapping`](../interfaces/base.ContractMapping.md)\>
 
 Returns the ContractMapping for the contract at that address, or undefined
-by looking up the contract address in Sourcify.
+by looking up the contract address on various contract verification services.
 
 #### Parameters
 

diff --git a/packages/docs/sdk/docs/explorer/classes/sourcify.Metadata.md b/packages/docs/sdk/docs/explorer/classes/sourcify.Metadata.md
@@ -19,6 +19,7 @@ light runtime verification.
 - [abi](sourcify.Metadata.md#abi)
 - [contractName](sourcify.Metadata.md#contractname)
 - [fnMapping](sourcify.Metadata.md#fnmapping)
+- [implementationAddress](sourcify.Metadata.md#implementationaddress)
 
 ### Accessors
 
@@ -42,15 +43,15 @@ light runtime verification.
 | :------ | :------ |
 | `connection` | `Connection` |
 | `address` | `string` |
-| `response` | `any` |
+| `response` | [`MetadataResponse`](../interfaces/sourcify.MetadataResponse.md) |
 
 #### Returns
 
 [`Metadata`](sourcify.Metadata.md)
 
 #### Defined in
 
-[src/sourcify.ts:73](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L73)
+[src/sourcify.ts:76](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L76)
 
 ## Properties
 
@@ -60,7 +61,7 @@ light runtime verification.
 
 #### Defined in
 
-[src/sourcify.ts:65](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L65)
+[src/sourcify.ts:67](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L67)
 
 ___
 
@@ -70,7 +71,7 @@ ___
 
 #### Defined in
 
-[src/sourcify.ts:66](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L66)
+[src/sourcify.ts:68](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L68)
 
 ___
 
@@ -80,7 +81,17 @@ ___
 
 #### Defined in
 
-[src/sourcify.ts:67](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L67)
+[src/sourcify.ts:70](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L70)
+
+___
+
+### implementationAddress
+
+• **implementationAddress**: ``null`` \| `string` = `null`
+
+#### Defined in
+
+[src/sourcify.ts:69](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L69)
 
 ## Accessors
 
@@ -100,7 +111,7 @@ ___
 
 #### Defined in
 
-[src/sourcify.ts:83](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L83)
+[src/sourcify.ts:88](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L88)
 
 ## Methods
 
@@ -127,7 +138,7 @@ and array of AbiItems matching the query
 
 #### Defined in
 
-[src/sourcify.ts:152](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L152)
+[src/sourcify.ts:158](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L158)
 
 ___
 
@@ -151,7 +162,7 @@ an AbiItem if found or null
 
 #### Defined in
 
-[src/sourcify.ts:136](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L136)
+[src/sourcify.ts:142](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L142)
 
 ___
 
@@ -167,4 +178,4 @@ Turn the ABI into a mapping of function selectors to ABI items.
 
 #### Defined in
 
-[src/sourcify.ts:119](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L119)
+[src/sourcify.ts:125](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L125)
diff --git a/packages/docs/sdk/docs/explorer/interfaces/sourcify.MetadataResponse.md b/packages/docs/sdk/docs/explorer/interfaces/sourcify.MetadataResponse.md
@@ -42,6 +42,8 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `compilationTarget?` | `Record`\<`string`, `string`\> |
+| `implementation?` | `string` |
+| `name?` | `string` |
 
 #### Defined in
 

diff --git a/packages/docs/sdk/docs/explorer/modules/sourcify.md b/packages/docs/sdk/docs/explorer/modules/sourcify.md
@@ -23,8 +23,8 @@
 
 ▸ **fetchMetadata**(`connection`, `contract`, `strict?`): `Promise`\<[`Metadata`](../classes/sourcify.Metadata.md) \| ``null``\>
 
-Fetch the sourcify response and instantiate a Metadata wrapper class around it.
-Try a full_match but fallback to partial_match when not strict.
+Fetch the sourcify or celoscan response and instantiate a Metadata wrapper class around it.
+Try a full_match but fallback to partial_match when not strict. (only valid for sourcify)
 
 #### Parameters
 
@@ -42,7 +42,7 @@ Metadata or null
 
 #### Defined in
 
-[src/sourcify.ts:179](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L179)
+[src/sourcify.ts:185](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L185)
 
 ___
 
@@ -73,4 +73,4 @@ the implementation address or null
 
 #### Defined in
 
-[src/sourcify.ts:228](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L228)
+[src/sourcify.ts:301](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L301)
diff --git a/packages/docs/sdk/docs/governance/classes/proposals.InteractiveProposalBuilder.md b/packages/docs/sdk/docs/governance/classes/proposals.InteractiveProposalBuilder.md
@@ -33,7 +33,7 @@
 
 #### Defined in
 
-[proposals.ts:466](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L466)
+[proposals.ts:464](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L464)
 
 ## Methods
 
@@ -47,7 +47,7 @@
 
 #### Defined in
 
-[proposals.ts:468](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L468)
+[proposals.ts:466](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L466)
 
 ___
 
@@ -61,4 +61,4 @@ ___
 
 #### Defined in
 
-[proposals.ts:473](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L473)
+[proposals.ts:471](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L471)
diff --git a/packages/docs/sdk/docs/governance/classes/proposals.ProposalBuilder.md b/packages/docs/sdk/docs/governance/classes/proposals.ProposalBuilder.md
@@ -144,7 +144,7 @@ ___
 
 #### Defined in
 
-[proposals.ts:460](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L460)
+[proposals.ts:458](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L458)
 
 ___
 

diff --git a/packages/sdk/governance/src/proposals.ts b/packages/sdk/governance/src/proposals.ts
@@ -348,7 +348,7 @@ export class ProposalBuilder {
   buildCallToExternalContract = async (
     tx: ProposalTransactionJSON
   ): Promise<ProposalTransaction> => {
-    if (!tx.address || (!isValidAddress(tx.address) && !isValidAddress(tx.contract))) {
+    if (!tx.address || !isValidAddress(tx.address)) {
       throw new Error(`${tx.contract} is not a core celo contract so address must be specified`)
     }
-Original file line number
+Diff line change
@@ Expand Up / @@ -144,7 +144,7 @@ ___ @@
     #### Defined in
-    [proposals.ts:460](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L460)
+    [proposals.ts:458](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L458)
     ___
@@ Expand Down @@