@circle-fin/smart-contract-platform 10.1.0 → 10.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/dist/smart-contract-platform.cjs.js +26 -23
- package/dist/smart-contract-platform.es.js +26 -23
- package/dist/types/clients/configurations.d.ts +30 -29
- package/dist/types/clients/core.d.ts +2 -1
- package/dist/types/clients/smart-contract-platform.d.ts +64 -57
- package/dist/types/smart-contract-platform.d.ts +6 -1
- package/package.json +8 -7
|
@@ -1320,6 +1320,12 @@ interface ImportContractRequest {
|
|
|
1320
1320
|
* @memberof ImportContractRequest
|
|
1321
1321
|
*/
|
|
1322
1322
|
'blockchain': Blockchain;
|
|
1323
|
+
/**
|
|
1324
|
+
* If true, refreshes the contract\'s ABI and source code from the blockchain explorer for contracts that have since been verified on-chain.
|
|
1325
|
+
* @type {boolean}
|
|
1326
|
+
* @memberof ImportContractRequest
|
|
1327
|
+
*/
|
|
1328
|
+
'refreshVerification'?: boolean;
|
|
1323
1329
|
}
|
|
1324
1330
|
|
|
1325
1331
|
/**
|
|
@@ -1646,7 +1652,7 @@ declare const DeployImportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1646
1652
|
* Deploy a smart contract on a specified blockchain using the contract\'s ABI and bytecode. The deployment will originate from one of your Circle Wallets.
|
|
1647
1653
|
* @summary Deploy a contract
|
|
1648
1654
|
* @param {ContractDeploymentRequest} contractDeploymentRequest Deploy contract request
|
|
1649
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1655
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1650
1656
|
* @param {*} [options] Override http request option.
|
|
1651
1657
|
* @throws {RequiredError}
|
|
1652
1658
|
*/
|
|
@@ -1655,7 +1661,7 @@ declare const DeployImportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1655
1661
|
* Estimate the network fee for deploying a smart contract on a specified blockchain, given the contract bytecode.
|
|
1656
1662
|
* @summary Estimate a contract deployment
|
|
1657
1663
|
* @param {ContractDeploymentEstimateFeeRequest} contractDeploymentEstimateFeeRequest Estimate a transaction fee for deploying a smart contract
|
|
1658
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1664
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1659
1665
|
* @param {*} [options] Override http request option.
|
|
1660
1666
|
* @throws {RequiredError}
|
|
1661
1667
|
*/
|
|
@@ -1664,7 +1670,7 @@ declare const DeployImportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1664
1670
|
* Add an existing smart contract to your library of contracts. It also can be done in the Developer Services Console.
|
|
1665
1671
|
* @summary Import a contract
|
|
1666
1672
|
* @param {ImportContractRequest} importContractRequest Import contract request
|
|
1667
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1673
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1668
1674
|
* @param {*} [options] Override http request option.
|
|
1669
1675
|
* @throws {RequiredError}
|
|
1670
1676
|
*/
|
|
@@ -1679,7 +1685,7 @@ declare const DeployImportApiFp: (configuration?: Configuration) => {
|
|
|
1679
1685
|
* Deploy a smart contract on a specified blockchain using the contract\'s ABI and bytecode. The deployment will originate from one of your Circle Wallets.
|
|
1680
1686
|
* @summary Deploy a contract
|
|
1681
1687
|
* @param {ContractDeploymentRequest} contractDeploymentRequest Deploy contract request
|
|
1682
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1688
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1683
1689
|
* @param {*} [options] Override http request option.
|
|
1684
1690
|
* @throws {RequiredError}
|
|
1685
1691
|
*/
|
|
@@ -1688,7 +1694,7 @@ declare const DeployImportApiFp: (configuration?: Configuration) => {
|
|
|
1688
1694
|
* Estimate the network fee for deploying a smart contract on a specified blockchain, given the contract bytecode.
|
|
1689
1695
|
* @summary Estimate a contract deployment
|
|
1690
1696
|
* @param {ContractDeploymentEstimateFeeRequest} contractDeploymentEstimateFeeRequest Estimate a transaction fee for deploying a smart contract
|
|
1691
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1697
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1692
1698
|
* @param {*} [options] Override http request option.
|
|
1693
1699
|
* @throws {RequiredError}
|
|
1694
1700
|
*/
|
|
@@ -1697,7 +1703,7 @@ declare const DeployImportApiFp: (configuration?: Configuration) => {
|
|
|
1697
1703
|
* Add an existing smart contract to your library of contracts. It also can be done in the Developer Services Console.
|
|
1698
1704
|
* @summary Import a contract
|
|
1699
1705
|
* @param {ImportContractRequest} importContractRequest Import contract request
|
|
1700
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1706
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1701
1707
|
* @param {*} [options] Override http request option.
|
|
1702
1708
|
* @throws {RequiredError}
|
|
1703
1709
|
*/
|
|
@@ -1712,7 +1718,7 @@ declare const DeployImportApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1712
1718
|
* Deploy a smart contract on a specified blockchain using the contract\'s ABI and bytecode. The deployment will originate from one of your Circle Wallets.
|
|
1713
1719
|
* @summary Deploy a contract
|
|
1714
1720
|
* @param {ContractDeploymentRequest} contractDeploymentRequest Deploy contract request
|
|
1715
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1721
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1716
1722
|
* @param {*} [options] Override http request option.
|
|
1717
1723
|
* @throws {RequiredError}
|
|
1718
1724
|
*/
|
|
@@ -1721,7 +1727,7 @@ declare const DeployImportApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1721
1727
|
* Estimate the network fee for deploying a smart contract on a specified blockchain, given the contract bytecode.
|
|
1722
1728
|
* @summary Estimate a contract deployment
|
|
1723
1729
|
* @param {ContractDeploymentEstimateFeeRequest} contractDeploymentEstimateFeeRequest Estimate a transaction fee for deploying a smart contract
|
|
1724
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1730
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1725
1731
|
* @param {*} [options] Override http request option.
|
|
1726
1732
|
* @throws {RequiredError}
|
|
1727
1733
|
*/
|
|
@@ -1730,7 +1736,7 @@ declare const DeployImportApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1730
1736
|
* Add an existing smart contract to your library of contracts. It also can be done in the Developer Services Console.
|
|
1731
1737
|
* @summary Import a contract
|
|
1732
1738
|
* @param {ImportContractRequest} importContractRequest Import contract request
|
|
1733
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1739
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1734
1740
|
* @param {*} [options] Override http request option.
|
|
1735
1741
|
* @throws {RequiredError}
|
|
1736
1742
|
*/
|
|
@@ -1747,7 +1753,7 @@ declare class DeployImportApi extends BaseAPI {
|
|
|
1747
1753
|
* Deploy a smart contract on a specified blockchain using the contract\'s ABI and bytecode. The deployment will originate from one of your Circle Wallets.
|
|
1748
1754
|
* @summary Deploy a contract
|
|
1749
1755
|
* @param {ContractDeploymentRequest} contractDeploymentRequest Deploy contract request
|
|
1750
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1756
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1751
1757
|
* @param {*} [options] Override http request option.
|
|
1752
1758
|
* @throws {RequiredError}
|
|
1753
1759
|
* @memberof DeployImportApi
|
|
@@ -1757,7 +1763,7 @@ declare class DeployImportApi extends BaseAPI {
|
|
|
1757
1763
|
* Estimate the network fee for deploying a smart contract on a specified blockchain, given the contract bytecode.
|
|
1758
1764
|
* @summary Estimate a contract deployment
|
|
1759
1765
|
* @param {ContractDeploymentEstimateFeeRequest} contractDeploymentEstimateFeeRequest Estimate a transaction fee for deploying a smart contract
|
|
1760
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1766
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1761
1767
|
* @param {*} [options] Override http request option.
|
|
1762
1768
|
* @throws {RequiredError}
|
|
1763
1769
|
* @memberof DeployImportApi
|
|
@@ -1767,7 +1773,7 @@ declare class DeployImportApi extends BaseAPI {
|
|
|
1767
1773
|
* Add an existing smart contract to your library of contracts. It also can be done in the Developer Services Console.
|
|
1768
1774
|
* @summary Import a contract
|
|
1769
1775
|
* @param {ImportContractRequest} importContractRequest Import contract request
|
|
1770
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1776
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1771
1777
|
* @param {*} [options] Override http request option.
|
|
1772
1778
|
* @throws {RequiredError}
|
|
1773
1779
|
* @memberof DeployImportApi
|
|
@@ -1783,7 +1789,7 @@ declare const EventMonitorsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1783
1789
|
/**
|
|
1784
1790
|
* Create a new event monitor based on the provided blockchain, contract address, and event signature.
|
|
1785
1791
|
* @summary Create Event Monitor
|
|
1786
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1792
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1787
1793
|
* @param {CreateEventMonitorRequest} [createEventMonitorRequest] Create Event Monitor Request
|
|
1788
1794
|
* @param {*} [options] Override http request option.
|
|
1789
1795
|
* @throws {RequiredError}
|
|
@@ -1793,7 +1799,7 @@ declare const EventMonitorsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1793
1799
|
* Delete an existing event monitor given its ID.
|
|
1794
1800
|
* @summary Delete Event Monitor
|
|
1795
1801
|
* @param {string} id Event Monitor ID.
|
|
1796
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1802
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1797
1803
|
* @param {*} [options] Override http request option.
|
|
1798
1804
|
* @throws {RequiredError}
|
|
1799
1805
|
*/
|
|
@@ -1809,7 +1815,7 @@ declare const EventMonitorsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1809
1815
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
1810
1816
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
1811
1817
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
1812
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1818
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1813
1819
|
* @param {*} [options] Override http request option.
|
|
1814
1820
|
* @throws {RequiredError}
|
|
1815
1821
|
*/
|
|
@@ -1824,7 +1830,7 @@ declare const EventMonitorsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1824
1830
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
1825
1831
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
1826
1832
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
1827
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1833
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1828
1834
|
* @param {*} [options] Override http request option.
|
|
1829
1835
|
* @throws {RequiredError}
|
|
1830
1836
|
*/
|
|
@@ -1833,7 +1839,7 @@ declare const EventMonitorsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1833
1839
|
* Update an existing event monitor given its ID.
|
|
1834
1840
|
* @summary Update an Event Monitor
|
|
1835
1841
|
* @param {string} id Event Monitor ID.
|
|
1836
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1842
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1837
1843
|
* @param {UpdateEventMonitorRequest} [updateEventMonitorRequest] Update Event Monitor Request
|
|
1838
1844
|
* @param {*} [options] Override http request option.
|
|
1839
1845
|
* @throws {RequiredError}
|
|
@@ -1848,7 +1854,7 @@ declare const EventMonitorsApiFp: (configuration?: Configuration) => {
|
|
|
1848
1854
|
/**
|
|
1849
1855
|
* Create a new event monitor based on the provided blockchain, contract address, and event signature.
|
|
1850
1856
|
* @summary Create Event Monitor
|
|
1851
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1857
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1852
1858
|
* @param {CreateEventMonitorRequest} [createEventMonitorRequest] Create Event Monitor Request
|
|
1853
1859
|
* @param {*} [options] Override http request option.
|
|
1854
1860
|
* @throws {RequiredError}
|
|
@@ -1858,7 +1864,7 @@ declare const EventMonitorsApiFp: (configuration?: Configuration) => {
|
|
|
1858
1864
|
* Delete an existing event monitor given its ID.
|
|
1859
1865
|
* @summary Delete Event Monitor
|
|
1860
1866
|
* @param {string} id Event Monitor ID.
|
|
1861
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1867
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1862
1868
|
* @param {*} [options] Override http request option.
|
|
1863
1869
|
* @throws {RequiredError}
|
|
1864
1870
|
*/
|
|
@@ -1874,7 +1880,7 @@ declare const EventMonitorsApiFp: (configuration?: Configuration) => {
|
|
|
1874
1880
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
1875
1881
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
1876
1882
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
1877
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1883
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1878
1884
|
* @param {*} [options] Override http request option.
|
|
1879
1885
|
* @throws {RequiredError}
|
|
1880
1886
|
*/
|
|
@@ -1889,7 +1895,7 @@ declare const EventMonitorsApiFp: (configuration?: Configuration) => {
|
|
|
1889
1895
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
1890
1896
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
1891
1897
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
1892
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1898
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1893
1899
|
* @param {*} [options] Override http request option.
|
|
1894
1900
|
* @throws {RequiredError}
|
|
1895
1901
|
*/
|
|
@@ -1898,7 +1904,7 @@ declare const EventMonitorsApiFp: (configuration?: Configuration) => {
|
|
|
1898
1904
|
* Update an existing event monitor given its ID.
|
|
1899
1905
|
* @summary Update an Event Monitor
|
|
1900
1906
|
* @param {string} id Event Monitor ID.
|
|
1901
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1907
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1902
1908
|
* @param {UpdateEventMonitorRequest} [updateEventMonitorRequest] Update Event Monitor Request
|
|
1903
1909
|
* @param {*} [options] Override http request option.
|
|
1904
1910
|
* @throws {RequiredError}
|
|
@@ -1913,7 +1919,7 @@ declare const EventMonitorsApiFactory: (configuration?: Configuration, basePath?
|
|
|
1913
1919
|
/**
|
|
1914
1920
|
* Create a new event monitor based on the provided blockchain, contract address, and event signature.
|
|
1915
1921
|
* @summary Create Event Monitor
|
|
1916
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1922
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1917
1923
|
* @param {CreateEventMonitorRequest} [createEventMonitorRequest] Create Event Monitor Request
|
|
1918
1924
|
* @param {*} [options] Override http request option.
|
|
1919
1925
|
* @throws {RequiredError}
|
|
@@ -1923,7 +1929,7 @@ declare const EventMonitorsApiFactory: (configuration?: Configuration, basePath?
|
|
|
1923
1929
|
* Delete an existing event monitor given its ID.
|
|
1924
1930
|
* @summary Delete Event Monitor
|
|
1925
1931
|
* @param {string} id Event Monitor ID.
|
|
1926
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1932
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1927
1933
|
* @param {*} [options] Override http request option.
|
|
1928
1934
|
* @throws {RequiredError}
|
|
1929
1935
|
*/
|
|
@@ -1939,7 +1945,7 @@ declare const EventMonitorsApiFactory: (configuration?: Configuration, basePath?
|
|
|
1939
1945
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
1940
1946
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
1941
1947
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
1942
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1948
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1943
1949
|
* @param {*} [options] Override http request option.
|
|
1944
1950
|
* @throws {RequiredError}
|
|
1945
1951
|
*/
|
|
@@ -1954,7 +1960,7 @@ declare const EventMonitorsApiFactory: (configuration?: Configuration, basePath?
|
|
|
1954
1960
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
1955
1961
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
1956
1962
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
1957
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1963
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1958
1964
|
* @param {*} [options] Override http request option.
|
|
1959
1965
|
* @throws {RequiredError}
|
|
1960
1966
|
*/
|
|
@@ -1963,7 +1969,7 @@ declare const EventMonitorsApiFactory: (configuration?: Configuration, basePath?
|
|
|
1963
1969
|
* Update an existing event monitor given its ID.
|
|
1964
1970
|
* @summary Update an Event Monitor
|
|
1965
1971
|
* @param {string} id Event Monitor ID.
|
|
1966
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1972
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1967
1973
|
* @param {UpdateEventMonitorRequest} [updateEventMonitorRequest] Update Event Monitor Request
|
|
1968
1974
|
* @param {*} [options] Override http request option.
|
|
1969
1975
|
* @throws {RequiredError}
|
|
@@ -1980,7 +1986,7 @@ declare class EventMonitorsApi extends BaseAPI {
|
|
|
1980
1986
|
/**
|
|
1981
1987
|
* Create a new event monitor based on the provided blockchain, contract address, and event signature.
|
|
1982
1988
|
* @summary Create Event Monitor
|
|
1983
|
-
* @param {string} [xRequestId] Developer-provided
|
|
1989
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1984
1990
|
* @param {CreateEventMonitorRequest} [createEventMonitorRequest] Create Event Monitor Request
|
|
1985
1991
|
* @param {*} [options] Override http request option.
|
|
1986
1992
|
* @throws {RequiredError}
|
|
@@ -1991,7 +1997,7 @@ declare class EventMonitorsApi extends BaseAPI {
|
|
|
1991
1997
|
* Delete an existing event monitor given its ID.
|
|
1992
1998
|
* @summary Delete Event Monitor
|
|
1993
1999
|
* @param {string} id Event Monitor ID.
|
|
1994
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2000
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
1995
2001
|
* @param {*} [options] Override http request option.
|
|
1996
2002
|
* @throws {RequiredError}
|
|
1997
2003
|
* @memberof EventMonitorsApi
|
|
@@ -2008,7 +2014,7 @@ declare class EventMonitorsApi extends BaseAPI {
|
|
|
2008
2014
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
2009
2015
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
2010
2016
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
2011
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2017
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2012
2018
|
* @param {*} [options] Override http request option.
|
|
2013
2019
|
* @throws {RequiredError}
|
|
2014
2020
|
* @memberof EventMonitorsApi
|
|
@@ -2024,7 +2030,7 @@ declare class EventMonitorsApi extends BaseAPI {
|
|
|
2024
2030
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
2025
2031
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
2026
2032
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
2027
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2033
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2028
2034
|
* @param {*} [options] Override http request option.
|
|
2029
2035
|
* @throws {RequiredError}
|
|
2030
2036
|
* @memberof EventMonitorsApi
|
|
@@ -2034,7 +2040,7 @@ declare class EventMonitorsApi extends BaseAPI {
|
|
|
2034
2040
|
* Update an existing event monitor given its ID.
|
|
2035
2041
|
* @summary Update an Event Monitor
|
|
2036
2042
|
* @param {string} id Event Monitor ID.
|
|
2037
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2043
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2038
2044
|
* @param {UpdateEventMonitorRequest} [updateEventMonitorRequest] Update Event Monitor Request
|
|
2039
2045
|
* @param {*} [options] Override http request option.
|
|
2040
2046
|
* @throws {RequiredError}
|
|
@@ -2052,7 +2058,7 @@ declare const InteractApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
2052
2058
|
* Query the state of a contract by providing the address and blockchain.
|
|
2053
2059
|
* @summary Execute a query function on a contract
|
|
2054
2060
|
* @param {ReadContractStateRequest} readContractStateRequest Read contract state by executing a read ABI function.
|
|
2055
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2061
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2056
2062
|
* @param {*} [options] Override http request option.
|
|
2057
2063
|
* @throws {RequiredError}
|
|
2058
2064
|
*/
|
|
@@ -2067,7 +2073,7 @@ declare const InteractApiFp: (configuration?: Configuration) => {
|
|
|
2067
2073
|
* Query the state of a contract by providing the address and blockchain.
|
|
2068
2074
|
* @summary Execute a query function on a contract
|
|
2069
2075
|
* @param {ReadContractStateRequest} readContractStateRequest Read contract state by executing a read ABI function.
|
|
2070
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2076
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2071
2077
|
* @param {*} [options] Override http request option.
|
|
2072
2078
|
* @throws {RequiredError}
|
|
2073
2079
|
*/
|
|
@@ -2082,7 +2088,7 @@ declare const InteractApiFactory: (configuration?: Configuration, basePath?: str
|
|
|
2082
2088
|
* Query the state of a contract by providing the address and blockchain.
|
|
2083
2089
|
* @summary Execute a query function on a contract
|
|
2084
2090
|
* @param {ReadContractStateRequest} readContractStateRequest Read contract state by executing a read ABI function.
|
|
2085
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2091
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2086
2092
|
* @param {*} [options] Override http request option.
|
|
2087
2093
|
* @throws {RequiredError}
|
|
2088
2094
|
*/
|
|
@@ -2099,7 +2105,7 @@ declare class InteractApi extends BaseAPI {
|
|
|
2099
2105
|
* Query the state of a contract by providing the address and blockchain.
|
|
2100
2106
|
* @summary Execute a query function on a contract
|
|
2101
2107
|
* @param {ReadContractStateRequest} readContractStateRequest Read contract state by executing a read ABI function.
|
|
2102
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2108
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2103
2109
|
* @param {*} [options] Override http request option.
|
|
2104
2110
|
* @throws {RequiredError}
|
|
2105
2111
|
* @memberof InteractApi
|
|
@@ -2117,7 +2123,7 @@ declare const TemplatesApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
2117
2123
|
* @summary Deploy a contract from a template
|
|
2118
2124
|
* @param {string} id The universally unique identifier of the resource.
|
|
2119
2125
|
* @param {TemplateContractDeploymentRequest} templateContractDeploymentRequest Deploy contract by template request.
|
|
2120
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2126
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2121
2127
|
* @param {*} [options] Override http request option.
|
|
2122
2128
|
* @throws {RequiredError}
|
|
2123
2129
|
*/
|
|
@@ -2127,7 +2133,7 @@ declare const TemplatesApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
2127
2133
|
* @summary Estimate fee for a contract template deployment
|
|
2128
2134
|
* @param {string} id The universally unique identifier of the resource.
|
|
2129
2135
|
* @param {ContractDeploymentEstimateRequest} contractDeploymentEstimateRequest Request object for estimating the transaction fees for deploying a contract from a template.
|
|
2130
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2136
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2131
2137
|
* @param {*} [options] Override http request option.
|
|
2132
2138
|
* @throws {RequiredError}
|
|
2133
2139
|
*/
|
|
@@ -2143,7 +2149,7 @@ declare const TemplatesApiFp: (configuration?: Configuration) => {
|
|
|
2143
2149
|
* @summary Deploy a contract from a template
|
|
2144
2150
|
* @param {string} id The universally unique identifier of the resource.
|
|
2145
2151
|
* @param {TemplateContractDeploymentRequest} templateContractDeploymentRequest Deploy contract by template request.
|
|
2146
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2152
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2147
2153
|
* @param {*} [options] Override http request option.
|
|
2148
2154
|
* @throws {RequiredError}
|
|
2149
2155
|
*/
|
|
@@ -2153,7 +2159,7 @@ declare const TemplatesApiFp: (configuration?: Configuration) => {
|
|
|
2153
2159
|
* @summary Estimate fee for a contract template deployment
|
|
2154
2160
|
* @param {string} id The universally unique identifier of the resource.
|
|
2155
2161
|
* @param {ContractDeploymentEstimateRequest} contractDeploymentEstimateRequest Request object for estimating the transaction fees for deploying a contract from a template.
|
|
2156
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2162
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2157
2163
|
* @param {*} [options] Override http request option.
|
|
2158
2164
|
* @throws {RequiredError}
|
|
2159
2165
|
*/
|
|
@@ -2169,7 +2175,7 @@ declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: st
|
|
|
2169
2175
|
* @summary Deploy a contract from a template
|
|
2170
2176
|
* @param {string} id The universally unique identifier of the resource.
|
|
2171
2177
|
* @param {TemplateContractDeploymentRequest} templateContractDeploymentRequest Deploy contract by template request.
|
|
2172
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2178
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2173
2179
|
* @param {*} [options] Override http request option.
|
|
2174
2180
|
* @throws {RequiredError}
|
|
2175
2181
|
*/
|
|
@@ -2179,7 +2185,7 @@ declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: st
|
|
|
2179
2185
|
* @summary Estimate fee for a contract template deployment
|
|
2180
2186
|
* @param {string} id The universally unique identifier of the resource.
|
|
2181
2187
|
* @param {ContractDeploymentEstimateRequest} contractDeploymentEstimateRequest Request object for estimating the transaction fees for deploying a contract from a template.
|
|
2182
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2188
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2183
2189
|
* @param {*} [options] Override http request option.
|
|
2184
2190
|
* @throws {RequiredError}
|
|
2185
2191
|
*/
|
|
@@ -2197,7 +2203,7 @@ declare class TemplatesApi extends BaseAPI {
|
|
|
2197
2203
|
* @summary Deploy a contract from a template
|
|
2198
2204
|
* @param {string} id The universally unique identifier of the resource.
|
|
2199
2205
|
* @param {TemplateContractDeploymentRequest} templateContractDeploymentRequest Deploy contract by template request.
|
|
2200
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2206
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2201
2207
|
* @param {*} [options] Override http request option.
|
|
2202
2208
|
* @throws {RequiredError}
|
|
2203
2209
|
* @memberof TemplatesApi
|
|
@@ -2208,7 +2214,7 @@ declare class TemplatesApi extends BaseAPI {
|
|
|
2208
2214
|
* @summary Estimate fee for a contract template deployment
|
|
2209
2215
|
* @param {string} id The universally unique identifier of the resource.
|
|
2210
2216
|
* @param {ContractDeploymentEstimateRequest} contractDeploymentEstimateRequest Request object for estimating the transaction fees for deploying a contract from a template.
|
|
2211
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2217
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2212
2218
|
* @param {*} [options] Override http request option.
|
|
2213
2219
|
* @throws {RequiredError}
|
|
2214
2220
|
* @memberof TemplatesApi
|
|
@@ -2225,7 +2231,7 @@ declare const ViewUpdateApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
2225
2231
|
* Get a single contract that you\'ve imported or deployed. Retrieved using the contracts ID as opposed to the on-chain address.
|
|
2226
2232
|
* @summary Get a contract
|
|
2227
2233
|
* @param {string} id The universally unique identifier of the resource.
|
|
2228
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2234
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2229
2235
|
* @param {*} [options] Override http request option.
|
|
2230
2236
|
* @throws {RequiredError}
|
|
2231
2237
|
*/
|
|
@@ -2243,7 +2249,7 @@ declare const ViewUpdateApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
2243
2249
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
2244
2250
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
2245
2251
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
2246
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2252
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2247
2253
|
* @param {*} [options] Override http request option.
|
|
2248
2254
|
* @throws {RequiredError}
|
|
2249
2255
|
*/
|
|
@@ -2253,7 +2259,7 @@ declare const ViewUpdateApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
2253
2259
|
* @summary Update a contract
|
|
2254
2260
|
* @param {string} id The universally unique identifier of the resource.
|
|
2255
2261
|
* @param {PatchContractRequest} patchContractRequest Update contract properties request
|
|
2256
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2262
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2257
2263
|
* @param {*} [options] Override http request option.
|
|
2258
2264
|
* @throws {RequiredError}
|
|
2259
2265
|
*/
|
|
@@ -2268,7 +2274,7 @@ declare const ViewUpdateApiFp: (configuration?: Configuration) => {
|
|
|
2268
2274
|
* Get a single contract that you\'ve imported or deployed. Retrieved using the contracts ID as opposed to the on-chain address.
|
|
2269
2275
|
* @summary Get a contract
|
|
2270
2276
|
* @param {string} id The universally unique identifier of the resource.
|
|
2271
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2277
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2272
2278
|
* @param {*} [options] Override http request option.
|
|
2273
2279
|
* @throws {RequiredError}
|
|
2274
2280
|
*/
|
|
@@ -2286,7 +2292,7 @@ declare const ViewUpdateApiFp: (configuration?: Configuration) => {
|
|
|
2286
2292
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
2287
2293
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
2288
2294
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
2289
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2295
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2290
2296
|
* @param {*} [options] Override http request option.
|
|
2291
2297
|
* @throws {RequiredError}
|
|
2292
2298
|
*/
|
|
@@ -2296,7 +2302,7 @@ declare const ViewUpdateApiFp: (configuration?: Configuration) => {
|
|
|
2296
2302
|
* @summary Update a contract
|
|
2297
2303
|
* @param {string} id The universally unique identifier of the resource.
|
|
2298
2304
|
* @param {PatchContractRequest} patchContractRequest Update contract properties request
|
|
2299
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2305
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2300
2306
|
* @param {*} [options] Override http request option.
|
|
2301
2307
|
* @throws {RequiredError}
|
|
2302
2308
|
*/
|
|
@@ -2311,7 +2317,7 @@ declare const ViewUpdateApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
2311
2317
|
* Get a single contract that you\'ve imported or deployed. Retrieved using the contracts ID as opposed to the on-chain address.
|
|
2312
2318
|
* @summary Get a contract
|
|
2313
2319
|
* @param {string} id The universally unique identifier of the resource.
|
|
2314
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2320
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2315
2321
|
* @param {*} [options] Override http request option.
|
|
2316
2322
|
* @throws {RequiredError}
|
|
2317
2323
|
*/
|
|
@@ -2329,7 +2335,7 @@ declare const ViewUpdateApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
2329
2335
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
2330
2336
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
2331
2337
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
2332
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2338
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2333
2339
|
* @param {*} [options] Override http request option.
|
|
2334
2340
|
* @throws {RequiredError}
|
|
2335
2341
|
*/
|
|
@@ -2339,7 +2345,7 @@ declare const ViewUpdateApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
2339
2345
|
* @summary Update a contract
|
|
2340
2346
|
* @param {string} id The universally unique identifier of the resource.
|
|
2341
2347
|
* @param {PatchContractRequest} patchContractRequest Update contract properties request
|
|
2342
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2348
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2343
2349
|
* @param {*} [options] Override http request option.
|
|
2344
2350
|
* @throws {RequiredError}
|
|
2345
2351
|
*/
|
|
@@ -2356,7 +2362,7 @@ declare class ViewUpdateApi extends BaseAPI {
|
|
|
2356
2362
|
* Get a single contract that you\'ve imported or deployed. Retrieved using the contracts ID as opposed to the on-chain address.
|
|
2357
2363
|
* @summary Get a contract
|
|
2358
2364
|
* @param {string} id The universally unique identifier of the resource.
|
|
2359
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2365
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2360
2366
|
* @param {*} [options] Override http request option.
|
|
2361
2367
|
* @throws {RequiredError}
|
|
2362
2368
|
* @memberof ViewUpdateApi
|
|
@@ -2375,7 +2381,7 @@ declare class ViewUpdateApi extends BaseAPI {
|
|
|
2375
2381
|
* @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
|
|
2376
2382
|
* @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
|
|
2377
2383
|
* @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
|
|
2378
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2384
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2379
2385
|
* @param {*} [options] Override http request option.
|
|
2380
2386
|
* @throws {RequiredError}
|
|
2381
2387
|
* @memberof ViewUpdateApi
|
|
@@ -2386,7 +2392,7 @@ declare class ViewUpdateApi extends BaseAPI {
|
|
|
2386
2392
|
* @summary Update a contract
|
|
2387
2393
|
* @param {string} id The universally unique identifier of the resource.
|
|
2388
2394
|
* @param {PatchContractRequest} patchContractRequest Update contract properties request
|
|
2389
|
-
* @param {string} [xRequestId] Developer-provided
|
|
2395
|
+
* @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
|
|
2390
2396
|
* @param {*} [options] Override http request option.
|
|
2391
2397
|
* @throws {RequiredError}
|
|
2392
2398
|
* @memberof ViewUpdateApi
|
|
@@ -2423,4 +2429,5 @@ declare class SmartContractPlatformClient {
|
|
|
2423
2429
|
constructor(baseUrl: string, config: ClientConfig, headers?: Record<string, string>);
|
|
2424
2430
|
}
|
|
2425
2431
|
|
|
2426
|
-
export {
|
|
2432
|
+
export { Blockchain, ContractInputType, ContractStatus, DeployImportApi, DeployImportApiAxiosParamCreator, DeployImportApiFactory, DeployImportApiFp, EventMonitorsApi, EventMonitorsApiAxiosParamCreator, EventMonitorsApiFactory, EventMonitorsApiFp, FeeLevel, InteractApi, InteractApiAxiosParamCreator, InteractApiFactory, InteractApiFp, SmartContractPlatformClient, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, VerificationStatus, ViewUpdateApi, ViewUpdateApiAxiosParamCreator, ViewUpdateApiFactory, ViewUpdateApiFp };
|
|
2433
|
+
export type { AbiParametersInner, Contract, ContractDeployment, ContractDeploymentData, ContractDeploymentEstimateFeeRequest, ContractDeploymentEstimateRequest, ContractDeploymentRequest, ContractResponse, ContractResponseData, Contracts, ContractsData, CreateEventMonitorRequest, Event, EventLog, EventLogs, EventLogsData, EventMonitor, EventMonitorResponse, EventMonitorResponseData, EventMonitors, EventMonitorsData, FeeEstimation, FeeEstimationData, Function, ImportContractRequest, ModelError, ParamType, PatchContractRequest, ReadContractState, ReadContractStateData, ReadContractStateRequest, SolFile, TemplateContractDeployment, TemplateContractDeploymentData, TemplateContractDeploymentRequest, TransactionFee, UpdateEventMonitorRequest };
|
|
@@ -138,6 +138,10 @@ type ImportContractInput = {
|
|
|
138
138
|
* Blockchain is the blockchain to deploy onto.
|
|
139
139
|
*/
|
|
140
140
|
blockchain: Blockchain;
|
|
141
|
+
/**
|
|
142
|
+
* If true, refreshes the contract's ABI and source code from the blockchain explorer for contracts that have since been verified on-chain.
|
|
143
|
+
*/
|
|
144
|
+
refreshVerification?: boolean;
|
|
141
145
|
} & WithIdempotencyKey & Common;
|
|
142
146
|
/**
|
|
143
147
|
* Represents the input for fetching all contracts.
|
|
@@ -609,4 +613,5 @@ declare class CircleSmartContractPlatformClient {
|
|
|
609
613
|
*/
|
|
610
614
|
declare function initiateSmartContractPlatformClient(config: ClientParams): CircleSmartContractPlatformClient;
|
|
611
615
|
|
|
612
|
-
export {
|
|
616
|
+
export { CircleSmartContractPlatformClient, defaultBaseUrl, initiateSmartContractPlatformClient };
|
|
617
|
+
export type { APIParams, ClientParams, Config, CreateEventMonitorInput, DeleteEventMonitorsInput, DeployContractInput, DeployContractTemplateInput, EstimateContractTemplateDeploymentFeeInput, EstimateDeploymentFeeInput, GetContractInput, ImportContractInput, ListContractsInput, ListEventLogsInput, ListEventMonitorsInput, QueryContractInput, ReadContractInput, StoredData, UpdateContractInput, UpdateEventMonitorInput };
|