@dark-fusion-protocol/scl-wallet v1.0.5

scl-wallet

SCL Wallet NPM Package

NPM Library

Initialization

!NOTE An empty SCLWallet object must be created to use the library.

import SclWallet 

var wallet = new SclWallet();

## Create Wallet

### Parameters

| Parameter | Type | Description | Example |
|---|---|---|---|
| wallet_name | string | The name of the wallet. | "WalletName" |
| password | string | The password of the wallet. | "password" |

### Code

```javascript
const result = await wallet.create_wallet(wallet_name, password);

Results

Init

Parameters

Code

const result = await wallet.init(wallet_name, password, network, esplora_url);

Results

Generate Wallet

Parameters

Code

const result = await wallet.generate_wallet(wallet_name, password, seed_phrase);

Results

Has Wallet

Parameters

Code

const result = await wallet.has_wallet(wallet_name);

Results

Generate Seed Phrase

Code

const result = wallet.gen_seed_phrase();

Results

Get Mnemonic

Parameters

Code

const result = await wallet.get_mnemonic(password);

Results

Sync

Code

const result = await wallet.sync();

Results

Sync SCL Balances

Code

const result = await wallet.sync_scl_balances_new();

Results

BTC

Get Balance

Code

const result = wallet.get_balance();

Results

Send BTC

Parameters

Code

const result = await wallet.send_btc(addresses, sats_amount, fee);

Results

Get BTC Transaction History

Code

const result = await wallet.get_btc_tx_history();

Results

[
  {
    "txid": "ed01c5898573a44cec52f8ceb18f6b8f70cb9d1bd7d2c88da1e644b13e678ffa",
    "version": 2,
    "locktime": 0,
    "vin": [
      {
        "txid": "87d03eee9ce5b6a5cbf08ca07f9b81eaedf7229b0a3f94f1b08b48ed19d09975",
        "vout": 2,
        "prevout": {
          "scriptpubkey": "00147feb6476a7b287abb1d049da763071a686030dc0",
          "scriptpubkey_asm": "OP_0 OP_PUSHBYTES_20 7feb6476a7b287abb1d049da763071a686030dc0",
          "scriptpubkey_type": "v0_p2wpkh",
          "scriptpubkey_address": "tb1q0l4kga48k2r6hvwsf8d8vvr356rqxrwq82m6sh",
          "value": 550
        },
        "scriptsig": "",
        "scriptsig_asm": "",
        "witness": [
          "304402201b94e03fe9d1bc8ca7239b874e02a80057c5e7e8a18afd198223d950f5dc58870220542679a3127daadb5fd8941981710a5a8709ca669569cefcacea672b83a0237001",
          "023089049796ed85da5d03eaadf85436973516d326aa38e84bcaeaacc9add4c8eb"
        ],
        "is_coinbase": false,
        "sequence": 4294967295
      },
      {
        "txid": "87d03eee9ce5b6a5cbf08ca07f9b81eaedf7229b0a3f94f1b08b48ed19d09975",
        "vout": 3,
        "prevout": {
          "scriptpubkey": "00147feb6476a7b287abb1d049da763071a686030dc0",
          "scriptpubkey_asm": "OP_0 OP_PUSHBYTES_20 7feb6476a7b287abb1d049da763071a686030dc0",
          "scriptpubkey_type": "v0_p2wpkh",
          "scriptpubkey_address": "tb1q0l4kga48k2r6hvwsf8d8vvr356rqxrwq82m6sh",
          "value": 97950
        },
        "scriptsig": "",
        "scriptsig_asm": "",
        "witness": [
          "3045022100ab0a85c7f4a0631fb3a070d65efaef50495f9b90ce032f4e2d04afb06acde8d1022000c193034f3163fbb534f42739ae5f070f44f46d500cfdf254f77e146e3ccfb501",
          "023089049796ed85da5d03eaadf85436973516d326aa38e84bcaeaacc9add4c8eb"
        ],
        "is_coinbase": false,
        "sequence": 4294967295
      }
    ],
    "vout": [
      {
        "scriptpubkey": "0014463cbe41a13b4f071f895e92c89901db245cddb0",
        "scriptpubkey_asm": "OP_0 OP_PUSHBYTES_20 463cbe41a13b4f071f895e92c89901db245cddb0",
        "scriptpubkey_type": "v0_p2wpkh",
        "scriptpubkey_address": "tb1qgc7tusdp8d8sw8uft6fv3xgpmvj9ehdsmgwv8m",
        "value": 550
      },
      {
        "scriptpubkey": "6a208ff36829d648827b72caa4a693664a35b80b2b0c07c7e1bfa2f0749a2deb68a0",
        "scriptpubkey_asm": "OP_RETURN OP_PUSHBYTES_32 8ff36829d648827b72caa4a693664a35b80b2b0c07c7e1bfa2f0749a2deb68a0",
        "scriptpubkey_type": "op_return",
        "value": 0
      },
      {
        "scriptpubkey": "00147feb6476a7b287abb1d049da763071a686030dc0",
        "scriptpubkey_asm": "OP_0 OP_PUSHBYTES_20 7feb6476a7b287abb1d049da763071a686030dc0",
        "scriptpubkey_type": "v0_p2wpkh",
        "scriptpubkey_address": "tb1q0l4kga48k2r6hvwsf8d8vvr356rqxrwq82m6sh",
        "value": 550
      },
      {
        "scriptpubkey": "00147feb6476a7b287abb1d049da763071a686030dc0",
        "scriptpubkey_asm": "OP_0 OP_PUSHBYTES_20 7feb6476a7b287abb1d049da763071a686030dc0",
        "scriptpubkey_type": "v0_p2wpkh",
        "scriptpubkey_address": "tb1q0l4kga48k2r6hvwsf8d8vvr356rqxrwq82m6sh",
        "value": 95900
      }
    ],
    "size": 445,
    "weight": 1129,
    "fee": 1500,
    "status": {
      "confirmed": true,
      "block_height": 2576116,
      "block_hash": "00000000016d66d2436ce1a2923c6d59434906827ca077d457e2bc04d60488dc",
      "block_time": 1706536149
    }
  }
]

SCL

Get SCL Balance

Code

const result = wallet.get_scl_balance();

Results

Send SCL

Parameters

Code

const result = await wallet.send_scl(addresses, scl_amount, contract_id, fee);

Results

Get Transaction History

Parameters

Code

const result = await wallet.get_tx_history(contract_id);

Results

Fees

Estimate Fee BTC

Parameters

Code

const result = await wallet.estimate_fee_btc(addresses, amount, number_of_blocks);

Results

Estimate Fee SCL

Parameters

Code

const result = await wallet.estimate_fee_scl(addresses, amount, contract_id, number_of_blocks);

Results

Estimate Fee Mint

Parameters

Code

const result = await wallet.estimate_fee_mint(number_of_blocks);

Results

Estimate Fee List

Parameters

{
	"contract_id": "de3e6478bf37224a58be08ab7b8b7094400e0edcff5a829248b1fd02f5d7f0e1",
	"amount": 100000,
	"price_per_token": 2500
},
{
	"contract_id": "09f590fc69175307307af184c2c53358a40630eddce420a45b14a959b8d03bd3",
	"amount": 100000,
	"price_per_token": 2500
}

Code

const result = await wallet.estimate_fee_list(list_order_json, number_of_blocks);

Results

Estimate Fee List Cancel

Parameters

Code

const result = await wallet.estimate_fee_cancel_listing(list_order_json, number_of_blocks);

Results

Estimate Fee Bid

Parameters

{
	"contract_id": "de3e6478bf37224a58be08ab7b8b7094400e0edcff5a829248b1fd02f5d7f0e1",
	"orders": [
		{
			"order_id": "06d9a1a4b1c6a622de362a51567b010979898aa9891ca71a5a56596dbfbc38e8",
			"purchase_amount": 100000,
			"purchase_price": 2500,
			"pay_address": "tb1qategau6gdfakhhf4n23dtg47eht6225ypfcvv2",
			"listing_utxo": "dba8b3df2aaaa9c9a9e61a4ac61f2fabe5bd6cb2682dc4a17cbf9af3ae16e548:1"
		},
		{
			"order_id": "25bf5e449ccb2c817e2323b571f96f694ff53c89cca88dd40ec93bf83d2eb443",
			"purchase_amount": 10000,
			"purchase_price": 4500,
			"pay_address": "tb1qategau6gdfakhhf4n23dtg47eht6225ypfcvv2",
			"listing_utxo": "dba8b3df2aaaa9c9a9e61a4ac61f2fabe5bd6cb2682dc4a17cbf9af3ae16e548:1"
		}
	]
}

Code

const result = await wallet.estimate_fee_bid(bid_order_json, number_of_blocks);

Results

Estimate Fee Bid Cancel

Parameters

Code

const result = await wallet.estimate_fee_cancel_bid(number_of_blocks);

Results

Estimate Fee Airdop

Parameters

Code

const result = await wallet.estimate_fee_airdrop(number_of_airdops, number_of_blocks);

Results

Contracts

Import Contract

Parameters

{
	"contract_id":"bdcdc39f36353082e4bc1025bb45ab7a50afe07950355a1fed4640ce8f469b60",
	"ticker":"TEST 200",
	"rest_url":"http://13.23.87.456:8080/",
	"contract_type":"SCL01",
	"decimals":8
}

Code

const result = await wallet.import_contract(contract_json);

Results

Delete Contract

Parameters

Code

const result = await wallet.delete_contract(contract_id);

Results

Get Contract

Parameters

Code

const result = await wallet.get_contract(contract_id);

Results

Get Contracts

Code

const result = await wallet.get_contracts();

Results

Minting

Mint SCL01 Contract

Parameters

Code

const result = await wallet.mint_scl01_contract(ticker, max_supply, decimals, fee);

Results

Mint SCL02 Contract

Parameters

Code

const result = await wallet.mint_scl02_contract(ticker, max_supply, decimals, fee, airdrop_amount);

Results

Mint SCL03 Contract

Parameters

Code

const result = await wallet.mint_scl03_contract(ticker, decimals, address, amount, fee);

Results

Right to Mint

Parameters

Code

const result = await wallet.mint_token_rtm(rights_utxo, rights_address, fee);

Results

Listing

Create Listing

Parameters

{
	"contract_id": "de3e6478bf37224a58be08ab7b8b7094400e0edcff5a829248b1fd02f5d7f0e1",
	"amount": 100000,
	"price_per_token": 2500
},
{
	"contract_id": "09f590fc69175307307af184c2c53358a40630eddce420a45b14a959b8d03bd3",
	"amount": 100000,
	"price_per_token": 2500
}

Code

const result = await wallet.list_token_batch(list_order_json, fee);

Results

Cancel Listing

Parameters

Code

const result = await wallet.cancel_listing(listing_utxo, fee);

Results

Bidding

Create Bid

Parameters

{
	"contract_id": "de3e6478bf37224a58be08ab7b8b7094400e0edcff5a829248b1fd02f5d7f0e1",
	"orders": [
		{
			"order_id": "06d9a1a4b1c6a622de362a51567b010979898aa9891ca71a5a56596dbfbc38e8",
			"purchase_amount": 100000,
			"purchase_price": 2500,
			"pay_address": "tb1qategau6gdfakhhf4n23dtg47eht6225ypfcvv2",
			"listing_utxo": "dba8b3df2aaaa9c9a9e61a4ac61f2fabe5bd6cb2682dc4a17cbf9af3ae16e548:1"
		},
		{
			"order_id": "25bf5e449ccb2c817e2323b571f96f694ff53c89cca88dd40ec93bf83d2eb443",
			"purchase_amount": 10000,
			"purchase_price": 4500,
			"pay_address": "tb1qategau6gdfakhhf4n23dtg47eht6225ypfcvv2",
			"listing_utxo": "dba8b3df2aaaa9c9a9e61a4ac61f2fabe5bd6cb2682dc4a17cbf9af3ae16e548:1"
		}
	]
}

Code

const result = await wallet.place_bid_batch(bid_order_json, fee);

Results

Accept Bid

Parameters

Code

const result = await wallet.accept_bid(unsigned_tx_hex, fulfil_tx, contract_id);

Results

Cancel Bid

Parameters

Code

const result = await wallet.cancel_bid(bid_utxo, fee);

Results

Airdrop

Claim Airdrop

Parameters

Code

const result = await wallet.airdrop(contract_ids, fee);

Results

Create Diminishing Airdrop

Parameters

Code

const result = await wallet.create_diminishing_airdrop(contract_id, pool_amount, stepdown_amount, stepdown_period, max_amount, min_amount, single, fee);

Results

Claim Diminishing Airdrop

Parameters

Code

const result = await wallet.claim_diminishing_airdrop(contract_id, dimairdop_id, fee);

Results

Drips

Create Drip

Parameters

Code

const result = await wallet.drip_scl(addresses, amount, contract_id, duration, fee);

Results

Create DGE

Parameters

Code

const result = await wallet.create_dge(contract_id, pool_amount, sats_rate, max_drop, drip_duration, donation_address, single_drop, fee);

Results

Claim DGE

Parameters

Code

const result = await wallet.claim_dge(contract_id, dge_id, donation_address, amount, fee);

Results

Utilities

New Address

Code

const result = wallet.new_address();

Results

Is Address

Parameters

Code

const result = wallet.is_address(address);

Results