@openzeppelin/compact-deployer 0.2.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/CHANGELOG.md +33 -0
- package/README.md +304 -0
- package/dist/config/compact-config.d.ts +31 -0
- package/dist/config/compact-config.js +123 -0
- package/dist/config/compact-config.js.map +1 -0
- package/dist/config/schema.d.ts +688 -0
- package/dist/config/schema.js +90 -0
- package/dist/config/schema.js.map +1 -0
- package/dist/deployer.d.ts +154 -0
- package/dist/deployer.js +916 -0
- package/dist/deployer.js.map +1 -0
- package/dist/deployments.d.ts +119 -0
- package/dist/deployments.js +144 -0
- package/dist/deployments.js.map +1 -0
- package/dist/errors.d.ts +94 -0
- package/dist/errors.js +124 -0
- package/dist/errors.js.map +1 -0
- package/dist/loaders/args.d.ts +22 -0
- package/dist/loaders/args.js +72 -0
- package/dist/loaders/args.js.map +1 -0
- package/dist/loaders/argv.d.ts +36 -0
- package/dist/loaders/argv.js +101 -0
- package/dist/loaders/argv.js.map +1 -0
- package/dist/loaders/artifact-path.d.ts +16 -0
- package/dist/loaders/artifact-path.js +35 -0
- package/dist/loaders/artifact-path.js.map +1 -0
- package/dist/loaders/artifact.d.ts +43 -0
- package/dist/loaders/artifact.js +115 -0
- package/dist/loaders/artifact.js.map +1 -0
- package/dist/loaders/constructor-meta.d.ts +17 -0
- package/dist/loaders/constructor-meta.js +99 -0
- package/dist/loaders/constructor-meta.js.map +1 -0
- package/dist/loaders/context.d.ts +14 -0
- package/dist/loaders/context.js +43 -0
- package/dist/loaders/context.js.map +1 -0
- package/dist/loaders/contract-resolve.d.ts +15 -0
- package/dist/loaders/contract-resolve.js +53 -0
- package/dist/loaders/contract-resolve.js.map +1 -0
- package/dist/loaders/init-state.d.ts +8 -0
- package/dist/loaders/init-state.js +37 -0
- package/dist/loaders/init-state.js.map +1 -0
- package/dist/loaders/ref-resolver.d.ts +8 -0
- package/dist/loaders/ref-resolver.js +27 -0
- package/dist/loaders/ref-resolver.js.map +1 -0
- package/dist/loaders/signing-key.d.ts +10 -0
- package/dist/loaders/signing-key.js +23 -0
- package/dist/loaders/signing-key.js.map +1 -0
- package/dist/providers/build.d.ts +20 -0
- package/dist/providers/build.js +41 -0
- package/dist/providers/build.js.map +1 -0
- package/dist/providers/network.d.ts +6 -0
- package/dist/providers/network.js +36 -0
- package/dist/providers/network.js.map +1 -0
- package/dist/providers/private-state-password.d.ts +12 -0
- package/dist/providers/private-state-password.js +27 -0
- package/dist/providers/private-state-password.js.map +1 -0
- package/dist/providers/proof-server.d.ts +29 -0
- package/dist/providers/proof-server.js +97 -0
- package/dist/providers/proof-server.js.map +1 -0
- package/dist/runDeploy.d.ts +167 -0
- package/dist/runDeploy.js +228 -0
- package/dist/runDeploy.js.map +1 -0
- package/dist/services/atomic-json.d.ts +7 -0
- package/dist/services/atomic-json.js +34 -0
- package/dist/services/atomic-json.js.map +1 -0
- package/dist/services/chain-state.d.ts +75 -0
- package/dist/services/chain-state.js +151 -0
- package/dist/services/chain-state.js.map +1 -0
- package/dist/services/contract-state.d.ts +29 -0
- package/dist/services/contract-state.js +54 -0
- package/dist/services/contract-state.js.map +1 -0
- package/dist/services/deploy-plan.d.ts +36 -0
- package/dist/services/deploy-plan.js +45 -0
- package/dist/services/deploy-plan.js.map +1 -0
- package/dist/services/deploy-tx.d.ts +189 -0
- package/dist/services/deploy-tx.js +297 -0
- package/dist/services/deploy-tx.js.map +1 -0
- package/dist/services/error-format.d.ts +10 -0
- package/dist/services/error-format.js +91 -0
- package/dist/services/error-format.js.map +1 -0
- package/dist/services/file-lock.d.ts +23 -0
- package/dist/services/file-lock.js +90 -0
- package/dist/services/file-lock.js.map +1 -0
- package/dist/services/maintenance-tx.d.ts +49 -0
- package/dist/services/maintenance-tx.js +43 -0
- package/dist/services/maintenance-tx.js.map +1 -0
- package/dist/services/wallet-cache.d.ts +99 -0
- package/dist/services/wallet-cache.js +239 -0
- package/dist/services/wallet-cache.js.map +1 -0
- package/dist/services/wallet-sync.d.ts +89 -0
- package/dist/services/wallet-sync.js +249 -0
- package/dist/services/wallet-sync.js.map +1 -0
- package/dist/wallet/handler.d.ts +64 -0
- package/dist/wallet/handler.js +151 -0
- package/dist/wallet/handler.js.map +1 -0
- package/dist/wallet/keystore.d.ts +55 -0
- package/dist/wallet/keystore.js +213 -0
- package/dist/wallet/keystore.js.map +1 -0
- package/dist/wallet/seeds.d.ts +41 -0
- package/dist/wallet/seeds.js +84 -0
- package/dist/wallet/seeds.js.map +1 -0
- package/package.json +133 -0
- package/proof-server.yml +16 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { ConfigError } from "../errors.js";
|
|
2
|
+
import { LoaderContext } from "./context.js";
|
|
3
|
+
import { RefResolver } from "./ref-resolver.js";
|
|
4
|
+
/** Initial private state for the contract constructor. `load` returns `undefined` when omitted in TOML. */
|
|
5
|
+
export class InitialPrivateState {
|
|
6
|
+
value;
|
|
7
|
+
constructor(value) {
|
|
8
|
+
this.value = value;
|
|
9
|
+
}
|
|
10
|
+
/** Source: `{ file }` (JSON with `"123n"` bigint strings) or `{ module, export }` (value or zero-arg function). */
|
|
11
|
+
static async load(ref, rootDir) {
|
|
12
|
+
if (!ref)
|
|
13
|
+
return undefined;
|
|
14
|
+
const resolver = new RefResolver(new LoaderContext(rootDir), 'init_private_state');
|
|
15
|
+
const value = await resolver.resolve(ref, (text, path) => {
|
|
16
|
+
try {
|
|
17
|
+
return JSON.parse(text, bigintReviver);
|
|
18
|
+
}
|
|
19
|
+
catch (e) {
|
|
20
|
+
throw new ConfigError(`init_private_state: invalid JSON at ${path}: ${e.message}`);
|
|
21
|
+
}
|
|
22
|
+
}, (v, path, exp) => {
|
|
23
|
+
if (v === undefined) {
|
|
24
|
+
throw new ConfigError(`init_private_state: module ${path} has no export "${exp}"`);
|
|
25
|
+
}
|
|
26
|
+
return v;
|
|
27
|
+
});
|
|
28
|
+
return new InitialPrivateState(value);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
function bigintReviver(_key, value) {
|
|
32
|
+
if (typeof value === 'string' && /^-?\d+n$/.test(value)) {
|
|
33
|
+
return BigInt(value.slice(0, -1));
|
|
34
|
+
}
|
|
35
|
+
return value;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=init-state.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"init-state.js","sourceRoot":"","sources":["../../src/loaders/init-state.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,2GAA2G;AAC3G,MAAM,OAAO,mBAAmB;IACrB,KAAK,CAAU;IAExB,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,mHAAmH;IACnH,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,GAAgC,EAChC,OAAe;QAEf,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAC;QAE3B,MAAM,QAAQ,GAAG,IAAI,WAAW,CAC9B,IAAI,aAAa,CAAC,OAAO,CAAC,EAC1B,oBAAoB,CACrB,CAAC;QACF,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAClC,GAAG,EACH,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACb,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YACzC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,WAAW,CACnB,uCAAuC,IAAI,KAAM,CAAW,CAAC,OAAO,EAAE,CACvE,CAAC;YACJ,CAAC;QACH,CAAC,EACD,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;YACf,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACpB,MAAM,IAAI,WAAW,CACnB,8BAA8B,IAAI,mBAAmB,GAAG,GAAG,CAC5D,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CACF,CAAC;QACF,OAAO,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;CACF;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,KAAc;IACjD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type FileOrModuleRef } from '../config/schema.ts';
|
|
2
|
+
import type { LoaderContext } from './context.ts';
|
|
3
|
+
/** Resolve a `{ file }` / `{ module, export }` ref to a typed value via caller-supplied parse + validate callbacks. */
|
|
4
|
+
export declare class RefResolver<T> {
|
|
5
|
+
#private;
|
|
6
|
+
constructor(ctx: LoaderContext, label: string);
|
|
7
|
+
resolve(ref: FileOrModuleRef, parseFile: (text: string, path: string) => T, validateExport: (value: unknown, path: string, exportName: string) => T): Promise<T>;
|
|
8
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { isFileRef, isModuleRef, } from "../config/schema.js";
|
|
2
|
+
import { ConfigError } from "../errors.js";
|
|
3
|
+
/** Resolve a `{ file }` / `{ module, export }` ref to a typed value via caller-supplied parse + validate callbacks. */
|
|
4
|
+
export class RefResolver {
|
|
5
|
+
#ctx;
|
|
6
|
+
#label;
|
|
7
|
+
constructor(ctx, label) {
|
|
8
|
+
this.#ctx = ctx;
|
|
9
|
+
this.#label = label;
|
|
10
|
+
}
|
|
11
|
+
async resolve(ref, parseFile, validateExport) {
|
|
12
|
+
if (isFileRef(ref)) {
|
|
13
|
+
const { text, path } = await this.#ctx.readText(ref.file, this.#label);
|
|
14
|
+
return parseFile(text, path);
|
|
15
|
+
}
|
|
16
|
+
if (isModuleRef(ref)) {
|
|
17
|
+
const { mod, path } = await this.#ctx.importModule(ref.module, this.#label);
|
|
18
|
+
const exported = mod[ref.export];
|
|
19
|
+
const resolved = typeof exported === 'function'
|
|
20
|
+
? await exported()
|
|
21
|
+
: exported;
|
|
22
|
+
return validateExport(resolved, path, ref.export);
|
|
23
|
+
}
|
|
24
|
+
throw new ConfigError(`${this.#label}: must be { file } or { module, export }`);
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=ref-resolver.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ref-resolver.js","sourceRoot":"","sources":["../../src/loaders/ref-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EACT,WAAW,GACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C,uHAAuH;AACvH,MAAM,OAAO,WAAW;IACb,IAAI,CAAgB;IACpB,MAAM,CAAS;IAExB,YAAY,GAAkB,EAAE,KAAa;QAC3C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,OAAO,CACX,GAAoB,EACpB,SAA4C,EAC5C,cAAuE;QAEvE,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,CAChD,GAAG,CAAC,MAAM,EACV,IAAI,CAAC,MAAM,CACZ,CAAC;YACF,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjC,MAAM,QAAQ,GACZ,OAAO,QAAQ,KAAK,UAAU;gBAC5B,CAAC,CAAC,MAAO,QAA0B,EAAE;gBACrC,CAAC,CAAC,QAAQ,CAAC;YACf,OAAO,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,IAAI,WAAW,CACnB,GAAG,IAAI,CAAC,MAAM,0CAA0C,CACzD,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Maintenance-authority signing key. Canonical form: 64 lowercase hex
|
|
3
|
+
* chars, no `0x`. Fuzzy input is rejected so midnight-js can't silently
|
|
4
|
+
* auto-sample a key the user then can't recover.
|
|
5
|
+
*/
|
|
6
|
+
export declare class SigningKey {
|
|
7
|
+
readonly hex: string;
|
|
8
|
+
private constructor();
|
|
9
|
+
static load(rootDir: string, path: string): Promise<SigningKey>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { ConfigError } from "../errors.js";
|
|
2
|
+
import { LoaderContext } from "./context.js";
|
|
3
|
+
/**
|
|
4
|
+
* Maintenance-authority signing key. Canonical form: 64 lowercase hex
|
|
5
|
+
* chars, no `0x`. Fuzzy input is rejected so midnight-js can't silently
|
|
6
|
+
* auto-sample a key the user then can't recover.
|
|
7
|
+
*/
|
|
8
|
+
export class SigningKey {
|
|
9
|
+
hex;
|
|
10
|
+
constructor(hex) {
|
|
11
|
+
this.hex = hex;
|
|
12
|
+
}
|
|
13
|
+
static async load(rootDir, path) {
|
|
14
|
+
const ctx = new LoaderContext(rootDir);
|
|
15
|
+
const { text, path: abs } = await ctx.readText(path, 'signing_key_file');
|
|
16
|
+
const trimmed = text.trim().replace(/^0x/i, '');
|
|
17
|
+
if (!/^[0-9a-fA-F]{64}$/.test(trimmed)) {
|
|
18
|
+
throw new ConfigError(`signing_key_file ${abs}: expected 32 bytes hex-encoded (64 hex chars)`);
|
|
19
|
+
}
|
|
20
|
+
return new SigningKey(trimmed.toLowerCase());
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=signing-key.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"signing-key.js","sourceRoot":"","sources":["../../src/loaders/signing-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;GAIG;AACH,MAAM,OAAO,UAAU;IACZ,GAAG,CAAS;IAErB,YAAoB,GAAW;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,IAAY;QAC7C,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,WAAW,CACnB,oBAAoB,GAAG,gDAAgD,CACxE,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/C,CAAC;CACF"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { MidnightProviders, PrivateStateProvider } from '@midnight-ntwrk/midnight-js-types';
|
|
2
|
+
import type { EnvironmentConfiguration, MidnightWalletProvider } from '@midnight-ntwrk/testkit-js';
|
|
3
|
+
import type { ContractConfig } from '../config/schema.ts';
|
|
4
|
+
export interface BuildProvidersOptions {
|
|
5
|
+
env: EnvironmentConfiguration;
|
|
6
|
+
wallet: MidnightWalletProvider;
|
|
7
|
+
contractName: string;
|
|
8
|
+
contract: ContractConfig;
|
|
9
|
+
zkConfigPath: string;
|
|
10
|
+
/** Directory `compact.toml` was loaded from; see `CompactConfig.rootDir`. */
|
|
11
|
+
rootDir: string;
|
|
12
|
+
/** Inject `inMemoryPrivateStateProvider` in tests to avoid LevelDB file-lock contention. */
|
|
13
|
+
privateStateProvider?: PrivateStateProvider;
|
|
14
|
+
/**
|
|
15
|
+
* Secret material for the default LevelDB password (SHA-256 of the wallet
|
|
16
|
+
* seed). Required unless {@link privateStateProvider} is supplied.
|
|
17
|
+
*/
|
|
18
|
+
privateStateSecret?: string;
|
|
19
|
+
}
|
|
20
|
+
export declare function buildProviders({ env, wallet, contractName, contract, zkConfigPath, rootDir, privateStateProvider, privateStateSecret, }: BuildProvidersOptions): MidnightProviders;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { resolve } from 'node:path';
|
|
2
|
+
import { httpClientProofProvider } from '@midnight-ntwrk/midnight-js-http-client-proof-provider';
|
|
3
|
+
import { indexerPublicDataProvider } from '@midnight-ntwrk/midnight-js-indexer-public-data-provider';
|
|
4
|
+
import { DEFAULT_CONFIG as LEVEL_DEFAULTS, levelPrivateStateProvider, } from '@midnight-ntwrk/midnight-js-level-private-state-provider';
|
|
5
|
+
import { NodeZkConfigProvider } from '@midnight-ntwrk/midnight-js-node-zk-config-provider';
|
|
6
|
+
import { ConfigError } from "../errors.js";
|
|
7
|
+
import { derivePrivateStatePassword } from "./private-state-password.js";
|
|
8
|
+
export function buildProviders({ env, wallet, contractName, contract, zkConfigPath, rootDir, privateStateProvider, privateStateSecret, }) {
|
|
9
|
+
const zkConfigProvider = new NodeZkConfigProvider(zkConfigPath);
|
|
10
|
+
const resolvedPrivateStateProvider = privateStateProvider ??
|
|
11
|
+
defaultLevelPrivateStateProvider(wallet, contract, contractName, rootDir, privateStateSecret);
|
|
12
|
+
return {
|
|
13
|
+
privateStateProvider: resolvedPrivateStateProvider,
|
|
14
|
+
publicDataProvider: indexerPublicDataProvider(env.indexer, env.indexerWS),
|
|
15
|
+
zkConfigProvider,
|
|
16
|
+
proofProvider: httpClientProofProvider(env.proofServer, zkConfigProvider),
|
|
17
|
+
walletProvider: wallet,
|
|
18
|
+
midnightProvider: wallet,
|
|
19
|
+
};
|
|
20
|
+
}
|
|
21
|
+
function defaultLevelPrivateStateProvider(wallet, contract, contractName, rootDir, privateStateSecret) {
|
|
22
|
+
if (!privateStateSecret) {
|
|
23
|
+
// Reached only with an injected wallet and no injected provider. There is
|
|
24
|
+
// no seed to derive from, and falling back to wallet public-key material
|
|
25
|
+
// would leave the private-state DB readable by anyone holding the address.
|
|
26
|
+
throw new ConfigError('Cannot derive a private-state DB password without a deployer seed. Pass `privateStateProvider` alongside `walletProvider`.');
|
|
27
|
+
}
|
|
28
|
+
const password = derivePrivateStatePassword(privateStateSecret);
|
|
29
|
+
return levelPrivateStateProvider({
|
|
30
|
+
// `midnightDbName` is handed straight to `new Level(location)`, so it
|
|
31
|
+
// is a filesystem path, not a logical name: left at the bare default
|
|
32
|
+
// the DB materialises in the shell's CWD and a deploy run from a
|
|
33
|
+
// subdirectory silently starts from an empty private state. There is
|
|
34
|
+
// no separate path option, so anchor the default name on rootDir.
|
|
35
|
+
midnightDbName: resolve(rootDir, LEVEL_DEFAULTS.midnightDbName),
|
|
36
|
+
privateStateStoreName: contract.private_state_store_name ?? `${contractName}-private-state`,
|
|
37
|
+
accountId: wallet.getCoinPublicKey(),
|
|
38
|
+
privateStoragePasswordProvider: () => password,
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=build.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"build.js","sourceRoot":"","sources":["../../src/providers/build.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wDAAwD,CAAC;AACjG,OAAO,EAAE,yBAAyB,EAAE,MAAM,0DAA0D,CAAC;AACrG,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,yBAAyB,GAC1B,MAAM,0DAA0D,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qDAAqD,CAAC;AAU3F,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAmBzE,MAAM,UAAU,cAAc,CAAC,EAC7B,GAAG,EACH,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,oBAAoB,EACpB,kBAAkB,GACI;IACtB,MAAM,gBAAgB,GAAG,IAAI,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAEhE,MAAM,4BAA4B,GAChC,oBAAoB;QACpB,gCAAgC,CAC9B,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,kBAAkB,CACnB,CAAC;IAEJ,OAAO;QACL,oBAAoB,EAAE,4BAA4B;QAClD,kBAAkB,EAAE,yBAAyB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC;QACzE,gBAAgB;QAChB,aAAa,EAAE,uBAAuB,CAAC,GAAG,CAAC,WAAW,EAAE,gBAAgB,CAAC;QACzE,cAAc,EAAE,MAAM;QACtB,gBAAgB,EAAE,MAAM;KACzB,CAAC;AACJ,CAAC;AAED,SAAS,gCAAgC,CACvC,MAA8B,EAC9B,QAAwB,EACxB,YAAoB,EACpB,OAAe,EACf,kBAAsC;IAEtC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,0EAA0E;QAC1E,yEAAyE;QACzE,2EAA2E;QAC3E,MAAM,IAAI,WAAW,CACnB,4HAA4H,CAC7H,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,0BAA0B,CAAC,kBAAkB,CAAC,CAAC;IAChE,OAAO,yBAAyB,CAAC;QAC/B,sEAAsE;QACtE,qEAAqE;QACrE,iEAAiE;QACjE,qEAAqE;QACrE,kEAAkE;QAClE,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,cAAc,CAAC;QAC/D,qBAAqB,EACnB,QAAQ,CAAC,wBAAwB,IAAI,GAAG,YAAY,gBAAgB;QACtE,SAAS,EAAE,MAAM,CAAC,gBAAgB,EAAE;QACpC,8BAA8B,EAAE,GAAG,EAAE,CAAC,QAAQ;KAC/C,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { EnvironmentConfiguration } from '@midnight-ntwrk/testkit-js';
|
|
2
|
+
import type { NetworkConfig } from '../config/schema.ts';
|
|
3
|
+
export interface ResolvedEnvironment {
|
|
4
|
+
env: EnvironmentConfiguration;
|
|
5
|
+
}
|
|
6
|
+
export declare function applyNetwork(network: NetworkConfig, proofServerUrl: string): ResolvedEnvironment;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { setNetworkId } from '@midnight-ntwrk/midnight-js-network-id';
|
|
2
|
+
import { ConfigError } from "../errors.js";
|
|
3
|
+
/**
|
|
4
|
+
* Set the midnight-js network-id singleton + build an
|
|
5
|
+
* `EnvironmentConfiguration`. `KNOWN_NETWORK_IDS` is closed so a typo
|
|
6
|
+
* fails fast here instead of as a generic midnight-js error later.
|
|
7
|
+
*/
|
|
8
|
+
const KNOWN_NETWORK_IDS = new Set([
|
|
9
|
+
'undeployed',
|
|
10
|
+
'devnet',
|
|
11
|
+
'qanet',
|
|
12
|
+
'testnet',
|
|
13
|
+
'preview',
|
|
14
|
+
'preprod',
|
|
15
|
+
]);
|
|
16
|
+
export function applyNetwork(network, proofServerUrl) {
|
|
17
|
+
if (!KNOWN_NETWORK_IDS.has(network.network_id)) {
|
|
18
|
+
throw new ConfigError(`Unknown network_id "${network.network_id}" (expected one of: ${[...KNOWN_NETWORK_IDS].join(', ')})`);
|
|
19
|
+
}
|
|
20
|
+
setNetworkId(network.network_id);
|
|
21
|
+
const env = {
|
|
22
|
+
walletNetworkId: network.network_id,
|
|
23
|
+
networkId: network.network_id,
|
|
24
|
+
indexer: network.indexer,
|
|
25
|
+
indexerWS: network.indexer_ws,
|
|
26
|
+
node: network.node,
|
|
27
|
+
nodeWS: network.node_ws,
|
|
28
|
+
proofServer: proofServerUrl,
|
|
29
|
+
// testkit-js requires this field even though our deploys never
|
|
30
|
+
// hit the faucet themselves. Set to undefined so dependent code
|
|
31
|
+
// paths (e.g. wait-for-funds hints) treat it as absent.
|
|
32
|
+
faucet: undefined,
|
|
33
|
+
};
|
|
34
|
+
return { env };
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=network.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"network.js","sourceRoot":"","sources":["../../src/providers/network.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAGtE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;;;GAIG;AAEH,MAAM,iBAAiB,GAAwB,IAAI,GAAG,CAAC;IACrD,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,SAAS;IACT,SAAS;IACT,SAAS;CACV,CAAC,CAAC;AAMH,MAAM,UAAU,YAAY,CAC1B,OAAsB,EACtB,cAAsB;IAEtB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,WAAW,CACnB,uBAAuB,OAAO,CAAC,UAAU,uBAAuB,CAAC,GAAG,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACrG,CAAC;IACJ,CAAC;IACD,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAEjC,MAAM,GAAG,GAA6B;QACpC,eAAe,EACb,OAAO,CAAC,UAAyD;QACnE,SAAS,EAAE,OAAO,CAAC,UAAU;QAC7B,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,SAAS,EAAE,OAAO,CAAC,UAAU;QAC7B,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,MAAM,EAAE,OAAO,CAAC,OAAO;QACvB,WAAW,EAAE,cAAc;QAC3B,+DAA+D;QAC/D,gEAAgE;QAChE,wDAAwD;QACxD,MAAM,EAAE,SAAS;KAClB,CAAC;IAEF,OAAO,EAAE,GAAG,EAAE,CAAC;AACjB,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Derive a leveldb-compatible password from secret key material. `secret`
|
|
3
|
+
* must be secret-derived (the deployer passes SHA-256 of the wallet seed);
|
|
4
|
+
* a public key would make the private-state DB decryptable by anyone who
|
|
5
|
+
* can read the wallet's address.
|
|
6
|
+
*
|
|
7
|
+
* level-private-state-provider rejects passwords with 4+ identical chars in
|
|
8
|
+
* a row, which structured seeds (TEST_MNEMONIC, `0x…0001`) routinely
|
|
9
|
+
* produce. We SHA-256 + base64url + strip + rehash-on-collision until clean,
|
|
10
|
+
* then append `A1!` for guaranteed character-class diversity.
|
|
11
|
+
*/
|
|
12
|
+
export declare function derivePrivateStatePassword(secret: string): string;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { createHash } from 'node:crypto';
|
|
2
|
+
/**
|
|
3
|
+
* Derive a leveldb-compatible password from secret key material. `secret`
|
|
4
|
+
* must be secret-derived (the deployer passes SHA-256 of the wallet seed);
|
|
5
|
+
* a public key would make the private-state DB decryptable by anyone who
|
|
6
|
+
* can read the wallet's address.
|
|
7
|
+
*
|
|
8
|
+
* level-private-state-provider rejects passwords with 4+ identical chars in
|
|
9
|
+
* a row, which structured seeds (TEST_MNEMONIC, `0x…0001`) routinely
|
|
10
|
+
* produce. We SHA-256 + base64url + strip + rehash-on-collision until clean,
|
|
11
|
+
* then append `A1!` for guaranteed character-class diversity.
|
|
12
|
+
*/
|
|
13
|
+
export function derivePrivateStatePassword(secret) {
|
|
14
|
+
for (let counter = 0; counter < 1024; counter++) {
|
|
15
|
+
const body = createHash('sha256')
|
|
16
|
+
.update(`${secret}:${counter}`)
|
|
17
|
+
.digest('base64url')
|
|
18
|
+
.replace(/[^A-Za-z0-9]/g, '');
|
|
19
|
+
if (!/(.)\1{3,}/.test(body)) {
|
|
20
|
+
return `${body}A1!`;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
// Pathologically improbable. Surface explicitly so the deploy fails loud
|
|
24
|
+
// rather than silently retrying forever.
|
|
25
|
+
throw new Error('derivePrivateStatePassword: unable to find a hash without 4+ repeated chars after 1024 rounds');
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=private-state-password.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"private-state-password.js","sourceRoot":"","sources":["../../src/providers/private-state-password.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAAc;IACvD,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC;aAC9B,MAAM,CAAC,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC;aAC9B,MAAM,CAAC,WAAW,CAAC;aACnB,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAChC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,GAAG,IAAI,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IACD,yEAAyE;IACzE,yCAAyC;IACzC,MAAM,IAAI,KAAK,CACb,+FAA+F,CAChG,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { Logger } from 'pino';
|
|
2
|
+
import type { NetworkConfig } from '../config/schema.ts';
|
|
3
|
+
export interface ProofServerOptions {
|
|
4
|
+
cliOverride?: string;
|
|
5
|
+
network: NetworkConfig;
|
|
6
|
+
logger: Logger;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Proof-server handle with a resolved URL + lifecycle. Always acquired via
|
|
10
|
+
* {@link ProofServer.start}; {@link dispose} is a no-op for static URLs
|
|
11
|
+
* and a container-stop for the `auto` / `PROOF_SERVER_PORT` paths.
|
|
12
|
+
*/
|
|
13
|
+
export declare class ProofServer {
|
|
14
|
+
#private;
|
|
15
|
+
/** Resolved URL the proof provider POSTs to. */
|
|
16
|
+
readonly url: string;
|
|
17
|
+
private constructor();
|
|
18
|
+
/**
|
|
19
|
+
* Resolve URL by precedence: `cliOverride` > TOML `proof_server` URL >
|
|
20
|
+
* `proof_server = "auto"` (boots container) > `PROOF_SERVER_PORT` env >
|
|
21
|
+
* `http://127.0.0.1:6300`.
|
|
22
|
+
*/
|
|
23
|
+
static start(opts: ProofServerOptions): Promise<ProofServer>;
|
|
24
|
+
private static fromStaticUrl;
|
|
25
|
+
/** Release any underlying container. Idempotent for static-URL instances. */
|
|
26
|
+
dispose(): Promise<void>;
|
|
27
|
+
/** `await using` hook: swallows teardown errors so they don't mask the deploy's real error. */
|
|
28
|
+
[Symbol.asyncDispose](): Promise<void>;
|
|
29
|
+
}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { existsSync } from 'node:fs';
|
|
2
|
+
import { dirname, resolve } from 'node:path';
|
|
3
|
+
import { fileURLToPath } from 'node:url';
|
|
4
|
+
import { DynamicProofServerContainer, getContainersConfiguration, StaticProofServerContainer, setContainersConfiguration, } from '@midnight-ntwrk/testkit-js';
|
|
5
|
+
import { ConfigError } from "../errors.js";
|
|
6
|
+
import { formatError } from "../services/error-format.js";
|
|
7
|
+
/** Holds the packaged `proof-server.yml`. Two levels up from `providers/` in
|
|
8
|
+
* both `src/` and the built `dist/`. */
|
|
9
|
+
const PACKAGE_ROOT = resolve(dirname(fileURLToPath(import.meta.url)), '..', '..');
|
|
10
|
+
/**
|
|
11
|
+
* Point testkit at a compose file it can read.
|
|
12
|
+
*
|
|
13
|
+
* testkit boots the `auto` container from `<proofServer.path>/<fileName>` and
|
|
14
|
+
* defaults that path to `process.cwd()`. A compose file in the cwd still wins,
|
|
15
|
+
* as the escape hatch for a different image; otherwise the packaged one. The
|
|
16
|
+
* choice is remade on every start because testkit's config is global.
|
|
17
|
+
*/
|
|
18
|
+
function useComposeFile(logger) {
|
|
19
|
+
const current = getContainersConfiguration();
|
|
20
|
+
const { fileName } = current.proofServer;
|
|
21
|
+
const cwd = process.cwd();
|
|
22
|
+
const path = existsSync(resolve(cwd, fileName)) ? cwd : PACKAGE_ROOT;
|
|
23
|
+
logger.debug(`Proof-server compose file: ${resolve(path, fileName)}`);
|
|
24
|
+
setContainersConfiguration({
|
|
25
|
+
...current,
|
|
26
|
+
proofServer: { ...current.proofServer, path },
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Proof-server handle with a resolved URL + lifecycle. Always acquired via
|
|
31
|
+
* {@link ProofServer.start}; {@link dispose} is a no-op for static URLs
|
|
32
|
+
* and a container-stop for the `auto` / `PROOF_SERVER_PORT` paths.
|
|
33
|
+
*/
|
|
34
|
+
export class ProofServer {
|
|
35
|
+
/** Resolved URL the proof provider POSTs to. */
|
|
36
|
+
url;
|
|
37
|
+
#dispose;
|
|
38
|
+
#logger;
|
|
39
|
+
constructor(url, dispose, logger) {
|
|
40
|
+
this.url = url;
|
|
41
|
+
this.#dispose = dispose;
|
|
42
|
+
this.#logger = logger;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Resolve URL by precedence: `cliOverride` > TOML `proof_server` URL >
|
|
46
|
+
* `proof_server = "auto"` (boots container) > `PROOF_SERVER_PORT` env >
|
|
47
|
+
* `http://127.0.0.1:6300`.
|
|
48
|
+
*/
|
|
49
|
+
static async start(opts) {
|
|
50
|
+
const { cliOverride, network, logger } = opts;
|
|
51
|
+
const explicit = cliOverride ?? network.proof_server;
|
|
52
|
+
if (explicit && explicit !== 'auto') {
|
|
53
|
+
logger.debug(`Using configured proof server: ${explicit}`);
|
|
54
|
+
return ProofServer.fromStaticUrl(explicit, logger);
|
|
55
|
+
}
|
|
56
|
+
if (explicit === 'auto') {
|
|
57
|
+
logger.info('Starting proof-server container (auto)…');
|
|
58
|
+
useComposeFile(logger);
|
|
59
|
+
const container = await DynamicProofServerContainer.start(logger, undefined, network.network_id);
|
|
60
|
+
return new ProofServer(container.getUrl(), () => container.stop(), logger);
|
|
61
|
+
}
|
|
62
|
+
const port = process.env.PROOF_SERVER_PORT;
|
|
63
|
+
if (port !== undefined) {
|
|
64
|
+
if (!/^\d+$/.test(port)) {
|
|
65
|
+
throw new ConfigError(`Invalid PROOF_SERVER_PORT: ${port}`);
|
|
66
|
+
}
|
|
67
|
+
const parsed = Number(port);
|
|
68
|
+
if (!Number.isInteger(parsed) || parsed < 1 || parsed > 65535) {
|
|
69
|
+
throw new ConfigError(`Invalid PROOF_SERVER_PORT: ${port}`);
|
|
70
|
+
}
|
|
71
|
+
logger.debug(`Using PROOF_SERVER_PORT=${parsed}`);
|
|
72
|
+
const container = new StaticProofServerContainer(parsed);
|
|
73
|
+
return new ProofServer(container.getUrl(), () => container.stop(), logger);
|
|
74
|
+
}
|
|
75
|
+
logger.debug('Falling back to default proof server at http://127.0.0.1:6300');
|
|
76
|
+
return ProofServer.fromStaticUrl('http://127.0.0.1:6300', logger);
|
|
77
|
+
}
|
|
78
|
+
static fromStaticUrl(url, logger) {
|
|
79
|
+
return new ProofServer(url, async () => {
|
|
80
|
+
/* no container to stop */
|
|
81
|
+
}, logger);
|
|
82
|
+
}
|
|
83
|
+
/** Release any underlying container. Idempotent for static-URL instances. */
|
|
84
|
+
async dispose() {
|
|
85
|
+
return this.#dispose();
|
|
86
|
+
}
|
|
87
|
+
/** `await using` hook: swallows teardown errors so they don't mask the deploy's real error. */
|
|
88
|
+
async [Symbol.asyncDispose]() {
|
|
89
|
+
try {
|
|
90
|
+
await this.#dispose();
|
|
91
|
+
}
|
|
92
|
+
catch (e) {
|
|
93
|
+
this.#logger.warn({ err: formatError(e) }, 'Proof server dispose failed');
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
//# sourceMappingURL=proof-server.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proof-server.js","sourceRoot":"","sources":["../../src/providers/proof-server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EACL,2BAA2B,EAC3B,0BAA0B,EAC1B,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAQ1D;yCACyC;AACzC,MAAM,YAAY,GAAG,OAAO,CAC1B,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACvC,IAAI,EACJ,IAAI,CACL,CAAC;AAEF;;;;;;;GAOG;AACH,SAAS,cAAc,CAAC,MAAc;IACpC,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAC;IAC7C,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;IACzC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IAErE,MAAM,CAAC,KAAK,CAAC,8BAA8B,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtE,0BAA0B,CAAC;QACzB,GAAG,OAAO;QACV,WAAW,EAAE,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,EAAE;KAC9C,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACtB,gDAAgD;IACvC,GAAG,CAAS;IACZ,QAAQ,CAAsB;IAC9B,OAAO,CAAS;IAEzB,YACE,GAAW,EACX,OAA4B,EAC5B,MAAc;QAEd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAwB;QACzC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAC9C,MAAM,QAAQ,GAAG,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC;QAErD,IAAI,QAAQ,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;YAC3D,OAAO,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YACvD,cAAc,CAAC,MAAM,CAAC,CAAC;YACvB,MAAM,SAAS,GAAG,MAAM,2BAA2B,CAAC,KAAK,CACvD,MAAM,EACN,SAAS,EACT,OAAO,CAAC,UAAU,CACnB,CAAC;YACF,OAAO,IAAI,WAAW,CACpB,SAAS,CAAC,MAAM,EAAE,EAClB,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EACtB,MAAM,CACP,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAC3C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,WAAW,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG,KAAK,EAAE,CAAC;gBAC9D,MAAM,IAAI,WAAW,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,2BAA2B,MAAM,EAAE,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,IAAI,0BAA0B,CAAC,MAAM,CAAC,CAAC;YACzD,OAAO,IAAI,WAAW,CACpB,SAAS,CAAC,MAAM,EAAE,EAClB,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EACtB,MAAM,CACP,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,KAAK,CACV,+DAA+D,CAChE,CAAC;QACF,OAAO,WAAW,CAAC,aAAa,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,GAAW,EAAE,MAAc;QACtD,OAAO,IAAI,WAAW,CACpB,GAAG,EACH,KAAK,IAAI,EAAE;YACT,0BAA0B;QAC5B,CAAC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,6EAA6E;IAC7E,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,+FAA+F;IAC/F,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,6BAA6B,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;CACF"}
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
import { type Logger } from 'pino';
|
|
2
|
+
import { type DeployResult } from './deployer.ts';
|
|
3
|
+
/**
|
|
4
|
+
* Shape every Compact-compiled `Contract` class satisfies. The
|
|
5
|
+
* compiler emits an `initialState(context, ...args)` method whose tail
|
|
6
|
+
* args mirror the constructor signature; {@link ConstructorArgsOf}
|
|
7
|
+
* lifts those args out of the artifact's `.d.ts` so deploy scripts
|
|
8
|
+
* don't have to redeclare them.
|
|
9
|
+
*/
|
|
10
|
+
export type CompactContractClass = {
|
|
11
|
+
prototype: {
|
|
12
|
+
initialState(context: never, ...args: never[]): unknown;
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* Extracts the constructor args tuple from a Compact-compiled
|
|
17
|
+
* `Contract` class (strips the leading `context` parameter). The
|
|
18
|
+
* result is a labeled tuple — hover on a value shows the param name
|
|
19
|
+
* and type. No codegen needed; the artifact's `.d.ts` is the source
|
|
20
|
+
* of truth.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* import type { Contract } from '../artifacts/Token/contract/index.js';
|
|
25
|
+
* import { runDeploy, type ConstructorArgsOf } from '@openzeppelin/compact-deployer/run-deploy';
|
|
26
|
+
*
|
|
27
|
+
* await runDeploy<ConstructorArgsOf<typeof Contract>>({
|
|
28
|
+
* contract: 'Token',
|
|
29
|
+
* args: ['OZE', 'OZE', 18n, ... ],
|
|
30
|
+
* });
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
export type ConstructorArgsOf<C extends CompactContractClass> = C['prototype']['initialState'] extends (context: never, ...args: infer A) => unknown ? A : never;
|
|
34
|
+
/**
|
|
35
|
+
* Typed constructor-args helper. Returns the args tuple unchanged at
|
|
36
|
+
* runtime; the work happens in the type system: `Contract` anchors
|
|
37
|
+
* the generic so each subsequent arg is checked against the matching
|
|
38
|
+
* position in `initialState`, and the editor shows the param name +
|
|
39
|
+
* type as you type each comma (TypeScript signature help works on
|
|
40
|
+
* function calls but not on tuple literals — that's why this exists
|
|
41
|
+
* instead of just `args: [...]`).
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* import { runDeploy, constructorArgs } from '@openzeppelin/compact-deployer/run-deploy';
|
|
46
|
+
* import { Contract } from '../artifacts/Token/contract/index.js';
|
|
47
|
+
*
|
|
48
|
+
* await runDeploy({
|
|
49
|
+
* contract: 'Token',
|
|
50
|
+
* args: constructorArgs(Contract,
|
|
51
|
+
* 'OpenZeppelin Token', // _name: string
|
|
52
|
+
* 'OZE', // _symbol: string
|
|
53
|
+
* 18n, // _decimals: bigint
|
|
54
|
+
* ),
|
|
55
|
+
* });
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
export declare function constructorArgs<C extends CompactContractClass>(_Contract: C, ...args: ConstructorArgsOf<C>): ConstructorArgsOf<C>;
|
|
59
|
+
/**
|
|
60
|
+
* Inputs to {@link runDeploy}. Every field has an argv default so a
|
|
61
|
+
* hand-written deploy script can be as short as
|
|
62
|
+
* `await runDeploy<ConstructorArgsOf<typeof Contract>>({ contract: 'X', args: [ … ] });`
|
|
63
|
+
* (typed tuple form) or
|
|
64
|
+
* `await runDeploy<MyNamedArgs>({ contract: 'X', args: { … } });`
|
|
65
|
+
* (named-object form — `MyNamedArgs` is hand-written or generated
|
|
66
|
+
* separately), or `await runDeploy({ contract: 'X' });` when args
|
|
67
|
+
* live in `compact.toml`.
|
|
68
|
+
*
|
|
69
|
+
* The `Args` generic is either:
|
|
70
|
+
* - a `readonly unknown[]` tuple (use `ConstructorArgsOf<typeof Contract>`
|
|
71
|
+
* to get the labeled tuple from the compiled artifact), or
|
|
72
|
+
* - a `Record<string, unknown>` object describing the constructor's
|
|
73
|
+
* named parameters; keys can appear in any order and the deployer
|
|
74
|
+
* reorders them via the artifact's `index.d.ts`.
|
|
75
|
+
*/
|
|
76
|
+
export interface RunDeployOptions<Args extends readonly unknown[] | Record<string, unknown> = readonly unknown[] | Record<string, unknown>> {
|
|
77
|
+
/** Contract name in `compact.toml` (required). */
|
|
78
|
+
contract: string;
|
|
79
|
+
/**
|
|
80
|
+
* Constructor args, either as a positional tuple or a named object.
|
|
81
|
+
* Highest precedence: overrides `compact.toml`'s `args` field.
|
|
82
|
+
*/
|
|
83
|
+
args?: Args;
|
|
84
|
+
/** Path to `compact.toml`. Argv: `--config`. Default: walk up from cwd. */
|
|
85
|
+
configPath?: string;
|
|
86
|
+
/** Network name. Argv: `--network`. Default: `[profile].default_network` from `compact.toml`. */
|
|
87
|
+
network?: string;
|
|
88
|
+
/** Seed file override. Argv: `--seed-file`. */
|
|
89
|
+
seedFile?: string;
|
|
90
|
+
/** Proof-server URL override. Argv: `--proof-server`. */
|
|
91
|
+
proofServer?: string;
|
|
92
|
+
/** Wallet-sync timeout in seconds. Argv: `--sync-timeout`. */
|
|
93
|
+
syncTimeoutSec?: number;
|
|
94
|
+
/** Deploy-tx finalization timeout in seconds. Argv: `--tx-timeout`. Default 600. */
|
|
95
|
+
txTimeoutSec?: number;
|
|
96
|
+
/** Replace a pending deploy record for this contract. Argv: `--force`. */
|
|
97
|
+
force?: boolean;
|
|
98
|
+
/** Dust/shielded sync batch size. Argv: `--sync-batch-size`. Default 5000. */
|
|
99
|
+
syncBatchSize?: number;
|
|
100
|
+
/**
|
|
101
|
+
* Verifier keys per transaction, for a contract too large to deploy in one
|
|
102
|
+
* tx. Argv: `--circuits-per-tx`, TOML: `[contracts.X].circuits_per_tx`.
|
|
103
|
+
*/
|
|
104
|
+
circuitsPerTx?: number;
|
|
105
|
+
/** Skip the on-disk wallet-state cache. Argv: `--no-cache`. */
|
|
106
|
+
skipWalletCache?: boolean;
|
|
107
|
+
/**
|
|
108
|
+
* Import a pre-warmed dust wallet state file (raw JSON or gzipped)
|
|
109
|
+
* into `.states/` before deploy. Use this when first-run preprod
|
|
110
|
+
* cold sync OOMs and you already have a `serializeState()` output.
|
|
111
|
+
* Argv: `--seed-cache-from-dust`.
|
|
112
|
+
*/
|
|
113
|
+
seedCacheFromDust?: string;
|
|
114
|
+
/** Like {@link seedCacheFromDust} but for the shielded sub-wallet. Argv: `--seed-cache-from-shielded`. */
|
|
115
|
+
seedCacheFromShielded?: string;
|
|
116
|
+
/** Like {@link seedCacheFromDust} but for the unshielded sub-wallet. Argv: `--seed-cache-from-unshielded`. */
|
|
117
|
+
seedCacheFromUnshielded?: string;
|
|
118
|
+
/** Dry-run mode (skip on-chain submission). Argv: `--dry-run`. */
|
|
119
|
+
dryRun?: boolean;
|
|
120
|
+
/** Emit a machine-readable JSON object on stdout instead of pretty lines. Argv: `--json`. */
|
|
121
|
+
json?: boolean;
|
|
122
|
+
/** Pino debug logs to stderr. Argv: `-v` / `--verbose`. */
|
|
123
|
+
verbose?: boolean;
|
|
124
|
+
/** Override the auto-built logger (for testing or for embedding in larger apps). */
|
|
125
|
+
logger?: Logger;
|
|
126
|
+
/** Keystore passphrase prompt. Only needed when `[wallet].keystore` is set. */
|
|
127
|
+
promptPassphrase?: (path: string) => Promise<string>;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* High-level deploy entrypoint for hand-written deploy scripts.
|
|
131
|
+
*
|
|
132
|
+
* Two call forms:
|
|
133
|
+
*
|
|
134
|
+
* 1. **Curried with Contract** — single source of truth for the
|
|
135
|
+
* contract identity, and the constructor args are typed function
|
|
136
|
+
* parameters (per-comma signature help in the editor):
|
|
137
|
+
* ```ts
|
|
138
|
+
* await runDeploy(Contract)('OZE', 'OZE', 18n, …);
|
|
139
|
+
* ```
|
|
140
|
+
* The deployer matches `Contract` against `[contracts.X]` entries
|
|
141
|
+
* in `compact.toml` by class identity to pick the config. Extra
|
|
142
|
+
* deploy opts can be passed as a second arg:
|
|
143
|
+
* ```ts
|
|
144
|
+
* await runDeploy(Contract, { network: 'preview' })('OZE', …);
|
|
145
|
+
* ```
|
|
146
|
+
*
|
|
147
|
+
* 2. **Options object** (legacy / multi-contract / TOML-driven args):
|
|
148
|
+
* ```ts
|
|
149
|
+
* await runDeploy({ contract: 'TokenExample', args: [...] });
|
|
150
|
+
* ```
|
|
151
|
+
*
|
|
152
|
+
* Parses `--network`, `--dry-run`, `--sync-timeout`, `--tx-timeout`,
|
|
153
|
+
* `--sync-batch-size`, `--circuits-per-tx`, `--no-cache`, `--force`, `--seed-cache-from-dust`,
|
|
154
|
+
* `--seed-cache-from-shielded`, `--seed-cache-from-unshielded`,
|
|
155
|
+
* `--seed-file`, `--proof-server`,
|
|
156
|
+
* `--config`, `--json`, `-v` / `--verbose` from `process.argv` as defaults. Explicit options win
|
|
157
|
+
* over argv. Wires a pino logger (stderr), runs Deployer.prepare +
|
|
158
|
+
* deploy or dryRun, and prints the result.
|
|
159
|
+
*
|
|
160
|
+
* Returns the result on success so callers can chain post-deploy work
|
|
161
|
+
* (e.g. seeding state via callTx). On error: logs, sets `process.exitCode`
|
|
162
|
+
* to the typed exit code, and rethrows the original error. Never calls
|
|
163
|
+
* `process.exit`, so an embedding app keeps control; catch the rethrow to
|
|
164
|
+
* let that exit code reach the shell.
|
|
165
|
+
*/
|
|
166
|
+
export declare function runDeploy<C extends CompactContractClass>(Contract: C, opts?: Omit<RunDeployOptions, 'contract' | 'args'>): (...args: ConstructorArgsOf<C>) => Promise<DeployResult>;
|
|
167
|
+
export declare function runDeploy<Args extends readonly unknown[] | Record<string, unknown> = readonly unknown[] | Record<string, unknown>>(opts: RunDeployOptions<Args>): Promise<DeployResult>;
|