@notabene/javascript-sdk 2.15.0 → 2.16.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/README.md CHANGED
@@ -356,6 +356,7 @@ const withdrawal = notabene.createWithdrawalAssist(
356
356
  microTransfer: {
357
357
  destination: '0x...',
358
358
  amountSubunits: '12344',
359
+ requireHash: true,
359
360
  },
360
361
  },
361
362
  },
@@ -766,6 +767,7 @@ const options: TransactionOptions = {
766
767
  microTransfer: {
767
768
  destination: '0x...',
768
769
  amountSubunits: '12344',
770
+ requireHash: true,
769
771
  },
770
772
  fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self-declaration']
771
773
  deminimis: {
@@ -839,6 +841,7 @@ withdrawal.update(
839
841
  microTransfer: {
840
842
  destination: '0x...',
841
843
  amountSubunits: '12344',
844
+ requireHash: true,
842
845
  },
843
846
  },
844
847
  },
@@ -962,12 +965,19 @@ You can support Micro Transfers (aka Satoshi tests) by adding a deposit address
962
965
 
963
966
  Your compliance team will have to determine how to handle and verify these transactions in the rules engine or individually.
964
967
 
968
+ | Property | Type | Description |
969
+ |----------|------|-------------|
970
+ | `destination` | `string` | The deposit address for the micro-transfer test |
971
+ | `amountSubunits` | `string` | The amount in subunits (e.g. satoshis, wei) to send |
972
+ | `requireHash` | `boolean` | When `true`, the user must provide the transaction hash as proof (default true) |
973
+
965
974
  ```ts
966
975
  const options: TransactionOptions = {
967
976
  proofs: {
968
977
  microTransfer: {
969
978
  destination: '0x...',
970
979
  amountSubunits: '1234',
980
+ requireHash: true,
971
981
  },
972
982
  fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self_declaration']
973
983
  },