postage: add create endpoint #1142

ralph-pichler · 2021-01-21T15:57:47Z

adds the /stamps/{amount}/{depth} endpoint where amount is the initial balance per chunk.

related changes:

chainId is now always queried when not running in standalone. even with swap disabled swap-endpoint is required.
swap is always disabled in standalone, even if swap is explicitly enabled

open issues:

currently postage stamps don't work at all with swap disabled as the token address is queried through the swap factory. this is only an issue if not standalone and --swap-enable=false.
package naming could be improved
bucketDepth is set incorrectly

acud

minor comments. otherwise looks good

pkg/api/postage.go

pkg/postage/postagecontract/contract.go

acud · 2021-01-21T19:17:14Z

pkg/postage/postagecontract/contract.go

+			batchID := createdEvent.BatchId[:]
+
+			c.postageService.Add(postage.NewStampIssuer(
+				"label",


@zelig please elaborate what these are for and if we should even set them now

yes, please set them via query param and/or form-data .
They are meeant to support 2 dimensional classification of stamps.
The UX presented in the book can then be simply supported from js side,
https://gateway.ethswarm.org/bzz/latest.bookofswarm.eth/#subsection.6.1.3
with label being generated from:

*minimal (a few hours)– Useful for immediate delivery of pss messages or singleowner chunks part of ephemeral chat or other temporary files.
•temporary (week)– Files or mailboxed messages meant not to be stored long butto be picked up by third parties asynchronously.
•long term (year)– Default long term storage.
•forever (10years)– Important content not to be lost/forgotten; to survive thegrowth of the network and subsequent increase of batch depth even if theuploader remains completely offline.

and batch reuse strategy maybe

"keyid" can be recorded as the batch owner etheraddress that would be used to call the appropriate signer with the right batch owner key.

label query param added. keyID is hex representation of owner address.

pkg/postage/postagecontract/contract.go

acud

one more thing - we should have an api test that covers this new endpoint - injecting a mock Interface and asserting it was called (or not) given different parameters.

ralph-pichler · 2021-01-22T10:36:13Z

@acud basic api test added. which cases should we test here?

pkg/api/postage.go

pkg/api/postage_test.go

pkg/api/postage.go

pkg/node/node.go

zelig · 2021-01-22T18:24:32Z

pkg/node/node.go


+	var postageContractService postagecontract.Interface


some TLC to naming here please.. i got no better idea though

pkg/postage/postagecontract/contract.go

zelig · 2021-01-22T18:27:23Z

pkg/postage/postagecontract/contract.go

+) Interface {
+	return &postageContract{
+		owner:               owner,
+		postageStampAddress: postageStampAddress,


this is the contract address no? please do not call it stamp address

see https://github.com/ethersphere/bee/pull/1142/files#r564473904

zelig · 2021-01-22T18:27:51Z

pkg/node/node.go


+	var postageContractService postagecontract.Interface
+	if !o.Standalone {


postageStampAddress is a misnomer below

the contract is actually called PostageStamp. For now I went with postageContractAddress. We should also change the flag which currently is --postage-stamp-address but we should reach a decision on naming first as changing that also means changing the helm chart.

zelig · 2021-01-22T18:31:03Z

pkg/postage/postagecontract/contract.go

+
+type batchCreatedEvent struct {
+	BatchId           [32]byte
+	TotalAmount       *big.Int


lets have one value called Value ok?

these names need to exactly match the contract names as the parser uses reflection underneath.

zelig · 2021-01-22T18:32:54Z

pkg/postage/postagecontract/contract_test.go

+	postageMock "github.com/ethersphere/bee/pkg/postage/mock"
+	"github.com/ethersphere/bee/pkg/postage/postagecontract"
+	"github.com/ethersphere/bee/pkg/settlement/swap/transaction"
+	transactionMock "github.com/ethersphere/bee/pkg/settlement/swap/transaction/mock"


time to move transaction pkg out of swap

agreed, but let's please do code moves in a separate PR after this

acud

LGTM

postage: new pkg for postage stamps, uploader stamping (#890) * postage: new pkg for postage stamps, uploader stamping * postage: amount->value, blockNumber big.Int-> uint64, stamp only has batch ID, not Batch * postage: fix godoc and copyright * postage, swarm: - swarm.Stamp as an interface - add postage/testing for mock Stamps - fix Stamp MarshalBinary to allow nil batch id and signature - add StampSize const * postage: heed review feedback Co-authored-by: acud <12988138+acud@users.noreply.github.com> Storage incentives: add stamper putter to api Postage BatchStore and BatchService (#1070) Co-authored-by: zelig <viktor.tron@gmail.com> add normalisedBalance to updater interface (#1108) make value the normalised balance (#1111) postage: add event listener (#1099) Wire up postage stamp syncing (#1114) localstore, shed: persist stamps (#1116) add --postage to beeinfra.sh setup pullsync, pushsync: add postage stamps (#1117) postage: add create endpoint (#1142) retrieve erc20 address from postage contract (#1169) postage: check balance before attempting stamp creation (#1177) postage: fix bucket depth (#1178) api: use hex encoding in postage api (#1179) increase page size (#1182) postage: handle bucket depth error in api (#1183) localstore: attach stamp to outgoing chunk (#1192) update postage stamp contract addresses for new token (#1208) batchstore: reserve (#1262) * postage/batchstore: reserve logic Co-authored-by: acud <12988138+acud@users.noreply.github.com> stamp support in storage and protocols (#1321) api: endpoints for stamp issuers (#1535) retrieval: add stamps (#1552) localstore reserve logic (#1322) Co-authored-by: acud <12988138+acud@users.noreply.github.com>

add create endpoint

371d0d5

bee-runner bot added the pull-request label Jan 21, 2021

ralph-pichler changed the title ~~add create endpoint~~ postage: add create endpoint Jan 21, 2021

temporary linting fix

e349115

acud reviewed Jan 21, 2021

View reviewed changes

ralph-pichler added 5 commits January 22, 2021 10:31

add unit test for contract interaction

fdc65e9

check data

4ed0c1f

add api test

b9b0cf0

add header

ad5bb38

minor fixes

5154e56

readd fallback batch for now

2ed154d

ralph-pichler marked this pull request as ready for review January 22, 2021 10:45

acud reviewed Jan 22, 2021

View reviewed changes

pkg/api/postage.go Show resolved Hide resolved

pkg/api/postage.go Outdated Show resolved Hide resolved

pkg/api/postage.go Outdated Show resolved Hide resolved

pkg/api/postage.go Outdated Show resolved Hide resolved

acud reviewed Jan 22, 2021

View reviewed changes

pkg/api/postage_test.go Outdated Show resolved Hide resolved

ralph-pichler added 3 commits January 22, 2021 15:45

fix logging and response

a14fb3f

add more api tests

12a09f8

2021

774dd60

acud reviewed Jan 22, 2021

View reviewed changes

pkg/api/postage.go Outdated Show resolved Hide resolved

pkg/node/node.go Outdated Show resolved Hide resolved

zelig approved these changes Jan 22, 2021

View reviewed changes

ralph-pichler added 4 commits January 25, 2021 18:45

minor fixes

8968d1d

remove fallback batch

7a376c2

add label

3e019b3

rename postagestampaddress to postagecontractaddress

8f6bf67

acud approved these changes Jan 26, 2021

View reviewed changes

ralph-pichler merged commit 3e123b5 into storage-incentives Jan 26, 2021

ralph-pichler deleted the postage_api branch January 26, 2021 15:07

acud pushed a commit that referenced this pull request Jan 27, 2021

postage: add create endpoint (#1142)

d75b882

acud pushed a commit that referenced this pull request Feb 1, 2021

postage: add create endpoint (#1142)

c65c1dd

acud pushed a commit that referenced this pull request Feb 3, 2021

postage: add create endpoint (#1142)

3b39567

acud pushed a commit that referenced this pull request Feb 9, 2021

postage: add create endpoint (#1142)

c0b76c7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

postage: add create endpoint #1142

postage: add create endpoint #1142

ralph-pichler commented Jan 21, 2021 •

edited

Loading

acud left a comment

acud Jan 21, 2021

zelig Jan 26, 2021 •

edited

Loading

ralph-pichler Jan 26, 2021

acud left a comment

ralph-pichler commented Jan 22, 2021

zelig Jan 22, 2021

zelig Jan 22, 2021

ralph-pichler Jan 26, 2021

zelig Jan 22, 2021

ralph-pichler Jan 26, 2021

zelig Jan 22, 2021

ralph-pichler Jan 25, 2021

zelig Jan 22, 2021

ralph-pichler Jan 25, 2021

acud left a comment


		var postageContractService postagecontract.Interface
		if !o.Standalone {

postage: add create endpoint #1142

postage: add create endpoint #1142

Conversation

ralph-pichler commented Jan 21, 2021 • edited Loading

acud left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zelig Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acud left a comment

Choose a reason for hiding this comment

ralph-pichler commented Jan 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acud left a comment

Choose a reason for hiding this comment

ralph-pichler commented Jan 21, 2021 •

edited

Loading

zelig Jan 26, 2021 •

edited

Loading