Class Utxo

constructor

• new Utxo(__namedParameters): Utxo

• Description

  Initialize a new utxo - unspent transaction output or input. Note, a full TX consists of 2 inputs and 2 outputs

  Parameters

  • __namedParameters: {
        account?: Account;
        amounts?: BN[];
        appData?: any;
        appDataHash?: BN;
        appDataIdl?: Idl;
        assetLookupTable: string[];
        assets?: PublicKey[];
        blinding?: BN;
        includeAppData?: boolean;
        index?: number;
        poolType?: BN;
        poseidon: any;
        verifierAddress?: PublicKey;
        verifierProgramLookupTable: string[];
    }

    • Optional account?: Account

    • Optional amounts?: BN[]

    • Optional appData?: any

    • Optional appDataHash?: BN

    • Optional appDataIdl?: Idl

    • assetLookupTable: string[]

    • Optional assets?: PublicKey[]

    • Optional blinding?: BN

    • Optional includeAppData?: boolean

    • Optional index?: number

    • Optional poolType?: BN

    • poseidon: any

    • Optional verifierAddress?: PublicKey

    • verifierProgramLookupTable: string[]

  Returns Utxo

Optional _commitment

Optional _nullifier

account

amounts

appData

appDataHash

Optional appDataIdl

assets

assetsCircuit

blinding

includeAppData

Optional index

poolType

splAssetIndex

transactionVersion

verifierAddress

verifierAddressCircuit

verifierProgramIndex

encrypt

• encrypt(poseidon, merkleTreePdaPublicKey?, transactionNonce?, compressed?): Promise<Uint8Array>

• Description

  Encrypts the utxo to the utxo's accounts public key with nacl.box.

  Parameters

  • poseidon: any

  • Optional merkleTreePdaPublicKey: PublicKey

  • Optional transactionNonce: number

  • compressed: boolean = true

  Returns Promise<Uint8Array>

  with the first 24 bytes being the nonce

getCommitment

• getCommitment(poseidon): string

• Description

  Returns commitment for this utxo

  Description

  PoseidonHash(amountHash, shieldedPubkey, blinding, assetHash, appDataHash, poolType, verifierAddressCircuit)

  Parameters

  • poseidon: any

  Returns string

getNullifier

• getNullifier(poseidon, index?): undefined | string

• Description

  Computes the nullifier for this utxo.

  Description

  PoseidonHash(commitment, index, signature)

  Parameters

  • poseidon: any

  • Optional index: number

    Merkle tree index of the utxo commitment (Optional)

  Returns undefined | string

toBytes

• toBytes(compressed?): Promise<Buffer>

• Description

  Parses a utxo to bytes.

  Parameters

  • compressed: boolean = false

  Returns Promise<Buffer>

toString

• toString(): Promise<string>

• Converts the Utxo instance into a base58 encoded string.

  Async

  Returns Promise<string>

  A promise that resolves to the base58 encoded string representation of the Utxo.

Static decrypt

• decrypt(__namedParameters): Promise<null | Utxo>

• Description

  Decrypts a utxo from an array of bytes, the last 24 bytes are the nonce.

  Parameters

  • __namedParameters: {
        account: Account;
        aes?: boolean;
        appDataIdl?: Idl;
        assetLookupTable: string[];
        commitment: Uint8Array;
        compressed?: boolean;
        encBytes: Uint8Array;
        index: number;
        merkleTreePdaPublicKey?: PublicKey;
        poseidon: any;
        transactionNonce?: number;
        verifierProgramLookupTable: string[];
    }

    • account: Account

    • Optional aes?: boolean

    • Optional appDataIdl?: Idl

    • assetLookupTable: string[]

    • commitment: Uint8Array

    • Optional compressed?: boolean

    • encBytes: Uint8Array

    • index: number

    • Optional merkleTreePdaPublicKey?: PublicKey

    • poseidon: any

    • Optional transactionNonce?: number

    • verifierProgramLookupTable: string[]

  Returns Promise<null | Utxo>

Static equal

• equal(poseidon, utxo0, utxo1, skipNullifier?): void

• Description

  Compares two Utxos.

  Parameters

  • poseidon: any

  • utxo0: Utxo

  • utxo1: Utxo

  • skipNullifier: boolean = false

  Returns void

Static fromBytes

• fromBytes(__namedParameters): Utxo

• Description

  Parses a utxo from bytes.

  Parameters

  • __namedParameters: {
        account?: Account;
        appDataIdl?: Idl;
        assetLookupTable: string[];
        bytes: Buffer;
        includeAppData?: boolean;
        index?: number;
        poseidon: any;
        verifierAddress?: PublicKey;
        verifierProgramLookupTable: string[];
    }

    • Optional account?: Account

    • Optional appDataIdl?: Idl

    • assetLookupTable: string[]

    • bytes: Buffer

    • Optional includeAppData?: boolean

    • Optional index?: number

    • poseidon: any

    • Optional verifierAddress?: PublicKey

    • verifierProgramLookupTable: string[]

  Returns Utxo

Static fromString

• fromString(string, poseidon, assetLookupTable, verifierProgramLookupTable): Utxo

• Creates a new Utxo from a given base58 encoded string.

  Static

  Parameters

  • string: string

    The base58 encoded string representation of the Utxo.

  • poseidon: any

  • assetLookupTable: string[]

  • verifierProgramLookupTable: string[]

  Returns Utxo

  The newly created Utxo.