quantumcoin 7.0.12 → 7.0.14

package/test/e2e/generated-sdks/all-solidity-types/all-solidity-types-js/README.md

@@ -0,0 +1,83 @@
+# all-solidity-types-js
+
+JS typed package generated from AllSolidityTypes.sol (e2e)
+
+> **Note:** This is an experimental SDK. Use at your own risk.
+
+## What’s in this package
+
+- JavaScript contract wrappers and factories in `src/` (TypeScript types via `.d.ts`)
+- Transactional tests in `test/e2e/`
+- Example scripts in `examples/`
+- ABI/BIN artifacts in `artifacts/`
+
+## Install
+
+- `npm install`
+
+## Build
+
+- (no build step required)
+
+## Run tests
+
+- `npm test`
+
+Transactional tests require:
+- `QC_RPC_URL` (required for transactional tests)
+- `QC_CHAIN_ID` (optional; defaults are used if omitted)
+
+## Examples
+
+- [deploy](./examples/deploy.js)
+- [read operations](./examples/read-operations.js)
+- [write operations](./examples/write-operations.js)
+- [events](./examples/events.js)
+
+## Contracts
+
+- [`AllSolidityTypes`](#allsoliditytypes)
+
+## AllSolidityTypes
+
+AllSolidityTypes
+A Solidity 0.7.6 contract that exercises a wide surface of ABI-encodable types.
+@dev
+- Includes: bool, all int/uint widths, address/address payable, string, bytes, bytes1..bytes32
+- Includes: enums, nested structs, fixed/dynamic arrays, arrays of structs, structs of structs
+- Excludes: fixed-point types and function types (by request)
+- Note: mappings are not ABI-encodable, so they are shown only as a storage type.
+
+- **Exports**: `AllSolidityTypes`, `AllSolidityTypes__factory`
+- **Constructor**: `constructor(bool bo, address payableAddr, string str, bytes dynBytes, uint8 choice, tuple u, tuple i, tuple fb, tuple misc, uint256[] seedU256s, bytes32[2] seedB32)`
+### Files
+- [`src/AllSolidityTypes.js`](./src/AllSolidityTypes.js)
+- [`src/AllSolidityTypes__factory.js`](./src/AllSolidityTypes__factory.js)
+- [`artifacts/AllSolidityTypes.abi.json`](./artifacts/AllSolidityTypes.abi.json)
+- [`artifacts/AllSolidityTypes.bin`](./artifacts/AllSolidityTypes.bin)
+### Examples
+- [deploy](./examples/deploy.js)
+- [read operations](./examples/read-operations.js)
+- [write operations](./examples/write-operations.js)
+- [events](./examples/events.js)
+### Tests
+- [transactional test](./test/e2e/AllSolidityTypes.e2e.test.js)
+### Functions
+- `echoAllFixedBytes(tuple x) pure returns (tuple)`
+- `echoAllInts(tuple x) pure returns (tuple)`
+- `echoAllMisc(tuple x) pure returns (tuple)`
+- `echoAllUints(tuple x) pure returns (tuple)`
+- `echoAllUintsArray(tuple[] xs) pure returns (tuple[])`
+- `echoInner(tuple x) pure returns (tuple)`
+- `echoInnerArray(tuple[] xs) pure returns (tuple[])`
+- `echoMatrix(uint256[][] m) pure returns (uint256[][])`
+- `echoOuter(tuple x) pure returns (tuple)`
+- `getStoredFixedBytes() view returns (tuple)`
+- `getStoredInts() view returns (tuple)`
+- `getStoredMisc() view returns (tuple)`
+- `getStoredUints() view returns (tuple)`
+- `multiReturn(bool bo, address addr, bytes32 b32, string s, uint256 x, tuple u) pure returns (bool, address, address, bytes32, string, uint256, tuple)`
+### Events
+- (none)
+### Errors
+- (none)