refactor 2

[xhliu]

setConstructor -> init

scrypt-ord/tests/contracts/nftCounter.ts

Line 11 in 09dbe2a

this.setConstructor(counter)

[xhliu]

scrypt-ord/src/contracts/onesatNFT.ts

Line 71 in 09dbe2a

contentType: 'text/plain',

This is not raw hex, just a string

scrypt-ord/src/inscription.ts

Line 5 in 09dbe2a

/** contentType in raw hex */

[xhliu]

https://github.com/sCrypt-Inc/scrypt-ord/blob/09dbe2ad0d36f240055e8729027b97c4305b2922/tests/specs/hashPuzzle.spec.ts#L17C18-L17C24
const tick = toByteString('DOGE', true),

lim = max / 10
amt = lim

https://github.com/sCrypt-Inc/scrypt-ord/blob/master/tests/specs/hashPuzzle.spec.ts#L19-L21

move all to before()

scrypt-ord/tests/specs/hashPuzzle.spec.ts

Lines 30 to 39 in 09dbe2a

	const hashPuzzle = new HashPuzzle(
	toByteString(tick, true),
	max,
	lim,
	sha256(message1)
	)
	await hashPuzzle.connect(getDefaultSigner())
	await hashPuzzle.deployToken()
	await hashPuzzle.mint(amt)

[xhliu]

Looks like first output is token change? If yes, let's move it to the last, as sat change.

scrypt-ord/tests/specs/hashPuzzle.spec.ts

Line 63 in 09dbe2a

const { tx } = await next0.methods.unlock(message1)

Also, add comments throughout to explain, e.g.,

1. what are nexts?
2. Why is this a burn?
3. What are outputs when callContract?

[xhliu]

https://github.com/sCrypt-Inc/scrypt-ord/blob/09dbe2ad0d36f240055e8729027b97c4305b2922/src/contracts/bsv20V1.ts
Let's put inscription at the beginning everywhere.

[xhliu]

Change to any amount other than 1, which is confusing to 1sat.

scrypt-ord/tests/contracts/ftCounter.ts

Line 29 in 09dbe2a

BSV20V1.buildTransferOutput(address, this.tick, 1n) +

[xhliu]

Rename build1SatStateOutput -> buildStateOutputFT & buildStateOutputNFT. 1Sat is too general here.
https://github.com/sCrypt-Inc/scrypt-ord/blob/09dbe2ad0d36f240055e8729027b97c4305b2922/tests/contracts/ftCounter.ts#L28C31-L28C31

[xhliu]

Rename changeAmt -> changeTokenAmt
https://github.com/sCrypt-Inc/scrypt-ord/blob/09dbe2ad0d36f240055e8729027b97c4305b2922/tests/specs/ftCounter.spec.ts#L47C19-L47C28

[xhliu]

Add comments for all files under https://github.com/sCrypt-Inc/scrypt-ord/tree/master/src/contracts, at least for all top-level functions.

[zhfnjust]

Looks like first output is token change? If yes, let's move it to the last, as sat change.

scrypt-ord/tests/specs/hashPuzzle.spec.ts

Line 63 in 09dbe2a

const { tx } = await next0.methods.unlock(message1)

Also, add comments throughout to explain, e.g.,

1. what are nexts?
2. Why is this a burn?
3. What are outputs when callContract?

1. update transfer() returns , no more nexts, just

Promise<{
        /** The method calling tx */
        tx: bsv.Transaction;
        changeInstance: BSV20V1 | null
        receivers: Array<BSV20V1>
    }>

2. add a burn method, so don't need to tell why this is a burn.
3. first output is a instance holds change token amt, the secound output is the first receiver, the third output is the secound receiver. last output is change output.

[xhliu]

hash160 -> pubKey2Addr

scrypt-ord/src/contracts/ordP2PKH.ts

Line 36 in 0ac28b5

assert(hash160(pubkey) == this.addr, 'public key hashes are not equal')

[xhliu]

const tick = toByteString('DOGE', true)
https://github.com/sCrypt-Inc/scrypt-ord/blob/master/tests/specs/hashPuzzle.spec.ts#L12C5-L12C24

[xhliu]

Let's make the API as close to the original sCrypt (without ordinals) as possible. It is still sCrypt but extended to support ordinals.

const recipients =                     [
                        {
                            instance: new HashPuzzle(
                                toByteString(tick, true),
                                max,
                                lim,
                                sha256(message2)
                            ),
                            amt: 10n,
                        },
                    ]
const { tx, atInputIndex } = await hashPuzzle.methods.unlock(message1, { transfer: recipients, tokenChangeAddress: tokenChangeAddr} as OrdMethodCallOptions)

OrdMethodCallOptions extends MethodCallOptions. tokenChangeAddress behaves same as changeAddress: if not set, token change goes to signer.getDefaultAddress().

scrypt-ord/tests/specs/hashPuzzle.spec.ts

Lines 37 to 52 in 0ac28b5

	const { tx, tokenChangeP2PKH, receivers } =
	await hashPuzzle.transfer(
	[
	{
	instance: new HashPuzzle(
	toByteString(tick, true),
	max,
	lim,
	sha256(message2)
	),
	amt: 10n,
	},
	],
	'unlock',
	message1
	)

[xhliu]

Make

scrypt-ord/tests/specs/hashPuzzle.spec.ts

Line 35 in 0ac28b5

it('transfer to an other hashPuzzle and withdraw.', async () => {

similar to
https://github.com/sCrypt-Inc/boilerplate/blob/5670d548bbc0d7502f037bb0ae20862ca58a89f9/tests/counter.test.ts#L11

Call/transfer multiple times in a chain of txs.

[xhliu]

No need to specially handle withdraw, it's just another transfer to an instance. I suggest removing it.

scrypt-ord/tests/specs/hashPuzzle.spec.ts

Lines 61 to 79 in 62d5ee7

	const withdraw = async () => {
	const address = await hashPuzzle.signer.getDefaultAddress()
	const recipients = [
	{
	instance: OrdP2PKH.fromAddress(address),
	amt: hashPuzzle.getAmt(),
	},
	]
	const { tx } = await hashPuzzle.methods.unlock(
	toByteString(`hello, sCrypt!:3`, true),
	{
	transfer: recipients,
	}
	)
	console.log('withdraw tx: ', tx.id)
	}
	await expect(withdraw()).not.rejected

[xhliu]

Does it support inscribing NFT to a p2pkh? https://github.com/sCrypt-Inc/scrypt-ord/blob/master/src/contracts/ordP2PKH.ts#L25

[xhliu]

Move this out of contracts folder to, say, src/utils.ts.

[xhliu]

ordP2PKH = new OrdP2PKH(address)

scrypt-ord/tests/specs/ordP2PKH.spec.ts

Line 18 in 62d5ee7

ordP2PKH = OrdP2PKH.fromAddress(address)

Same everywhere

scrypt-ord/tests/specs/fromTxHashPuzzle.spec.ts

Line 50 in 62d5ee7

instance: OrdP2PKH.fromAddress(address),

[xhliu]

No need to specially handle p2pkh. Can we use the generalized transfer, or remove the whole test file?
https://github.com/sCrypt-Inc/scrypt-ord/blob/62d5ee7a9e7662f7ebb5aa60b359aab402566f25/tests/specs/ordP2PKH.spec.ts

E.g., this can be just like any other transfer: ordP2PKH.methods.unlock

scrypt-ord/tests/specs/ordP2PKH.spec.ts

Line 27 in 62d5ee7

const { tx, nexts } = await ordP2PKH.transferBsv20(

[xhliu]

Just reuse fromTx() from contractID https://docs.scrypt.io/how-to-deploy-and-call-a-contract/call-deployed#interact. Again, make API as close as before.

scrypt-ord/tests/specs/fromTxHashPuzzle.spec.ts

Line 34 in 62d5ee7

hashPuzzle = HashPuzzle.fromUTXO(

Do NOT need tx details to call, such as

scrypt-ord/tests/specs/fromTxHashPuzzle.spec.ts

Line 28 in 62d5ee7

script: '0063036f726451126170706c69636174696f6e2f6273762d323000367b2270223a226273762d3230222c226f70223a227472616e73666572222c227469636b223a224c554e43222c22616d74223a2236227d6800000000044c554e4304406f400104406f400120eb2c9ad39d81bbe2acbec6f42859d94f86226186838560f3a698d9047f49ce72615379577a75567a567a567a567a567a567a51587a75577a577a577a577a577a577a577a0079567a75557a557a557a557a557a757575756151795579a88777777777776a00010200000000',

[xhliu]

This is gonna cover #5?

[xhliu]

Merge https://github.com/sCrypt-Inc/scrypt-ord/blob/master/tests/specs/skipTokenChange.spec.ts into https://github.com/sCrypt-Inc/scrypt-ord/blob/master/tests/specs/hashPuzzle.spec.ts, since lots of same code.

[xhliu]

Let's remove all places where p2pkh is treated differently from a contract. It is just ONE contract.
Like

scrypt-ord/src/contracts/onesatNFT.ts

Line 121 in 62d5ee7

static send2Contract(

[zhfnjust]

Does it support inscribing NFT to a p2pkh? https://github.com/sCrypt-Inc/scrypt-ord/blob/master/src/contracts/ordP2PKH.ts#L25

yes

[zhfnjust]

Do NOT need tx details to call, such as

yes

[xhliu]

Use a CONST variable for this magic number. Same everywhere.

const P2pkhScriptLen = 50

scrypt-ord/src/contracts/ordP2PKH.ts

Line 54 in 182478c

? ls.toHex().slice(50)

scrypt-ord/src/contracts/ordP2PKH.ts

Line 100 in 182478c

const nopScript = bsv.Script.fromHex(utxo.script.slice(50))

[xhliu]

readonly and comment saying it's dummy. @zhfnjust

scrypt-ord/src/contracts/bsv20V1.ts

Line 36 in dba56bc

isBSV20V1: boolean

[xhliu]

@zhfnjust close this after all is fixed.

[zhfnjust]

Add comments for all files under https://github.com/sCrypt-Inc/scrypt-ord/tree/master/src/contracts, at least for all top-level functions.

#37