pshenmic-dpp 1.0.4 → 1.0.6

package/docs/IdentityCreditWithdrawalTransition.md

@@ -0,0 +1,244 @@
+# IdentityCreditWithdrawalTransitionWASM
+
+This class allows to create instance of IdentityCreditWithdrawalTransition struct
+
+`IdentityCreditWithdrawalTransitionWASM` can be created via constructor, bytes and state transition
+
+Constructor params:
+
+- `identityId -> IdentifierWASM | String | ArrayLike`
+- `amount -> BigInt`
+- `coreFeePerByte -> Number`
+- `pooling -> PoolingENUM`
+- `outputScript -> OutPutScript`
+- `nonce -> BigInt`
+- `userFeeIncrease -> Number`
+
+___
+
+## Navigation
+
+- [Example](#Example)
+- [Fields](#fields)
+    - [userFeeIncrease](#userfeeincrease)
+    - [identityId](#identityid)
+    - [amount](#amount)
+    - [nonce](#nonce)
+    - [signature](#signature)
+    - [signaturePublicKeyId](#signaturepublickeyid)
+    - [pooling](#pooling)
+    - [outputScript](#outputscript)
+- [Getters](#getters)
+    - [getPurposeRequirement](#getpurposerequirement)
+    - [getModifiedDataIds](#getmodifieddataids)
+    - [getOptionalAssetLockProof](#getoptionalassetlockproof)
+    - [getSignableBytes](#getsignablebytes)
+    - [toBytes](#tobytes)
+    - [toStateTransition](#tostatetransition)
+
+___
+
+### Example
+
+```js
+const identifier = new wasm.IdentifierWASM('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec')
+const script = wasm.CoreScriptWASM.newP2PKH([1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1])
+
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+```
+
+___
+
+## Fields
+
+All fields are readable and writable.
+
+### `userFeeIncrease`
+
+Contains userFeeIncrease in `Number`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.userFeeIncrease = 99
+
+transition.userFeeIncrease // -> Number
+```
+
+___
+
+### `identityId`
+
+Contains identity identifier in `IdentifierWASM`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.identityId = '12FRq8L3VuBEQfCAZykmUaiXXrsd1Bwub2gcaMmtNbn3'
+
+transition.identityId // -> IdentifierWASM
+```
+
+___
+
+### `amount`
+
+Contains credits amount for transfer in `BigInt`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.amount = BigInt(999999999)
+
+transition.amount // -> BigInt
+```
+
+___
+
+### `nonce`
+
+Contains nonce in `BigInt`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.nonce = BigInt(999999999)
+
+transition.nonce // -> BigInt
+```
+
+___
+
+### `signature`
+
+Contains signature in `Uint8Array`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.signature = Uint8Array.from([1, 2, 3, 4, 5])
+
+transition.signature // -> Uint8Array
+```
+
+___
+
+### `signaturePublicKeyId`
+
+Contains signature public key id in `Number`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.signaturePublicKeyId = 12
+
+transition.signaturePublicKeyId // -> Number
+```
+
+___
+
+### `pooling`
+
+Contains pooling enum in `String`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.pooling = "never"
+
+transition.pooling // -> Number
+```
+
+___
+
+### `outputScript`
+
+Contains output script in `CoreScriptWASM | undefined`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.outputScript = wasm.CoreScriptWASM.newP2PKH([1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1])
+
+transition.outputScript // -> CoreScriptWASM
+```
+
+___
+
+## Getters
+
+### `getPurposeRequirement`
+
+Returns purpose requirement in PurposeENUM `String`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.getPurposeRequirement() // -> String
+
+```
+
+___
+
+### `getModifiedDataIds`
+
+Returns modified ids in `[IdentifierWASM]`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.getModifiedDataIds() // -> [IdentifierWASM]
+
+```
+
+___
+
+### `getOptionalAssetLockProof`
+
+Returns asset lock proof in `AssetLockProofWASM | undefined`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.getOptionalAssetLockProof() // -> AssetLockProofWASM | undefined
+
+```
+
+___
+
+### `getSignableBytes`
+
+Returns bytes for sign in `Uint8Array`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.getSignableBytes() // -> Uint8Array
+
+```
+
+___
+
+### `toBytes`
+
+Returns transition in `Uint8Array`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.toBytes() // -> Uint8Array
+
+```
+
+___
+
+### `toStateTransition`
+
+Returns `StateTransitionWASM`
+
+```js
+const transition = new wasm.IdentityCreditWithdrawalTransitionWASM(identifier, BigInt(111), 1, 'never', script, BigInt(1), 1)
+
+transition.toStateTransition() // -> StateTransitionWASM
+
+```

package/docs/IdentityPublicKey.md

@@ -0,0 +1,348 @@
+# IdentityPublicKeyWASM
+
+This class allows to create IdentityPublicKey instance and interact
+
+Arguments in constructor:
+
+- `id -> Number`
+- `purpose -> PurposeEnum`
+- `securityLevel -> SecurityLevelEnum`
+- `keyType -> KeyTypeEnum`
+- `readOnly -> Boolean`
+- `binaryData -> Hex String`
+- `disabledAt -> ?BigInt`
+
+You can create `IdentityPublicKeyWASM` via constructor and `fromBytes`
+
+If you want to create `IdentityPublicKey` from bytes,
+you need to use serialized to bytes `IdentityPublicKey` from `rs-dpp` or `pshenmic-dpp`
+___
+
+## Navigation
+
+- [Example](#example)
+- [Getters methods](#getters-methods)
+    - [validatePrivateKey](#validateprivatekey)
+    - [getKeyId](#getkeyid)
+    - [getPurpose](#getpurpose)
+    - [getSecurityLevel](#getsecuritylevel)
+    - [getKeyType](#getkeytype)
+    - [getReadOnly](#getreadonly)
+    - [getData](#getdata)
+    - [getDisabledAt](#getdisabledat)
+- [Setters methods](#setters-methods)
+    - [setKeyId](#setkeyid)
+    - [setPurpose](#setpurpose)
+    - [setSecurityLevel](#setsecuritylevel)
+    - [setKeyType](#setkeytype)
+    - [setReadOnly](#setreadonly)
+    - [setData](#setdata)
+    - [setDisabledAt](#setdisabledat)
+
+___
+
+## Example
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+```
+
+___
+
+## Getters methods
+
+### `validatePrivateKey`
+
+Allows to validate private key for selected public key.
+
+Returns `Boolean`
+
+```js
+const privateKey = PrivateKeyWASM.fromWIF('cR4EZ2nAvCmn2cFepKn7UgSSQFgFTjkySAchvcoiEVdm48eWjQGn')
+
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.validatePrivateKey(privateKey.getBytes(), 'mainnet')
+```
+
+___
+
+### `getKeyId`
+
+Returns key id in `Number`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.getKeyId() // -> Number
+```
+
+___
+
+### `getPurpose`
+
+Returns purpose value for identity public key in `String`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.getPurpose() // -> String
+```
+
+___
+
+### `getSecurityLevel`
+
+Returns security level for identity public key in `String`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.getSecurityLevel() // -> String
+```
+
+___
+
+### `getKeyType`
+
+Returns key type for identity public key in `String`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.getKeyType() // -> String
+```
+
+___
+
+### `getReadOnly`
+
+Returns read only flag for identity public key in `Boolean`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.getReadOnly() // -> Boolean
+```
+
+___
+
+### `getData`
+
+Returns identity public key data in Hex `String`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.getData() // -> String
+```
+
+___
+
+### `getDisabledAt`
+
+Returns optional disabled at timestamp identity public key `?Number`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.getDisabledAt() // -> ?BigInt
+```
+
+___
+
+## Setters methods
+
+### `setKeyId`
+
+Allows to set key id in `Number`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.setKeyId(11)
+```
+
+___
+
+### `setPurpose`
+
+Allows to set purpose value for identity public key in `PurposeEnum`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.setPurpose('ENCRYPTION')
+```
+
+___
+
+### `setSecurityLevel`
+
+Allows to set security level for identity public key in `SecurityLevelEnum`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.setSecurityLevel('HIGH')
+```
+
+___
+
+### `setKeyType`
+
+Allows to set key type for identity public key in `KeyTypeEnum`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.setKeyType('ECDSA_HASH160')
+```
+
+___
+
+### `setReadOnly`
+
+Allows to set read only flag for identity public key in `Boolean`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.setReadOnly(true)
+```
+
+___
+
+### `setData`
+
+Allows to set identity public key data in Hex `String`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.setData('0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48')
+```
+
+___
+
+### `setDisabledAt`
+
+Allows to set disabled at timestamp identity public key `BigInt`
+
+```js
+const publicKey = new IdentityPublicKeyWASM(
+  2,
+  'AUTHENTICATION',
+  'CRITICAL',
+  'ECDSA_SECP256K1',
+  false,
+  '0300000002e40e81d928fde2bde7880070e4fa9c1d1d9b168da707ea468afa2b48'
+)
+
+publicKey.setDisabledAt(BigInt(11))
+```

package/docs/IdentityPublicKeyInCreation.md

@@ -0,0 +1,141 @@
+# IdentityPublicKeyInCreationWASM
+
+This class allows to create and interact with instance of IdentityPublicKeyInCreation struct
+
+`IdentityPublicKeyInCreationWASM` can be created only via constructor
+
+Constructor params:
+
+- `id -> Number`
+- `purpose -> PurposeEnum`
+- `securityLevel -> SecurityLevelEnum`
+- `keyType -> KeyTypeEnum`
+- `readOnly -> Boolean`
+- `binaryData -> Uint8Array`
+- `signature -> Uint8Array`
+
+___
+
+## Navigation
+
+- [Example](#Example)
+- [Fields](#fields)
+    - [keyId](#keyid)
+    - [purpose](#purpose)
+    - [securityLevel](#securitylevel)
+    - [keyType](#keytype)
+    - [readOnly](#readonly)
+    - [data](#data)
+    - [signature](#signature)
+- [Getters](#getters)
+    - [toIdentityPublicKey](#toIdentityPublicKey)
+
+___
+
+### Example
+
+```js
+const key = new wasm.IdentityPublicKeyInCreationWASM(
+  1, 'system', 'master', 'ECDSA_SECP256K1', false, [], []
+)
+```
+
+___
+
+## Fields
+
+All fields are readable and writable.
+
+### `keyId`
+
+Contains id of key in `Number`
+
+```js
+key.keyId = 1
+
+key.keyId // -> Number
+```
+
+___
+
+### `purpose`
+
+Contains purpose enum in `String`
+
+```js
+key.purpose = 'system'
+
+key.purpose // -> String
+```
+
+___
+
+### `securityLevel`
+
+Contains securityLevel enum in `String`
+
+```js
+key.securityLevel = 'master'
+
+key.securityLevel // -> String
+```
+
+___
+
+### `keyType`
+
+Contains keyType enum in `String`
+
+```js
+key.keyType = 'ECDSA_SECP256K1'
+
+key.keyType // -> String
+```
+
+___
+
+### `readOnly`
+
+Contains readOnly flag in `Boolean`
+
+```js
+key.readOnly = true
+
+key.readOnly // -> Boolean
+```
+
+___
+
+### `data`
+
+Contains data in `Uint8Array`
+
+```js
+key.data = Uint8Array.from([1, 2, 3, 4, 5])
+
+key.data // -> Uint8Array
+```
+
+___
+
+### `signature`
+
+Contains signature in `Uint8Array`
+
+```js
+key.signature = Uint8Array.from([1, 2, 3, 4, 5])
+
+key.signature // -> Uint8Array
+```
+
+___
+
+## Getters
+
+### `toIdentityPublicKey`
+
+Allows to get `IdentityPublicKeyWASM`
+
+```js
+key.toIdentityPublicKey() // -> IdentityPublicKeyWASM
+```