@btc-vision/btc-runtime 1.5.2 → 1.5.4

package/README.md

@@ -31,13 +31,13 @@ execution while integrating deeply with Bitcoin's decentralized architecture.
 
 ### Features
 
-- **AssemblyScript and WebAssembly:** Efficient and high-performance contract execution using WebAssembly.
-- **Bitcoin Integration:** Direct interaction with Bitcoin L1, enabling the creation of decentralized applications that
-  operate on the Bitcoin network.
-- **Comprehensive Storage Management:** Flexible and secure storage management using primary pointers and sub-pointers,
-  ensuring data integrity through cryptographic proofs.
-- **Event Handling:** Sophisticated event system for contract state changes, allowing easy tracking and logging of
-  contract activities.
+-   **AssemblyScript and WebAssembly:** Efficient and high-performance contract execution using WebAssembly.
+-   **Bitcoin Integration:** Direct interaction with Bitcoin L1, enabling the creation of decentralized applications that
+    operate on the Bitcoin network.
+-   **Comprehensive Storage Management:** Flexible and secure storage management using primary pointers and sub-pointers,
+    ensuring data integrity through cryptographic proofs.
+-   **Event Handling:** Sophisticated event system for contract state changes, allowing easy tracking and logging of
+    contract activities.
 
 ## Installation
 
@@ -105,7 +105,7 @@ import {
     Map,
     OP20InitParameters,
     Selector,
-    AddressMap
+    AddressMap,
 } from '@btc-vision/btc-runtime/runtime';
 import { u128, u256 } from 'as-bignum/assembly';
 
@@ -142,7 +142,7 @@ export class MyToken extends DeployableOP_20 {
     }
 
     private airdrop(calldata: Calldata): BytesWriter {
-        this.onlyOwner(Blockchain.tx.sender);
+        this.onlyDeployer(Blockchain.tx.sender);
 
         const drops: AddressMap<u256> = calldata.readAddressValueTuple();
 
@@ -169,7 +169,7 @@ export class MyToken extends DeployableOP_20 {
     }
 
     private airdropWithAmount(calldata: Calldata): BytesWriter {
-        this.onlyOwner(Blockchain.tx.sender);
+        this.onlyDeployer(Blockchain.tx.sender);
 
         const amount: u256 = calldata.readU256();
         const addresses: Address[] = calldata.readAddressArray();
@@ -211,11 +211,11 @@ class ComplexData extends Serializable {
 
 For more detailed explanations on specific topics, refer to the individual documentation files:
 
-- [Blockchain.md](docs/Blockchain.md)
-- [Contract.md](docs/Contract.md)
-- [Events.md](docs/Events.md)
-- [Pointers.md](docs/Pointers.md)
-- [Storage.md](docs/Storage.md)
+-   [Blockchain.md](docs/Blockchain.md)
+-   [Contract.md](docs/Contract.md)
+-   [Events.md](docs/Events.md)
+-   [Pointers.md](docs/Pointers.md)
+-   [Storage.md](docs/Storage.md)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@btc-vision/btc-runtime",
-  "version": "1.5.2",
+  "version": "1.5.4",
   "description": "Bitcoin Smart Contract Runtime",
   "main": "btc/index.ts",
   "scripts": {},

package/runtime/buffer/BytesReader.ts

@@ -329,12 +329,12 @@ export class BytesReader {
     }
 
     public readTransactionInputs(): TransactionInput[] {
-        const length = this.readU8();
+        const length = this.readU16();
         const result = new Array<TransactionInput>(length);
 
         for (let i: u16 = 0; i < length; i++) {
             const txId = this.readBytes(32);
-            const outputIndex = this.readU8();
+            const outputIndex = this.readU16();
             const scriptSig = this.readBytesWithLength();
             result[i] = new TransactionInput(txId, outputIndex, scriptSig);
         }
@@ -343,11 +343,11 @@ export class BytesReader {
     }
 
     public readTransactionOutputs(): TransactionOutput[] {
-        const length = this.readU8();
+        const length = this.readU16();
         const result = new Array<TransactionOutput>(length);
 
         for (let i: u16 = 0; i < length; i++) {
-            const index = this.readU8();
+            const index = this.readU16();
             const scriptPubKey = this.readStringWithLength();
             const value = this.readU64();
             result[i] = new TransactionOutput(index, scriptPubKey, value);

package/runtime/contracts/DeployableOP_20.ts

@@ -9,16 +9,16 @@ import { Address } from '../types/Address';
 import { Revert } from '../types/Revert';
 import { SafeMath } from '../types/SafeMath';
 
+import { sha256 } from '../env/global';
+import { EMPTY_POINTER } from '../math/bytes';
+import { AddressMemoryMap } from '../memory/AddressMemoryMap';
+import { MapOfMap } from '../memory/MapOfMap';
 import { ApproveStr, TransferFromStr, TransferStr } from '../shared-libraries/TransferHelper';
 import { Calldata } from '../types';
 import { ADDRESS_BYTE_LENGTH, BOOLEAN_BYTE_LENGTH, U256_BYTE_LENGTH } from '../utils';
 import { IOP_20 } from './interfaces/IOP_20';
 import { OP20InitParameters } from './interfaces/OP20InitParameters';
 import { OP_NET } from './OP_NET';
-import { sha256 } from '../env/global';
-import { EMPTY_POINTER } from '../math/bytes';
-import { MapOfMap } from '../memory/MapOfMap';
-import { AddressMemoryMap } from '../memory/AddressMemoryMap';
 
 const nonceMapPointer: u16 = Blockchain.nextPointer;
 const maxSupplyPointer: u16 = Blockchain.nextPointer;
@@ -84,12 +84,15 @@ export abstract class DeployableOP_20 extends OP_NET implements IOP_20 {
         return this._symbol.value;
     }
 
-    public instantiate(params: OP20InitParameters, skipOwnerVerification: boolean = false): void {
+    public instantiate(
+        params: OP20InitParameters,
+        skipDeployerVerification: boolean = false,
+    ): void {
         if (!this._maxSupply.value.isZero()) {
             throw new Revert('Already initialized');
         }
 
-        if (!skipOwnerVerification) this.onlyDeployer(Blockchain.tx.sender);
+        if (!skipDeployerVerification) this.onlyDeployer(Blockchain.tx.sender);
 
         if (params.decimals > 32) {
             throw new Revert('Decimals can not be more than 32');
@@ -446,8 +449,8 @@ export abstract class DeployableOP_20 extends OP_NET implements IOP_20 {
         this.emitEvent(approveEvent);
     }
 
-    protected createMintEvent(owner: Address, value: u256): void {
-        const mintEvent = new MintEvent(owner, value);
+    protected createMintEvent(recipient: Address, value: u256): void {
+        const mintEvent = new MintEvent(recipient, value);
         this.emitEvent(mintEvent);
     }
 

package/runtime/contracts/OP_NET.ts

@@ -17,14 +17,11 @@ export class OP_NET implements IBTC {
         return Blockchain.contractDeployer;
     }
 
-    public onDeployment(_calldata: Calldata): void {
-    }
+    public onDeployment(_calldata: Calldata): void {}
 
-    public onExecutionStarted(): void {
-    }
+    public onExecutionStarted(): void {}
 
-    public onExecutionCompleted(): void {
-    }
+    public onExecutionCompleted(): void {}
 
     public execute(method: Selector, _calldata: Calldata): BytesWriter {
         let response: BytesWriter;
@@ -55,7 +52,7 @@ export class OP_NET implements IBTC {
 
     protected onlyDeployer(caller: Address): void {
         if (this.contractDeployer !== caller) {
-            throw new Revert('Only owner can call this method');
+            throw new Revert('Only deployer can call this method');
         }
     }
 }

package/runtime/env/classes/UTXO.ts

@@ -2,7 +2,7 @@
 export class TransactionInput {
     public constructor(
         public readonly txId: Uint8Array,
-        public readonly outputIndex: u8,
+        public readonly outputIndex: u16,
         public readonly scriptSig: Uint8Array,
     ) {
     }
@@ -11,7 +11,7 @@ export class TransactionInput {
 @final
 export class TransactionOutput {
     public constructor(
-        public readonly index: u8,
+        public readonly index: u16,
         public readonly to: string,
         public readonly value: u64,
     ) {

package/runtime/storage/arrays/StoredAddressArray.ts

@@ -1,7 +1,6 @@
-import { BytesReader } from '../../buffer/BytesReader';
 import { BytesWriter } from '../../buffer/BytesWriter';
 import { Blockchain } from '../../env';
-import { addUint8ArraysBE, u64ToBE32Bytes } from '../../math/bytes';
+import { addUint8ArraysBE, encodeBasePointer, readLengthAndStartIndex, u64ToBE32Bytes } from '../../math/bytes';
 import { Address } from '../../types/Address';
 import { Revert } from '../../types/Revert';
 
@@ -38,25 +37,15 @@ export class StoredAddressArray {
             `You must pass a 30 bytes sub-pointer. (AddressArray, got ${subPointer.length})`,
         );
 
-        // Construct base pointer as a 32-byte array
-        const writer = new BytesWriter(32);
-        writer.writeU16(pointer);
-        writer.writeBytes(subPointer);
+        const basePointer = encodeBasePointer(pointer, subPointer);
+        this.lengthPointer = Uint8Array.wrap(basePointer.buffer);
+        this.baseU256Pointer = basePointer;
 
-        // We'll reuse the same bytes as the "base pointer" for offsets
-        const baseU256Pointer = writer.getBuffer(); // 32 bytes
-        // For length+startIndex, we'll use the same pointer
-        const lengthPointer = Uint8Array.wrap(baseU256Pointer.buffer);
+        const storedLenStart = Blockchain.getStorageAt(basePointer);
+        const data = readLengthAndStartIndex(storedLenStart);
 
-        // Load length + startIndex from storage (16 bytes: 8 for length, 8 for startIndex).
-        const storedLengthAndStartIndex: Uint8Array = Blockchain.getStorageAt(lengthPointer);
-
-        const reader = new BytesReader(storedLengthAndStartIndex);
-        this._length = reader.readU64();
-        this._startIndex = reader.readU64();
-
-        this.lengthPointer = lengthPointer;
-        this.baseU256Pointer = baseU256Pointer;
+        this._length = data[0];
+        this._startIndex = data[1];
     }
 
     /** Get an element by its global index. */

package/runtime/storage/arrays/StoredBooleanArray.ts

@@ -1,8 +1,15 @@
 import { BytesWriter } from '../../buffer/BytesWriter';
-import { BytesReader } from '../../buffer/BytesReader';
 import { Blockchain } from '../../env';
 import { Revert } from '../../types/Revert';
-import { addUint8ArraysBE, GET_EMPTY_BUFFER, getBit, setBit, u64ToBE32Bytes } from '../../math/bytes';
+import {
+    addUint8ArraysBE,
+    encodeBasePointer,
+    GET_EMPTY_BUFFER,
+    getBit,
+    readLengthAndStartIndex,
+    setBit,
+    u64ToBE32Bytes,
+} from '../../math/bytes';
 
 /**
  * @class StoredBooleanArray
@@ -42,22 +49,15 @@ export class StoredBooleanArray {
     ) {
         assert(subPtr.length <= 30, `You must pass a 30 bytes sub-pointer. (StoredBooleanArray, got ${subPtr.length})`);
 
-        const writer = new BytesWriter(32);
-        writer.writeU16(pointer);
-        writer.writeBytes(subPtr);
-
-        const basePtr = writer.getBuffer();
+        const basePointer = encodeBasePointer(pointer, subPtr);
+        this.lengthPointer = Uint8Array.wrap(basePointer.buffer);
+        this.basePointer = basePointer;
 
-        this.basePointer = basePtr;
-        this.lengthPointer = basePtr;
+        const storedLenStart = Blockchain.getStorageAt(basePointer);
+        const data = readLengthAndStartIndex(storedLenStart);
 
-        const storedLenStart: Uint8Array = Blockchain.getStorageAt(
-            this.lengthPointer,
-        );
-
-        const r = new BytesReader(storedLenStart);
-        this._length = r.readU64();
-        this._startIndex = r.readU64();
+        this._length = data[0];
+        this._startIndex = data[1];
     }
 
     // -------------- Public Accessors -------------- //
@@ -187,12 +187,11 @@ export class StoredBooleanArray {
 
         // 2) If length or startIndex changed, store them
         if (this._isChangedLength || this._isChangedStartIndex) {
-            const w = new BytesWriter(16);
+            const w = new BytesWriter(32);
             w.writeU64(this._length);
             w.writeU64(this._startIndex);
 
-            const data = w.getBuffer(); // 16 bytes
-            // You could store 32 bytes if you prefer; the leftover bytes can be 0
+            const data = w.getBuffer();
             Blockchain.setStorageAt(this.lengthPointer, data);
 
             this._isChangedLength = false;
@@ -215,9 +214,7 @@ export class StoredBooleanArray {
         }
 
         // also reset length + startIndex in storage
-        const writer = new BytesWriter(16);
-        writer.writeU64(0);
-        writer.writeU64(0);
+        const writer = new BytesWriter(32);
         Blockchain.setStorageAt(this.lengthPointer, writer.getBuffer());
 
         // reset in memory