Merge pull request #15 from smartcontractkit/gauntlet-erc20

Gauntlet Starkgate ERC20 and Argent Account support

Author: RodrigoAD

docs/gauntlet/README.md

@@ -6,6 +6,8 @@
   - [Basic Setup](./getting_started.md#basic-setup)
   - [CLI](../../packages-ts/gauntlet-starknet-cli/README.md)
   - [Example Contract](../../packages-ts/gauntlet-starknet-example/README.md)
-  - [Account Contract](../../packages-ts/gauntlet-starknet-account/README.md)
+  - [OZ Contracts](../../packages-ts/gauntlet-starknet-oz/README.md)
+  - [Starkgate Contracts](../../packages-ts/gauntlet-starknet-starkgate/README.md)
+  - [Argent Contracts](../../packages-ts/gauntlet-starknet-argent/README.md)
   - [OCR2 Contracts](../../packages-ts/gauntlet-starknet-ocr2/README.md)
 - Contribute

…ges-ts/gauntlet-starknet-account/LICENSE …ages-ts/gauntlet-starknet-argent/LICENSEpackages-ts/gauntlet-starknet-account/LICENSE renamed to packages-ts/gauntlet-starknet-argent/LICENSE packages-ts/gauntlet-starknet-account/LICENSE renamed to packages-ts/gauntlet-starknet-argent/LICENSE

@@ -0,0 +1,31 @@
+# Gauntlet Starknet Commands for Argent Contracts
+
+## Account
+
+### Deploy
+
+```
+yarn gauntlet argent_account:deploy --network=<NETWORK>
+```
+
+Note the contract address. The contract is not configured yet. A signer needs to be specified in it:
+
+### Initialize
+
+```bash
+yarn gauntlet argent_account:initialize --network=<NETWORK> <CONTRACT_ADDRESS>
+# OR If you already have a private key
+yarn gauntlet argent_account:initialize --network=<NETWORK> --publicKey=<PUBLIC_KEY> <CONTRACT_ADDRESS>
+```
+
+If no public key is provided, the command will generate a new Keypair and will give the details during the execution.
+
+You need to pay some fee to call initialize, but as this could be the first account wallet you are deploying, use the `--noWallet` option to bypass the fee. This will be soon deprecated
+
+At the end of the process, you will want to include the account contract and the private key to your `.env` configuration file.
+
+```bash
+# .env
+PRIVATE_KEY=0x...
+ACCOUNT=0x...
+```

packages-ts/gauntlet-starknet-argent/README.md

@@ -1,7 +1,7 @@
 {
-  "name": "@chainlink/gauntlet-starknet-account",
+  "name": "@chainlink/gauntlet-starknet-argent",
   "version": "0.0.1",
-  "description": "Gauntlet Starknet Account",
+  "description": "Gauntlet Starknet Argent contracts",
   "keywords": [
     "typescript",
     "cli"

…s/gauntlet-starknet-account/package.json …ts/gauntlet-starknet-argent/package.jsonpackages-ts/gauntlet-starknet-account/package.json renamed to packages-ts/gauntlet-starknet-argent/package.json packages-ts/gauntlet-starknet-account/package.json renamed to packages-ts/gauntlet-starknet-argent/package.json

@@ -0,0 +1,40 @@
+import {
+  BeforeExecute,
+  ExecuteCommandConfig,
+  ExecutionContext,
+  makeExecuteCommand,
+  Validation,
+} from '@chainlink/gauntlet-starknet'
+import { CATEGORIES } from '../../lib/categories'
+import { accountContractLoader } from '../../lib/contracts'
+
+type UserInput = {}
+
+type ContractInput = []
+
+const makeUserInput = async (flags, args): Promise<UserInput> => ({})
+
+const makeContractInput = async (input: UserInput, context: ExecutionContext): Promise<ContractInput> => {
+  return []
+}
+
+const beforeExecute: BeforeExecute<UserInput, ContractInput> = (context, input, deps) => async () => {
+  deps.logger.info(`About to deploy an Argent Account Contract`)
+}
+
+const commandConfig: ExecuteCommandConfig<UserInput, ContractInput> = {
+  ux: {
+    category: CATEGORIES.ACCOUNT,
+    function: 'deploy',
+    examples: [`${CATEGORIES.ACCOUNT}:deploy --network=<NETWORK>`],
+  },
+  makeUserInput,
+  makeContractInput,
+  validations: [],
+  loadContract: accountContractLoader,
+  hooks: {
+    beforeExecute,
+  },
+}
+
+export default makeExecuteCommand(commandConfig)

packages-ts/gauntlet-starknet-argent/src/commands/account/deploy.ts

@@ -0,0 +1,4 @@
+import Deploy from './deploy'
+import Initialize from './initialize'
+
+export default [Deploy, Initialize]

packages-ts/gauntlet-starknet-argent/src/commands/account/index.ts

@@ -0,0 +1,73 @@
+import {
+  AfterExecute,
+  BeforeExecute,
+  ExecuteCommandConfig,
+  makeExecuteCommand,
+  Validation,
+} from '@chainlink/gauntlet-starknet'
+import { ec } from 'starknet'
+import { CATEGORIES } from '../../lib/categories'
+import { accountContractLoader } from '../../lib/contracts'
+
+type UserInput = {
+  publicKey: string
+  privateKey?: string
+}
+
+type ContractInput = [string, 0]
+
+const makeUserInput = async (flags, args): Promise<UserInput> => {
+  if (flags.input) return flags.input as UserInput
+
+  // If public key is not provided, generate a new address
+  const keypair = ec.genKeyPair()
+  const generatedPK = '0x' + keypair.getPrivate('hex')
+  const pubkey = flags.publicKey || ec.getStarkKey(ec.getKeyPair(generatedPK))
+  return {
+    publicKey: pubkey,
+    privateKey: !flags.publicKey && generatedPK,
+  }
+}
+
+const makeContractInput = async (input: UserInput): Promise<ContractInput> => {
+  return [input.publicKey, 0]
+}
+
+const beforeExecute: BeforeExecute<UserInput, ContractInput> = (context, input, deps) => async () => {
+  deps.logger.info(`About to deploy an Account Contract with public key ${input.contract[0]}`)
+  if (input.user.privateKey) {
+    await deps.prompt(`The generated private key will be shown next, continue?`)
+    deps.logger.line()
+
+    deps.logger.info(`To sign future transactions, store the Private Key`)
+    deps.logger.info(`PRIVATE_KEY: ${input.user.privateKey}`)
+
+    deps.logger.line()
+  }
+}
+
+const afterExecute: AfterExecute<UserInput, ContractInput> = (context, input, deps) => async (result) => {
+  deps.logger.success(`Account contract located at ${result.responses[0].tx.address}`)
+  return {
+    publicKey: input.user.publicKey,
+    privateKey: input.user.privateKey,
+  }
+}
+
+const commandConfig: ExecuteCommandConfig<UserInput, ContractInput> = {
+  ux: {
+    category: CATEGORIES.ACCOUNT,
+    function: 'initialize',
+    examples: [`${CATEGORIES.ACCOUNT}:initialize --network=<NETWORK> --publicKey=<ADDRESS> <CONTRACT_ADDRESS>`],
+  },
+  makeUserInput,
+  makeContractInput,
+  validations: [],
+  loadContract: accountContractLoader,
+  hooks: {
+    beforeExecute,
+    afterExecute,
+  },
+}
+
+export default makeExecuteCommand(commandConfig)