@@ -44,17 +44,17 @@ Using the API
4444 addresses = gna_result[' addresses' ]
4545
4646 # Generate 1 address, starting with index 42:
47- gna_result = api.get_new_addresses(start = 42 )
47+ gna_result = api.get_new_addresses(index = 42 )
4848 addresses = gna_result[' addresses' ]
4949
5050 # Find the first unused address, starting with index 86:
51- gna_result = api.get_new_addresses(start = 86 , count = None )
51+ gna_result = api.get_new_addresses(index = 86 , count = None )
5252 addresses = gna_result[' addresses' ]
5353
5454 To generate addresses using the API, invoke its ``get_new_addresses ``
5555method, using the following parameters:
5656
57- - ``start : int ``: The starting index (defaults to 0). This can be used
57+ - ``index : int ``: The starting index (defaults to 0). This can be used
5858 to skip over addresses that have already been generated.
5959- ``count: Optional[int] ``: The number of addresses to generate
6060 (defaults to 1).
@@ -80,13 +80,13 @@ Using AddressGenerator
8080 generator = AddressGenerator(b ' SEED9GOES9HERE' )
8181
8282 # Generate a list of addresses:
83- addresses = generator.get_addresses(start = 0 , count = 5 )
83+ addresses = generator.get_addresses(index = 0 , count = 5 )
8484
8585 # Generate a list of addresses in reverse order:
86- addresses = generator.get_addresses(start = 42 , count = 10 , step = - 1 )
86+ addresses = generator.get_addresses(index = 42 , count = 10 , step = - 1 )
8787
8888 # Create an iterator, advancing 5 indices each iteration.
89- iterator = generator.create_iterator(start = 86 , step = 5 )
89+ iterator = generator.create_iterator(index = 86 , step = 5 )
9090 for address in iterator:
9191 ...
9292
0 commit comments