@1money/protocol-ts-sdk 1.1.2-alpha.7 → 2.0.0

package/.claude/settings.local.json

@@ -19,7 +19,8 @@
       "Bash(cat:*)",
       "Bash(xargs grep:*)",
       "Bash(npm run lint:es_fix:*)",
-      "Bash(node test-encoding.mjs:*)"
+      "Bash(node test-encoding.mjs:*)",
+      "Bash(npm test:*)"
     ],
     "deny": []
   }

package/README.md

@@ -37,6 +37,34 @@ const apiClient = api({
 });
 ```
 
+### Configure Custom HTTP Headers
+
+You can set custom HTTP headers that will be included in all API requests:
+
+```typescript
+import { setInitConfig } from '@1money/protocol-ts-sdk';
+
+// Set custom headers for all requests
+setInitConfig({
+  headers: {
+    'Authorization': 'Bearer your-token',
+    'X-Custom-Header': 'custom-value'
+  }
+});
+
+// You can also combine with other configuration options
+setInitConfig({
+  baseURL: 'https://api.custom-domain.com',
+  timeout: 10000,
+  headers: {
+    'Authorization': 'Bearer your-token',
+    'X-API-Key': 'your-api-key'
+  }
+});
+```
+
+**Note**: Custom headers are automatically merged with axios default headers, ensuring both your custom headers and the library's default security headers are included in all requests.
+
 ### Fetch the current checkpoint number
 
 ```typescript
@@ -207,43 +235,40 @@ apiClient.tokens.getTokenMetadata(tokenAddress)
 
 #### Issue New Token
 ```typescript
-import { signMessage, toHex } from '@1money/protocol-ts-sdk';
+import {
+  TransactionBuilder,
+  createPrivateKeySigner
+} from '@1money/protocol-ts-sdk';
 
 // Your private key (DO NOT share or commit your private key)
 const privateKey = 'YOUR_PRIVATE_KEY';
+const masterAuthority = '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3';
 
-// First, get the latest epoch checkpoint
-const epochData = await apiClient.state.getLatestEpochCheckpoint()
+// Get chain id and current nonce
+const { chain_id } = await apiClient.chain.getChainId()
+  .success(response => response);
+const { nonce } = await apiClient.accounts.getNonce(masterAuthority)
   .success(response => response);
 
-// Create the payload array for signing
-const payload = [
-  1, // chain_id
-  1, // nonce
-  'MTK', // symbol
-  'My Token', // name
-  18, // decimals
-  '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3', // master_authority
-  true, // is_private
-];
-
-// Generate signature
-const signature = await signMessage(payload, privateKey);
-if (!signature) {
-  throw new Error('Failed to generate signature');
-}
-
-// Create the issue payload
-const issuePayload = {
-  chain_id: 1,
-  nonce: 1,
-  name: 'My Token',
+// Build transaction and prepare signature hash internally
+const prepared = TransactionBuilder.tokenIssue({
+  chain_id,
+  nonce,
   symbol: 'MTK',
+  name: 'My Token',
   decimals: 18,
-  master_authority: '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3',
+  master_authority: masterAuthority,
   is_private: true,
-  signature
-};
+  clawback_enabled: true
+});
+
+// Sign with private key
+const signed = await prepared.sign(
+  createPrivateKeySigner(privateKey as `0x${string}`)
+);
+
+// Build request body with signature
+const issuePayload = signed.toRequest();
 
 apiClient.tokens.issueToken(issuePayload)
   .success(response => {
@@ -256,40 +281,38 @@ apiClient.tokens.issueToken(issuePayload)
 
 #### Manage Token Blacklist/Whitelist
 ```typescript
-import { signMessage, toHex } from '@1money/protocol-ts-sdk';
-import type { ManageListAction } from '@1money/protocol-ts-sdk/api';
+import {
+  ManageListAction,
+  TransactionBuilder,
+  createPrivateKeySigner
+} from '@1money/protocol-ts-sdk';
 
 // Your private key (DO NOT share or commit your private key)
 const privateKey = 'YOUR_PRIVATE_KEY';
+const operatorAddress = '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3';
 
-// First, get the latest epoch checkpoint
-const epochData = await apiClient.state.getLatestEpochCheckpoint()
+// Get chain id and current nonce
+const { chain_id } = await apiClient.chain.getChainId()
+  .success(response => response);
+const { nonce } = await apiClient.accounts.getNonce(operatorAddress)
   .success(response => response);
 
-// Create the payload array for signing
-const payload = [
-  1, // chain_id
-  1, // nonce
-  ManageListAction.Add, // action
-  '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3', // address
-  '0x2cd8999Be299373D7881f4aDD11510030ad1412F', // token
-];
+// Build transaction and prepare signature hash internally
+const prepared = TransactionBuilder.tokenManageList({
+  chain_id,
+  nonce,
+  action: ManageListAction.Add,
+  address: operatorAddress,
+  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F'
+});
 
-// Generate signature
-const signature = await signMessage(payload, privateKey);
-if (!signature) {
-  throw new Error('Failed to generate signature');
-}
+// Sign with private key
+const signed = await prepared.sign(
+  createPrivateKeySigner(privateKey as `0x${string}`)
+);
 
-// Create the manage list payload
-const manageListPayload = {
-  chain_id: 1,
-  nonce: 1,
-  action: ManageListAction.Add,
-  address: '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3',
-  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
-  signature
-};
+// Build request body with signature
+const manageListPayload = signed.toRequest();
 
 // Use manageBlacklist for blacklist operations
 apiClient.tokens.manageBlacklist(manageListPayload)
@@ -312,39 +335,36 @@ apiClient.tokens.manageWhitelist(manageListPayload)
 
 #### Burn Tokens
 ```typescript
-import { signMessage, toHex } from '@1money/protocol-ts-sdk';
+import {
+  TransactionBuilder,
+  createPrivateKeySigner
+} from '@1money/protocol-ts-sdk';
 
 // Your private key (DO NOT share or commit your private key)
 const privateKey = 'YOUR_PRIVATE_KEY';
+const ownerAddress = '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3';
 
-// First, get the latest epoch checkpoint
-const epochData = await apiClient.state.getLatestEpochCheckpoint()
+// Get chain id and current nonce
+const { chain_id } = await apiClient.chain.getChainId()
+  .success(response => response);
+const { nonce } = await apiClient.accounts.getNonce(ownerAddress)
   .success(response => response);
 
-// Create the payload array for signing
-const payload = [
-  1, // chain_id
-  1, // nonce
-  '0x2cd8999Be299373D7881f4aDD11510030ad1412F', // recipient (for burn, same as sender)
-  '1000000000000000000', // amount
-  '0x2cd8999Be299373D7881f4aDD11510030ad1412F', // token
-];
+// Build transaction and prepare signature hash internally
+const prepared = TransactionBuilder.tokenBurn({
+  chain_id,
+  nonce,
+  value: '1000000000000000000',
+  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F'
+});
 
-// Generate signature
-const signature = await signMessage(payload, privateKey);
-if (!signature) {
-  throw new Error('Failed to generate signature');
-}
+// Sign with private key
+const signed = await prepared.sign(
+  createPrivateKeySigner(privateKey as `0x${string}`)
+);
 
-// Create the burn payload
-const burnPayload = {
-  chain_id: 1,
-  nonce: 1,
-  recipient: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
-  value: '1000000000000000000',
-  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
-  signature
-};
+// Build request body with signature
+const burnPayload = signed.toRequest();
 
 apiClient.tokens.burnToken(burnPayload)
   .success(response => {
@@ -357,44 +377,41 @@ apiClient.tokens.burnToken(burnPayload)
 
 #### Grant Token Authority
 ```typescript
-import { signMessage, toHex } from '@1money/protocol-ts-sdk';
-import type { AuthorityType, AuthorityAction } from '@1money/protocol-ts-sdk/api';
+import {
+  AuthorityAction,
+  AuthorityType,
+  TransactionBuilder,
+  createPrivateKeySigner
+} from '@1money/protocol-ts-sdk';
 
 // Your private key (DO NOT share or commit your private key)
 const privateKey = 'YOUR_PRIVATE_KEY';
+const masterAddress = '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3';
 
-// First, get the latest epoch checkpoint
-const epochData = await apiClient.state.getLatestEpochCheckpoint()
+// Get chain id and current nonce
+const { chain_id } = await apiClient.chain.getChainId()
+  .success(response => response);
+const { nonce } = await apiClient.accounts.getNonce(masterAddress)
   .success(response => response);
 
-// Create the payload array for signing
-const payload = [
-  1, // chain_id
-  1, // nonce
-  AuthorityAction.Grant, // action
-  AuthorityType.MasterMint, // authority_type (sends 'MasterMintBurn')
-  '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3', // authority_address
-  '0x2cd8999Be299373D7881f4aDD11510030ad1412F', // token
-  '1000000000000000000000', // value (optional, for MintBurnTokens type)
-];
-
-// Generate signature
-const signature = await signMessage(payload, privateKey);
-if (!signature) {
-  throw new Error('Failed to generate signature');
-}
-
-// Create the authority payload
-const authorityPayload = {
-  chain_id: 1,
-  nonce: 1,
+// Build transaction and prepare signature hash internally
+const prepared = TransactionBuilder.tokenAuthority({
+  chain_id,
+  nonce,
   action: AuthorityAction.Grant,
-  authority_type: AuthorityType.MasterMint, // value is 'MasterMintBurn'
+  authority_type: AuthorityType.MasterMint,
   authority_address: '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3',
   token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
-  value: '1000000000000000000000',
-  signature
-};
+  value: '1000000000000000000000'
+});
+
+// Sign with private key
+const signed = await prepared.sign(
+  createPrivateKeySigner(privateKey as `0x${string}`)
+);
+
+// Build request body with signature
+const authorityPayload = signed.toRequest();
 
 apiClient.tokens.grantAuthority(authorityPayload)
   .success(response => {
@@ -405,6 +422,100 @@ apiClient.tokens.grantAuthority(authorityPayload)
   });
 ```
 
+#### Bridge and Mint
+```typescript
+import {
+  TransactionBuilder,
+  createPrivateKeySigner
+} from '@1money/protocol-ts-sdk';
+
+// Your private key (DO NOT share or commit your private key)
+const privateKey = 'YOUR_PRIVATE_KEY';
+const bridgeOperatorAddress = '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3';
+
+// Get chain id and current nonce
+const { chain_id } = await apiClient.chain.getChainId()
+  .success(response => response);
+const { nonce } = await apiClient.accounts.getNonce(bridgeOperatorAddress)
+  .success(response => response);
+
+// Build transaction and prepare signature hash internally
+const prepared = TransactionBuilder.tokenBridgeAndMint({
+  chain_id,
+  nonce,
+  recipient: '0x6324dAc598f9B637824978eD6b268C896E0c40E0',
+  value: '25000000000000000000',
+  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
+  source_chain_id: 1,
+  source_tx_hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+  bridge_metadata: 'bridge_from_chain_1'
+});
+
+// Sign with private key
+const signed = await prepared.sign(
+  createPrivateKeySigner(privateKey as `0x${string}`)
+);
+
+// Build request body with signature
+const bridgeAndMintPayload = signed.toRequest();
+
+apiClient.tokens.bridgeAndMint(bridgeAndMintPayload)
+  .success(response => {
+    console.log('Bridge and mint transaction hash:', response.hash);
+  })
+  .error(err => {
+    console.error('Error:', err);
+  });
+```
+
+#### Burn and Bridge
+```typescript
+import {
+  TransactionBuilder,
+  createPrivateKeySigner
+} from '@1money/protocol-ts-sdk';
+
+// Your private key (DO NOT share or commit your private key)
+const privateKey = 'YOUR_PRIVATE_KEY';
+const senderAddress = '0x6324dAc598f9B637824978eD6b268C896E0c40E0';
+
+// Get chain id and current nonce
+const { chain_id } = await apiClient.chain.getChainId()
+  .success(response => response);
+const { nonce } = await apiClient.accounts.getNonce(senderAddress)
+  .success(response => response);
+
+// Build transaction and prepare signature hash internally
+const prepared = TransactionBuilder.tokenBurnAndBridge({
+  chain_id,
+  nonce,
+  sender: senderAddress,
+  value: '20000000000000000000',
+  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
+  destination_chain_id: 1,
+  destination_address: '0x1234567890abcdef1234567890abcdef12345678',
+  escrow_fee: '1000000000000000000',
+  bridge_metadata: 'bridge_to_chain_1',
+  bridge_param: '0x'
+});
+
+// Sign with private key
+const signed = await prepared.sign(
+  createPrivateKeySigner(privateKey as `0x${string}`)
+);
+
+// Build request body with signature
+const burnAndBridgePayload = signed.toRequest();
+
+apiClient.tokens.burnAndBridge(burnAndBridgePayload)
+  .success(response => {
+    console.log('Burn and bridge transaction hash:', response.hash);
+  })
+  .error(err => {
+    console.error('Error:', err);
+  });
+```
+
 ### Transactions API
 
 #### Get Transaction Details
@@ -434,10 +545,11 @@ apiClient.transactions.getReceiptByHash(txHash)
 #### Estimate Transaction Fee
 ```typescript
 const fromAddress = '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3';
+const toAddress = '0x6324dAc598f9B637824978eD6b268C896E0c40E0';
 const value = '1000000000';
 const tokenAddress = '0x2cd8999Be299373D7881f4aDD11510030ad1412F';
 
-apiClient.transactions.estimateFee(fromAddress, value, tokenAddress)
+apiClient.transactions.estimateFee(fromAddress, toAddress, value, tokenAddress)
   .success(response => {
     console.log('Estimated fee:', response);
   })
@@ -448,39 +560,37 @@ apiClient.transactions.estimateFee(fromAddress, value, tokenAddress)
 
 #### Submit Payment Transaction
 ```typescript
-import { signMessage, toHex } from '@1money/protocol-ts-sdk';
+import {
+  TransactionBuilder,
+  createPrivateKeySigner
+} from '@1money/protocol-ts-sdk';
 
 // Your private key (DO NOT share or commit your private key)
 const privateKey = 'YOUR_PRIVATE_KEY';
+const senderAddress = '0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC74ff3';
 
-// First, get the latest epoch checkpoint
-const epochData = await apiClient.state.getLatestEpochCheckpoint()
+// Get chain id and current nonce
+const { chain_id } = await apiClient.chain.getChainId()
+  .success(response => response);
+const { nonce } = await apiClient.accounts.getNonce(senderAddress)
   .success(response => response);
 
-// Create the payload array for signing
-const payload = [
-  1, // chain_id
-  1, // nonce
-  '0x2cd8999Be299373D7881f4aDD11510030ad1412F', // recipient
-  '1000000000', // value
-  '0x2cd8999Be299373D7881f4aDD11510030ad1412F', // token
-];
+// Build transaction and prepare signature hash internally
+const prepared = TransactionBuilder.payment({
+  chain_id,
+  nonce,
+  recipient: '0xa128999Be299373D7881f4aDD11510030ad13512',
+  value: '1000000000',
+  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F'
+});
 
-// Generate signature
-const signature = await signMessage(payload, privateKey);
-if (!signature) {
-  throw new Error('Failed to generate signature');
-}
+// Sign with private key
+const signed = await prepared.sign(
+  createPrivateKeySigner(privateKey as `0x${string}`)
+);
 
-// Create the payment payload
-const paymentPayload = {
-  chain_id: 1,
-  nonce: 1,
-  recipient: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
-  value: '1000000000',
-  token: '0x2cd8999Be299373D7881f4aDD11510030ad1412F',
-  signature
-};
+// Build request body with signature
+const paymentPayload = signed.toRequest();
 
 apiClient.transactions.payment(paymentPayload)
   .success(response => {

package/es/__integration__/helpers.d.ts

@@ -1,9 +1,6 @@
 /**
  * Integration test helper utilities
  */
-import type { RestSignature } from '../api/tokens/types';
-import type { TestAccount } from './setup';
-import type { Payload } from '../utils/interface';
 /**
  * Create API client for integration tests
  */
@@ -14,10 +11,6 @@ export declare function createTestClient(): {
     transactions: typeof import("../api/transactions").transactionsApi;
     chain: typeof import("../api/chain").chainApi;
 };
-/**
- * Sign a payload with an account and return RestSignature format
- */
-export declare function signPayload(payload: Payload, account: TestAccount): Promise<RestSignature>;
 /**
  * Wait for a transaction to be finalized
  * @param txHash Transaction hash

package/es/api/checkpoints/types.d.ts

@@ -12,7 +12,6 @@ export interface Header {
     receipts_root: B256Schema;
     number: number;
     timestamp: number;
-    extra_data: string;
 }
 export interface Checkpoint extends Header {
     size?: number;

package/es/api/index.js

@@ -46,7 +46,7 @@ import'viem';import'@ethereumjs/rlp';import axios from'axios';function _typeof(e
             this._restScope = scope || this._restScope;
             // @ts-ignore
             if (this._restScope.length === 0) {
-                console.warn('[1Money client]: The ".rest(cb, scope)" scope is empty and will never be triggered!');
+                console.warn('[1Money SDK]: The ".rest(cb, scope)" scope is empty and will never be triggered!');
             }
             else {
                 let deletedCounter = 0;
@@ -61,7 +61,7 @@ import'viem';import'@ethereumjs/rlp';import axios from'axios';function _typeof(e
                     }
                 });
                 if (deletedCounter === this._restScope.length) {
-                    console.warn(`[1Money client]: The "${this._restScope.join(', ')}" had been called and the "rest" will never be triggered!`);
+                    console.warn(`[1Money SDK]: The "${this._restScope.join(', ')}" had been called and the "rest" will never be triggered!`);
                 }
             }
             return wrapper;
@@ -110,7 +110,7 @@ class Request {
     }
     setting(config) {
         if (!config)
-            return console.warn('[1Money client]: setting method required correct parameters!');
+            return console.warn('[1Money SDK]: setting method required correct parameters!');
         this._config = { ...this._config, ...config };
     }
     request(options) {
@@ -266,7 +266,7 @@ class Request {
                     return;
                 cleanup();
                 const data = err.response?.data ?? {};
-                console.error(`[1Money client]: Error(${err.status ?? 500}, ${err.code ?? 'UNKNOWN'}), Message: ${err.message}, Config: ${err.config?.method}, ${err.config?.baseURL ?? ''}, ${err.config?.url ?? ''}, ${JSON.stringify(err.config?.headers ?? {})}, Request: ${JSON.stringify(err.config?.data ?? {})}, Response: ${JSON.stringify(data)};`);
+                console.error(`[1Money SDK]: Error(${err.status ?? 500}, ${err.code ?? 'UNKNOWN'}), Message: ${err.message}, Config: ${err.config?.method}, ${err.config?.baseURL ?? ''}, ${err.config?.url ?? ''}, ${JSON.stringify(err.config?.headers ?? {})}, Request: ${JSON.stringify(err.config?.data ?? {})}, Response: ${JSON.stringify(data)};`);
                 const status = err.response?.status ?? 500;
                 const headers = err.response?.headers ?? {};
                 try {
@@ -487,6 +487,14 @@ const tokensApi = {
      */
     burnAndBridge: (payload) => {
         return post(`${API_PREFIX$2}/burn_and_bridge`, payload, { withCredentials: false });
+    },
+    /**
+     * Claw back tokens from a wallet
+     * @param payload Token clawback request payload
+     * @returns Promise with transaction hash response
+     */
+    clawbackToken: (payload) => {
+        return post(`${API_PREFIX$2}/clawback`, payload, { withCredentials: false });
     }
 };const API_PREFIX$1 = `/${API_VERSION}/transactions`;
 /**
@@ -520,15 +528,13 @@ const transactionsApi = {
     /**
      * Estimate transaction fee
      * @param from Address of the transaction author
+     * @param to Address of the transaction recipient
      * @param value Value of the transaction
-     * @param token Optional token address
+     * @param token Token address
      * @returns Promise with fee estimate response
      */
-    estimateFee: (from, value, token) => {
-        let url = `${API_PREFIX$1}/estimate_fee?from=${from}&value=${value}`;
-        if (token) {
-            url += `&token=${token}`;
-        }
+    estimateFee: (from, to, value, token) => {
+        const url = `${API_PREFIX$1}/estimate_fee?from=${from}&value=${value}&to=${to}&token=${token}`;
         return get(url, { withCredentials: false });
     },
     /**
@@ -560,6 +566,7 @@ var AuthorityType;
     AuthorityType["ManageList"] = "ManageList";
     AuthorityType["UpdateMetadata"] = "UpdateMetadata";
     AuthorityType["Bridge"] = "Bridge";
+    AuthorityType["Clawback"] = "Clawback";
 })(AuthorityType || (AuthorityType = {}));
 var AuthorityAction;
 (function (AuthorityAction) {

package/es/api/tokens/index.d.ts

@@ -1,5 +1,5 @@
 import type { Hash, HashWithToken } from '../../api/types';
-import type { MintInfo, TokenManageListPayload, TokenBurnPayload, TokenAuthorityPayload, TokenIssuePayload, TokenMintPayload, TokenPausePayload, TokenMetadataPayload, TokenBridgeAndMintPayload, TokenBurnAndBridgePayload } from './types';
+import type { MintInfo, TokenManageListPayload, TokenBurnPayload, TokenAuthorityPayload, TokenIssuePayload, TokenMintPayload, TokenPausePayload, TokenMetadataPayload, TokenBridgeAndMintPayload, TokenBurnAndBridgePayload, TokenClawbackPayload } from './types';
 /**
  * Tokens API methods
  */
@@ -70,5 +70,11 @@ export declare const tokensApi: {
      * @returns Promise with transaction hash response
      */
     burnAndBridge: (payload: TokenBurnAndBridgePayload) => import("../../client/index.js").PromiseWrapper<"custom", Hash, Hash, Hash, import("../../client/index.js").ParsedError<string>, import("../../client/index.js").ParsedError<string> | Hash, import("../../client/index.js").ParsedError<"timeout">, ""> & Promise<Hash>;
+    /**
+     * Claw back tokens from a wallet
+     * @param payload Token clawback request payload
+     * @returns Promise with transaction hash response
+     */
+    clawbackToken: (payload: TokenClawbackPayload) => import("../../client/index.js").PromiseWrapper<"custom", Hash, Hash, Hash, import("../../client/index.js").ParsedError<string>, import("../../client/index.js").ParsedError<string> | Hash, import("../../client/index.js").ParsedError<"timeout">, ""> & Promise<Hash>;
 };
 export default tokensApi;