@notabene/javascript-sdk 2.15.0-next.3 → 2.16.0-next.1

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.
Files changed (9) hide show
  1. package/README.md +10 -0
  2. package/dist/cjs/notabene.d.ts +1 -0
  3. package/dist/cjs/package.json +1 -1
  4. package/dist/esm/notabene.d.ts +1 -0
  5. package/dist/esm/package.json +1 -1
  6. package/dist/notabene.d.ts +1 -0
  7. package/package.json +1 -1
  8. package/src/types.ts +1 -0
  9. package/src/utils/arbitraries.ts +1 -0
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
  },
package/dist/cjs/notabene.d.ts CHANGED
@@ -2468,6 +2468,7 @@ export declare interface TransactionOptions {
2468
2468
  microTransfer?: {
2469
2469
  destination: BlockchainAddress;
2470
2470
  amountSubunits: string;
2471
+ requireHash?: boolean;
2471
2472
  };
2472
2473
  fallbacks?: ProofTypes[];
2473
2474
  deminimis?: ThresholdOptions;
package/dist/cjs/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.15.0-next.3",
13
+ "version": "2.16.0-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
package/dist/esm/notabene.d.ts CHANGED
@@ -2468,6 +2468,7 @@ export declare interface TransactionOptions {
2468
2468
  microTransfer?: {
2469
2469
  destination: BlockchainAddress;
2470
2470
  amountSubunits: string;
2471
+ requireHash?: boolean;
2471
2472
  };
2472
2473
  fallbacks?: ProofTypes[];
2473
2474
  deminimis?: ThresholdOptions;
package/dist/esm/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.15.0-next.3",
13
+ "version": "2.16.0-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
package/dist/notabene.d.ts CHANGED
@@ -2468,6 +2468,7 @@ export declare interface TransactionOptions {
2468
2468
  microTransfer?: {
2469
2469
  destination: BlockchainAddress;
2470
2470
  amountSubunits: string;
2471
+ requireHash?: boolean;
2471
2472
  };
2472
2473
  fallbacks?: ProofTypes[];
2473
2474
  deminimis?: ThresholdOptions;
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.15.0-next.3",
13
+ "version": "2.16.0-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
package/src/types.ts CHANGED
@@ -920,6 +920,7 @@ export interface TransactionOptions {
920
920
  microTransfer?: {
921
921
  destination: BlockchainAddress;
922
922
  amountSubunits: string;
923
+ requireHash?: boolean; // Defaults true
923
924
  };
924
925
  fallbacks?: ProofTypes[]; // Legacy — replaced by agentSections.fallback
925
926
  deminimis?: ThresholdOptions;
package/src/utils/arbitraries.ts CHANGED
@@ -208,6 +208,7 @@ export const arbitraryTransactionOptions =
208
208
  fc.record({
209
209
  destination: arbitraryBlockchainAddress(),
210
210
  amountSubunits: fc.string(),
211
+ requireHash: fc.option(fc.boolean()),
211
212
  }),
212
213
  ),
213
214
  fallbacks: fc.option(