@zerc20/wallet-sdk 0.0.0-stage → 0.1.0

package/wasm/zerc20_wallet_core.d.ts

@@ -0,0 +1,176 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The ASP tree's leaves for `count` positions from `first`, from an ASP `/bitmap/{c}` page (position `first + j` is
+ * bit `j % 8`, least significant first, of byte `j / 8`): `asp_leaf(position)` where approved, 0 elsewhere.
+ */
+export function aspLeaves(bitmap: Uint8Array, first: bigint, count: number): Uint8Array;
+
+/**
+ * A seed's `index`-th burn address for one chain and token, with its salt: `{salt, address}`. About 2^16 hashes.
+ */
+export function burnAddress(seed: Uint8Array, chain_id: bigint, token_id: number, index: number): any;
+
+export function burnAddressOf(chain_id: bigint, public_key: string, salt: string): string | undefined;
+
+/**
+ * The key that owns the notes paid to a seed's `index`-th receive code for one chain and token, shaped like
+ * `spendKey`.
+ */
+export function codeKey(seed: Uint8Array, chain_id: bigint, token_id: number, index: number): any;
+
+/**
+ * `CommitmentLedger`'s hash chain after appending a commitment with `fields` to `prev`.
+ */
+export function hashChain(prev: string, fields: string[]): string;
+
+/**
+ * One commitment's leaf, from its 4 fields.
+ */
+export function leaf(fields: string[]): string;
+
+/**
+ * The leaves of commitments in the indexer's layout (4 fields of 32 bytes each, as after a `/commitments/{p}` page's
+ * 32-byte header), 32 bytes each.
+ */
+export function leaves(entries: Uint8Array): Uint8Array;
+
+/**
+ * The note hash a note's opening commits to.
+ */
+export function noteHash(chain_id: bigint, public_key: string, value: string, token_id: number, salt: string): string;
+
+/**
+ * The tag of a note commitment.
+ */
+export function noteTag(token_id: number, note_hash: string): number;
+
+/**
+ * The nullifier that spending the note or deposit at `commitment_index` publishes.
+ */
+export function nullifier(chain_id: bigint, commitment_index: bigint, nullifying_key: string): string;
+
+/**
+ * The sibling path (32 hex values) of position `i` in the tree at `n` leaves, from what a wallet downloads: the leaves
+ * of `i`'s chunk, the chunk roots of `i`'s page, the page roots, and the root entry's partial chunk and page roots
+ * (zero or absent where there is none). Lists may run past `n`. Check the path with `pathRoot` against a root the chain
+ * accepts.
+ */
+export function path(i: bigint, n: bigint, chunk_leaves: Uint8Array, page_chunks: Uint8Array, page_roots: Uint8Array, partial_chunk?: string | null, partial_page?: string | null): string[];
+
+/**
+ * The root of the tree holding `leaf` at position `i` with path `siblings`.
+ */
+export function pathRoot(leaf: string, i: bigint, siblings: string[]): string;
+
+/**
+ * The `k`-th burn address a point of sale holding `lane_key` makes for `public_key` on one chain and token, with its
+ * salt: `{salt, address}`. About 2^16 hashes.
+ */
+export function posBurnAddress(lane_key: Uint8Array, chain_id: bigint, token_id: number, k: number, public_key: string): any;
+
+/**
+ * Seals a merge witness (JSON) to the merge prover's key, padded with spaces to `pad_to` bytes. Take the key from
+ * `verifyAttestation`, as for the attester's.
+ */
+export function sealMergeWitness(public_key: Uint8Array, witness: string, pad_to: number): Uint8Array;
+
+/**
+ * Seals a witness (JSON) to an attester's key, padded with spaces to `pad_to` bytes so its length is the same for
+ * every amount. Take the key from `verifyAttestation`; only a development attester, which has no document, is taken
+ * at its word.
+ */
+export function sealWitness(public_key: Uint8Array, witness: string, pad_to: number): Uint8Array;
+
+/**
+ * The statement a merge witness proves and the witness the attester and the merge prover take, as [`sign_transact`]
+ * for a JoinSplit: `{statement, witness}`. `statement` holds the public inputs and the fee (JSON with `tokenId`,
+ * `chainId`, `commitmentRoot`, `aspRoot`, `fee` and `feeRecipient`), and `witness` is the attester's merge witness
+ * JSON with each input's `private_key` in place of its keys. The statement gains the nullifiers and the note.
+ */
+export function signMerge(statement: string, witness: string): string;
+
+/**
+ * The statement a JoinSplit witness (snarkjs's input JSON) proves, given the public inputs in `statement` (JSON with
+ * `tokenId`, `chainId`, `commitmentRoot` and `aspRoot`; the rest is ignored), and the attester's witness for it:
+ * `{statement, witness}`. The statement is the public signals the proof and the attestation cover. The attester's
+ * witness has each input's private key replaced by its signing and nullifying keys, and its owner's signature on the
+ * statement. Fails with the attester's own reason when the attester would refuse the witness.
+ */
+export function signTransact(statement: string, witness: string): string;
+
+/**
+ * The key that owns a seed's notes and deposits on every chain and token: `{secret, authKeyHash, publicKey,
+ * nullifyingKey}`.
+ */
+export function spendKey(seed: Uint8Array): any;
+
+/**
+ * The tag of a transfer to `to` (`0x` address), such as a deposit to a burn address.
+ */
+export function transferTag(token_id: number, to: string): number;
+
+/**
+ * The key an attester's enclave opens witnesses with, once its `/attestation` document (`attestation`, decoded from
+ * base64) checks out: signed by a certificate chain up to the root whose DER has SHA-256 `root_sha256` (hex), valid
+ * at `now` (Unix seconds), and measuring `pcr0` (hex).
+ */
+export function verifyAttestation(attestation: Uint8Array, root_sha256: string, pcr0: string, now: bigint): Uint8Array;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly aspLeaves: (a: number, b: number, c: bigint, d: number) => [number, number, number, number];
+    readonly burnAddress: (a: number, b: number, c: bigint, d: number, e: number) => [number, number, number];
+    readonly burnAddressOf: (a: bigint, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly codeKey: (a: number, b: number, c: bigint, d: number, e: number) => [number, number, number];
+    readonly hashChain: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly leaf: (a: number, b: number) => [number, number, number, number];
+    readonly leaves: (a: number, b: number) => [number, number, number, number];
+    readonly noteHash: (a: bigint, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
+    readonly noteTag: (a: number, b: number, c: number) => [number, number, number];
+    readonly nullifier: (a: bigint, b: bigint, c: number, d: number) => [number, number, number, number];
+    readonly path: (a: bigint, b: bigint, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number) => [number, number, number, number];
+    readonly pathRoot: (a: number, b: number, c: bigint, d: number, e: number) => [number, number, number, number];
+    readonly posBurnAddress: (a: number, b: number, c: bigint, d: number, e: number, f: number, g: number) => [number, number, number];
+    readonly sealMergeWitness: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly sealWitness: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly signMerge: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly signTransact: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly spendKey: (a: number, b: number) => [number, number, number];
+    readonly transferTag: (a: number, b: number, c: number) => [number, number, number];
+    readonly verifyAttestation: (a: number, b: number, c: number, d: number, e: number, f: number, g: bigint) => [number, number, number, number];
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_drop_slice: (a: number, b: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;