Add cairo account

packages/core-cairo/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add Account and EthAccount. ([#387](https://github.com/OpenZeppelin/contracts-wizard/pull/387))
+
 - **Breaking changes**:
   - Use OpenZeppelin Contracts for Cairo v0.15.0. ([#378](https://github.com/OpenZeppelin/contracts-wizard/pull/378))
   - Use OpenZeppelin Contracts for Cairo v0.16.0. ([#384](https://github.com/OpenZeppelin/contracts-wizard/pull/384))

packages/core-cairo/README.md

@@ -16,6 +16,7 @@ The following contract types are supported:
 - `erc20`
 - `erc721`
 - `erc1155`
+- `account`
 - `custom`
 
 Each contract type has functions/constants as defined below.
@@ -33,6 +34,9 @@ function print(opts?: ERC721Options): string
 function print(opts?: ERC1155Options): string
 ```
 ```js
+function print(opts?: AccountOptions): string
+```
+```js
 function print(opts?: CustomOptions): string
 ```
 Returns a string representation of a contract generated using the provided options. If `opts` is not provided, uses [`defaults`](#defaults).
@@ -48,6 +52,9 @@ const defaults: Required<ERC721Options>
 const defaults: Required<ERC1155Options>
 ```
 ```js
+const defaults: Required<AccountOptions>
+```
+```js
 const defaults: Required<CustomOptions>
 ```
 The default options that are used for [`print`](#print).
@@ -67,6 +74,8 @@ function isAccessControlRequired(opts: Partial<CustomOptions>): boolean
 ```
 Whether any of the provided options require access control to be enabled. If this returns `true`, then calling `print` with the same options would cause the `access` option to default to `'ownable'` if it was `undefined` or `false`. 
 
+> Note that account contracts handle permissions differently from the other supported contracts.
+Thus, the `account` contract type does not include `isAccessControlRequired`.
 
 ### Contract specific functions
 

packages/core-cairo/src/account.test.ts

@@ -0,0 +1,196 @@
+import test from 'ava';
+
+import { buildAccount, AccountOptions } from './account';
+import { printContract } from './print';
+
+import { account } from '.';
+
+function testAccount(title: string, opts: Partial<AccountOptions>) {
+  test(title, t => {
+    const c = buildAccount({
+      name: 'MyAccount',
+      type: 'stark',
+      ...opts,
+    });
+    t.snapshot(printContract(c));
+  });
+}
+
+function testEthAccount(title: string, opts: Partial<AccountOptions>) {
+  test(title, t => {
+    const c = buildAccount({
+      name: 'MyAccount',
+      type: 'eth',
+      ...opts,
+    });
+    t.snapshot(printContract(c));
+  });
+}
+
+/**
+ * Tests external API for equivalence with internal API
+ */
+function testAPIEquivalence(title: string, opts?: AccountOptions) {
+  test(title, t => {
+    t.is(account.print(opts), printContract(buildAccount({
+      name: 'MyAccount',
+      type: 'stark',
+      declare: true,
+      deploy: true,
+      pubkey: true,
+      ...opts,
+    })));
+  });
+}
+
+testAccount('default full account, mixin + upgradeable', {});
+
+testAccount('default full account, mixin + non-upgradeable', {
+  upgradeable: false
+});
+
+testAccount('explicit full account, mixin + upgradeable', {
+  name: 'MyAccount',
+  type: 'stark',
+  declare: true,
+  deploy: true,
+  pubkey: true,
+  upgradeable: true
+});
+
+testAccount('explicit full account, mixin + non-upgradeable', {
+  name: 'MyAccount',
+  type: 'stark',
+  declare: true,
+  deploy: true,
+  pubkey: true,
+  upgradeable: false
+});
+
+testAccount('basic account, upgradeable', {
+  declare: false,
+  deploy: false,
+  pubkey: false
+});
+
+testAccount('basic account, non-upgradeable', {
+  declare: false,
+  deploy: false,
+  pubkey: false,
+  upgradeable: false
+});
+
+testAccount('account declarer', {
+  deploy: false,
+  pubkey: false
+});
+
+testAccount('account deployable', {
+  declare: false,
+  pubkey: false
+});
+
+testAccount('account public key', {
+  declare: false,
+  deploy: false,
+});
+
+testAccount('account declarer, deployable', {
+  pubkey: false
+});
+
+testAccount('account declarer, public key', {
+  deploy: false
+});
+
+testAccount('account deployable, public key', {
+  declare: false
+});
+
+testEthAccount('default full ethAccount, mixin + upgradeable', {});
+
+testEthAccount('default full ethAccount, mixin + non-upgradeable', {
+  upgradeable: false
+});
+
+testEthAccount('explicit full ethAccount, mixin + upgradeable', {
+  name: 'MyAccount',
+  type: 'eth',
+  declare: true,
+  deploy: true,
+  pubkey: true,
+  upgradeable: true
+});
+
+testEthAccount('explicit full ethAccount, mixin + non-upgradeable', {
+  name: 'MyAccount',
+  type: 'eth',
+  declare: true,
+  deploy: true,
+  pubkey: true,
+  upgradeable: false
+});
+
+testEthAccount('basic ethAccount, upgradeable', {
+  declare: false,
+  deploy: false,
+  pubkey: false
+});
+
+testEthAccount('basic ethAccount, non-upgradeable', {
+  declare: false,
+  deploy: false,
+  pubkey: false,
+  upgradeable: false
+});
+
+testEthAccount('ethAccount declarer', {
+  deploy: false,
+  pubkey: false
+});
+
+testEthAccount('ethAccount deployable', {
+  declare: false,
+  pubkey: false
+});
+
+testEthAccount('ethAccount public key', {
+  declare: false,
+  deploy: false,
+});
+
+testEthAccount('ethAccount declarer, deployable', {
+  pubkey: false
+});
+
+testEthAccount('ethAccount declarer, public key', {
+  deploy: false
+});
+
+testEthAccount('ethAccount deployable, public key', {
+  declare: false
+});
+
+testAPIEquivalence('account API default');
+
+testAPIEquivalence('account API basic', {
+  name: 'CustomAccount',
+  type: 'stark',
+  declare: false,
+  deploy: false,
+  pubkey: false,
+  upgradeable: false,
+});
+
+testAPIEquivalence('account API full upgradeable', {
+  name: 'CustomAccount',
+  type: 'stark',
+  declare: true,
+  deploy: true,
+  pubkey: true,
+  upgradeable: true,
+});
+
+test('account API assert defaults', async t => {
+  t.is(account.print(account.defaults), account.print());
+});