@cartesi/cli 0.14.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.
Files changed (88) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +19 -0
  3. package/bin/dev.cmd +3 -0
  4. package/bin/dev.js +25 -0
  5. package/bin/run.cmd +3 -0
  6. package/bin/run.js +8 -0
  7. package/dist/baseCommand.d.ts +26 -0
  8. package/dist/baseCommand.d.ts.map +1 -0
  9. package/dist/baseCommand.js +80 -0
  10. package/dist/commands/address-book.d.ts +9 -0
  11. package/dist/commands/address-book.d.ts.map +1 -0
  12. package/dist/commands/address-book.js +21 -0
  13. package/dist/commands/build.d.ts +24 -0
  14. package/dist/commands/build.d.ts.map +1 -0
  15. package/dist/commands/build.js +219 -0
  16. package/dist/commands/clean.d.ts +8 -0
  17. package/dist/commands/clean.d.ts.map +1 -0
  18. package/dist/commands/clean.js +11 -0
  19. package/dist/commands/create.d.ts +16 -0
  20. package/dist/commands/create.d.ts.map +1 -0
  21. package/dist/commands/create.js +66 -0
  22. package/dist/commands/deploy/build.d.ts +12 -0
  23. package/dist/commands/deploy/build.d.ts.map +1 -0
  24. package/dist/commands/deploy/build.js +61 -0
  25. package/dist/commands/deploy/index.d.ts +13 -0
  26. package/dist/commands/deploy/index.d.ts.map +1 -0
  27. package/dist/commands/deploy/index.js +78 -0
  28. package/dist/commands/doctor.d.ts +13 -0
  29. package/dist/commands/doctor.d.ts.map +1 -0
  30. package/dist/commands/doctor.js +106 -0
  31. package/dist/commands/hash.d.ts +10 -0
  32. package/dist/commands/hash.d.ts.map +1 -0
  33. package/dist/commands/hash.js +22 -0
  34. package/dist/commands/run.d.ts +15 -0
  35. package/dist/commands/run.d.ts.map +1 -0
  36. package/dist/commands/run.js +137 -0
  37. package/dist/commands/send/dapp-address.d.ts +9 -0
  38. package/dist/commands/send/dapp-address.d.ts.map +1 -0
  39. package/dist/commands/send/dapp-address.js +20 -0
  40. package/dist/commands/send/erc20.d.ts +14 -0
  41. package/dist/commands/send/erc20.d.ts.map +1 -0
  42. package/dist/commands/send/erc20.js +70 -0
  43. package/dist/commands/send/erc721.d.ts +14 -0
  44. package/dist/commands/send/erc721.d.ts.map +1 -0
  45. package/dist/commands/send/erc721.js +73 -0
  46. package/dist/commands/send/ether.d.ts +13 -0
  47. package/dist/commands/send/ether.d.ts.map +1 -0
  48. package/dist/commands/send/ether.js +32 -0
  49. package/dist/commands/send/generic.d.ts +15 -0
  50. package/dist/commands/send/generic.d.ts.map +1 -0
  51. package/dist/commands/send/generic.js +119 -0
  52. package/dist/commands/send/index.d.ts +28 -0
  53. package/dist/commands/send/index.d.ts.map +1 -0
  54. package/dist/commands/send/index.js +102 -0
  55. package/dist/commands/shell.d.ts +14 -0
  56. package/dist/commands/shell.d.ts.map +1 -0
  57. package/dist/commands/shell.js +65 -0
  58. package/dist/contracts.d.ts +4863 -0
  59. package/dist/contracts.d.ts.map +1 -0
  60. package/dist/contracts.js +2074 -0
  61. package/dist/flags.d.ts +17 -0
  62. package/dist/flags.d.ts.map +1 -0
  63. package/dist/flags.js +28 -0
  64. package/dist/index.d.ts +2 -0
  65. package/dist/index.d.ts.map +1 -0
  66. package/dist/index.js +1 -0
  67. package/dist/node/DockerfileDeploy.txt +4 -0
  68. package/dist/node/default.env +28 -0
  69. package/dist/node/docker-compose-anvil.yaml +49 -0
  70. package/dist/node/docker-compose-database.yaml +15 -0
  71. package/dist/node/docker-compose-envfile.yaml +4 -0
  72. package/dist/node/docker-compose-explorer.yaml +84 -0
  73. package/dist/node/docker-compose-host.yaml +30 -0
  74. package/dist/node/docker-compose-prompt.yaml +17 -0
  75. package/dist/node/docker-compose-proxy.yaml +48 -0
  76. package/dist/node/docker-compose-snapshot-volume.yaml +8 -0
  77. package/dist/node/docker-compose-validator.yaml +59 -0
  78. package/dist/prompts.d.ts +62 -0
  79. package/dist/prompts.d.ts.map +1 -0
  80. package/dist/prompts.js +159 -0
  81. package/dist/types/docker.d.ts +22 -0
  82. package/dist/types/docker.d.ts.map +1 -0
  83. package/dist/types/docker.js +1 -0
  84. package/dist/wallet.d.ts +24 -0
  85. package/dist/wallet.d.ts.map +1 -0
  86. package/dist/wallet.js +204 -0
  87. package/oclif.manifest.json +887 -0
  88. package/package.json +100 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"docker.d.ts","sourceRoot":"","sources":["../../src/types/docker.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,gBAAgB,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,24 @@
1
+ import { Address, Chain, Hex, PublicClient, WalletClient } from "viem";
2
+ export type SupportedChainsOptions = {
3
+ includeDevnet?: boolean;
4
+ includeMainnets?: boolean;
5
+ includeTestnets?: boolean;
6
+ };
7
+ export declare const supportedChains: (options?: SupportedChainsOptions) => Chain[];
8
+ export declare const DEFAULT_DEVNET_MNEMONIC = "test test test test test test test test test test test junk";
9
+ export type WalletType = "mnemonic" | "private-key";
10
+ export interface EthereumPromptOptions {
11
+ chain?: Chain;
12
+ rpcUrl?: string;
13
+ mnemonicPassphrase?: string;
14
+ mnemonicIndex?: number;
15
+ privateKey?: Hex;
16
+ }
17
+ export type TransactionPrompt = (walletClient: WalletClient, publicClient: PublicClient) => Promise<Address>;
18
+ declare const createClients: (options: EthereumPromptOptions) => Promise<{
19
+ chain: Chain;
20
+ publicClient: PublicClient;
21
+ walletClient: WalletClient;
22
+ }>;
23
+ export default createClients;
24
+ //# sourceMappingURL=wallet.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../src/wallet.ts"],"names":[],"mappings":"AAEA,OAAO,EAEH,OAAO,EACP,KAAK,EACL,GAAG,EAEH,YAAY,EAEZ,YAAY,EAKf,MAAM,MAAM,CAAC;AAiBd,MAAM,MAAM,sBAAsB,GAAG;IACjC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,eAAO,MAAM,eAAe,aAAc,sBAAsB,KAAG,KAAK,EAoBvE,CAAC;AAEF,eAAO,MAAM,uBAAuB,gEAC6B,CAAC;AAElE,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,aAAa,CAAC;AAepD,MAAM,WAAW,qBAAqB;IAClC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,GAAG,CAAC;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,CAC5B,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,KACzB,OAAO,CAAC,OAAO,CAAC,CAAC;AAkLtB,QAAA,MAAM,aAAa,YACN,qBAAqB,KAC/B,QAAQ;IACP,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;CAC9B,CAuBA,CAAC;AAEF,eAAe,aAAa,CAAC"}
package/dist/wallet.js ADDED
@@ -0,0 +1,204 @@
1
+ import input from "@inquirer/input";
2
+ import chalk from "chalk";
3
+ import { formatUnits, http, createPublicClient as viemCreatePublicClient, createWalletClient as viemCreateWalletClient, } from "viem";
4
+ import { mnemonicToAccount, privateKeyToAccount } from "viem/accounts";
5
+ import { arbitrum, arbitrumSepolia, base, baseSepolia, foundry, mainnet, optimism, optimismSepolia, sepolia, } from "viem/chains";
6
+ import { hexInput, selectAuto } from "./prompts.js";
7
+ export const supportedChains = (options) => {
8
+ options = options || {
9
+ includeDevnet: false, // default is not to show devnet
10
+ includeMainnets: true,
11
+ includeTestnets: true,
12
+ };
13
+ options.includeTestnets = options.includeTestnets ?? true; // default is true if not specified
14
+ options.includeMainnets = options.includeMainnets ?? true; // default is true if not specified
15
+ const chains = [];
16
+ if (options.includeDevnet) {
17
+ chains.push(foundry);
18
+ }
19
+ if (options.includeTestnets) {
20
+ chains.push(arbitrumSepolia, baseSepolia, optimismSepolia, sepolia);
21
+ }
22
+ if (options.includeMainnets) {
23
+ chains.push(arbitrum, base, mainnet, optimism);
24
+ }
25
+ return chains;
26
+ };
27
+ export const DEFAULT_DEVNET_MNEMONIC = "test test test test test test test test test test test junk";
28
+ const walletChoices = (chain) => {
29
+ const dev = chain.id === foundry.id;
30
+ return [
31
+ {
32
+ name: `Mnemonic${dev ? "" : chalk.red(" (UNSAFE)")}`,
33
+ value: "mnemonic",
34
+ },
35
+ {
36
+ name: `Private Key${dev ? "" : chalk.red(" (UNSAFE)")}`,
37
+ value: "private-key",
38
+ },
39
+ ];
40
+ };
41
+ const selectChain = async (options) => {
42
+ // if development mode, include foundry as an option
43
+ const chains = supportedChains({ includeDevnet: true });
44
+ if (options.chain) {
45
+ const chain = options.chain;
46
+ if (chains.findIndex((c) => c.id === chain.id) >= 0) {
47
+ return options.chain;
48
+ }
49
+ throw new Error(`Unsupported chainId ${options.chain.id}`);
50
+ }
51
+ else {
52
+ // allow user to select from list
53
+ const choices = chains.map((chain) => ({
54
+ name: chain.name,
55
+ value: chain,
56
+ }));
57
+ return await selectAuto({
58
+ message: "Chain",
59
+ choices,
60
+ pageSize: choices.length,
61
+ discardDisabled: true,
62
+ });
63
+ }
64
+ };
65
+ const selectTransport = async (options, chain) => {
66
+ // use user provided url (in args) or try to use default one from chain, or ask for one
67
+ if (options.rpcUrl) {
68
+ return http(options.rpcUrl);
69
+ }
70
+ else {
71
+ const url = await input({
72
+ message: "RPC URL",
73
+ default: chain.rpcUrls.default.http[0],
74
+ });
75
+ return http(url);
76
+ }
77
+ };
78
+ const createPublicClient = async (chain, transport) => {
79
+ const publicClient = viemCreatePublicClient({ transport, chain });
80
+ // check if chainId matches
81
+ const chainId = await publicClient.getChainId();
82
+ if (chainId !== chain.id) {
83
+ throw new Error(`Chain of provided RPC URL (${chainId}) does not match selected chain (${chain.id}))`);
84
+ }
85
+ return publicClient;
86
+ };
87
+ /**
88
+ * Format the balance of an account for display
89
+ * @param account account to format the balance for
90
+ * @param publicClient client to query the balance
91
+ * @returns formatted balance string
92
+ */
93
+ const addressBalanceLabel = async (address, publicClient) => {
94
+ const chain = publicClient.chain;
95
+ if (chain) {
96
+ // query balance using provider
97
+ const balance = await publicClient.getBalance({ address });
98
+ // format balance
99
+ const symbol = chain.nativeCurrency.symbol;
100
+ const balanceStr = formatUnits(balance, chain.nativeCurrency.decimals);
101
+ let balanceLabel = chalk.bold(`${balanceStr} ${symbol}`);
102
+ // display in red if balance is zero
103
+ if (balance === 0n) {
104
+ balanceLabel = chalk.red(balanceLabel);
105
+ }
106
+ return `${address} ${balanceLabel}`;
107
+ }
108
+ else {
109
+ return address;
110
+ }
111
+ };
112
+ const createWalletClient = async (options, chain, publicClient, publicTransport) => {
113
+ if (options.privateKey) {
114
+ // private key specified
115
+ const account = privateKeyToAccount(options.privateKey);
116
+ return viemCreateWalletClient({
117
+ account,
118
+ transport: publicTransport,
119
+ chain,
120
+ });
121
+ }
122
+ else if (options.mnemonicPassphrase) {
123
+ // mnemonic specified
124
+ const account = mnemonicToAccount(options.mnemonicPassphrase, {
125
+ addressIndex: options.mnemonicIndex,
126
+ });
127
+ // create wallet client
128
+ return viemCreateWalletClient({
129
+ account,
130
+ transport: publicTransport,
131
+ chain,
132
+ });
133
+ }
134
+ else {
135
+ const wallets = walletChoices(chain);
136
+ const wallet = await selectAuto({
137
+ message: "Wallet",
138
+ choices: wallets,
139
+ discardDisabled: true,
140
+ });
141
+ if (wallet === "mnemonic") {
142
+ // use the publicClient transport
143
+ const mnemonic = await input({
144
+ message: "Mnemonic",
145
+ default: chain.id === 31337 ? DEFAULT_DEVNET_MNEMONIC : undefined,
146
+ });
147
+ // select account from mnemonic
148
+ if (options.mnemonicIndex) {
149
+ return viemCreateWalletClient({
150
+ transport: publicTransport,
151
+ chain,
152
+ account: mnemonicToAccount(mnemonic, {
153
+ addressIndex: options.mnemonicIndex,
154
+ }),
155
+ });
156
+ }
157
+ else {
158
+ const choices = await Promise.all([...Array(10)].map(async (_, addressIndex) => {
159
+ const account = mnemonicToAccount(mnemonic, {
160
+ addressIndex,
161
+ });
162
+ const name = await addressBalanceLabel(account.address, publicClient);
163
+ return { name, value: account };
164
+ }));
165
+ const account = await selectAuto({
166
+ message: "Account",
167
+ choices,
168
+ pageSize: choices.length,
169
+ });
170
+ return viemCreateWalletClient({
171
+ transport: publicTransport,
172
+ chain,
173
+ account,
174
+ });
175
+ }
176
+ }
177
+ else if (wallet === "private-key") {
178
+ const privateKey = await hexInput({ message: "Private Key" });
179
+ const account = privateKeyToAccount(privateKey);
180
+ return viemCreateWalletClient({
181
+ transport: publicTransport,
182
+ chain,
183
+ account,
184
+ });
185
+ }
186
+ throw new Error(`Unsupported wallet ${wallet}`);
187
+ }
188
+ };
189
+ const createClients = async (options) => {
190
+ // select chain
191
+ const chain = await selectChain(options);
192
+ // select RPC URL
193
+ const transport = await selectTransport(options, chain);
194
+ // create public client
195
+ const publicClient = await createPublicClient(chain, transport);
196
+ // create wallet client
197
+ const walletClient = await createWalletClient(options, chain, publicClient, transport);
198
+ return {
199
+ chain,
200
+ publicClient,
201
+ walletClient,
202
+ };
203
+ };
204
+ export default createClients;