@twin.org/dlt-iota 0.0.2-next.9 → 0.0.3-next.10

package/README.md

@@ -1,6 +1,6 @@
 # TWIN DLT IOTA
 
-DLT helpers for use with IOTA.
+This package provides utilities for integrating applications with IOTA distributed ledger capabilities, including client construction, transaction submission, sponsored transaction support, and smart contract migration helpers. It is intended for services that need a reliable and repeatable approach to ledger operations without rebuilding common primitives.
 
 ## Installation
 
@@ -8,94 +8,12 @@ DLT helpers for use with IOTA.
 npm install @twin.org/dlt-iota
 ```
 
-## Testing
+## Docker
 
-The tests developed are functional tests and need an instance of the IOTA Gas Station and Redis up and running.
-
-### Quick Setup (Recommended)
-
-The simplest way to set up the testing environment using our unified container:
-
-```shell
-# Start the unified container with Redis + Gas Station
-docker run -d --name twin-gas-station-test \
-  -p 6379:6379 -p 9527:9527 -p 9184:9184 \
-  twinfoundation/twin-gas-station-test:latest
-
-# Wait a moment for services to start, then verify
-docker exec twin-gas-station-test redis-cli ping  # Should return: PONG
-curl http://localhost:9527/  # Should return: OK
-
-# Services are ready - you can now run tests
-npm run test
-
-# When finished, cleanup
-docker stop twin-gas-station-test && docker rm twin-gas-station-test
-```
-
-That's it! The unified container includes:
-
-- Redis server (port 6379)
-- IOTA Gas Station (port 9527, metrics 9184)
-- Pre-configured with test keypair and settings
-- Health checks and proper startup sequencing
-
-### Alternative Setup Methods
-
-For advanced users who prefer alternative setups:
-
-#### Option A: Standalone Docker Images
-
-If you prefer to run services separately:
-
-```shell
-# Pull the required Docker images
-docker pull redis:7-alpine
-docker pull iotaledger/gas-station:latest
-
-# Start Redis
-docker run -d --name gas-station-redis -p 6379:6379 redis:7-alpine
-
-# Create gas station config file
-cat > gas-station-config.yaml << EOF
-signer-config:
-  local:
-    keypair: AKT1Ghtd+yNbI9fFCQin3FpiGx8xoUdJMe7iAhoFUm4f
-rpc-host-ip: 0.0.0.0
-rpc-port: 9527
-metrics-port: 9184
-storage-config:
-  redis:
-    redis_url: "redis://127.0.0.1:6379"
-fullnode-url: "https://api.testnet.iota.cafe"
-coin-init-config:
-  target-init-balance: 100000000
-  refresh-interval-sec: 86400
-daily-gas-usage-cap: 1500000000000
-access-controller:
-  access-policy: disabled
-EOF
-
-# Start IOTA Gas Station
-docker run -d --name gas-station \
-  -p 9527:9527 -p 9184:9184 \
-  -v $(pwd)/gas-station-config.yaml:/config/config.yaml \
-  --network host \
-  -e GAS_STATION_AUTH=qEyCL6d9BKKFl/tfDGAKeGFkhUlf7FkqiGV7Xw4JUsI= \
-  iotaledger/gas-station:latest \
-  --config-path /config/config.yaml
-```
-
-#### Option B: Docker Compose
-
-Using the IOTA gas station repository:
+To perform testing of this component it may be necessary to launch a local instance of the gas station to communicate with.
 
 ```shell
-# Clone and setup gas station repository
-git clone https://github.com/iotaledger/gas-station.git
-cd gas-station/docker
-../target/debug/tool generate-sample-config --docker-compose --config-path config.yaml --network testnet
-GAS_STATION_AUTH=qEyCL6d9BKKFl/tfDGAKeGFkhUlf7FkqiGV7Xw4JUsI= docker-compose up -d
+docker run -d --name twin-gas-station-test -p 6379:6379 -p 9527:9527 -p 9184:9184 -e IOTA_NODE_URL="https://api.testnet.iota.cafe" -e GAS_STATION_AUTH="qEyCL6d9BKKFl/tfDGAKeGFkhUlf7FkqiGV7Xw4JUsI=" twinfoundation/twin-gas-station-test:latest
 ```
 
 ## Examples

package/dist/es/index.js

@@ -0,0 +1,24 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./iota.js";
+export * from "./iotaIdentityUtils.js";
+export * from "./iotaSmartContractUtils.js";
+export * from "./models/IAdminCapFields.js";
+export * from "./models/IContractData.js";
+export * from "./models/IGasReservationResult.js";
+export * from "./models/IGasStationConfig.js";
+export * from "./models/IGasStationExecuteResponse.js";
+export * from "./models/IGasStationReserveGasResponse.js";
+export * from "./models/IGasStationReserveGasResult.js";
+export * from "./models/IIotaClient.js";
+export * from "./models/IIotaControllerCapInfo.js";
+export * from "./models/IIotaTransaction.js";
+export * from "./models/IIotaTransactionBlockResponse.js";
+export * from "./models/IIotaConfig.js";
+export * from "./models/IIotaDryRun.js";
+export * from "./models/IIotaResponseOptions.js";
+export * from "./models/IMigrationStateFields.js";
+export * from "./models/ISmartContractDeployments.js";
+export * from "./models/ISmartContractObject.js";
+export * from "./models/networkTypes.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,WAAW,CAAC;AAC1B,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wCAAwC,CAAC;AACvD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yBAAyB,CAAC;AACxC,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,uCAAuC,CAAC;AACtD,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./iota.js\";\nexport * from \"./iotaIdentityUtils.js\";\nexport * from \"./iotaSmartContractUtils.js\";\nexport * from \"./models/IAdminCapFields.js\";\nexport * from \"./models/IContractData.js\";\nexport * from \"./models/IGasReservationResult.js\";\nexport * from \"./models/IGasStationConfig.js\";\nexport * from \"./models/IGasStationExecuteResponse.js\";\nexport * from \"./models/IGasStationReserveGasResponse.js\";\nexport * from \"./models/IGasStationReserveGasResult.js\";\nexport * from \"./models/IIotaClient.js\";\nexport * from \"./models/IIotaControllerCapInfo.js\";\nexport * from \"./models/IIotaTransaction.js\";\nexport * from \"./models/IIotaTransactionBlockResponse.js\";\nexport * from \"./models/IIotaConfig.js\";\nexport * from \"./models/IIotaDryRun.js\";\nexport * from \"./models/IIotaResponseOptions.js\";\nexport * from \"./models/IMigrationStateFields.js\";\nexport * from \"./models/ISmartContractDeployments.js\";\nexport * from \"./models/ISmartContractObject.js\";\nexport * from \"./models/networkTypes.js\";\n"]}