@maxandriani/indy-besu-vdr-nodejs 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,74 @@
-# Temporary Holding Version
+# WASM FFI for Indy Besu VDR
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+### TypeScript definitions
+
+The generated package (`pkg/indy_besu_vdr_wasm.d.ts`) exports full TypeScript
+definitions for every method input and output (see `src/types.rs`). They mirror
+the serde serialization of the corresponding `indy-besu-vdr` Rust types:
+
+* `DidString` — template-literal type accepting only the DID methods supported
+  by this VDR per the [Indy DID method](https://hyperledger-indy.github.io/indy-did-method/)
+  specification: `did:indy:besu(:network)?:<identifier>` and
+  `did:ethr(:network)?:<identifier>`.
+* `DidDocument`, `DidRecord`, `DidDocumentWithMeta`, `DidDocAttribute`, DID event types.
+* `SchemaData`/`SchemaRecord`, `CredentialDefinitionData`/`CredentialDefinitionRecord`,
+  revocation registry definition/entry/status-list types.
+* Client types: `ContractConfig`, `QuorumConfig`, `PingStatus`, `EventLog`, `SignatureData`.
+
+### Requirements
+
+* Rust of version 1.79.0 or higher.
+* Wasm-pack: https://rustwasm.github.io/wasm-pack/installer/
+
+Install rustup alongside Homebrew Rust—no need to uninstall anything:
+
+```sh
+brew install rustup
+```
+
+Then initialize a toolchain and install the WebAssembly target:
+
+```sh
+export PATH="/opt/homebrew/opt/rustup/bin:$PATH"
+rustup toolchain install stable
+rustup default stable
+rustup target add wasm32-unknown-unknown
+```
+
+### Build
+
+#### NodeJS bindings
+
+```
+wasm-pack build --target=nodejs
+```
+
+#### WASM (consumed in browser without bundler usage) bindings
+
+```
+wasm-pack build --target=web
+```
+
+#### Bindings to use with webpack
+
+```
+wasm-pack build
+```
+
+### Run demo
+
+#### NodeJS demo
+
+* Build NodeJS bindings from `wasm` directory
+  ```
+  wasm-pack build --target=nodejs
+  ```
+* Install dependencies
+  ```
+  cd demo/node
+  yarn install
+  ```
+* Run demo
+  ```
+  yarn start
+  ```

package/indy_besu_vdr_wasm.d.ts

@@ -0,0 +1,512 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A DID handled by this VDR.
+ *
+ * Supported methods (per https://hyperledger-indy.github.io/indy-did-method/):
+ * - `did:indy:besu(:network)?:<identifier>`
+ * - `did:ethr(:network)?:<identifier>`
+ *
+ * At most ONE network segment is allowed, and the identifier must be either
+ * a 20-byte Ethereum address or a 64/65-byte uncompressed public key
+ * (hex-encoded, `0x` prefixed).
+ */
+export type DidString =
+  | `did:indy:besu:${string}`
+  | `did:ethr:${string}`;
+
+/** Ethereum account address (`0x` + 40 hex chars) */
+export type AddressString = string;
+
+export interface ContractSpec {
+  contractName: string;
+  abi: Array<Record<string, unknown>>;
+}
+
+export interface ContractConfig {
+  address: AddressString;
+  specPath?: string | null;
+  spec?: ContractSpec | null;
+}
+
+export interface QuorumConfig {
+  nodes: string[];
+  request_retries?: number | null;
+  request_timeout?: number | null;
+  retry_interval?: number | null;
+}
+
+export type Status =
+  | { Ok: { block_number: number; block_timestamp: number } }
+  | { Err: { msg: string } };
+
+export interface PingStatus {
+  status: Status;
+}
+
+export interface SignatureData {
+  /** recovery ID used for public key recovery */
+  recovery_id: number;
+  /** ECDSA signature bytes */
+  signature: number[];
+}
+
+export interface EventLog {
+  /** 32-byte topic hashes (`0x` prefixed hex) */
+  topics: string[];
+  data: number[];
+  block: number;
+}
+
+export type VerificationKeyType =
+  | "Ed25519VerificationKey2018"
+  | "X25519KeyAgreementKey2019"
+  | "Ed25519VerificationKey2020"
+  | "X25519KeyAgreementKey2020"
+  | "JsonWebKey2020"
+  | "EcdsaSecp256k1VerificationKey2019"
+  | "EcdsaSecp256k1VerificationKey2020"
+  | "EcdsaSecp256k1RecoveryMethod2020";
+
+export interface VerificationMethod {
+  id: string;
+  type: VerificationKeyType;
+  controller: string;
+  blockchainAccountId?: string;
+  publicKeyMultibase?: string;
+  publicKeyHex?: string;
+  publicKeyBase58?: string;
+  publicKeyBase64?: string;
+  publicKeyJwk?: string;
+}
+
+export type VerificationMethodOrReference = string | VerificationMethod;
+
+export type ServiceType =
+  | "LinkedDomains"
+  | "DIDCommMessaging"
+  | "CredentialRegistry"
+  | "OID4VCI"
+  | "OID4VP";
+
+export interface ServiceEndpointObject {
+  uri: string;
+  accept: string[];
+  routingKeys: string[];
+}
+
+export type ServiceEndpoint =
+  | string
+  | ServiceEndpointObject
+  | Array<string | ServiceEndpointObject>;
+
+export interface DidService {
+  id: string;
+  type: ServiceType;
+  serviceEndpoint: ServiceEndpoint;
+}
+
+/** DID Document matching https://www.w3.org/TR/did-core/ */
+export interface DidDocument {
+  "@context": string | string[];
+  id: DidString;
+  controller?: string | string[];
+  verificationMethod: VerificationMethod[];
+  authentication?: VerificationMethodOrReference[];
+  assertionMethod?: VerificationMethodOrReference[];
+  capabilityInvocation?: VerificationMethodOrReference[];
+  capabilityDelegation?: VerificationMethodOrReference[];
+  keyAgreement?: VerificationMethodOrReference[];
+  service?: DidService[];
+  alsoKnownAs?: string[];
+}
+
+export interface DidMetadata {
+  owner?: AddressString;
+  created?: number;
+  deactivated?: boolean;
+  versionId?: number;
+  updated?: number;
+  nextVersionId?: number;
+  nextUpdate?: number;
+}
+
+/** DID Record stored in the IndyBesu DID Registry */
+export interface DidRecord {
+  document: DidDocument;
+  metadata: DidMetadata;
+}
+
+export type DidResolutionError =
+  | "notFound"
+  | "invalidDid"
+  | "representationNotSupported"
+  | "invalidDidUrl"
+  | "methodNotSupported";
+
+export interface DidResolutionMetadata {
+  contentType: string | null;
+  error: DidResolutionError | null;
+  message: string | null;
+}
+
+export interface DidDocumentWithMeta {
+  didDocument?: DidDocument;
+  didDocumentMetadata: DidMetadata;
+  didResolutionMetadata: DidResolutionMetadata;
+}
+
+export interface DidResolutionOptions {
+  accept?: string | null;
+  blockTag?: number | null;
+}
+
+export type PublicKeyPurpose = "veriKey" | "sigAuth" | "enc";
+
+export type PublicKeyType =
+  | "Ed25519VerificationKey2020"
+  | "X25519KeyAgreementKey2020"
+  | "EcdsaSecp256k1VerificationKey2020";
+
+export interface PublicKeyAttribute {
+  purpose: PublicKeyPurpose;
+  type: PublicKeyType;
+  publicKeyHex?: string;
+  publicKeyBase64?: string;
+  publicKeyBase58?: string;
+  publicKeyPem?: string;
+}
+
+export interface ServiceAttribute {
+  type: ServiceType;
+  serviceEndpoint: ServiceEndpoint;
+}
+
+/** Attribute which can be associated with a `did:ethr` DID */
+export type DidDocAttribute = PublicKeyAttribute | ServiceAttribute;
+
+export interface DidAttributeChanged {
+  identity: AddressString;
+  name: string;
+  value: number[];
+  validTo: number;
+  previousChange: number;
+}
+
+export interface DidDelegateChanged {
+  identity: AddressString;
+  delegate: AddressString;
+  delegateType: number[];
+  validTo: number;
+  previousChange: number;
+}
+
+export interface DidOwnerChanged {
+  identity: AddressString;
+  owner: AddressString;
+  previousChange: number;
+}
+
+export type DidEvent =
+  | { AttributeChangedEvent: DidAttributeChanged }
+  | { DelegateChanged: DidDelegateChanged }
+  | { OwnerChanged: DidOwnerChanged };
+
+/** AnonCreds Schema matching https://hyperledger.github.io/anoncreds-spec/#term:schema */
+export interface SchemaData {
+  issuerId: DidString;
+  name: string;
+  version: string;
+  attrNames: string[];
+}
+
+export interface SchemaMetadata {
+  created: number;
+}
+
+export interface SchemaRecord {
+  schema: SchemaData;
+  metadata: SchemaMetadata;
+}
+
+/** AnonCreds Credential Definition matching https://hyperledger.github.io/anoncreds-spec/#term:credential-definition */
+export interface CredentialDefinitionData {
+  issuerId: DidString;
+  schemaId: string;
+  credDefType: "CL";
+  tag: string;
+  value: Record<string, unknown>;
+}
+
+export interface CredentialDefinitionMetadata {
+  created: number;
+}
+
+export interface CredentialDefinitionRecord {
+  credentialDefinition: CredentialDefinitionData;
+  metadata: CredentialDefinitionMetadata;
+}
+
+export interface AccumKey {
+  z: string;
+}
+
+export interface RevocationRegistryPublicKeys {
+  accumKey: AccumKey;
+}
+
+export interface RevocationRegistryDefinitionValue {
+  maxCredNum: number;
+  publicKeys: RevocationRegistryPublicKeys;
+  tailsHash: string;
+  tailsLocation: string;
+}
+
+/** AnonCreds Revocation Registry Definition matching https://hyperledger.github.io/anoncreds-spec/#term:revocation-registry-definition */
+export interface RevocationRegistryDefinitionData {
+  issuerId: DidString;
+  revocDefType: "CL_ACCUM";
+  credDefId: string;
+  tag: string;
+  value: RevocationRegistryDefinitionValue;
+}
+
+export interface RevocationRegistryDefinitionMetadata {
+  created: number;
+}
+
+export interface RevocationRegistryDefinitionRecord {
+  revocationRegistryDefinition: RevocationRegistryDefinitionData;
+  metadata: RevocationRegistryDefinitionMetadata;
+}
+
+export interface RevocationRegistryEntryData {
+  currentAccumulator: string;
+  prevAccumulator?: string | null;
+  issued?: number[] | null;
+  revoked?: number[] | null;
+}
+
+export interface RevocationRegistryEntryValue {
+  revRegDefId: string;
+  issuerId: DidString;
+  revRegEntryData: RevocationRegistryEntryData;
+}
+
+export interface RevocationStatusListData {
+  issuerId: DidString;
+  revRegDefId: string;
+  revocationList: number[];
+  currentAccumulator: string;
+  timestamp: number;
+}
+
+
+
+export class CredentialDefinition {
+  free(): void;
+  [Symbol.dispose](): void;
+  static fromString(string: string): CredentialDefinition;
+  constructor(issuer_id: string, schema_id: string, tag: string, value: Record<string, unknown>);
+  getId(): string;
+  asValue(): CredentialDefinitionData;
+  toString(): string;
+}
+
+export class CredentialDefinitionRegistry {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static resolveCredentialDefinition(client: LedgerClient, id: string): Promise<CredentialDefinition>;
+  static parseResolveCredentialDefinitionResult(client: LedgerClient, bytes: Uint8Array): CredentialDefinitionRecord;
+  static buildCreateCredentialDefinitionTransaction(client: LedgerClient, from: string, cred_def: CredentialDefinition, nonce?: bigint | null): Promise<Transaction>;
+  static buildResolveCredentialDefinitionTransaction(client: LedgerClient, id: string): Promise<Transaction>;
+  static buildCreateCredentialDefinitionEndorsingData(client: LedgerClient, cred_def: CredentialDefinition): Promise<TransactionEndorsingData>;
+}
+
+export class DidResolver {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static resolveDid(client: LedgerClient, did: string, options: DidResolutionOptions | undefined | null): Promise<DidDocumentWithMeta>;
+}
+
+export class Endorsement {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static buildEndorsementTransaction(client: LedgerClient, from: string, endorsing_data: TransactionEndorsingData, nonce?: bigint | null): Promise<Transaction>;
+}
+
+export class EthrDidRegistry {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static parseDidOwnerResult(client: LedgerClient, bytes: Uint8Array): string;
+  static parseDidChangedResult(client: LedgerClient, bytes: Uint8Array): bigint;
+  static parseDidEventResponse(client: LedgerClient, log: EventLog): DidEvent;
+  static buildGetDidEventsQuery(client: LedgerClient, did: string, from_block?: bigint | null, to_block?: bigint | null): Promise<EventQuery>;
+  static buildGetDidOwnerTransaction(client: LedgerClient, did: string): Promise<Transaction>;
+  static buildGetDidChangedTransaction(client: LedgerClient, did: string): Promise<Transaction>;
+  static buildDidAddDelegateTransaction(client: LedgerClient, sender: string, did: string, delegate_type: string, delegate: string, validity: bigint, nonce?: bigint | null): Promise<Transaction>;
+  static buildDidChangeOwnerTransaction(client: LedgerClient, sender: string, did: string, new_owner: string, nonce?: bigint | null): Promise<Transaction>;
+  static buildDidSetAttributeTransaction(client: LedgerClient, sender: string, did: string, attribute: DidDocAttribute, validity: bigint, nonce?: bigint | null): Promise<Transaction>;
+  static buildGetIdentityNonceTransaction(client: LedgerClient, identity: string): Promise<Transaction>;
+  static buildDidAddDelegateEndorsingData(client: LedgerClient, did: string, delegate_type: string, delegate: string, validity: bigint): Promise<TransactionEndorsingData>;
+  static buildDidChangeOwnerEndorsingData(client: LedgerClient, did: string, new_owner: string): Promise<TransactionEndorsingData>;
+  static buildDidRevokeDelegateTransaction(client: LedgerClient, sender: string, did: string, delegate_type: string, delegate: string, nonce?: bigint | null): Promise<Transaction>;
+  static buildDidRevokeAttributeTransaction(client: LedgerClient, sender: string, did: string, attribute: DidDocAttribute, nonce?: bigint | null): Promise<Transaction>;
+  static buildDidSetAttributeEndorsingData(client: LedgerClient, did: string, attribute: DidDocAttribute, validity: bigint): Promise<TransactionEndorsingData>;
+  static parseDidOwnerChangedEventResponse(client: LedgerClient, log: EventLog): DidOwnerChanged;
+  static buildDidRevokeDelegateEndorsingData(client: LedgerClient, did: string, delegate_type: string, delegate: string): Promise<TransactionEndorsingData>;
+  static buildDidRevokeAttributeEndorsingData(client: LedgerClient, did: string, attribute: DidDocAttribute): Promise<TransactionEndorsingData>;
+  static parseDidDelegateChangedEventResponse(client: LedgerClient, log: EventLog): DidDelegateChanged;
+  static parseDidAttributeChangedEventResponse(client: LedgerClient, log: EventLog): DidAttributeChanged;
+}
+
+export class EventQuery {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+}
+
+export class IndyDidRegistry {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static parseResolveDidResult(client: LedgerClient, bytes: Uint8Array): DidRecord;
+  static buildCreateDidTransaction(client: LedgerClient, from: string, did: string, did_doc: DidDocument, nonce?: bigint | null): Promise<Transaction>;
+  static buildUpdateDidTransaction(client: LedgerClient, from: string, did: string, did_doc: DidDocument, nonce?: bigint | null): Promise<Transaction>;
+  static buildResolveDidTransaction(client: LedgerClient, did: string): Promise<Transaction>;
+  static buildCreateDidEndorsingData(client: LedgerClient, did: string, did_doc: DidDocument): Promise<TransactionEndorsingData>;
+  static buildUpdateDidEndorsingData(client: LedgerClient, did: string, did_doc: DidDocument): Promise<TransactionEndorsingData>;
+  static buildDeactivateDidTransaction(client: LedgerClient, from: string, did: string, nonce?: bigint | null): Promise<Transaction>;
+  static buildDeactivateDidEndorsingData(client: LedgerClient, did: string): Promise<TransactionEndorsingData>;
+}
+
+export class LedgerClient {
+  free(): void;
+  [Symbol.dispose](): void;
+  getReceipt(hash: Uint8Array): Promise<string>;
+  queryEvents(query: EventQuery): Promise<EventLog[]>;
+  submitTransaction(transaction: Transaction): Promise<number[]>;
+  getTransactionCount(address: string): Promise<bigint>;
+  constructor(chain_id: number, node_address: string, contract_configs: ContractConfig[], network: string | null | undefined, quorum_config: QuorumConfig | undefined | null);
+  ping(): Promise<PingStatus>;
+}
+
+export class LegacyMappingRegistry {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static parseDidMappingResult(client: LedgerClient, bytes: Uint8Array): string;
+  static parseResourceMappingResult(client: LedgerClient, bytes: Uint8Array): string;
+  static buildGetDidMappingTransaction(client: LedgerClient, legacy_identifier: string): Promise<Transaction>;
+  static buildCreateDidMappingTransaction(client: LedgerClient, from: string, did: string, legacy_did: string, legacy_verkey: string, ed25519_signature: Uint8Array, nonce?: bigint | null): Promise<Transaction>;
+  static buildGetResourceMappingTransaction(client: LedgerClient, legacy_identifier: string): Promise<Transaction>;
+  static buildCreateDidMappingEndorsingData(client: LedgerClient, did: string, legacy_did: string, legacy_verkey: string, ed25519_signature: Uint8Array): Promise<TransactionEndorsingData>;
+  static buildCreateResourceMappingTransaction(client: LedgerClient, from: string, did: string, legacy_issuer_identifier: string, legacy_identifier: string, new_identifier: string, nonce?: bigint | null): Promise<Transaction>;
+  static buildCreateResourceMappingEndorsingData(client: LedgerClient, did: string, legacy_issuer_identifier: string, legacy_identifier: string, new_identifier: string): Promise<TransactionEndorsingData>;
+}
+
+export class RevocationRegistry {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static resolveRevocationRegistryDefinition(client: LedgerClient, id: string): Promise<RevocationRegistryDefinition>;
+  static resolveRevocationRegistryStatusList(client: LedgerClient, id: string, to_timestamp: bigint): Promise<RevocationRegistryStatusList>;
+  static buildCreateRevocationRegistryEntryTransaction(client: LedgerClient, from: string, rev_reg_entry: RevocationRegistryEntry, nonce?: bigint | null): Promise<Transaction>;
+  static parseResolveRevocationRegistryDefinitionResult(client: LedgerClient, bytes: Uint8Array): RevocationRegistryDefinitionRecord;
+  static buildCreateRevocationRegistryEntryEndorsingData(client: LedgerClient, rev_reg_entry: RevocationRegistryEntry): Promise<TransactionEndorsingData>;
+  static buildCreateRevocationRegistryDefinitionTransaction(client: LedgerClient, from: string, rev_reg_def: RevocationRegistryDefinition, nonce?: bigint | null): Promise<Transaction>;
+  static buildLatestRevocationRegistryEntryFromStatusList(client: LedgerClient, id: string, revocation_registry_status_list: Uint8Array, accumulator: string): Promise<RevocationRegistryEntry>;
+  static buildResolveRevocationRegistryDefinitionTransaction(client: LedgerClient, id: string): Promise<Transaction>;
+  static buildCreateRevocationRegistryDefinitionEndorsingData(client: LedgerClient, rev_reg_def: RevocationRegistryDefinition): Promise<TransactionEndorsingData>;
+}
+
+export class RevocationRegistryDefinition {
+  free(): void;
+  [Symbol.dispose](): void;
+  static fromString(string: string): RevocationRegistryDefinition;
+  constructor(issuer_id: string, cred_def_id: string, tag: string, value: RevocationRegistryDefinitionValue);
+  getId(): string;
+  asValue(): RevocationRegistryDefinitionData;
+  toString(): string;
+}
+
+export class RevocationRegistryEntry {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor(issuer_id: string, rev_reg_def_id: string, current_accumulator: string, prev_accumulator?: string | null, issued?: Uint32Array | null, revoked?: Uint32Array | null);
+  asValue(): RevocationRegistryEntryValue;
+  toString(): string;
+}
+
+export class RevocationRegistryStatusList {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  asValue(): RevocationStatusListData;
+  toString(): string;
+}
+
+export class RoleControl {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static parseGetRoleResult(client: LedgerClient, bytes: Uint8Array): number;
+  static parseHasRoleResult(client: LedgerClient, bytes: Uint8Array): boolean;
+  static buildGetRoleTransaction(client: LedgerClient, account: string): Promise<Transaction>;
+  static buildHasRoleTransaction(client: LedgerClient, role: number, account: string): Promise<Transaction>;
+  static buildAssignRoleTransaction(client: LedgerClient, from: string, role: number, account: string, nonce?: bigint | null): Promise<Transaction>;
+  static buildRevokeRoleTransaction(client: LedgerClient, from: string, role: number, account: string, nonce?: bigint | null): Promise<Transaction>;
+}
+
+export class Schema {
+  free(): void;
+  [Symbol.dispose](): void;
+  static fromString(string: string): Schema;
+  constructor(issuer_id: string, name: string, version: string, attr_names: string[]);
+  getId(): string;
+  asValue(): SchemaData;
+  toString(): string;
+}
+
+export class SchemaRegistry {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static resolveSchema(client: LedgerClient, id: string): Promise<Schema>;
+  static parseResolveSchemaResult(client: LedgerClient, bytes: Uint8Array): SchemaRecord;
+  static buildCreateSchemaTransaction(client: LedgerClient, from: string, schema: Schema, nonce?: bigint | null): Promise<Transaction>;
+  static buildResolveSchemaTransaction(client: LedgerClient, id: string): Promise<Transaction>;
+  static buildCreateSchemaEndorsingData(client: LedgerClient, schema: Schema): Promise<TransactionEndorsingData>;
+}
+
+export class Transaction {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  setSignature(signature_data: SignatureData): void;
+  getSigningBytes(): Uint8Array;
+  to(): string;
+}
+
+export class TransactionEndorsingData {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  setSignature(signature_data: SignatureData): void;
+  getSigningBytes(): Uint8Array;
+}
+
+export class ValidatorControl {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static parseGetValidatorsResult(client: LedgerClient, bytes: Uint8Array): AddressString[];
+  static buildAddValidatorTransaction(client: LedgerClient, from: string, validator_address: string, nonce?: bigint | null): Promise<Transaction>;
+  static buildGetValidatorsTransaction(client: LedgerClient): Promise<Transaction>;
+  static buildRemoveValidatorTransaction(client: LedgerClient, from: string, validator_address: string, nonce?: bigint | null): Promise<Transaction>;
+}